@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/spec-enhancers/consolidate.spec-enhancer.d.ts

@@ -0,0 +1,68 @@
+import { ApplicationConfig } from '@loopback/core';
+import { OASEnhancer, OpenApiSpec } from '@loopback/openapi-v3';
+/**
+ * This enhancer consolidates schemas into `/components/schemas` and replaces
+ * instances of said schema with a $ref pointer.
+ *
+ * Please note that the title property must be set on a schema in order to be
+ * considered for consolidation.
+ *
+ * For example, with the following schema instance:
+ *
+ * ```json
+ * schema: {
+ *   title: 'loopback.example',
+ *   properties: {
+ *     test: {
+ *       type: 'string',
+ *     },
+ *   },
+ * }
+ * ```
+ *
+ * The consolidator will copy the schema body to
+ * `/components/schemas/loopback.example` and replace any instance of the schema
+ * with a reference to the component schema as follows:
+ *
+ * ```json
+ * schema: {
+ *   $ref: '#/components/schemas/loopback.example',
+ * }
+ * ```
+ *
+ * When comparing schemas to avoid naming collisions, the description field
+ * is ignored.
+ */
+export declare class ConsolidationEnhancer implements OASEnhancer {
+    readonly config?: ApplicationConfig | undefined;
+    name: string;
+    disabled: boolean;
+    constructor(config?: ApplicationConfig | undefined);
+    modifySpec(spec: OpenApiSpec): OpenApiSpec;
+    /**
+     * Recursively search OpenApiSpec PathsObject for SchemaObjects with title
+     * property. Moves reusable schema bodies to #/components/schemas and replace
+     * with json pointer. It handles title collisions with schema body comparision.
+     */
+    private consolidateSchemaObjects;
+    private recursiveWalk;
+    /**
+     * Carry out schema consolidation after tree traversal. If 'title' property
+     * set then we consider current schema for consolidation. SchemaObjects with
+     * properties (and title set) are moved to #/components/schemas/<title> and
+     * replaced with ReferenceObject.
+     *
+     * Features:
+     *  - name collision protection
+     *
+     * @param schema - current schema element to process
+     * @param parentPath - path object to parent
+     * @param spec - subject OpenApi specification
+     */
+    private processSchema;
+    private getRefSchema;
+    private patchRef;
+    private patchPath;
+    private ifConsolidationCandidate;
+    private isTraversable;
+}

package/dist/spec-enhancers/consolidate.spec-enhancer.js

@@ -0,0 +1,145 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsolidationEnhancer = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const openapi_v3_1 = require("@loopback/openapi-v3");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const json_schema_compare_1 = tslib_1.__importDefault(require("json-schema-compare"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const debug = debug_1.default('loopback:openapi:spec-enhancer:consolidate');
+/**
+ * This enhancer consolidates schemas into `/components/schemas` and replaces
+ * instances of said schema with a $ref pointer.
+ *
+ * Please note that the title property must be set on a schema in order to be
+ * considered for consolidation.
+ *
+ * For example, with the following schema instance:
+ *
+ * ```json
+ * schema: {
+ *   title: 'loopback.example',
+ *   properties: {
+ *     test: {
+ *       type: 'string',
+ *     },
+ *   },
+ * }
+ * ```
+ *
+ * The consolidator will copy the schema body to
+ * `/components/schemas/loopback.example` and replace any instance of the schema
+ * with a reference to the component schema as follows:
+ *
+ * ```json
+ * schema: {
+ *   $ref: '#/components/schemas/loopback.example',
+ * }
+ * ```
+ *
+ * When comparing schemas to avoid naming collisions, the description field
+ * is ignored.
+ */
+let ConsolidationEnhancer = /** @class */ (() => {
+    let ConsolidationEnhancer = class ConsolidationEnhancer {
+        constructor(config) {
+            var _a, _b, _c;
+            this.config = config;
+            this.name = 'consolidate';
+            this.disabled = ((_c = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.rest) === null || _b === void 0 ? void 0 : _b.openApiSpec) === null || _c === void 0 ? void 0 : _c.consolidate) === false;
+        }
+        modifySpec(spec) {
+            return !this.disabled ? this.consolidateSchemaObjects(spec) : spec;
+        }
+        /**
+         * Recursively search OpenApiSpec PathsObject for SchemaObjects with title
+         * property. Moves reusable schema bodies to #/components/schemas and replace
+         * with json pointer. It handles title collisions with schema body comparision.
+         */
+        consolidateSchemaObjects(spec) {
+            // use 'paths' as crawl root
+            this.recursiveWalk(spec.paths, ['paths'], spec);
+            return spec;
+        }
+        recursiveWalk(rootSchema, parentPath, spec) {
+            if (this.isTraversable(rootSchema)) {
+                Object.entries(rootSchema).forEach(([key, subSchema]) => {
+                    if (subSchema) {
+                        this.recursiveWalk(subSchema, parentPath.concat(key), spec);
+                        this.processSchema(subSchema, parentPath.concat(key), spec);
+                    }
+                });
+            }
+        }
+        /**
+         * Carry out schema consolidation after tree traversal. If 'title' property
+         * set then we consider current schema for consolidation. SchemaObjects with
+         * properties (and title set) are moved to #/components/schemas/<title> and
+         * replaced with ReferenceObject.
+         *
+         * Features:
+         *  - name collision protection
+         *
+         * @param schema - current schema element to process
+         * @param parentPath - path object to parent
+         * @param spec - subject OpenApi specification
+         */
+        processSchema(schema, parentPath, spec) {
+            const schemaObj = this.ifConsolidationCandidate(schema);
+            if (schemaObj) {
+                // name collison protection
+                let instanceNo = 1;
+                let title = schemaObj.title;
+                let refSchema = this.getRefSchema(title, spec);
+                while (refSchema &&
+                    !json_schema_compare_1.default(schemaObj, refSchema, {
+                        ignore: ['description'],
+                    })) {
+                    title = `${schemaObj.title}${instanceNo++}`;
+                    refSchema = this.getRefSchema(title, spec);
+                }
+                if (!refSchema) {
+                    debug('Creating new component $ref with schema %j', schema);
+                    this.patchRef(title, schema, spec);
+                }
+                debug('Creating link to $ref %j', title);
+                this.patchPath(title, parentPath, spec);
+            }
+        }
+        getRefSchema(name, spec) {
+            const schema = lodash_1.default.get(spec, ['components', 'schemas', name]);
+            return schema;
+        }
+        patchRef(name, value, spec) {
+            lodash_1.default.set(spec, ['components', 'schemas', name], value);
+        }
+        patchPath(name, path, spec) {
+            const patch = {
+                $ref: `#/components/schemas/${name}`,
+            };
+            lodash_1.default.set(spec, path, patch);
+        }
+        ifConsolidationCandidate(schema) {
+            // use title to discriminate references
+            return openapi_v3_1.isSchemaObject(schema) && schema.properties && schema.title
+                ? schema
+                : undefined;
+        }
+        isTraversable(schema) {
+            return schema && typeof schema === 'object' ? true : false;
+        }
+    };
+    ConsolidationEnhancer = tslib_1.__decorate([
+        core_1.bind(openapi_v3_1.asSpecEnhancer, { scope: core_1.BindingScope.SINGLETON }),
+        tslib_1.__param(0, core_1.inject(core_1.CoreBindings.APPLICATION_CONFIG, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], ConsolidationEnhancer);
+    return ConsolidationEnhancer;
+})();
+exports.ConsolidationEnhancer = ConsolidationEnhancer;
+//# sourceMappingURL=consolidate.spec-enhancer.js.map

package/dist/spec-enhancers/consolidate.spec-enhancer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consolidate.spec-enhancer.js","sourceRoot":"","sources":["../../src/spec-enhancers/consolidate.spec-enhancer.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAMwB;AACxB,qDAQ8B;AAC9B,0DAAiC;AACjC,sFAA0C;AAC1C,4DAAuB;AAEvB,MAAM,KAAK,GAAG,eAAY,CAAC,4CAA4C,CAAC,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH;IAAA,IAAa,qBAAqB,GAAlC,MAAa,qBAAqB;QAIhC,YAEW,MAA0B;;YAA1B,WAAM,GAAN,MAAM,CAAoB;YALrC,SAAI,GAAG,aAAa,CAAC;YAOnB,IAAI,CAAC,QAAQ,GAAG,mBAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,0CAAE,WAAW,0CAAE,WAAW,MAAK,KAAK,CAAC;QACxE,CAAC;QAED,UAAU,CAAC,IAAiB;YAC1B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACrE,CAAC;QAED;;;;WAIG;QACK,wBAAwB,CAAC,IAAiB;YAChD,4BAA4B;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;YAEhD,OAAO,IAAI,CAAC;QACd,CAAC;QAEO,aAAa,CACnB,UAAmC,EACnC,UAAyB,EACzB,IAAiB;YAEjB,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAClC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE;oBACtD,IAAI,SAAS,EAAE;wBACb,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;wBAC5D,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;qBAC7D;gBACH,CAAC,CAAC,CAAC;aACJ;QACH,CAAC;QAED;;;;;;;;;;;;WAYG;QACK,aAAa,CACnB,MAAsC,EACtC,UAAyB,EACzB,IAAiB;YAEjB,MAAM,SAAS,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;YACxD,IAAI,SAAS,EAAE;gBACb,2BAA2B;gBAC3B,IAAI,UAAU,GAAG,CAAC,CAAC;gBACnB,IAAI,KAAK,GAAG,SAAS,CAAC,KAAM,CAAC;gBAC7B,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC/C,OACE,SAAS;oBACT,CAAC,6BAAO,CAAC,SAAoC,EAAE,SAAS,EAAE;wBACxD,MAAM,EAAE,CAAC,aAAa,CAAC;qBACxB,CAAC,EACF;oBACA,KAAK,GAAG,GAAG,SAAS,CAAC,KAAK,GAAG,UAAU,EAAE,EAAE,CAAC;oBAC5C,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;iBAC5C;gBACD,IAAI,CAAC,SAAS,EAAE;oBACd,KAAK,CAAC,4CAA4C,EAAE,MAAM,CAAC,CAAC;oBAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;iBACpC;gBACD,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;gBACzC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;aACzC;QACH,CAAC;QAEO,YAAY,CAClB,IAAY,EACZ,IAAiB;YAEjB,MAAM,MAAM,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;YAE5D,OAAO,MAAM,CAAC;QAChB,CAAC;QAEO,QAAQ,CACd,IAAY,EACZ,KAA8B,EAC9B,IAAiB;YAEjB,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;QAEO,SAAS,CAAC,IAAY,EAAE,IAAmB,EAAE,IAAiB;YACpE,MAAM,KAAK,GAAG;gBACZ,IAAI,EAAE,wBAAwB,IAAI,EAAE;aACrC,CAAC;YACF,gBAAC,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3B,CAAC;QAEO,wBAAwB,CAC9B,MAAsC;YAEtC,uCAAuC;YACvC,OAAO,2BAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,KAAK;gBAChE,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QAEO,aAAa,CAAC,MAA+B;YACnD,OAAO,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7D,CAAC;KACF,CAAA;IAxHY,qBAAqB;QADjC,WAAI,CAAC,2BAAc,EAAE,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;QAMjD,mBAAA,aAAM,CAAC,mBAAY,CAAC,kBAAkB,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OALjD,qBAAqB,CAwHjC;IAAD,4BAAC;KAAA;AAxHY,sDAAqB"}

package/dist/spec-enhancers/info.spec-enhancer.d.ts

@@ -0,0 +1,19 @@
+import { ApplicationMetadata } from '@loopback/core';
+import { OASEnhancer, OpenApiSpec } from '@loopback/openapi-v3';
+/**
+ * An OpenAPI spec enhancer to populate `info` with application metadata
+ * (package.json).
+ */
+export declare class InfoSpecEnhancer implements OASEnhancer {
+    readonly pkg?: ApplicationMetadata | undefined;
+    name: string;
+    constructor(pkg?: ApplicationMetadata | undefined);
+    modifySpec(spec: OpenApiSpec): OpenApiSpec;
+    /**
+     * Parse package.json
+     * {@link https://docs.npmjs.com/files/package.json#people-fields-author-contributors | author}
+     *
+     * @param author - Author string or object from package.json
+     */
+    private static parseAuthor;
+}

package/dist/spec-enhancers/info.spec-enhancer.js

@@ -0,0 +1,89 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoSpecEnhancer = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const core_1 = require("@loopback/core");
+const openapi_v3_1 = require("@loopback/openapi-v3");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = debug_1.default('loopback:openapi:spec-enhancer:info');
+/**
+ * An OpenAPI spec enhancer to populate `info` with application metadata
+ * (package.json).
+ */
+let InfoSpecEnhancer = /** @class */ (() => {
+    var InfoSpecEnhancer_1;
+    let InfoSpecEnhancer = InfoSpecEnhancer_1 = class InfoSpecEnhancer {
+        constructor(pkg) {
+            this.pkg = pkg;
+            this.name = 'info';
+        }
+        modifySpec(spec) {
+            if (this.pkg == null) {
+                debug('Application metadata is not found. Skipping spec enhancing.');
+                return spec;
+            }
+            const contact = InfoSpecEnhancer_1.parseAuthor(this.pkg.author);
+            const patchSpec = {
+                info: {
+                    title: this.pkg.name,
+                    description: this.pkg.description,
+                    version: this.pkg.version,
+                    contact,
+                },
+            };
+            debug('Enhancing OpenAPI spec with %j', patchSpec);
+            return openapi_v3_1.mergeOpenAPISpec(spec, patchSpec);
+        }
+        /**
+         * Parse package.json
+         * {@link https://docs.npmjs.com/files/package.json#people-fields-author-contributors | author}
+         *
+         * @param author - Author string or object from package.json
+         */
+        static parseAuthor(author) {
+            var _a, _b, _c, _d, _e, _f;
+            let contact = {};
+            if (author == null) {
+                contact = {};
+            }
+            else if (typeof author === 'string') {
+                // "Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)"
+                const emailRegex = /<([^<>]+)>/; // <email>
+                const urlRegex = /\(([^()]+)\)/; // (url)
+                const nameRegex = /([^<>()]+)/;
+                contact = {
+                    name: (_b = (_a = nameRegex.exec(author)) === null || _a === void 0 ? void 0 : _a[1]) === null || _b === void 0 ? void 0 : _b.trim(),
+                    email: (_d = (_c = emailRegex.exec(author)) === null || _c === void 0 ? void 0 : _c[1]) === null || _d === void 0 ? void 0 : _d.trim(),
+                    url: (_f = (_e = urlRegex.exec(author)) === null || _e === void 0 ? void 0 : _e[1]) === null || _f === void 0 ? void 0 : _f.trim(),
+                };
+            }
+            else if (typeof author === 'object') {
+                const authorObj = author;
+                contact = {
+                    name: authorObj.name,
+                    email: authorObj.email,
+                    url: authorObj.url,
+                };
+            }
+            // Remove undefined/null values
+            for (const p in contact) {
+                if (contact[p] == null)
+                    delete contact[p];
+            }
+            return contact;
+        }
+    };
+    InfoSpecEnhancer = InfoSpecEnhancer_1 = tslib_1.__decorate([
+        context_1.bind(openapi_v3_1.asSpecEnhancer, { scope: context_1.BindingScope.SINGLETON }),
+        tslib_1.__param(0, context_1.inject(core_1.CoreBindings.APPLICATION_METADATA, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], InfoSpecEnhancer);
+    return InfoSpecEnhancer;
+})();
+exports.InfoSpecEnhancer = InfoSpecEnhancer;
+//# sourceMappingURL=info.spec-enhancer.js.map

package/dist/spec-enhancers/info.spec-enhancer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.spec-enhancer.js","sourceRoot":"","sources":["../../src/spec-enhancers/info.spec-enhancer.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAM2B;AAC3B,yCAAiE;AACjE,qDAM8B;AAC9B,0DAAiC;AAEjC,MAAM,KAAK,GAAG,eAAY,CAAC,qCAAqC,CAAC,CAAC;AAElE;;;GAGG;AAEH;;IAAA,IAAa,gBAAgB,wBAA7B,MAAa,gBAAgB;QAG3B,YAEW,GAAyB;YAAzB,QAAG,GAAH,GAAG,CAAsB;YAJpC,SAAI,GAAG,MAAM,CAAC;QAKX,CAAC;QAEJ,UAAU,CAAC,IAAiB;YAC1B,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,EAAE;gBACpB,KAAK,CAAC,6DAA6D,CAAC,CAAC;gBACrE,OAAO,IAAI,CAAC;aACb;YACD,MAAM,OAAO,GAAkB,kBAAgB,CAAC,WAAW,CACzD,IAAI,CAAC,GAAG,CAAC,MAAM,CAChB,CAAC;YACF,MAAM,SAAS,GAAG;gBAChB,IAAI,EAAE;oBACJ,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI;oBACpB,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW;oBACjC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO;oBACzB,OAAO;iBACR;aACF,CAAC;YACF,KAAK,CAAC,gCAAgC,EAAE,SAAS,CAAC,CAAC;YACnD,OAAO,6BAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC3C,CAAC;QAED;;;;;WAKG;QACK,MAAM,CAAC,WAAW,CAAC,MAAiB;;YAC1C,IAAI,OAAO,GAAkB,EAAE,CAAC;YAChC,IAAI,MAAM,IAAI,IAAI,EAAE;gBAClB,OAAO,GAAG,EAAE,CAAC;aACd;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBACrC,kEAAkE;gBAClE,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,UAAU;gBAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,QAAQ;gBACzC,MAAM,SAAS,GAAG,YAAY,CAAC;gBAC/B,OAAO,GAAG;oBACR,IAAI,cAAE,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,0CAAG,CAAC,2CAAG,IAAI,EAAE;oBACzC,KAAK,cAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,0CAAG,CAAC,2CAAG,IAAI,EAAE;oBAC3C,GAAG,cAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,0CAAG,CAAC,2CAAG,IAAI,EAAE;iBACxC,CAAC;aACH;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBACrC,MAAM,SAAS,GAAG,MAAoB,CAAC;gBACvC,OAAO,GAAG;oBACR,IAAI,EAAE,SAAS,CAAC,IAAc;oBAC9B,KAAK,EAAE,SAAS,CAAC,KAAe;oBAChC,GAAG,EAAE,SAAS,CAAC,GAAa;iBAC7B,CAAC;aACH;YACD,+BAA+B;YAC/B,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE;gBACvB,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI;oBAAE,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAA;IA9DY,gBAAgB;QAD5B,cAAI,CAAC,2BAAc,EAAE,EAAC,KAAK,EAAE,sBAAY,CAAC,SAAS,EAAC,CAAC;QAKjD,mBAAA,gBAAM,CAAC,mBAAY,CAAC,oBAAoB,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OAJnD,gBAAgB,CA8D5B;IAAD,uBAAC;KAAA;AA9DY,4CAAgB"}

package/dist/types.d.ts

@@ -0,0 +1,178 @@
+import { HandlerContext, Request, Response } from '@loopback/express';
+import { ReferenceObject, SchemaObject } from '@loopback/openapi-v3';
+import ajv, { Ajv, FormatDefinition, KeywordDefinition } from 'ajv';
+import { Options, OptionsJson, OptionsText, OptionsUrlencoded } from 'body-parser';
+import { ResolvedRoute, RouteEntry } from './router';
+/**
+ * Re-export types from `./middleware`
+ */
+export * from '@loopback/express';
+/**
+ * Find a route matching the incoming request.
+ * Throw an error when no route was found.
+ */
+export declare type FindRoute = (request: Request) => ResolvedRoute;
+/**
+ *
+ */
+export declare type ParseParams = (request: Request, route: ResolvedRoute) => Promise<OperationArgs>;
+/**
+ * Invokes a method defined in the Application Controller
+ *
+ * @param controller - Name of end-user's application controller
+ *  class which defines the methods.
+ * @param method - Method name in application controller class
+ * @param args - Operation arguments for the method
+ * @returns OperationRetval Result from method invocation
+ */
+export declare type InvokeMethod = (route: RouteEntry, args: OperationArgs) => Promise<OperationRetval>;
+/**
+ * Send the operation response back to the client.
+ *
+ * @param response - The response the response to send to.
+ * @param result - The operation result to send.
+ */
+export declare type Send = (response: Response, result: OperationRetval) => void;
+/**
+ * Reject the request with an error.
+ *
+ * @param handlerContext - The context object holding HTTP request, response
+ * and other data  needed to handle an incoming HTTP request.
+ * @param err - The error.
+ */
+export declare type Reject = (handlerContext: HandlerContext, err: Error) => void;
+/**
+ * Log information about a failed request.
+ *
+ * @param err - The error reported by request handling code.
+ * @param statusCode - Status code of the HTTP response
+ * @param request - The request that failed.
+ */
+export declare type LogError = (err: Error, statusCode: number, request: Request) => void;
+/**
+ * Cache for AJV schema validators
+ */
+export declare type SchemaValidatorCache = WeakMap<SchemaObject | ReferenceObject, // First keyed by schema object
+Map<string, ajv.ValidateFunction>>;
+/**
+ * Options for AJV errors
+ */
+export declare type AjvErrorOptions = {
+    keepErrors?: boolean;
+    singleError?: boolean;
+};
+/**
+ * Factory function for Ajv instances
+ */
+export declare type AjvFactory = (options?: ajv.Options) => Ajv;
+/**
+ * Ajv keyword definition with a name
+ */
+export declare type AjvKeyword = KeywordDefinition & {
+    name: string;
+};
+/**
+ * Ajv format definition with a name
+ */
+export declare type AjvFormat = FormatDefinition & {
+    name: string;
+};
+/**
+ * Options for request body validation using AJV
+ */
+export interface RequestBodyValidationOptions extends ajv.Options {
+    /**
+     * Custom cache for compiled schemas by AJV. This setting makes it possible
+     * to skip the default cache.
+     */
+    compiledSchemaCache?: SchemaValidatorCache;
+    /**
+     * Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords
+     * - `true`: Add all keywords from `ajv-keywords`
+     * - `string[]`: Add an array of keywords from `ajv-keywords`
+     */
+    ajvKeywords?: true | string[];
+    /**
+     * Enable custom error messages in JSON-Schema for AJV validator
+     * from https://github.com/epoberezkin/ajv-errors
+     * - `true`: Enable `ajv-errors`
+     * - `AjvErrorOptions`: Enable `ajv-errors` with options
+     */
+    ajvErrors?: true | AjvErrorOptions;
+    /**
+     * A function that transform the `ErrorObject`s reported by AJV.
+     * This could be used for error messages customization, localization, etc.
+     */
+    ajvErrorTransformer?: (errors: ajv.ErrorObject[]) => ajv.ErrorObject[];
+    /**
+     * A factory to create Ajv instance
+     */
+    ajvFactory?: (options: ajv.Options) => Ajv;
+}
+/**
+ * Options for request body parsing
+ * See https://github.com/expressjs/body-parser/#options
+ *
+ * Built-in parsers retrieve their own options from the request body parser
+ * options. The parser specific properties override common ones.
+ */
+export interface RequestBodyParserOptions extends Options {
+    /**
+     * Options for json parser
+     */
+    json?: OptionsJson;
+    /**
+     * Options for urlencoded parser
+     */
+    urlencoded?: OptionsUrlencoded;
+    /**
+     * Options for text parser
+     */
+    text?: OptionsText;
+    /**
+     * Options for raw parser
+     */
+    raw?: Options;
+    /**
+     * Validation options for AJV, see https://github.com/epoberezkin/ajv#options
+     * This setting is global for all request body parsers and it cannot be
+     * overridden inside parser specific properties such as `json` or `text`.
+     */
+    validation?: RequestBodyValidationOptions;
+    /**
+     * Common options for all parsers
+     */
+    [name: string]: unknown;
+}
+export declare type PathParameterValues = {
+    [key: string]: any;
+};
+export declare type OperationArgs = any[];
+/**
+ * Return value of a controller method (a function implementing an operation).
+ * This is a type alias for "any", used to distinguish
+ * operation results from other "any" typed values.
+ */
+export declare type OperationRetval = any;
+/**
+ * user profile to add in session
+ */
+export interface SessionUserProfile {
+    provider: string;
+    token: string;
+    email: string;
+    [attribute: string]: any;
+}
+/**
+ * interface to set variables in user session
+ */
+export interface Session {
+    profile: SessionUserProfile;
+    [key: string]: any;
+}
+/**
+ * extending express request type with a session field
+ */
+export interface RequestWithSession extends Request {
+    session: Session;
+}

package/dist/types.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * Re-export types from `./middleware`
+ */
+tslib_1.__exportStar(require("@loopback/express"), exports);
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAahE;;GAEG;AACH,4DAAkC"}

package/dist/validation/ajv-factory.provider.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from '@loopback/core';
+import { AjvFactory, RequestBodyValidationOptions } from '../types';
+/**
+ * A provider class that instantiate an AJV instance
+ */
+export declare class AjvFactoryProvider implements Provider<AjvFactory> {
+    private options;
+    constructor(options?: RequestBodyValidationOptions);
+    private keywords;
+    private formats;
+    value(): AjvFactory;
+}

package/dist/validation/ajv-factory.provider.js

@@ -0,0 +1,87 @@
+"use strict";
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AjvFactoryProvider = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const ajv_1 = tslib_1.__importDefault(require("ajv"));
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const keys_1 = require("../keys");
+const debug = debug_1.default('loopback:rest:ajv');
+const ajvKeywords = require('ajv-keywords');
+const ajvErrors = require('ajv-errors');
+/**
+ * A provider class that instantiate an AJV instance
+ */
+let AjvFactoryProvider = /** @class */ (() => {
+    let AjvFactoryProvider = class AjvFactoryProvider {
+        constructor(options = {}) {
+            this.options = options;
+        }
+        value() {
+            return options => {
+                var _a;
+                let validationOptions = {
+                    ...this.options,
+                    ...options,
+                };
+                // See https://github.com/epoberezkin/ajv#options
+                validationOptions = {
+                    allErrors: true,
+                    jsonPointers: true,
+                    // nullable: support keyword "nullable" from Open API 3 specification.
+                    nullable: true,
+                    // Allow OpenAPI spec binary format
+                    unknownFormats: ['binary'],
+                    ...validationOptions,
+                };
+                debug('AJV options', validationOptions);
+                const ajvInst = new ajv_1.default(validationOptions);
+                if (validationOptions.ajvKeywords === true) {
+                    ajvKeywords(ajvInst);
+                }
+                else if (Array.isArray(validationOptions.ajvKeywords)) {
+                    ajvKeywords(ajvInst, validationOptions.ajvKeywords);
+                }
+                if (validationOptions.ajvErrors === true) {
+                    ajvErrors(ajvInst);
+                }
+                else if (((_a = validationOptions.ajvErrors) === null || _a === void 0 ? void 0 : _a.constructor) === Object) {
+                    ajvErrors(ajvInst, validationOptions.ajvErrors);
+                }
+                if (this.keywords) {
+                    this.keywords.forEach(keyword => {
+                        debug('Adding Ajv keyword %s', keyword.name);
+                        ajvInst.addKeyword(keyword.name, keyword);
+                    });
+                }
+                if (this.formats) {
+                    this.formats.forEach(format => {
+                        debug('Adding Ajv format %s', format.name);
+                        ajvInst.addFormat(format.name, format);
+                    });
+                }
+                return ajvInst;
+            };
+        }
+    };
+    tslib_1.__decorate([
+        core_1.inject(core_1.filterByTag(keys_1.RestTags.AJV_KEYWORD)),
+        tslib_1.__metadata("design:type", Array)
+    ], AjvFactoryProvider.prototype, "keywords", void 0);
+    tslib_1.__decorate([
+        core_1.inject(core_1.filterByTag(keys_1.RestTags.AJV_FORMAT)),
+        tslib_1.__metadata("design:type", Array)
+    ], AjvFactoryProvider.prototype, "formats", void 0);
+    AjvFactoryProvider = tslib_1.__decorate([
+        core_1.bind({ scope: core_1.BindingScope.SINGLETON }),
+        tslib_1.__param(0, core_1.inject(keys_1.RestBindings.REQUEST_BODY_PARSER_OPTIONS.deepProperty('validation'), { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], AjvFactoryProvider);
+    return AjvFactoryProvider;
+})();
+exports.AjvFactoryProvider = AjvFactoryProvider;
+//# sourceMappingURL=ajv-factory.provider.js.map

package/dist/validation/ajv-factory.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ajv-factory.provider.js","sourceRoot":"","sources":["../../src/validation/ajv-factory.provider.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAMwB;AACxB,sDAA0B;AAC1B,0DAAgC;AAChC,kCAA+C;AAO/C,MAAM,KAAK,GAAG,eAAW,CAAC,mBAAmB,CAAC,CAAC;AAE/C,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAExC;;GAEG;AAEH;IAAA,IAAa,kBAAkB,GAA/B,MAAa,kBAAkB;QAC7B,YAKU,UAAwC,EAAE;YAA1C,YAAO,GAAP,OAAO,CAAmC;QACjD,CAAC;QAQJ,KAAK;YACH,OAAO,OAAO,CAAC,EAAE;;gBACf,IAAI,iBAAiB,GAAiC;oBACpD,GAAG,IAAI,CAAC,OAAO;oBACf,GAAG,OAAO;iBACX,CAAC;gBACF,iDAAiD;gBACjD,iBAAiB,GAAG;oBAClB,SAAS,EAAE,IAAI;oBACf,YAAY,EAAE,IAAI;oBAClB,sEAAsE;oBACtE,QAAQ,EAAE,IAAI;oBACd,mCAAmC;oBACnC,cAAc,EAAE,CAAC,QAAQ,CAAC;oBAC1B,GAAG,iBAAiB;iBACrB,CAAC;gBAEF,KAAK,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;gBACxC,MAAM,OAAO,GAAG,IAAI,aAAO,CAAC,iBAAiB,CAAC,CAAC;gBAE/C,IAAI,iBAAiB,CAAC,WAAW,KAAK,IAAI,EAAE;oBAC1C,WAAW,CAAC,OAAO,CAAC,CAAC;iBACtB;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE;oBACvD,WAAW,CAAC,OAAO,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;iBACrD;gBAED,IAAI,iBAAiB,CAAC,SAAS,KAAK,IAAI,EAAE;oBACxC,SAAS,CAAC,OAAO,CAAC,CAAC;iBACpB;qBAAM,IAAI,OAAA,iBAAiB,CAAC,SAAS,0CAAE,WAAW,MAAK,MAAM,EAAE;oBAC9D,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;iBACjD;gBAED,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;wBAC9B,KAAK,CAAC,uBAAuB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;wBAC7C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;oBAC5C,CAAC,CAAC,CAAC;iBACJ;gBAED,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBAC5B,KAAK,CAAC,sBAAsB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;wBAC3C,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;oBACzC,CAAC,CAAC,CAAC;iBACJ;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;QACJ,CAAC;KACF,CAAA;IArDC;QADC,aAAM,CAAC,kBAAW,CAAC,eAAQ,CAAC,WAAW,CAAC,CAAC;;wDACX;IAG/B;QADC,aAAM,CAAC,kBAAW,CAAC,eAAQ,CAAC,UAAU,CAAC,CAAC;;uDACZ;IAblB,kBAAkB;QAD9B,WAAI,CAAC,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;QAGjC,mBAAA,aAAM,CACL,mBAAY,CAAC,2BAA2B,CAAC,YAAY,CAAC,YAAY,CAAC,EACnE,EAAC,QAAQ,EAAE,IAAI,EAAC,CACjB,CAAA;;OALQ,kBAAkB,CA+D9B;IAAD,yBAAC;KAAA;AA/DY,gDAAkB"}

package/dist/validation/request-body.validator.d.ts

@@ -0,0 +1,14 @@
+import { RequestBodyObject, SchemasObject } from '@loopback/openapi-v3';
+import { RequestBody } from '..';
+import { RequestBodyValidationOptions } from '../types';
+/**
+ * Check whether the request body is valid according to the provided OpenAPI schema.
+ * The JSON schema is generated from the OpenAPI schema which is typically defined
+ * by `@requestBody()`.
+ * The validation leverages AJV schema validator.
+ * @param body - The request body parsed from an HTTP request.
+ * @param requestBodySpec - The OpenAPI requestBody specification defined in `@requestBody()`.
+ * @param globalSchemas - The referenced schemas generated from `OpenAPISpec.components.schemas`.
+ * @param options - Request body validation options for AJV
+ */
+export declare function validateRequestBody(body: RequestBody, requestBodySpec?: RequestBodyObject, globalSchemas?: SchemasObject, options?: RequestBodyValidationOptions): Promise<void>;