@opra/http 1.0.0-beta.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Panates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @opra/core
+
+OPRA schema package.

package/cjs/express-adapter.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressAdapter = void 0;
+const tslib_1 = require("tslib");
+const nodePath = tslib_1.__importStar(require("node:path"));
+const common_1 = require("@opra/common");
+const express_1 = require("express");
+const http_adapter_js_1 = require("./http-adapter.js");
+const http_context_js_1 = require("./http-context.js");
+const http_incoming_interface_js_1 = require("./interfaces/http-incoming.interface.js");
+const http_outgoing_interface_js_1 = require("./interfaces/http-outgoing.interface.js");
+const wrap_exception_js_1 = require("./utils/wrap-exception.js");
+class ExpressAdapter extends http_adapter_js_1.HttpAdapter {
+    constructor(app, document, options) {
+        super(document, options);
+        this._controllerInstances = new Map();
+        this.app = app;
+        if (!(this.document.api instanceof common_1.HttpApi))
+            throw new TypeError('document.api must be instance of HttpApi');
+        for (const c of this.api.controllers.values())
+            this._createControllers(c);
+        this._initRouter(options?.basePath);
+    }
+    get platform() {
+        return 'express';
+    }
+    async close() {
+        const processInstance = async (controller) => {
+            if (controller.controllers.size) {
+                const subResources = Array.from(controller.controllers.values());
+                subResources.reverse();
+                for (const subResource of subResources) {
+                    await processInstance(subResource);
+                }
+            }
+            if (controller.onShutdown) {
+                const instance = this._controllerInstances.get(controller) || controller.instance;
+                if (instance) {
+                    try {
+                        await controller.onShutdown.call(instance, controller);
+                    }
+                    catch (e) {
+                        if (this.listenerCount('error'))
+                            this.emit('error', (0, wrap_exception_js_1.wrapException)(e));
+                    }
+                }
+            }
+        };
+        for (const c of this.api.controllers.values())
+            await processInstance(c);
+        this._controllerInstances.clear();
+    }
+    getControllerInstance(controllerPath) {
+        const controller = this.api.findController(controllerPath);
+        return controller && this._controllerInstances.get(controller);
+    }
+    _initRouter(basePath) {
+        const router = (0, express_1.Router)();
+        if (basePath) {
+            if (!basePath.startsWith('/'))
+                basePath = '/' + basePath;
+            if (basePath)
+                this.app.use(basePath, router);
+        }
+        else
+            this.app.use(router);
+        const createContext = async (_req, _res, args) => {
+            const request = http_incoming_interface_js_1.HttpIncoming.from(_req);
+            const response = http_outgoing_interface_js_1.HttpOutgoing.from(_res);
+            const ctx = new http_context_js_1.HttpContext({
+                adapter: this,
+                platform: this.platform,
+                request,
+                response,
+                controller: args?.controller,
+                controllerInstance: args?.controllerInstance,
+                operation: args?.operation,
+                operationHandler: args?.operationHandler,
+            });
+            await this.emitAsync('createContext', ctx);
+            return ctx;
+        };
+        /** Add an endpoint that returns document schema */
+        router.get('/\\$schema', (_req, _res, next) => {
+            createContext(_req, _res)
+                .then(ctx => this.handler.sendDocumentSchema(ctx).catch(next))
+                .catch(next);
+        });
+        /** Add operation endpoints */
+        if (this.api.controllers.size) {
+            const processResource = (controller, currentPath) => {
+                currentPath = nodePath.join(currentPath, controller.path);
+                for (const operation of controller.operations.values()) {
+                    const routePath = currentPath + (operation.path || '');
+                    const controllerInstance = this._controllerInstances.get(controller);
+                    const operationHandler = controllerInstance[operation.name];
+                    if (!operationHandler)
+                        continue;
+                    /** Define router callback */
+                    router[operation.method.toLowerCase()](routePath, (_req, _res, _next) => {
+                        createContext(_req, _res, {
+                            controller,
+                            controllerInstance,
+                            operation,
+                            operationHandler,
+                        })
+                            .then(ctx => this.handler.handleRequest(ctx))
+                            .then(() => {
+                            if (!_res.headersSent)
+                                _next();
+                        })
+                            .catch((e) => this.emit('error', e));
+                    });
+                }
+                if (controller.controllers.size) {
+                    for (const child of controller.controllers.values())
+                        processResource(child, currentPath);
+                }
+            };
+            for (const c of this.api.controllers.values())
+                processResource(c, '/');
+        }
+        /** Add an endpoint that returns 404 error at last */
+        router.use('*', (_req, _res, next) => {
+            createContext(_req, _res)
+                .then(ctx => {
+                ctx.errors.push(new common_1.NotFoundError({
+                    message: `No endpoint found at [${_req.method}]${_req.baseUrl}`,
+                    details: {
+                        path: _req.baseUrl,
+                        method: _req.method,
+                    },
+                }));
+                this.handler.sendResponse(ctx).catch(next);
+            })
+                .catch(next);
+        });
+    }
+    _createControllers(controller) {
+        let instance = controller.instance;
+        if (!instance && controller.ctor)
+            instance = new controller.ctor();
+        if (instance) {
+            if (typeof controller.onInit === 'function')
+                controller.onInit.call(instance, controller);
+            this._controllerInstances.set(controller, instance);
+            // Initialize sub resources
+            for (const r of controller.controllers.values()) {
+                this._createControllers(r);
+            }
+        }
+        return instance;
+    }
+}
+exports.ExpressAdapter = ExpressAdapter;

package/cjs/http-adapter.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpAdapter = void 0;
+const common_1 = require("@opra/common");
+const core_1 = require("@opra/core");
+const http_handler_js_1 = require("./http-handler.js");
+/**
+ *
+ * @class HttpAdapter
+ */
+class HttpAdapter extends core_1.PlatformAdapter {
+    constructor(document, options) {
+        super(document, options);
+        this.protocol = 'http';
+        if (!(document.api instanceof common_1.HttpApi))
+            throw new TypeError(`The document does not expose an HTTP Api`);
+        this.handler = new http_handler_js_1.HttpHandler(this);
+        this.interceptors = [...(options?.interceptors || [])];
+    }
+    get api() {
+        return this.document.httpApi;
+    }
+}
+exports.HttpAdapter = HttpAdapter;

package/cjs/http-context.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpContext = void 0;
+const tslib_1 = require("tslib");
+const type_is_1 = tslib_1.__importDefault(require("@browsery/type-is"));
+const common_1 = require("@opra/common");
+const core_1 = require("@opra/core");
+const valgen_1 = require("valgen");
+const multipart_reader_js_1 = require("./impl/multipart-reader.js");
+class HttpContext extends core_1.ExecutionContext {
+    constructor(init) {
+        super({ ...init, document: init.adapter.document, protocol: 'http' });
+        this.adapter = init.adapter;
+        this.protocol = 'http';
+        if (init.controller)
+            this.controller = init.controller;
+        if (init.controllerInstance)
+            this.controllerInstance = init.controllerInstance;
+        if (init.operation)
+            this.operation = init.operation;
+        if (init.operationHandler)
+            this.operationHandler = init.operationHandler;
+        this.request = init.request;
+        this.response = init.response;
+        this.mediaType = init.mediaType;
+        this.cookies = init.cookies || {};
+        this.headers = init.headers || {};
+        this.pathParams = init.pathParams || {};
+        this.queryParams = init.queryParams || {};
+        this._body = init.body;
+        this.on('finish', () => {
+            if (this._multipartReader)
+                this._multipartReader.purge().catch(() => undefined);
+        });
+    }
+    get isMultipart() {
+        return !!this.request.is('multipart');
+    }
+    async getMultipartReader() {
+        if (!this.isMultipart)
+            throw new common_1.InternalServerError('Request content is not a multipart content');
+        if (this._multipartReader)
+            return this._multipartReader;
+        const { mediaType } = this;
+        if (mediaType?.contentType) {
+            const arr = Array.isArray(mediaType.contentType) ? mediaType.contentType : [mediaType.contentType];
+            const contentType = arr.find(ct => type_is_1.default.is(ct, ['multipart']));
+            if (!contentType)
+                throw new common_1.NotAcceptableError('This endpoint does not accept multipart requests');
+        }
+        const reader = new multipart_reader_js_1.MultipartReader(this, {
+            limits: {
+                fields: mediaType?.maxFields,
+                fieldSize: mediaType?.maxFieldsSize,
+                files: mediaType?.maxFiles,
+                fileSize: mediaType?.maxFileSize,
+            },
+        }, mediaType);
+        this._multipartReader = reader;
+        return reader;
+    }
+    async getBody() {
+        if (this._body !== undefined)
+            return this._body;
+        const { request, operation, mediaType } = this;
+        if (this.isMultipart) {
+            const reader = await this.getMultipartReader();
+            /** Retrieve all fields */
+            const parts = await reader.getAll();
+            /** Filter fields according to configuration */
+            this._body = [...parts];
+            return this._body;
+        }
+        this._body = await this.request.readBody({ limit: operation?.requestBody?.maxContentSize });
+        if (this._body != null) {
+            // Convert Buffer to string if media is text
+            if (Buffer.isBuffer(this._body) && request.is(['json', 'xml', 'txt', 'text'])) {
+                this._body = this._body.toString('utf-8');
+            }
+            // Transform text to Object if media is JSON
+            if (typeof this._body === 'string' && request.is(['json']))
+                this._body = JSON.parse(this._body);
+        }
+        if (mediaType) {
+            // Decode/Validate the data object according to data model
+            if (this._body && mediaType.type) {
+                let decode = this.adapter[core_1.kAssetCache].get(mediaType, 'decode');
+                if (!decode) {
+                    decode =
+                        mediaType.type?.generateCodec('decode', {
+                            partial: operation?.requestBody?.partial,
+                            projection: '*',
+                            ignoreReadonlyFields: true,
+                        }) || valgen_1.vg.isAny();
+                    this.adapter[core_1.kAssetCache].set(mediaType, 'decode', decode);
+                }
+                this._body = decode(this._body);
+            }
+        }
+        return this._body;
+    }
+}
+exports.HttpContext = HttpContext;