@terreno/api 0.0.1

package/dist/openApi.js

@@ -0,0 +1,441 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultOpenApiErrorResponses = exports.apiErrorContent = void 0;
+exports.getOpenApiMiddleware = getOpenApiMiddleware;
+exports.listOpenApiMiddleware = listOpenApiMiddleware;
+exports.createOpenApiMiddleware = createOpenApiMiddleware;
+exports.patchOpenApiMiddleware = patchOpenApiMiddleware;
+exports.deleteOpenApiMiddleware = deleteOpenApiMiddleware;
+exports.readOpenApiMiddleware = readOpenApiMiddleware;
+var flatten_1 = __importDefault(require("lodash/flatten"));
+var merge_1 = __importDefault(require("lodash/merge"));
+var mongoose_to_swagger_1 = __importDefault(require("mongoose-to-swagger"));
+var logger_1 = require("./logger");
+var populate_1 = require("./populate");
+var noop = function (_a, _b, next) { return next(); };
+var m2sOptions = {
+    props: ["readOnly", "required", "enum", "default"],
+};
+exports.apiErrorContent = {
+    "application/json": {
+        schema: { $ref: "#/components/schemas/APIError" },
+    },
+};
+// Default error responses
+exports.defaultOpenApiErrorResponses = {
+    400: {
+        content: exports.apiErrorContent,
+        description: "Bad request",
+    },
+    401: {
+        description: "The user must be authenticated",
+    },
+    403: {
+        content: exports.apiErrorContent,
+        description: "The user is not allowed to perform this action on this document",
+    },
+    404: {
+        content: exports.apiErrorContent,
+        description: "Document not found",
+    },
+    405: {
+        content: exports.apiErrorContent,
+        description: "The user is not allowed to perform this action on any document",
+    },
+};
+// We repeat this constantly, so we make it a component so we only have to define it once.
+function createAPIErrorComponent(openApi) {
+    // Create a schema component called APIError
+    openApi === null || openApi === void 0 ? void 0 : openApi.component("schemas", "APIError", {
+        properties: {
+            code: {
+                description: "An application-specific error code, expressed as a string value.",
+                type: "string",
+            },
+            detail: {
+                description: "A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.",
+                type: "string",
+            },
+            id: {
+                description: "A unique identifier for this particular occurrence of the problem.",
+                type: "string",
+            },
+            links: {
+                properties: {
+                    about: {
+                        description: "A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.",
+                        type: "string",
+                    },
+                    type: {
+                        description: "A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.",
+                        type: "string",
+                    },
+                },
+                type: "object",
+            },
+            meta: {
+                description: "A meta object containing non-standard meta-information about the error.",
+                type: "object",
+            },
+            source: {
+                properties: {
+                    header: {
+                        description: "A string indicating the name of a single request header which caused the error.",
+                        type: "string",
+                    },
+                    parameter: {
+                        description: "A string indicating which URI query parameter caused the error.",
+                        type: "string",
+                    },
+                    pointer: {
+                        description: 'A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].',
+                        type: "string",
+                    },
+                },
+                type: "object",
+            },
+            status: {
+                description: "The HTTP status code applicable to this problem, expressed as a string value.",
+                type: "number",
+            },
+            title: {
+                description: "The error message",
+                type: "string",
+            },
+        },
+        type: "object",
+    });
+}
+function getOpenApiMiddleware(model, options) {
+    var _c, _d, _e, _f, _g;
+    createAPIErrorComponent(options.openApi);
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        // Just log this once rather than for each middleware.
+        logger_1.logger.debug("No options.openApi provided, skipping *OpenApiMiddleware");
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.read) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
+        extraModelProperties: options.openApiExtraModelProperties,
+        populatePaths: options.populatePaths,
+    }), properties = _h.properties, required = _h.required;
+    return options.openApi.path((0, merge_1.default)({
+        responses: __assign({ 200: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: properties,
+                            required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Successful read",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [model.collection.collectionName],
+    }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.get) !== null && _g !== void 0 ? _g : {}));
+}
+function listOpenApiMiddleware(model, options) {
+    var _c, _d, _e, _f, _g, _h;
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.list) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    var modelSwagger = (0, mongoose_to_swagger_1.default)(model, m2sOptions);
+    // TODO: handle permissions
+    // Convert modelRouter queryFields into OpenAPI parameters
+    var defaultQueryParams = [
+        {
+            in: "query",
+            name: "_id",
+            schema: {
+                properties: {
+                    $in: {
+                        items: {
+                            type: "string",
+                        },
+                        type: "array",
+                    },
+                },
+                type: "object",
+            },
+        },
+    ];
+    var modelQueryParams = (0, flatten_1.default)((_f = options.queryFields) === null || _f === void 0 ? void 0 : _f.filter(function (field) { return field !== "_id"; }).map(function (field) {
+        var _c, _d, _e;
+        var params = [];
+        // Check for datetime/number to support gt/gte/lt/lte
+        if (((_c = modelSwagger.properties[field]) === null || _c === void 0 ? void 0 : _c.type) === "number" ||
+            ((_d = modelSwagger.properties[field]) === null || _d === void 0 ? void 0 : _d.format) === "date-time") {
+            params.push({
+                in: "query",
+                name: field,
+                schema: {
+                    oneOf: [
+                        modelSwagger.properties[field],
+                        {
+                            properties: {
+                                $gt: modelSwagger.properties[field],
+                                $gte: modelSwagger.properties[field],
+                                $lt: modelSwagger.properties[field],
+                                $lte: modelSwagger.properties[field],
+                            },
+                            type: "object",
+                        },
+                    ],
+                },
+            });
+        }
+        else {
+            params.push({
+                in: "query",
+                name: field,
+                schema: {
+                    oneOf: [
+                        modelSwagger.properties[field],
+                        {
+                            properties: {
+                                $in: {
+                                    items: {
+                                        type: (_e = modelSwagger.properties[field]) === null || _e === void 0 ? void 0 : _e.type,
+                                    },
+                                    type: "array",
+                                },
+                            },
+                            type: "object",
+                        },
+                    ],
+                },
+            });
+        }
+        return params;
+    }));
+    var _j = (0, populate_1.getOpenApiSpecForModel)(model, {
+        extraModelProperties: options.openApiExtraModelProperties,
+        populatePaths: options.populatePaths,
+    }), properties = _j.properties, required = _j.required;
+    return options.openApi.path((0, merge_1.default)({
+        parameters: __spreadArray(__spreadArray(__spreadArray([], __read(defaultQueryParams), false), __read((modelQueryParams !== null && modelQueryParams !== void 0 ? modelQueryParams : [])), false), [
+            // pagination
+            {
+                in: "query",
+                name: "page",
+                schema: {
+                    type: "number",
+                },
+            },
+            {
+                in: "query",
+                name: "sort",
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                in: "query",
+                name: "limit",
+                schema: {
+                    type: "number",
+                },
+            },
+        ], false),
+        responses: __assign({ 200: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: {
+                                data: {
+                                    items: {
+                                        properties: properties,
+                                        required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
+                                        type: "object",
+                                    },
+                                    type: "array",
+                                },
+                                limit: {
+                                    type: "number",
+                                },
+                                more: {
+                                    type: "boolean",
+                                },
+                                page: {
+                                    type: "number",
+                                },
+                                total: {
+                                    type: "number",
+                                },
+                            },
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Successful list",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [model.collection.collectionName],
+    }, (_h = (_g = options.openApiOverwrite) === null || _g === void 0 ? void 0 : _g.list) !== null && _h !== void 0 ? _h : {}));
+}
+function createOpenApiMiddleware(model, options) {
+    var _c, _d, _e, _f, _g;
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.create) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
+        extraModelProperties: options.openApiExtraModelProperties,
+        populatePaths: options.populatePaths,
+    }), properties = _h.properties, required = _h.required;
+    return options.openApi.path((0, merge_1.default)({
+        requestBody: {
+            content: {
+                "application/json": {
+                    schema: {
+                        properties: properties,
+                        type: "object",
+                    },
+                },
+            },
+            required: true,
+        },
+        responses: __assign({ 201: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: properties,
+                            required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Successful create",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [model.collection.collectionName],
+    }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.create) !== null && _g !== void 0 ? _g : {}));
+}
+function patchOpenApiMiddleware(model, options) {
+    var _c, _d, _e, _f, _g;
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.update) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    var _h = (0, populate_1.getOpenApiSpecForModel)(model, {
+        extraModelProperties: options.openApiExtraModelProperties,
+        populatePaths: options.populatePaths,
+    }), properties = _h.properties, required = _h.required;
+    return options.openApi.path((0, merge_1.default)({
+        requestBody: {
+            content: {
+                "application/json": {
+                    schema: {
+                        properties: properties,
+                        type: "object",
+                    },
+                },
+            },
+            required: true,
+        },
+        responses: __assign({ 200: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: properties,
+                            required: __spreadArray(__spreadArray([], __read(required), false), ["_id", "created", "updated"], false),
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Successful update",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [model.collection.collectionName],
+    }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.update) !== null && _g !== void 0 ? _g : {}));
+}
+function deleteOpenApiMiddleware(model, options) {
+    var _c, _d, _e, _f, _g;
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.delete) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    return options.openApi.path((0, merge_1.default)({
+        responses: __assign({ 204: {
+                description: "Successful delete",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [model.collection.collectionName],
+    }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.delete) !== null && _g !== void 0 ? _g : {}));
+}
+// This is a generic OpenAPI wrapper for a read that returns any object described by `properties`.
+// Useful for endpoints that don't directly map to a model.
+function readOpenApiMiddleware(options, properties, required, queryParameters) {
+    var _c, _d, _e, _f, _g;
+    if (!((_c = options.openApi) === null || _c === void 0 ? void 0 : _c.path)) {
+        // Just log this once rather than for each middleware.
+        logger_1.logger.debug("No options.openApi provided, skipping *OpenApiMiddleware");
+        return noop;
+    }
+    if (((_e = (_d = options.permissions) === null || _d === void 0 ? void 0 : _d.read) === null || _e === void 0 ? void 0 : _e.length) === 0) {
+        return noop;
+    }
+    return options.openApi.path((0, merge_1.default)({
+        parameters: queryParameters,
+        responses: __assign({ 200: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: properties,
+                            required: required,
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Successful read",
+            } }, exports.defaultOpenApiErrorResponses),
+        tags: [],
+    }, (_g = (_f = options.openApiOverwrite) === null || _f === void 0 ? void 0 : _f.get) !== null && _g !== void 0 ? _g : {}));
+}

package/dist/openApi.test.d.ts

@@ -0,0 +1 @@
+export {};