@opra/core 0.33.13 → 1.0.0-alpha.2

package/esm/http/express-adapter.js

@@ -0,0 +1,159 @@
+import { Router } from 'express';
+import * as nodePath from 'path';
+import { HttpApi, NotFoundError } from '@opra/common';
+import { kHandler } from '../constants.js';
+import { HttpAdapter } from './http-adapter.js';
+import { HttpContext } from './http-context.js';
+import { HttpIncoming } from './interfaces/http-incoming.interface.js';
+import { HttpOutgoing } from './interfaces/http-outgoing.interface.js';
+export class ExpressAdapter extends HttpAdapter {
+    constructor(app, document, options) {
+        super(document, options);
+        this._controllerInstances = new Map();
+        this.app = app;
+        if (!(this.document.api instanceof 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 processResource = async (resource) => {
+            if (resource.controllers.size) {
+                const subResources = Array.from(resource.controllers.values());
+                subResources.reverse();
+                for (const subResource of subResources) {
+                    await processResource(subResource);
+                }
+            }
+            if (resource.onShutdown) {
+                const instance = this._controllerInstances.get(resource) || resource.instance;
+                if (instance)
+                    try {
+                        await resource.onShutdown.call(instance, resource);
+                    }
+                    catch (e) {
+                        this.logger.error(e);
+                    }
+            }
+        };
+        for (const c of this.api.controllers.values())
+            await processResource(c);
+        this._controllerInstances.clear();
+    }
+    getControllerInstance(controllerPath) {
+        const controller = this.api.findController(controllerPath);
+        return controller && this._controllerInstances.get(controller);
+    }
+    _initRouter(basePath) {
+        const router = Router();
+        if (basePath) {
+            if (!basePath.startsWith('/'))
+                basePath = '/' + basePath;
+            if (basePath)
+                this.app.use(basePath, router);
+        }
+        else
+            this.app.use(router);
+        const createContext = (_req, _res, args) => {
+            const request = HttpIncoming.from(_req);
+            const response = HttpOutgoing.from(_res);
+            const platformArgs = {
+                request: _req,
+                response: _res,
+            };
+            return new HttpContext({
+                adapter: this,
+                platform: this.platform,
+                platformArgs,
+                request,
+                response,
+                controller: args?.controller,
+                controllerInstance: args?.controllerInstance,
+                operation: args?.operation,
+                operationHandler: args?.operationHandler,
+            });
+        };
+        /** Add an endpoint that returns document schema */
+        router.get('*', (_req, _res, next) => {
+            if (_req.url.includes('/$schema')) {
+                const url = (_req.url.includes('?') ? _req.url.substring(0, _req.url.indexOf('?')) : _req.url).toLowerCase();
+                if (url === '/$schema') {
+                    const context = createContext(_req, _res);
+                    this[kHandler].sendDocumentSchema(context).catch(next);
+                    return;
+                }
+            }
+            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) => {
+                        const context = createContext(_req, _res, {
+                            controller,
+                            controllerInstance,
+                            operation,
+                            operationHandler,
+                        });
+                        this[kHandler]
+                            .handleRequest(context)
+                            .then(() => {
+                            if (!_res.headersSent)
+                                _next();
+                        })
+                            .catch((e) => this.logger.fatal(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) => {
+            const res = HttpOutgoing.from(_res);
+            // const url = new URL(_req.originalUrl, '')
+            this[kHandler]
+                .sendErrorResponse(res, [
+                new NotFoundError({
+                    message: `No endpoint found for [${_req.method}]${_req.baseUrl}`,
+                    details: {
+                        path: _req.baseUrl,
+                        method: _req.method,
+                    },
+                }),
+            ])
+                .catch(next);
+        });
+    }
+    _createControllers(controller) {
+        let instance = controller.instance;
+        if (!instance && controller.ctor)
+            instance = new controller.ctor();
+        if (instance) {
+            if (typeof instance.onInit === 'function')
+                instance.onInit.call(instance, this);
+            this._controllerInstances.set(controller, instance);
+            // Initialize sub resources
+            for (const r of controller.controllers.values()) {
+                this._createControllers(r);
+            }
+        }
+        return instance;
+    }
+}

package/esm/http/http-adapter.js

@@ -0,0 +1,23 @@
+import { HttpApi } from '@opra/common';
+import { kHandler } from '../constants.js';
+import { PlatformAdapter } from '../platform-adapter.js';
+import { HttpHandler } from './impl/http-handler.js';
+/**
+ *
+ * @class HttpAdapter
+ */
+export class HttpAdapter extends PlatformAdapter {
+    constructor(document, options) {
+        super(document, options);
+        this.protocol = 'http';
+        if (!(document.api instanceof HttpApi))
+            throw new TypeError(`The document does not expose an HTTP Api`);
+        this[kHandler] = new HttpHandler(this);
+        this.interceptors = [...(options?.interceptors || [])];
+        if (options?.onRequest)
+            this.on('request', options.onRequest);
+    }
+    get api() {
+        return this.document.api;
+    }
+}

package/esm/http/http-context.js

@@ -0,0 +1,111 @@
+import { vg } from 'valgen';
+import typeIs from '@browsery/type-is';
+import { BadRequestError, InternalServerError, NotAcceptableError, } from '@opra/common';
+import { kAssetCache } from '../constants.js';
+import { ExecutionContext } from '../execution-context.js';
+import { MultipartReader } from './impl/multipart-reader.js';
+export class HttpContext extends 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;
+    }
+    get isMultipart() {
+        return !!this.request.is('multipart');
+    }
+    async getMultipartReader() {
+        if (!this.isMultipart)
+            throw new InternalServerError('Request content is not a multipart content');
+        if (this._multipartReader)
+            return this._multipartReader;
+        const { request, mediaType } = this;
+        if (mediaType?.contentType) {
+            const arr = Array.isArray(mediaType.contentType) ? mediaType.contentType : [mediaType.contentType];
+            const contentType = arr.find(ct => typeIs.is(ct, ['multipart']));
+            if (!contentType)
+                throw new NotAcceptableError('This endpoint does not accept multipart requests');
+        }
+        const reader = new MultipartReader(request, {
+            maxFields: mediaType?.maxFields,
+            maxFieldsSize: mediaType?.maxFieldsSize,
+            maxFiles: mediaType?.maxFiles,
+            maxFileSize: mediaType?.maxFileSize,
+            maxTotalFileSize: mediaType?.maxTotalFileSize,
+            minFileSize: mediaType?.minFileSize,
+        });
+        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 = [];
+            const multipartFields = mediaType?.multipartFields;
+            if (mediaType && multipartFields?.length) {
+                const fieldsFound = new Map();
+                for (const item of parts) {
+                    const field = mediaType.findMultipartField(item.fieldName, item.type);
+                    if (field) {
+                        fieldsFound.set(field, true);
+                        this._body.push(item);
+                    }
+                }
+                /** Check required fields */
+                for (const field of multipartFields) {
+                    if (field.required && !fieldsFound.get(field))
+                        throw new BadRequestError({
+                            message: `Multipart field (${field.fieldName}) is required`,
+                        });
+                }
+            }
+            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[kAssetCache].get(mediaType, 'decode');
+                if (!decode) {
+                    decode =
+                        mediaType.type?.generateCodec('decode', {
+                            partial: operation.requestBody?.partial,
+                            projection: '*',
+                        }) || vg.isAny();
+                    this.adapter[kAssetCache].set(mediaType, 'decode', decode);
+                }
+                this._body = decode(this._body);
+            }
+        }
+        return this._body;
+    }
+}

package/esm/http/impl/asset-cache.js

@@ -0,0 +1,17 @@
+export class AssetCache {
+    constructor() {
+        this._items = new WeakMap();
+    }
+    get(obj, name) {
+        const cache = this._items.get(obj);
+        return cache && cache[name];
+    }
+    set(obj, name, asset) {
+        let cache = this._items.get(obj);
+        if (!cache) {
+            cache = {};
+            this._items.set(obj, cache);
+        }
+        cache[name] = asset;
+    }
+}