@loopback/rest-explorer 2.1.1 → 2.2.2

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.2.2](https://github.com/strongloop/loopback-next/compare/@loopback/rest-explorer@2.2.1...@loopback/rest-explorer@2.2.2) (2020-05-20)
+
+**Note:** Version bump only for package @loopback/rest-explorer
+
+
+
+
+
+## [2.2.1](https://github.com/strongloop/loopback-next/compare/@loopback/rest-explorer@2.2.0...@loopback/rest-explorer@2.2.1) (2020-05-19)
+
+**Note:** Version bump only for package @loopback/rest-explorer
+
+
+
+
+
+# [2.2.0](https://github.com/strongloop/loopback-next/compare/@loopback/rest-explorer@2.1.2...@loopback/rest-explorer@2.2.0) (2020-05-07)
+
+
+### Features
+
+* demo customize the swagger ui theme ([695ba58](https://github.com/strongloop/loopback-next/commit/695ba58fda37763467c07016bdaa15a7399cd0e6))
+
+
+
+
+
+## [2.1.2](https://github.com/strongloop/loopback-next/compare/@loopback/rest-explorer@2.1.1...@loopback/rest-explorer@2.1.2) (2020-04-29)
+
+**Note:** Version bump only for package @loopback/rest-explorer
+
+
+
+
+
 ## [2.1.1](https://github.com/strongloop/loopback-next/compare/@loopback/rest-explorer@2.1.0...@loopback/rest-explorer@2.1.1) (2020-04-23)
 
 **Note:** Version bump only for package @loopback/rest-explorer

package/README.md

@@ -44,14 +44,6 @@ this.bind(RestExplorerBindings.CONFIG).to({
 });
 ```
 
-_NOTE: The Explorer UI's visual style is not customizable yet. Our recommended
-solution is to create a fork of this module, make any style changes in the fork
-and publish the modified module under a different name. The
-[GitHub issue #2023](https://github.com/strongloop/loopback-next/issues/2023) is
-requesting a configuration option for customizing the visual style, please
-up-vote the issue and/or join the discussion if you are interested in this
-feature._
-
 ### Advanced Configuration and Reverse Proxies
 
 By default, the component will add an additional OpenAPI spec endpoint, in the
@@ -139,6 +131,47 @@ needed in this situation, such as passing a non-standard header from your
 reverse proxy to tell the app the external path, and custom code in your app to
 make the app and explorer aware of this.
 
+### Customizing Swagger UI Theme
+
+The Explorer UI’s visual style can be customized by configuring the
+`swaggerThemeFile` property. Here is the steps to do it:
+
+First, provide your own Swagger-UI theme file in a public folder. For example,
+in the
+[Todo example](https://github.com/strongloop/loopback-next/tree/master/examples/todo)
+application:
+
+Its `/public` folder is set up as the default home page with url `/`. Copy a
+swagger theme file `theme-newspaper.css` to be under `/public`.
+
+Then configure the `swaggerThemeFile` field to be the relative path to home page
+as `/theme-newspaper.css`:
+
+```ts
+export class TodoListApplication extends BootMixin(
+  ServiceMixin(RepositoryMixin(RestApplication)),
+) {
+  constructor(options: ApplicationConfig = {}) {
+    // ...
+
+    // customize the swagger-ui
+    this.configure(RestExplorerBindings.COMPONENT).to({
+      // Keep the theme file in the `public` dir of the app
+      // If required create a dir and keep the file, just specify the path
+      swaggerThemeFile: '/theme-newspaper.css',
+    });
+
+    // ...
+  }
+}
+```
+
+When the application runs, the explorer template will load the
+`theme-newspaper.css` file as its theme.
+
+Here is a repository that contains popular Swagger-UI themes:
+https://github.com/ostranme/swagger-ui-themes.
+
 ## Contributions
 
 - [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)

package/dist/index.js

@@ -17,4 +17,5 @@ const tslib_1 = require("tslib");
  */
 tslib_1.__exportStar(require("./rest-explorer.component"), exports);
 tslib_1.__exportStar(require("./rest-explorer.keys"), exports);
+tslib_1.__exportStar(require("./rest-explorer.types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;GASG;AAEH,oEAA0C;AAC1C,+DAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;AAEhE;;;;;;;;;GASG;AAEH,oEAA0C;AAC1C,+DAAqC;AACrC,gEAAsC"}

package/dist/rest-explorer.component.js

@@ -4,6 +4,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestExplorerComponent = void 0;
 const tslib_1 = require("tslib");
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const context_1 = require("@loopback/context");
@@ -15,32 +16,35 @@ const swaggerUI = require('swagger-ui-dist');
 /**
  * A component providing a self-hosted API Explorer.
  */
-let RestExplorerComponent = class RestExplorerComponent {
-    constructor(application, restExplorerConfig = {}) {
-        var _a;
-        this.application = application;
-        const explorerPath = (_a = restExplorerConfig.path) !== null && _a !== void 0 ? _a : '/explorer';
-        this.registerControllerRoute('get', explorerPath, 'indexRedirect');
-        this.registerControllerRoute('get', explorerPath + '/', 'index');
-        if (restExplorerConfig.useSelfHostedSpec !== false) {
-            this.registerControllerRoute('get', explorerPath + '/openapi.json', 'spec');
+let RestExplorerComponent = /** @class */ (() => {
+    let RestExplorerComponent = class RestExplorerComponent {
+        constructor(application, restExplorerConfig = {}) {
+            var _a;
+            this.application = application;
+            const explorerPath = (_a = restExplorerConfig.path) !== null && _a !== void 0 ? _a : '/explorer';
+            this.registerControllerRoute('get', explorerPath, 'indexRedirect');
+            this.registerControllerRoute('get', explorerPath + '/', 'index');
+            if (restExplorerConfig.useSelfHostedSpec !== false) {
+                this.registerControllerRoute('get', explorerPath + '/openapi.json', 'spec');
+            }
+            application.static(explorerPath, swaggerUI.getAbsoluteFSPath());
+            // Disable redirect to externally hosted API explorer
+            application.restServer.config.apiExplorer = { disabled: true };
         }
-        application.static(explorerPath, swaggerUI.getAbsoluteFSPath());
-        // Disable redirect to externally hosted API explorer
-        application.restServer.config.apiExplorer = { disabled: true };
-    }
-    registerControllerRoute(verb, path, methodName) {
-        this.application.route(verb, path, {
-            'x-visibility': 'undocumented',
-            responses: {},
-        }, rest_explorer_controller_1.ExplorerController, rest_1.createControllerFactoryForClass(rest_explorer_controller_1.ExplorerController), methodName);
-    }
-};
-RestExplorerComponent = tslib_1.__decorate([
-    context_1.bind({ tags: { [context_1.ContextTags.KEY]: rest_explorer_keys_1.RestExplorerBindings.COMPONENT.key } }),
-    tslib_1.__param(0, context_1.inject(core_1.CoreBindings.APPLICATION_INSTANCE)),
-    tslib_1.__param(1, context_1.config()),
-    tslib_1.__metadata("design:paramtypes", [rest_1.RestApplication, Object])
-], RestExplorerComponent);
+        registerControllerRoute(verb, path, methodName) {
+            this.application.route(verb, path, {
+                'x-visibility': 'undocumented',
+                responses: {},
+            }, rest_explorer_controller_1.ExplorerController, rest_1.createControllerFactoryForClass(rest_explorer_controller_1.ExplorerController), methodName);
+        }
+    };
+    RestExplorerComponent = tslib_1.__decorate([
+        context_1.bind({ tags: { [context_1.ContextTags.KEY]: rest_explorer_keys_1.RestExplorerBindings.COMPONENT.key } }),
+        tslib_1.__param(0, context_1.inject(core_1.CoreBindings.APPLICATION_INSTANCE)),
+        tslib_1.__param(1, context_1.config()),
+        tslib_1.__metadata("design:paramtypes", [rest_1.RestApplication, Object])
+    ], RestExplorerComponent);
+    return RestExplorerComponent;
+})();
 exports.RestExplorerComponent = RestExplorerComponent;
 //# sourceMappingURL=rest-explorer.component.js.map

package/dist/rest-explorer.component.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest-explorer.component.js","sourceRoot":"","sources":["../src/rest-explorer.component.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,6DAA6D;AAC7D,+CAAoE;AACpE,yCAAuD;AACvD,yCAAgF;AAChF,yEAA8D;AAC9D,6DAA0D;AAG1D,MAAM,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE7C;;GAEG;AAEH,IAAa,qBAAqB,GAAlC,MAAa,qBAAqB;IAChC,YAEU,WAA4B,EAEpC,qBAAyC,EAAE;;QAFnC,gBAAW,GAAX,WAAW,CAAiB;QAIpC,MAAM,YAAY,SAAG,kBAAkB,CAAC,IAAI,mCAAI,WAAW,CAAC;QAE5D,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QACnE,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,GAAG,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,kBAAkB,CAAC,iBAAiB,KAAK,KAAK,EAAE;YAClD,IAAI,CAAC,uBAAuB,CAC1B,KAAK,EACL,YAAY,GAAG,eAAe,EAC9B,MAAM,CACP,CAAC;SACH;QAED,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAEhE,qDAAqD;QACrD,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,GAAG,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;IAC/D,CAAC;IAEO,uBAAuB,CAC7B,IAAY,EACZ,IAAY,EACZ,UAAkB;QAElB,IAAI,CAAC,WAAW,CAAC,KAAK,CACpB,IAAI,EACJ,IAAI,EACJ;YACE,cAAc,EAAE,cAAc;YAC9B,SAAS,EAAE,EAAE;SACd,EACD,6CAAkB,EAClB,sCAA+B,CAAC,6CAAkB,CAAC,EACnD,UAAU,CACX,CAAC;IACJ,CAAC;CACF,CAAA;AA1CY,qBAAqB;IADjC,cAAI,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,qBAAW,CAAC,GAAG,CAAC,EAAE,yCAAoB,CAAC,SAAS,CAAC,GAAG,EAAC,EAAC,CAAC;IAGjE,mBAAA,gBAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzC,mBAAA,gBAAM,EAAE,CAAA;6CADY,sBAAe;GAH3B,qBAAqB,CA0CjC;AA1CY,sDAAqB"}
+{"version":3,"file":"rest-explorer.component.js","sourceRoot":"","sources":["../src/rest-explorer.component.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,6DAA6D;AAC7D,+CAAoE;AACpE,yCAAuD;AACvD,yCAAgF;AAChF,yEAA8D;AAC9D,6DAA0D;AAG1D,MAAM,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE7C;;GAEG;AAEH;IAAA,IAAa,qBAAqB,GAAlC,MAAa,qBAAqB;QAChC,YAEU,WAA4B,EAEpC,qBAAyC,EAAE;;YAFnC,gBAAW,GAAX,WAAW,CAAiB;YAIpC,MAAM,YAAY,SAAG,kBAAkB,CAAC,IAAI,mCAAI,WAAW,CAAC;YAE5D,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,GAAG,EAAE,OAAO,CAAC,CAAC;YACjE,IAAI,kBAAkB,CAAC,iBAAiB,KAAK,KAAK,EAAE;gBAClD,IAAI,CAAC,uBAAuB,CAC1B,KAAK,EACL,YAAY,GAAG,eAAe,EAC9B,MAAM,CACP,CAAC;aACH;YAED,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEhE,qDAAqD;YACrD,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,GAAG,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;QAC/D,CAAC;QAEO,uBAAuB,CAC7B,IAAY,EACZ,IAAY,EACZ,UAAkB;YAElB,IAAI,CAAC,WAAW,CAAC,KAAK,CACpB,IAAI,EACJ,IAAI,EACJ;gBACE,cAAc,EAAE,cAAc;gBAC9B,SAAS,EAAE,EAAE;aACd,EACD,6CAAkB,EAClB,sCAA+B,CAAC,6CAAkB,CAAC,EACnD,UAAU,CACX,CAAC;QACJ,CAAC;KACF,CAAA;IA1CY,qBAAqB;QADjC,cAAI,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,qBAAW,CAAC,GAAG,CAAC,EAAE,yCAAoB,CAAC,SAAS,CAAC,GAAG,EAAC,EAAC,CAAC;QAGjE,mBAAA,gBAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;QAEzC,mBAAA,gBAAM,EAAE,CAAA;iDADY,sBAAe;OAH3B,qBAAqB,CA0CjC;IAAD,4BAAC;KAAA;AA1CY,sDAAqB"}

package/dist/rest-explorer.controller.d.ts

@@ -8,6 +8,7 @@ export declare class ExplorerController {
     static readonly OPENAPI_FORM: OpenApiSpecForm;
     private openApiSpecUrl;
     private useSelfHostedSpec;
+    private swaggerThemeFile;
     constructor(restConfig: (Partial<import("@loopback/rest").RestServerResolvedOptions> & import("@loopback/http-server").HttpOptions) | (Partial<import("@loopback/rest").RestServerResolvedOptions> & import("@loopback/http-server").HttpsOptions) | undefined, explorerConfig: RestExplorerConfig | undefined, serverBasePath: string, restServer: RestServer, requestContext: RequestContext);
     indexRedirect(): void;
     index(): void;

package/dist/rest-explorer.controller.js

@@ -4,6 +4,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExplorerController = void 0;
 const tslib_1 = require("tslib");
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const context_1 = require("@loopback/context");
@@ -16,79 +17,86 @@ const rest_explorer_keys_1 = require("./rest-explorer.keys");
 const indexHtml = path_1.default.resolve(__dirname, '../templates/index.html.ejs');
 const template = fs_1.default.readFileSync(indexHtml, 'utf-8');
 const templateFn = ejs_1.default.compile(template);
-let ExplorerController = class ExplorerController {
-    constructor(restConfig = {}, explorerConfig = {}, serverBasePath, restServer, requestContext) {
-        this.serverBasePath = serverBasePath;
-        this.restServer = restServer;
-        this.requestContext = requestContext;
-        this.useSelfHostedSpec = explorerConfig.useSelfHostedSpec !== false;
-        this.openApiSpecUrl = this.getOpenApiSpecUrl(restConfig);
-    }
-    indexRedirect() {
-        const { request, response } = this.requestContext;
-        let url = request.originalUrl || request.url;
-        // be safe against path-modifying reverse proxies by generating the redirect
-        // as a _relative_ URL
-        const lastSlash = url.lastIndexOf('/');
-        if (lastSlash >= 0) {
-            url = './' + url.substr(lastSlash + 1) + '/';
+let ExplorerController = /** @class */ (() => {
+    let ExplorerController = class ExplorerController {
+        constructor(restConfig = {}, explorerConfig = {}, serverBasePath, restServer, requestContext) {
+            var _a;
+            this.serverBasePath = serverBasePath;
+            this.restServer = restServer;
+            this.requestContext = requestContext;
+            this.useSelfHostedSpec = explorerConfig.useSelfHostedSpec !== false;
+            this.openApiSpecUrl = this.getOpenApiSpecUrl(restConfig);
+            this.swaggerThemeFile = (_a = explorerConfig.swaggerThemeFile) !== null && _a !== void 0 ? _a : './swagger-ui.css';
         }
-        response.redirect(301, url);
-    }
-    index() {
-        let openApiSpecUrl = this.openApiSpecUrl;
-        // if using self-hosted openapi spec, then the path to use is always the
-        // exact relative path, and no base path logic needs to be applied
-        if (!this.useSelfHostedSpec) {
-            // baseURL is composed from mountPath and basePath
-            // OpenAPI endpoints ignore basePath but do honor mountPath
-            let rootPath = this.requestContext.request.baseUrl;
-            if (this.serverBasePath &&
-                this.serverBasePath !== '/' &&
-                rootPath.endsWith(this.serverBasePath)) {
-                rootPath = rootPath.slice(0, -this.serverBasePath.length);
+        indexRedirect() {
+            const { request, response } = this.requestContext;
+            let url = request.originalUrl || request.url;
+            // be safe against path-modifying reverse proxies by generating the redirect
+            // as a _relative_ URL
+            const lastSlash = url.lastIndexOf('/');
+            if (lastSlash >= 0) {
+                url = './' + url.substr(lastSlash + 1) + '/';
             }
-            if (rootPath && rootPath !== '/') {
-                openApiSpecUrl = rootPath + openApiSpecUrl;
+            response.redirect(301, url);
+        }
+        index() {
+            const swaggerThemeFile = this.swaggerThemeFile;
+            let openApiSpecUrl = this.openApiSpecUrl;
+            // if using self-hosted openapi spec, then the path to use is always the
+            // exact relative path, and no base path logic needs to be applied
+            if (!this.useSelfHostedSpec) {
+                // baseURL is composed from mountPath and basePath
+                // OpenAPI endpoints ignore basePath but do honor mountPath
+                let rootPath = this.requestContext.request.baseUrl;
+                if (this.serverBasePath &&
+                    this.serverBasePath !== '/' &&
+                    rootPath.endsWith(this.serverBasePath)) {
+                    rootPath = rootPath.slice(0, -this.serverBasePath.length);
+                }
+                if (rootPath && rootPath !== '/') {
+                    openApiSpecUrl = rootPath + openApiSpecUrl;
+                }
             }
+            const data = {
+                openApiSpecUrl,
+                swaggerThemeFile,
+            };
+            const homePage = templateFn(data);
+            this.requestContext.response
+                .status(200)
+                .contentType('text/html')
+                .send(homePage);
+        }
+        spec() {
+            return this.restServer.getApiSpec(this.requestContext);
         }
-        const data = {
-            openApiSpecUrl,
-        };
-        const homePage = templateFn(data);
-        this.requestContext.response
-            .status(200)
-            .contentType('text/html')
-            .send(homePage);
-    }
-    spec() {
-        return this.restServer.getApiSpec(this.requestContext);
-    }
-    getOpenApiSpecUrl(restConfig) {
-        var _a, _b;
-        if (this.useSelfHostedSpec) {
-            return './' + ExplorerController.OPENAPI_RELATIVE_URL;
+        getOpenApiSpecUrl(restConfig) {
+            var _a, _b;
+            if (this.useSelfHostedSpec) {
+                return './' + ExplorerController.OPENAPI_RELATIVE_URL;
+            }
+            const openApiConfig = (_a = restConfig.openApiSpec) !== null && _a !== void 0 ? _a : {};
+            const endpointMapping = (_b = openApiConfig.endpointMapping) !== null && _b !== void 0 ? _b : {};
+            const endpoint = Object.keys(endpointMapping).find(k => isOpenApiV3Json(endpointMapping[k]));
+            return endpoint !== null && endpoint !== void 0 ? endpoint : '/openapi.json';
         }
-        const openApiConfig = (_a = restConfig.openApiSpec) !== null && _a !== void 0 ? _a : {};
-        const endpointMapping = (_b = openApiConfig.endpointMapping) !== null && _b !== void 0 ? _b : {};
-        const endpoint = Object.keys(endpointMapping).find(k => isOpenApiV3Json(endpointMapping[k]));
-        return endpoint !== null && endpoint !== void 0 ? endpoint : '/openapi.json';
-    }
-};
-ExplorerController.OPENAPI_RELATIVE_URL = 'openapi.json';
-ExplorerController.OPENAPI_FORM = Object.freeze({
-    version: '3.0.0',
-    format: 'json',
-});
-ExplorerController = tslib_1.__decorate([
-    tslib_1.__param(0, context_1.inject(rest_1.RestBindings.CONFIG, { optional: true })),
-    tslib_1.__param(1, context_1.config({ fromBinding: rest_explorer_keys_1.RestExplorerBindings.COMPONENT })),
-    tslib_1.__param(2, context_1.inject(rest_1.RestBindings.BASE_PATH)),
-    tslib_1.__param(3, context_1.inject(rest_1.RestBindings.SERVER)),
-    tslib_1.__param(4, context_1.inject(rest_1.RestBindings.Http.CONTEXT)),
-    tslib_1.__metadata("design:paramtypes", [Object, Object, String, rest_1.RestServer,
-        rest_1.RequestContext])
-], ExplorerController);
+    };
+    ExplorerController.OPENAPI_RELATIVE_URL = 'openapi.json';
+    ExplorerController.OPENAPI_FORM = Object.freeze({
+        version: '3.0.0',
+        format: 'json',
+    });
+    ExplorerController = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(rest_1.RestBindings.CONFIG, { optional: true })),
+        tslib_1.__param(1, context_1.config({ fromBinding: rest_explorer_keys_1.RestExplorerBindings.COMPONENT })),
+        tslib_1.__param(2, context_1.inject(rest_1.RestBindings.BASE_PATH)),
+        tslib_1.__param(3, context_1.inject(rest_1.RestBindings.SERVER)),
+        tslib_1.__param(4, context_1.inject(rest_1.RestBindings.Http.CONTEXT)),
+        tslib_1.__metadata("design:paramtypes", [Object, Object, String, rest_1.RestServer,
+            rest_1.RequestContext])
+    ], ExplorerController);
+    return ExplorerController;
+})();
 exports.ExplorerController = ExplorerController;
 function isOpenApiV3Json(mapping) {
     return (mapping.version === ExplorerController.OPENAPI_FORM.version &&

package/dist/rest-explorer.controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest-explorer.controller.js","sourceRoot":"","sources":["../src/rest-explorer.controller.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,6DAA6D;AAC7D,+CAAiD;AACjD,yCAMwB;AACxB,sDAAsB;AACtB,oDAAoB;AACpB,wDAAwB;AACxB,6DAA0D;AAG1D,qDAAqD;AACrD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;AACzE,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACrD,MAAM,UAAU,GAAG,aAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEzC,IAAa,kBAAkB,GAA/B,MAAa,kBAAkB;IAU7B,YAEE,aAA+B,EAAE,EAEjC,iBAAqC,EAAE,EACC,cAAsB,EACzB,UAAsB,EAChB,cAA8B;QAFjC,mBAAc,GAAd,cAAc,CAAQ;QACzB,eAAU,GAAV,UAAU,CAAY;QAChB,mBAAc,GAAd,cAAc,CAAgB;QAEzE,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC,iBAAiB,KAAK,KAAK,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC3D,CAAC;IAED,aAAa;QACX,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAChD,IAAI,GAAG,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;QAC7C,4EAA4E;QAC5E,sBAAsB;QACtB,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,SAAS,IAAI,CAAC,EAAE;YAClB,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;SAC9C;QACD,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK;QACH,IAAI,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAEzC,wEAAwE;QACxE,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,kDAAkD;YAClD,2DAA2D;YAC3D,IAAI,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC;YACnD,IACE,IAAI,CAAC,cAAc;gBACnB,IAAI,CAAC,cAAc,KAAK,GAAG;gBAC3B,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,EACtC;gBACA,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aAC3D;YAED,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAChC,cAAc,GAAG,QAAQ,GAAG,cAAc,CAAC;aAC5C;SACF;QACD,MAAM,IAAI,GAAG;YACX,cAAc;SACf,CAAC;QAEF,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,cAAc,CAAC,QAAQ;aACzB,MAAM,CAAC,GAAG,CAAC;aACX,WAAW,CAAC,WAAW,CAAC;aACxB,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzD,CAAC;IAEO,iBAAiB,CAAC,UAA4B;;QACpD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,GAAG,kBAAkB,CAAC,oBAAoB,CAAC;SACvD;QACD,MAAM,aAAa,SAAG,UAAU,CAAC,WAAW,mCAAI,EAAE,CAAC;QACnD,MAAM,eAAe,SAAG,aAAa,CAAC,eAAe,mCAAI,EAAE,CAAC;QAC5D,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACrD,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACpC,CAAC;QACF,OAAO,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,eAAe,CAAC;IACrC,CAAC;CACF,CAAA;AAjFiB,uCAAoB,GAAG,cAAc,CAAC;AACtC,+BAAY,GAAoB,MAAM,CAAC,MAAM,CAAC;IAC5D,OAAO,EAAE,OAAO;IAChB,MAAM,EAAE,MAAM;CACf,CAAC,CAAC;AALQ,kBAAkB;IAW1B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;IAE7C,mBAAA,gBAAM,CAAC,EAAC,WAAW,EAAE,yCAAoB,CAAC,SAAS,EAAC,CAAC,CAAA;IAErD,mBAAA,gBAAM,CAAC,mBAAY,CAAC,SAAS,CAAC,CAAA;IAC9B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,CAAC,CAAA;IAC3B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;qEADe,iBAAU;QACA,qBAAc;GAjBhE,kBAAkB,CAkF9B;AAlFY,gDAAkB;AAoF/B,SAAS,eAAe,CAAC,OAAwB;IAC/C,OAAO,CACL,OAAO,CAAC,OAAO,KAAK,kBAAkB,CAAC,YAAY,CAAC,OAAO;QAC3D,OAAO,CAAC,MAAM,KAAK,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAC1D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"rest-explorer.controller.js","sourceRoot":"","sources":["../src/rest-explorer.controller.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,6DAA6D;AAC7D,+CAAiD;AACjD,yCAMwB;AACxB,sDAAsB;AACtB,oDAAoB;AACpB,wDAAwB;AACxB,6DAA0D;AAG1D,qDAAqD;AACrD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;AACzE,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACrD,MAAM,UAAU,GAAG,aAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEzC;IAAA,IAAa,kBAAkB,GAA/B,MAAa,kBAAkB;QAW7B,YAEE,aAA+B,EAAE,EAEjC,iBAAqC,EAAE,EACC,cAAsB,EACzB,UAAsB,EAChB,cAA8B;;YAFjC,mBAAc,GAAd,cAAc,CAAQ;YACzB,eAAU,GAAV,UAAU,CAAY;YAChB,mBAAc,GAAd,cAAc,CAAgB;YAEzE,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC,iBAAiB,KAAK,KAAK,CAAC;YACpE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACzD,IAAI,CAAC,gBAAgB,SACnB,cAAc,CAAC,gBAAgB,mCAAI,kBAAkB,CAAC;QAC1D,CAAC;QAED,aAAa;YACX,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC,cAAc,CAAC;YAChD,IAAI,GAAG,GAAG,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;YAC7C,4EAA4E;YAC5E,sBAAsB;YACtB,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,SAAS,IAAI,CAAC,EAAE;gBAClB,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;aAC9C;YACD,QAAQ,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,KAAK;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAC/C,IAAI,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;YAEzC,wEAAwE;YACxE,kEAAkE;YAClE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;gBAC3B,kDAAkD;gBAClD,2DAA2D;gBAC3D,IAAI,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC;gBACnD,IACE,IAAI,CAAC,cAAc;oBACnB,IAAI,CAAC,cAAc,KAAK,GAAG;oBAC3B,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,EACtC;oBACA,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;iBAC3D;gBAED,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;oBAChC,cAAc,GAAG,QAAQ,GAAG,cAAc,CAAC;iBAC5C;aACF;YACD,MAAM,IAAI,GAAG;gBACX,cAAc;gBACd,gBAAgB;aACjB,CAAC;YAEF,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ;iBACzB,MAAM,CAAC,GAAG,CAAC;iBACX,WAAW,CAAC,WAAW,CAAC;iBACxB,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC;QAED,IAAI;YACF,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzD,CAAC;QAEO,iBAAiB,CAAC,UAA4B;;YACpD,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC1B,OAAO,IAAI,GAAG,kBAAkB,CAAC,oBAAoB,CAAC;aACvD;YACD,MAAM,aAAa,SAAG,UAAU,CAAC,WAAW,mCAAI,EAAE,CAAC;YACnD,MAAM,eAAe,SAAG,aAAa,CAAC,eAAe,mCAAI,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACrD,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CACpC,CAAC;YACF,OAAO,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,eAAe,CAAC;QACrC,CAAC;KACF,CAAA;IAtFiB,uCAAoB,GAAG,cAAc,CAAC;IACtC,+BAAY,GAAoB,MAAM,CAAC,MAAM,CAAC;QAC5D,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;IALQ,kBAAkB;QAY1B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;QAE7C,mBAAA,gBAAM,CAAC,EAAC,WAAW,EAAE,yCAAoB,CAAC,SAAS,EAAC,CAAC,CAAA;QAErD,mBAAA,gBAAM,CAAC,mBAAY,CAAC,SAAS,CAAC,CAAA;QAC9B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,CAAC,CAAA;QAC3B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;yEADe,iBAAU;YACA,qBAAc;OAlBhE,kBAAkB,CAuF9B;IAAD,yBAAC;KAAA;AAvFY,gDAAkB;AAyF/B,SAAS,eAAe,CAAC,OAAwB;IAC/C,OAAO,CACL,OAAO,CAAC,OAAO,KAAK,kBAAkB,CAAC,YAAY,CAAC,OAAO;QAC3D,OAAO,CAAC,MAAM,KAAK,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAC1D,CAAC;AACJ,CAAC"}

package/dist/rest-explorer.keys.d.ts

@@ -1,4 +1,4 @@
-import { BindingKey } from '@loopback/context';
+import { BindingAddress, BindingKey } from '@loopback/context';
 import { RestExplorerComponent } from './rest-explorer.component';
 import { RestExplorerConfig } from './rest-explorer.types';
 /**
@@ -15,5 +15,5 @@ export declare namespace RestExplorerBindings {
      * We recommend `ctx.configure(RestExplorerBindings.COMPONENT)` to be used
      * instead of `ctx.bind(RestExplorerBindings.CONFIG)`.
      */
-    const CONFIG: import("@loopback/context").BindingAddress<RestExplorerConfig>;
+    const CONFIG: BindingAddress<RestExplorerConfig>;
 }

package/dist/rest-explorer.keys.js

@@ -4,6 +4,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestExplorerBindings = void 0;
 const context_1 = require("@loopback/context");
 /**
  * Binding keys used by this component.

package/dist/rest-explorer.keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest-explorer.keys.js","sourceRoot":"","sources":["../src/rest-explorer.keys.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;AAEhE,+CAA6C;AAI7C;;GAEG;AACH,IAAiB,oBAAoB,CAgBpC;AAhBD,WAAiB,oBAAoB;IACnC;;OAEG;IACU,8BAAS,GAAG,oBAAU,CAAC,MAAM,CACxC,kCAAkC,CACnC,CAAC;IACF;;;;;OAKG;IACU,2BAAM,GAAG,oBAAU,CAAC,iBAAiB,CAChD,qBAAA,SAAS,CACV,CAAC;AACJ,CAAC,EAhBgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAgBpC"}
+{"version":3,"file":"rest-explorer.keys.js","sourceRoot":"","sources":["../src/rest-explorer.keys.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,uCAAuC;AACvC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,+CAA6D;AAI7D;;GAEG;AACH,IAAiB,oBAAoB,CAgBpC;AAhBD,WAAiB,oBAAoB;IACnC;;OAEG;IACU,8BAAS,GAAG,oBAAU,CAAC,MAAM,CACxC,kCAAkC,CACnC,CAAC;IACF;;;;;OAKG;IACU,2BAAM,GAAuC,oBAAU,CAAC,iBAAiB,CAEpF,qBAAA,SAAS,CAAC,CAAC;AACf,CAAC,EAhBgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAgBpC"}

package/dist/rest-explorer.types.d.ts

@@ -23,4 +23,5 @@ export declare type RestExplorerConfig = {
      * forwarded to the application behind the proxy.
      */
     useSelfHostedSpec?: false;
+    swaggerThemeFile?: string;
 };

package/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@loopback/rest-explorer",
-  "version": "2.1.1",
+  "version": "2.2.2",
   "description": "LoopBack's API Explorer",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "engines": {
     "node": ">=10"
   },
@@ -16,20 +18,20 @@
   "copyright.owner": "IBM Corp.",
   "license": "MIT",
   "dependencies": {
-    "@loopback/context": "^3.5.1",
-    "@loopback/core": "^2.4.1",
-    "@loopback/rest": "^3.3.1",
-    "ejs": "^3.0.2",
-    "swagger-ui-dist": "^3.25.0",
-    "tslib": "^1.11.1"
+    "@loopback/context": "^3.8.1",
+    "@loopback/core": "^2.7.0",
+    "@loopback/rest": "^5.0.1",
+    "ejs": "^3.1.3",
+    "swagger-ui-dist": "^3.25.3",
+    "tslib": "^2.0.0"
   },
   "devDependencies": {
-    "@loopback/build": "^5.2.0",
-    "@loopback/eslint-config": "^6.0.4",
-    "@loopback/testlab": "^3.1.1",
-    "@types/ejs": "^3.0.2",
+    "@loopback/build": "^5.4.1",
+    "@loopback/eslint-config": "^7.0.1",
+    "@loopback/testlab": "^3.1.5",
+    "@types/ejs": "^3.0.4",
     "@types/express": "^4.17.6",
-    "@types/node": "^10.17.21",
+    "@types/node": "^10.17.24",
     "express": "^4.17.1"
   },
   "keywords": [
@@ -39,8 +41,6 @@
   ],
   "files": [
     "README.md",
-    "index.js",
-    "index.d.ts",
     "dist",
     "src",
     "!*/__tests__",
@@ -54,5 +54,5 @@
     "url": "https://github.com/strongloop/loopback-next.git",
     "directory": "packages/rest-explorer"
   },
-  "gitHead": "11f282df0bbdf25c505a2131e6d82b85005a22a2"
+  "gitHead": "62aea854bf85c5a5995b59e6908fe5409f7eea96"
 }

package/src/rest-explorer.controller.ts

@@ -32,6 +32,7 @@ export class ExplorerController {
 
   private openApiSpecUrl: string;
   private useSelfHostedSpec: boolean;
+  private swaggerThemeFile: string;
 
   constructor(
     @inject(RestBindings.CONFIG, {optional: true})
@@ -44,6 +45,8 @@ export class ExplorerController {
   ) {
     this.useSelfHostedSpec = explorerConfig.useSelfHostedSpec !== false;
     this.openApiSpecUrl = this.getOpenApiSpecUrl(restConfig);
+    this.swaggerThemeFile =
+      explorerConfig.swaggerThemeFile ?? './swagger-ui.css';
   }
 
   indexRedirect() {
@@ -59,6 +62,7 @@ export class ExplorerController {
   }
 
   index() {
+    const swaggerThemeFile = this.swaggerThemeFile;
     let openApiSpecUrl = this.openApiSpecUrl;
 
     // if using self-hosted openapi spec, then the path to use is always the
@@ -81,6 +85,7 @@ export class ExplorerController {
     }
     const data = {
       openApiSpecUrl,
+      swaggerThemeFile,
     };
 
     const homePage = templateFn(data);

package/src/rest-explorer.keys.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {BindingKey} from '@loopback/context';
+import {BindingAddress, BindingKey} from '@loopback/context';
 import {RestExplorerComponent} from './rest-explorer.component';
 import {RestExplorerConfig} from './rest-explorer.types';
 
@@ -23,7 +23,7 @@ export namespace RestExplorerBindings {
    * We recommend `ctx.configure(RestExplorerBindings.COMPONENT)` to be used
    * instead of `ctx.bind(RestExplorerBindings.CONFIG)`.
    */
-  export const CONFIG = BindingKey.buildKeyForConfig<RestExplorerConfig>(
-    COMPONENT,
-  );
+  export const CONFIG: BindingAddress<RestExplorerConfig> = BindingKey.buildKeyForConfig<
+    RestExplorerConfig
+  >(COMPONENT);
 }

package/src/rest-explorer.types.ts

@@ -29,4 +29,7 @@ export type RestExplorerConfig = {
    * forwarded to the application behind the proxy.
    */
   useSelfHostedSpec?: false;
+
+  // Relative URL of the theme CSS file
+  swaggerThemeFile?: string;
 };

package/templates/index.html.ejs

@@ -5,7 +5,7 @@
 <head>
   <meta charset="UTF-8">
   <title>LoopBack API Explorer</title>
-  <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
+  <link rel="stylesheet" type="text/css" href="<%- swaggerThemeFile %>">
   <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
   <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
   <style>

package/index.d.ts

@@ -1,6 +0,0 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
-// Node module: @loopback/rest-explorer
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
-export * from './dist';

package/index.js

@@ -1,6 +0,0 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
-// Node module: @loopback/rest-explorer
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-
-module.exports = require('./dist');