From 3ef4ff4ee266107027cb74afe451c84814cef7cb Mon Sep 17 00:00:00 2001 From: Diana Lau Date: Fri, 6 Apr 2018 12:06:07 -0400 Subject: [PATCH] docs: update link from docs.strongloop.com --- index.js | 84 +++++++++++++++++++++++++++++++------------------------- 1 file changed, 46 insertions(+), 38 deletions(-) diff --git a/index.js b/index.js index 1d4d138..517ed57 100644 --- a/index.js +++ b/index.js @@ -3,24 +3,24 @@ // This file is licensed under the MIT License. // License text available at https://opensource.org/licenses/MIT -'use strict'; +"use strict"; -var SG = require('strong-globalize'); +var SG = require("strong-globalize"); SG.SetRootDir(__dirname); var g = SG(); /*! * Adds dynamically-updated docs as /explorer */ -var deprecated = require('depd')('loopback-explorer'); -var url = require('url'); -var path = require('path'); -var urlJoin = require('./lib/url-join'); -var _defaults = require('lodash').defaults; -var cors = require('cors'); -var createSwaggerObject = require('loopback-swagger').generateSwaggerSpec; -var SWAGGER_UI_ROOT = require('swagger-ui/index').dist; -var STATIC_ROOT = path.join(__dirname, 'public'); +var deprecated = require("depd")("loopback-explorer"); +var url = require("url"); +var path = require("path"); +var urlJoin = require("./lib/url-join"); +var _defaults = require("lodash").defaults; +var cors = require("cors"); +var createSwaggerObject = require("loopback-swagger").generateSwaggerSpec; +var SWAGGER_UI_ROOT = require("swagger-ui/index").dist; +var STATIC_ROOT = path.join(__dirname, "public"); module.exports = explorer; explorer.routes = routes; @@ -33,25 +33,32 @@ explorer.routes = routes; */ function explorer(loopbackApplication, options) { - options = _defaults({}, options, { mountPath: '/explorer' }); - loopbackApplication.use(options.mountPath, routes(loopbackApplication, options)); - loopbackApplication.set('loopback-component-explorer', options); + options = _defaults({}, options, { mountPath: "/explorer" }); + loopbackApplication.use( + options.mountPath, + routes(loopbackApplication, options) + ); + loopbackApplication.set("loopback-component-explorer", options); } function routes(loopbackApplication, options) { var loopback = loopbackApplication.loopback; - var loopbackMajor = loopback && loopback.version && - loopback.version.split('.')[0] || 1; + var loopbackMajor = + (loopback && loopback.version && loopback.version.split(".")[0]) || 1; if (loopbackMajor < 2) { - throw new Error(g.f('{{loopback-component-explorer}} requires ' + - '{{loopback}} 2.0 or newer')); + throw new Error( + g.f( + "{{loopback-component-explorer}} requires " + + "{{loopback}} 2.0 or newer" + ) + ); } options = _defaults({}, options, { - resourcePath: 'swagger.json', - apiInfo: loopbackApplication.get('apiInfo') || {}, - swaggerUI: true, + resourcePath: "swagger.json", + apiInfo: loopbackApplication.get("apiInfo") || {}, + swaggerUI: true }); var router = new loopback.Router(); @@ -60,16 +67,16 @@ function routes(loopbackApplication, options) { // config.json is loaded by swagger-ui. The server should respond // with the relative URI of the resource doc. - router.get('/config.json', function(req, res) { + router.get("/config.json", function(req, res) { // Get the path we're mounted at. It's best to get this from the referer // in case we're proxied at a deep path. - var source = url.parse(req.headers.referer || '').pathname; + var source = url.parse(req.headers.referer || "").pathname; // If no referer is available, use the incoming url. if (!source) { - source = req.originalUrl.replace(/\/config.json(\?.*)?$/, ''); + source = req.originalUrl.replace(/\/config.json(\?.*)?$/, ""); } res.send({ - url: urlJoin(source, '/' + options.resourcePath), + url: urlJoin(source, "/" + options.resourcePath) }); }); @@ -79,7 +86,7 @@ function routes(loopbackApplication, options) { // In this way one could e.g. make changes to index.html without having // to worry about constantly pulling in JS updates. if (options.uiDirs) { - if (typeof options.uiDirs === 'string') { + if (typeof options.uiDirs === "string") { router.use(loopback.static(options.uiDirs)); } else if (Array.isArray(options.uiDirs)) { options.uiDirs.forEach(function(dir) { @@ -112,25 +119,25 @@ function mountSwagger(loopbackApplication, swaggerApp, opts) { // listening to modelRemoted event for updating the swaggerObject // with the newly created model to appear in the Swagger UI. - loopbackApplication.on('modelRemoted', function() { + loopbackApplication.on("modelRemoted", function() { swaggerObject = createSwaggerObject(loopbackApplication, opts); }); // listening to started event for updating the swaggerObject // when a call to app.models.[modelName].nestRemoting([modelName]) // to appear that method in the Swagger UI. - loopbackApplication.on('remoteMethodAdded', function() { + loopbackApplication.on("remoteMethodAdded", function() { swaggerObject = createSwaggerObject(loopbackApplication, opts); }); // listening to remoteMethodDisabled event for updating the swaggerObject // when a remote method is disabled to hide that method in the Swagger UI. - loopbackApplication.on('remoteMethodDisabled', function() { + loopbackApplication.on("remoteMethodDisabled", function() { swaggerObject = createSwaggerObject(loopbackApplication, opts); }); - var resourcePath = opts && opts.resourcePath || 'swagger.json'; - if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath; + var resourcePath = (opts && opts.resourcePath) || "swagger.json"; + if (resourcePath[0] !== "/") resourcePath = "/" + resourcePath; var remotes = loopbackApplication.remotes(); setupCors(swaggerApp, remotes); @@ -142,14 +149,15 @@ function mountSwagger(loopbackApplication, swaggerApp, opts) { function setupCors(swaggerApp, remotes) { var corsOptions = remotes.options && remotes.options.cors; - if (corsOptions === false) - return; + if (corsOptions === false) return; - deprecated(g.f( - 'The built-in CORS middleware provided by loopback-component-explorer ' + - 'was deprecated. See %s for more details.', - 'https://docs.strongloop.com/display/public/LB/Security+considerations' - )); + deprecated( + g.f( + "The built-in CORS middleware provided by loopback-component-explorer " + + "was deprecated. See %s for more details.", + "https://loopback.io/doc/en/lb3/Security-considerations.html" + ) + ); if (corsOptions === undefined) { corsOptions = { origin: true, credentials: true };