@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/body-parsers/body-parser.text.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright IBM Corp. 2018. 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.TextBodyParser = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const body_parser_1 = require("body-parser");
+const type_is_1 = require("type-is");
+const keys_1 = require("../keys");
+const body_parser_helpers_1 = require("./body-parser.helpers");
+let TextBodyParser = /** @class */ (() => {
+    let TextBodyParser = class TextBodyParser {
+        constructor(options = {}) {
+            this.name = body_parser_helpers_1.builtinParsers.text;
+            const textOptions = Object.assign({ type: 'text/*' }, body_parser_helpers_1.getParserOptions('text', options));
+            this.textParser = body_parser_1.text(textOptions);
+        }
+        supports(mediaType) {
+            // Please note that `text/*` matches `text/plain` and `text/html` but`text`
+            // does not.
+            return !!type_is_1.is(mediaType, 'text/*');
+        }
+        async parse(request) {
+            const body = await body_parser_helpers_1.invokeBodyParserMiddleware(this.textParser, request);
+            return { value: body };
+        }
+    };
+    TextBodyParser = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(keys_1.RestBindings.REQUEST_BODY_PARSER_OPTIONS, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], TextBodyParser);
+    return TextBodyParser;
+})();
+exports.TextBodyParser = TextBodyParser;
+//# sourceMappingURL=body-parser.text.js.map

package/dist/body-parsers/body-parser.text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"body-parser.text.js","sourceRoot":"","sources":["../../src/body-parsers/body-parser.text.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAAyC;AACzC,6CAAiC;AACjC,qCAA2B;AAC3B,kCAAqC;AAErC,+DAK+B;AAG/B;IAAA,IAAa,cAAc,GAA3B,MAAa,cAAc;QAIzB,YAEE,UAAoC,EAAE;YALxC,SAAI,GAAG,oCAAc,CAAC,IAAI,CAAC;YAOzB,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAC/B,EAAC,IAAI,EAAE,QAAQ,EAAC,EAChB,sCAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAClC,CAAC;YACF,IAAI,CAAC,UAAU,GAAG,kBAAI,CAAC,WAAW,CAAC,CAAC;QACtC,CAAC;QAED,QAAQ,CAAC,SAAiB;YACxB,2EAA2E;YAC3E,YAAY;YACZ,OAAO,CAAC,CAAC,YAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,OAAgB;YAC1B,MAAM,IAAI,GAAG,MAAM,gDAA0B,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACxE,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC;QACvB,CAAC;KACF,CAAA;IAzBY,cAAc;QAKtB,mBAAA,gBAAM,CAAC,mBAAY,CAAC,2BAA2B,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OAL1D,cAAc,CAyB1B;IAAD,qBAAC;KAAA;AAzBY,wCAAc"}

package/dist/body-parsers/body-parser.urlencoded.d.ts

@@ -0,0 +1,9 @@
+import { Request, RequestBodyParserOptions } from '../types';
+import { BodyParser, RequestBody } from './types';
+export declare class UrlEncodedBodyParser implements BodyParser {
+    name: symbol;
+    private urlencodedParser;
+    constructor(options?: RequestBodyParserOptions);
+    supports(mediaType: string): boolean;
+    parse(request: Request): Promise<RequestBody>;
+}

package/dist/body-parsers/body-parser.urlencoded.js

@@ -0,0 +1,36 @@
+"use strict";
+// Copyright IBM Corp. 2018. 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.UrlEncodedBodyParser = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const body_parser_1 = require("body-parser");
+const type_is_1 = require("type-is");
+const keys_1 = require("../keys");
+const body_parser_helpers_1 = require("./body-parser.helpers");
+let UrlEncodedBodyParser = /** @class */ (() => {
+    let UrlEncodedBodyParser = class UrlEncodedBodyParser {
+        constructor(options = {}) {
+            this.name = body_parser_helpers_1.builtinParsers.urlencoded;
+            const urlencodedOptions = body_parser_helpers_1.getParserOptions('urlencoded', options);
+            this.urlencodedParser = body_parser_1.urlencoded(urlencodedOptions);
+        }
+        supports(mediaType) {
+            return !!type_is_1.is(mediaType, 'urlencoded');
+        }
+        async parse(request) {
+            const body = await body_parser_helpers_1.invokeBodyParserMiddleware(this.urlencodedParser, request);
+            return { value: body, coercionRequired: true };
+        }
+    };
+    UrlEncodedBodyParser = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(keys_1.RestBindings.REQUEST_BODY_PARSER_OPTIONS, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], UrlEncodedBodyParser);
+    return UrlEncodedBodyParser;
+})();
+exports.UrlEncodedBodyParser = UrlEncodedBodyParser;
+//# sourceMappingURL=body-parser.urlencoded.js.map

package/dist/body-parsers/body-parser.urlencoded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"body-parser.urlencoded.js","sourceRoot":"","sources":["../../src/body-parsers/body-parser.urlencoded.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAAyC;AACzC,6CAAuC;AACvC,qCAA2B;AAC3B,kCAAqC;AAErC,+DAK+B;AAG/B;IAAA,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;QAI/B,YAEE,UAAoC,EAAE;YALxC,SAAI,GAAG,oCAAc,CAAC,UAAU,CAAC;YAO/B,MAAM,iBAAiB,GAAG,sCAAgB,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAClE,IAAI,CAAC,gBAAgB,GAAG,wBAAU,CAAC,iBAAiB,CAAC,CAAC;QACxD,CAAC;QAED,QAAQ,CAAC,SAAiB;YACxB,OAAO,CAAC,CAAC,YAAE,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACvC,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,OAAgB;YAC1B,MAAM,IAAI,GAAG,MAAM,gDAA0B,CAC3C,IAAI,CAAC,gBAAgB,EACrB,OAAO,CACR,CAAC;YACF,OAAO,EAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAC,CAAC;QAC/C,CAAC;KACF,CAAA;IAvBY,oBAAoB;QAK5B,mBAAA,gBAAM,CAAC,mBAAY,CAAC,2BAA2B,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OAL1D,oBAAoB,CAuBhC;IAAD,2BAAC;KAAA;AAvBY,oDAAoB"}

package/dist/body-parsers/index.d.ts

@@ -0,0 +1,8 @@
+export * from './body-parser';
+export * from './body-parser.helpers';
+export * from './body-parser.json';
+export * from './body-parser.raw';
+export * from './body-parser.stream';
+export * from './body-parser.text';
+export * from './body-parser.urlencoded';
+export * from './types';

package/dist/body-parsers/index.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright IBM Corp. 2018. 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");
+tslib_1.__exportStar(require("./body-parser"), exports);
+tslib_1.__exportStar(require("./body-parser.helpers"), exports);
+tslib_1.__exportStar(require("./body-parser.json"), exports);
+tslib_1.__exportStar(require("./body-parser.raw"), exports);
+tslib_1.__exportStar(require("./body-parser.stream"), exports);
+tslib_1.__exportStar(require("./body-parser.text"), exports);
+tslib_1.__exportStar(require("./body-parser.urlencoded"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/body-parsers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/body-parsers/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,wDAA8B;AAC9B,gEAAsC;AACtC,6DAAmC;AACnC,4DAAkC;AAClC,+DAAqC;AACrC,6DAAmC;AACnC,mEAAyC;AACzC,kDAAwB"}

package/dist/body-parsers/types.d.ts

@@ -0,0 +1,51 @@
+import { ReferenceObject, SchemaObject } from '@loopback/openapi-v3';
+import { Request } from '../types';
+/**
+ * Request body with metadata
+ */
+export declare type RequestBody = {
+    /**
+     * Parsed value of the request body
+     */
+    value: any | undefined;
+    /**
+     * Is coercion required? Some forms of request such as urlencoded don't
+     * have rich types such as number or boolean.
+     */
+    coercionRequired?: boolean;
+    /**
+     * Resolved media type
+     */
+    mediaType?: string;
+    /**
+     * Corresponding schema for the request body
+     */
+    schema?: SchemaObject | ReferenceObject;
+};
+/**
+ * Interface to be implemented by body parser extensions
+ */
+export interface BodyParser {
+    /**
+     * Name of the parser
+     */
+    name: string | symbol;
+    /**
+     * Indicate if the given media type is supported
+     * @param mediaType - Media type
+     */
+    supports(mediaType: string): boolean;
+    /**
+     * Parse the request body
+     * @param request - http request
+     */
+    parse(request: Request): Promise<RequestBody>;
+}
+/**
+ * Plain function for body parsing
+ */
+export declare type BodyParserFunction = (request: Request) => Promise<RequestBody>;
+/**
+ * Binding tag for request body parser extensions
+ */
+export declare const REQUEST_BODY_PARSER_TAG = "rest.requestBodyParser";

package/dist/body-parsers/types.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. 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.REQUEST_BODY_PARSER_TAG = void 0;
+/**
+ * Binding tag for request body parser extensions
+ */
+exports.REQUEST_BODY_PARSER_TAG = 'rest.requestBodyParser';
+//# sourceMappingURL=types.js.map

package/dist/body-parsers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/body-parsers/types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAqDhE;;GAEG;AACU,QAAA,uBAAuB,GAAG,wBAAwB,CAAC"}

package/dist/coercion/coerce-parameter.d.ts

@@ -0,0 +1,9 @@
+import { ParameterObject } from '@loopback/openapi-v3';
+/**
+ * Coerce the http raw data to a JavaScript type data of a parameter
+ * according to its OpenAPI schema specification.
+ *
+ * @param data - The raw data get from http request
+ * @param schema - The parameter's schema defined in OpenAPI specification
+ */
+export declare function coerceParameter(data: string | undefined | object, spec: ParameterObject): string | number | boolean | object | undefined;

package/dist/coercion/coerce-parameter.js

@@ -0,0 +1,166 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. 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.coerceParameter = void 0;
+const tslib_1 = require("tslib");
+const openapi_v3_1 = require("@loopback/openapi-v3");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const __1 = require("../");
+const parse_json_1 = require("../parse-json");
+const utils_1 = require("./utils");
+const validator_1 = require("./validator");
+const isRFC3339 = require('validator/lib/isRFC3339');
+const debug = debug_1.default('loopback:rest:coercion');
+/**
+ * Coerce the http raw data to a JavaScript type data of a parameter
+ * according to its OpenAPI schema specification.
+ *
+ * @param data - The raw data get from http request
+ * @param schema - The parameter's schema defined in OpenAPI specification
+ */
+function coerceParameter(data, spec) {
+    let schema = spec.schema;
+    // If a query parameter is a url encoded Json object, the schema is defined under content['application/json']
+    if (!schema && spec.in === 'query' && spec.content) {
+        const jsonSpec = spec.content['application/json'];
+        schema = jsonSpec.schema;
+    }
+    if (!schema || openapi_v3_1.isReferenceObject(schema)) {
+        debug('The parameter with schema %s is not coerced since schema' +
+            'dereference is not supported yet.', schema);
+        return data;
+    }
+    const OAIType = utils_1.getOAIPrimitiveType(schema.type, schema.format);
+    const validator = new validator_1.Validator({ parameterSpec: spec });
+    validator.validateParamBeforeCoercion(data);
+    if (data === undefined)
+        return data;
+    switch (OAIType) {
+        case 'byte':
+            return coerceBuffer(data, spec);
+        case 'date':
+            return coerceDatetime(data, spec, { dateOnly: true });
+        case 'date-time':
+            return coerceDatetime(data, spec);
+        case 'float':
+        case 'double':
+        case 'number':
+            return coerceNumber(data, spec);
+        case 'long':
+            return coerceInteger(data, spec, { isLong: true });
+        case 'integer':
+            return coerceInteger(data, spec);
+        case 'boolean':
+            return coerceBoolean(data, spec);
+        case 'object':
+            return coerceObject(data, spec);
+        case 'string':
+        case 'password':
+            return coerceString(data, spec);
+        default:
+            return data;
+    }
+}
+exports.coerceParameter = coerceParameter;
+function coerceString(data, spec) {
+    if (typeof data !== 'string')
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    debug('data of type string is coerced to %s', data);
+    return data;
+}
+function coerceBuffer(data, spec) {
+    if (typeof data === 'object')
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    return Buffer.from(data, 'base64');
+}
+function coerceDatetime(data, spec, options) {
+    if (typeof data === 'object' || utils_1.isEmpty(data))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    if (options === null || options === void 0 ? void 0 : options.dateOnly) {
+        if (!utils_1.matchDateFormat(data))
+            throw __1.RestHttpErrors.invalidData(data, spec.name);
+    }
+    else {
+        if (!isRFC3339(data))
+            throw __1.RestHttpErrors.invalidData(data, spec.name);
+    }
+    const coercedDate = new Date(data);
+    if (!utils_1.isValidDateTime(coercedDate))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    return coercedDate;
+}
+function coerceNumber(data, spec) {
+    if (typeof data === 'object' || utils_1.isEmpty(data))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    const coercedNum = Number(data);
+    if (isNaN(coercedNum))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    debug('data of type number is coerced to %s', coercedNum);
+    return coercedNum;
+}
+function coerceInteger(data, spec, options) {
+    if (typeof data === 'object' || utils_1.isEmpty(data))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    const coercedInt = Number(data);
+    if (isNaN(coercedInt))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    if (options === null || options === void 0 ? void 0 : options.isLong) {
+        if (!Number.isInteger(coercedInt))
+            throw __1.RestHttpErrors.invalidData(data, spec.name);
+    }
+    else {
+        if (!Number.isSafeInteger(coercedInt))
+            throw __1.RestHttpErrors.invalidData(data, spec.name);
+    }
+    debug('data of type integer is coerced to %s', coercedInt);
+    return coercedInt;
+}
+function coerceBoolean(data, spec) {
+    if (typeof data === 'object' || utils_1.isEmpty(data))
+        throw __1.RestHttpErrors.invalidData(data, spec.name);
+    if (utils_1.isTrue(data))
+        return true;
+    if (utils_1.isFalse(data))
+        return false;
+    throw __1.RestHttpErrors.invalidData(data, spec.name);
+}
+function coerceObject(input, spec) {
+    const data = parseJsonIfNeeded(input, spec);
+    if (data === undefined) {
+        // Skip any further checks and coercions, nothing we can do with `undefined`
+        return undefined;
+    }
+    if (typeof data !== 'object' || Array.isArray(data))
+        throw __1.RestHttpErrors.invalidData(input, spec.name);
+    // TODO(bajtos) apply coercion based on properties defined by spec.schema
+    return data;
+}
+function parseJsonIfNeeded(data, spec) {
+    if (typeof data !== 'string')
+        return data;
+    if (spec.in !== 'query' || (spec.in === 'query' && !spec.content)) {
+        debug('Skipping JSON.parse, argument %s is not a url encoded json object query parameter (since content field is missing in parameter schema)', spec.name);
+        return data;
+    }
+    if (data === '') {
+        debug('Converted empty string to object value `undefined`');
+        return undefined;
+    }
+    try {
+        const result = parse_json_1.parseJson(data);
+        debug('Parsed parameter %s as %j', spec.name, result);
+        return result;
+    }
+    catch (err) {
+        debug('Cannot parse %s value %j as JSON: %s', spec.name, data, err.message);
+        throw __1.RestHttpErrors.invalidData(data, spec.name, {
+            details: {
+                syntaxError: err.message,
+            },
+        });
+    }
+}
+//# sourceMappingURL=coerce-parameter.js.map

package/dist/coercion/coerce-parameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coerce-parameter.js","sourceRoot":"","sources":["../../src/coercion/coerce-parameter.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,qDAAwE;AACxE,0DAAgC;AAChC,2BAAmC;AACnC,8CAAwC;AACxC,mCASiB;AACjB,2CAAsC;AACtC,MAAM,SAAS,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;AACrD,MAAM,KAAK,GAAG,eAAW,CAAC,wBAAwB,CAAC,CAAC;AAEpD;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,IAAiC,EACjC,IAAqB;IAErB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAEzB,6GAA6G;IAC7G,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAClD,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;KAC1B;IAED,IAAI,CAAC,MAAM,IAAI,8BAAiB,CAAC,MAAM,CAAC,EAAE;QACxC,KAAK,CACH,0DAA0D;YACxD,mCAAmC,EACrC,MAAM,CACP,CAAC;QACF,OAAO,IAAI,CAAC;KACb;IACD,MAAM,OAAO,GAAG,2BAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC,CAAC;IAEvD,SAAS,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAEpC,QAAQ,OAAO,EAAE;QACf,KAAK,MAAM;YACT,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC,KAAK,MAAM;YACT,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAC;QACtD,KAAK,WAAW;YACd,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC,KAAK,MAAM;YACT,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACnD,KAAK,SAAS;YACZ,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,KAAK,SAAS;YACZ,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,KAAK,QAAQ;YACX,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU;YACb,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC;YACE,OAAO,IAAI,CAAC;KACf;AACH,CAAC;AAnDD,0CAmDC;AAED,SAAS,YAAY,CAAC,IAAqB,EAAE,IAAqB;IAChE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC1B,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEpD,KAAK,CAAC,sCAAsC,EAAE,IAAI,CAAC,CAAC;IACpD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB,EAAE,IAAqB;IAChE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC1B,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,cAAc,CACrB,IAAqB,EACrB,IAAqB,EACrB,OAA6B;IAE7B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,eAAO,CAAC,IAAI,CAAC;QAC3C,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE;QACrB,IAAI,CAAC,uBAAe,CAAC,IAAI,CAAC;YACxB,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;KACrD;SAAM;QACL,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAAE,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;KACzE;IAED,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,uBAAe,CAAC,WAAW,CAAC;QAC/B,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB,EAAE,IAAqB;IAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,eAAO,CAAC,IAAI,CAAC;QAC3C,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEpD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,UAAU,CAAC;QAAE,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEzE,KAAK,CAAC,sCAAsC,EAAE,UAAU,CAAC,CAAC;IAC1D,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,aAAa,CACpB,IAAqB,EACrB,IAAqB,EACrB,OAAgC;IAEhC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,eAAO,CAAC,IAAI,CAAC;QAC3C,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEpD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,UAAW,CAAC;QAAE,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAE1E,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE;QACnB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC;YAC/B,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;KACrD;SAAM;QACL,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC;YACnC,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;KACrD;IAED,KAAK,CAAC,uCAAuC,EAAE,UAAU,CAAC,CAAC;IAC3D,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,aAAa,CAAC,IAAqB,EAAE,IAAqB;IACjE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,eAAO,CAAC,IAAI,CAAC;QAC3C,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,IAAI,cAAM,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9B,IAAI,eAAO,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAChC,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,YAAY,CAAC,KAAsB,EAAE,IAAqB;IACjE,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE5C,IAAI,IAAI,KAAK,SAAS,EAAE;QACtB,4EAA4E;QAC5E,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACjD,MAAM,kBAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAErD,yEAAyE;IACzE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,iBAAiB,CACxB,IAAqB,EACrB,IAAqB;IAErB,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAE1C,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QACjE,KAAK,CACH,wIAAwI,EACxI,IAAI,CAAC,IAAI,CACV,CAAC;QACF,OAAO,IAAI,CAAC;KACb;IAED,IAAI,IAAI,KAAK,EAAE,EAAE;QACf,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAC5D,OAAO,SAAS,CAAC;KAClB;IAED,IAAI;QACF,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtD,OAAO,MAAM,CAAC;KACf;IAAC,OAAO,GAAG,EAAE;QACZ,KAAK,CAAC,sCAAsC,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5E,MAAM,kBAAc,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;YAChD,OAAO,EAAE;gBACP,WAAW,EAAE,GAAG,CAAC,OAAO;aACzB;SACF,CAAC,CAAC;KACJ;AACH,CAAC"}

package/dist/coercion/utils.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Options for function coerceDatetime
+ */
+export declare type DateCoercionOptions = {
+    dateOnly?: boolean;
+};
+/**
+ * Options for function coerceInteger
+ */
+export declare type IntegerCoercionOptions = {
+    isLong?: boolean;
+};
+export declare function isEmpty(data: string): boolean;
+/**
+ * A set of truthy values. A data in this set will be coerced to `true`.
+ *
+ * @param data - The raw data get from http request
+ * @returns The corresponding coerced boolean type
+ */
+export declare function isTrue(data: string): boolean;
+/**
+ * A set of falsy values. A data in this set will be coerced to `false`.
+ * @param data - The raw data get from http request
+ * @returns The corresponding coerced boolean type
+ */
+export declare function isFalse(data: string): boolean;
+/**
+ * Return false for invalid date
+ */
+export declare function isValidDateTime(data: Date): boolean;
+/**
+ * Return true when a date follows the RFC3339 standard
+ *
+ * @param date - The date to verify
+ */
+export declare function matchDateFormat(date: string): boolean;
+/**
+ * Return the corresponding OpenAPI data type given an OpenAPI schema
+ *
+ * @param type - The type in an OpenAPI schema specification
+ * @param format - The format in an OpenAPI schema specification
+ */
+export declare function getOAIPrimitiveType(type?: string, format?: string): "object" | "boolean" | "string" | "number" | "array" | "byte" | "binary" | "date" | "date-time" | "password" | "float" | "double" | "long" | "integer" | undefined;

package/dist/coercion/utils.js

@@ -0,0 +1,96 @@
+"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 });
+exports.getOAIPrimitiveType = exports.matchDateFormat = exports.isValidDateTime = exports.isFalse = exports.isTrue = exports.isEmpty = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = debug_1.default('loopback:rest:coercion');
+function isEmpty(data) {
+    const result = data === '';
+    debug('isEmpty(%j) -> %s', data, result);
+    return result;
+}
+exports.isEmpty = isEmpty;
+/**
+ * A set of truthy values. A data in this set will be coerced to `true`.
+ *
+ * @param data - The raw data get from http request
+ * @returns The corresponding coerced boolean type
+ */
+function isTrue(data) {
+    return ['TRUE', '1'].includes(data.toUpperCase());
+}
+exports.isTrue = isTrue;
+/**
+ * A set of falsy values. A data in this set will be coerced to `false`.
+ * @param data - The raw data get from http request
+ * @returns The corresponding coerced boolean type
+ */
+function isFalse(data) {
+    return ['FALSE', '0'].includes(data.toUpperCase());
+}
+exports.isFalse = isFalse;
+/**
+ * Return false for invalid date
+ */
+function isValidDateTime(data) {
+    return isNaN(data.getTime()) ? false : true;
+}
+exports.isValidDateTime = isValidDateTime;
+const REGEX_RFC3339_DATE = /^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])$/;
+/**
+ * Return true when a date follows the RFC3339 standard
+ *
+ * @param date - The date to verify
+ */
+function matchDateFormat(date) {
+    const pattern = new RegExp(REGEX_RFC3339_DATE);
+    const result = pattern.test(date);
+    debug('matchDateFormat(%j) -> %s', date, result);
+    return result;
+}
+exports.matchDateFormat = matchDateFormat;
+/**
+ * Return the corresponding OpenAPI data type given an OpenAPI schema
+ *
+ * @param type - The type in an OpenAPI schema specification
+ * @param format - The format in an OpenAPI schema specification
+ */
+function getOAIPrimitiveType(type, format) {
+    if (type === 'object' || type === 'array')
+        return type;
+    if (type === 'string') {
+        switch (format) {
+            case 'byte':
+                return 'byte';
+            case 'binary':
+                return 'binary';
+            case 'date':
+                return 'date';
+            case 'date-time':
+                return 'date-time';
+            case 'password':
+                return 'password';
+            default:
+                return 'string';
+        }
+    }
+    if (type === 'boolean')
+        return 'boolean';
+    if (type === 'number')
+        switch (format) {
+            case 'float':
+                return 'float';
+            case 'double':
+                return 'double';
+            default:
+                return 'number';
+        }
+    if (type === 'integer')
+        return format === 'int64' ? 'long' : 'integer';
+}
+exports.getOAIPrimitiveType = getOAIPrimitiveType;
+//# sourceMappingURL=utils.js.map

package/dist/coercion/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/coercion/utils.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,0DAAgC;AAChC,MAAM,KAAK,GAAG,eAAW,CAAC,wBAAwB,CAAC,CAAC;AAgBpD,SAAgB,OAAO,CAAC,IAAY;IAClC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,KAAK,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,OAAO,MAAM,CAAC;AAChB,CAAC;AAJD,0BAIC;AACD;;;;;GAKG;AACH,SAAgB,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACpD,CAAC;AAFD,wBAEC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CAAC,IAAY;IAClC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACrD,CAAC;AAFD,0BAEC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAU;IACxC,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC;AAFD,0CAEC;AAED,MAAM,kBAAkB,GAAG,yEAAyE,CAAC;AAErG;;;;GAIG;AACH,SAAgB,eAAe,CAAC,IAAY;IAC1C,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,KAAK,CAAC,2BAA2B,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AALD,0CAKC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,IAAa,EAAE,MAAe;IAChE,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IACvD,IAAI,IAAI,KAAK,QAAQ,EAAE;QACrB,QAAQ,MAAM,EAAE;YACd,KAAK,MAAM;gBACT,OAAO,MAAM,CAAC;YAChB,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB,KAAK,MAAM;gBACT,OAAO,MAAM,CAAC;YAChB,KAAK,WAAW;gBACd,OAAO,WAAW,CAAC;YACrB,KAAK,UAAU;gBACb,OAAO,UAAU,CAAC;YACpB;gBACE,OAAO,QAAQ,CAAC;SACnB;KACF;IACD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,IAAI,IAAI,KAAK,QAAQ;QACnB,QAAQ,MAAM,EAAE;YACd,KAAK,OAAO;gBACV,OAAO,OAAO,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO,QAAQ,CAAC;YAClB;gBACE,OAAO,QAAQ,CAAC;SACnB;IACH,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzE,CAAC;AA7BD,kDA6BC"}

package/dist/coercion/validator.d.ts

@@ -0,0 +1,49 @@
+import { ParameterObject } from '@loopback/openapi-v3';
+/**
+ * A set of options to pass into the validator functions
+ */
+export declare type ValidationOptions = {
+    required?: boolean;
+};
+/**
+ * The context information that a validator needs
+ */
+export declare type ValidationContext = {
+    parameterSpec: ParameterObject;
+};
+/**
+ * Validator class provides a bunch of functions that perform
+ * validations on the request parameters and request body.
+ */
+export declare class Validator {
+    ctx: ValidationContext;
+    constructor(ctx: ValidationContext);
+    /**
+     * The validation executed before type coercion. Like
+     * checking absence.
+     *
+     * @param type - A parameter's type.
+     * @param value - A parameter's raw value from http request.
+     * @param opts - options
+     */
+    validateParamBeforeCoercion(value: string | object | undefined, opts?: ValidationOptions): void;
+    /**
+     * Check is a parameter required or not.
+     *
+     * @param opts
+     */
+    isRequired(opts?: ValidationOptions): boolean;
+    /**
+     * Return `true` if the value is empty, return `false` otherwise.
+     *
+     * @param value
+     */
+    isAbsent(value: any): boolean;
+    /**
+     * Return `true` if defined specification is for a url encoded Json object query parameter
+     *
+     * for url encoded Json object query parameters,
+     * schema is defined under content['application/json']
+     */
+    isUrlEncodedJsonParam(): boolean;
+}

package/dist/coercion/validator.js

@@ -0,0 +1,85 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. 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.Validator = void 0;
+const __1 = require("../");
+/**
+ * Validator class provides a bunch of functions that perform
+ * validations on the request parameters and request body.
+ */
+class Validator {
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    /**
+     * The validation executed before type coercion. Like
+     * checking absence.
+     *
+     * @param type - A parameter's type.
+     * @param value - A parameter's raw value from http request.
+     * @param opts - options
+     */
+    validateParamBeforeCoercion(value, opts) {
+        if (this.isAbsent(value) && this.isRequired(opts)) {
+            const name = this.ctx.parameterSpec.name;
+            throw __1.RestHttpErrors.missingRequired(name);
+        }
+    }
+    /**
+     * Check is a parameter required or not.
+     *
+     * @param opts
+     */
+    isRequired(opts) {
+        if (this.ctx.parameterSpec.required)
+            return true;
+        if (opts === null || opts === void 0 ? void 0 : opts.required)
+            return true;
+        return false;
+    }
+    /**
+     * Return `true` if the value is empty, return `false` otherwise.
+     *
+     * @param value
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    isAbsent(value) {
+        var _a;
+        if (value === '' || value === undefined)
+            return true;
+        const spec = this.ctx.parameterSpec;
+        const schema = (_a = this.ctx.parameterSpec.schema) !== null && _a !== void 0 ? _a : {};
+        const valueIsNull = value === 'null' || value === null;
+        if (this.isUrlEncodedJsonParam()) {
+            // is this an url encoded Json object query parameter?
+            // check for NULL values
+            if (valueIsNull)
+                return true;
+        }
+        else if (spec.schema) {
+            // if parameter spec contains schema object, check if supplied value is NULL
+            if (schema.type === 'object' && valueIsNull)
+                return true;
+        }
+        return false;
+    }
+    /**
+     * Return `true` if defined specification is for a url encoded Json object query parameter
+     *
+     * for url encoded Json object query parameters,
+     * schema is defined under content['application/json']
+     */
+    isUrlEncodedJsonParam() {
+        var _a, _b;
+        const spec = this.ctx.parameterSpec;
+        if (spec.in === 'query' && ((_b = (_a = spec.content) === null || _a === void 0 ? void 0 : _a['application/json']) === null || _b === void 0 ? void 0 : _b.schema)) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.Validator = Validator;
+//# sourceMappingURL=validator.js.map