@opra/core 1.0.0-alpha.9 → 1.0.0-beta.2

package/esm/http/impl/multipart-reader.js

@@ -1,55 +1,155 @@
+import { randomFillSync } from 'node:crypto';
+import fs from 'node:fs';
+import os from 'node:os';
+import nodePath from 'node:path';
+import typeIs from '@browsery/type-is';
+import { BadRequestError } from '@opra/common';
+import busboy from 'busboy';
 import { EventEmitter } from 'events';
-import formidable from 'formidable';
-import fs from 'fs/promises';
+import fsPromise from 'fs/promises';
+import { isNotNullish } from 'valgen';
 export class MultipartReader extends EventEmitter {
-    constructor(incoming, options) {
+    constructor(context, options, mediaType) {
         super();
+        this.context = context;
+        this.mediaType = mediaType;
         this._started = false;
+        this._finished = false;
         this._cancelled = false;
         this._items = [];
         this._stack = [];
         this.setMaxListeners(1000);
-        this._incoming = incoming;
-        const form = (this._form = formidable({
-            ...options,
-            filter: (part) => !this._cancelled && (!options?.filter || options.filter(part)),
-        }));
-        form.once('error', () => {
+        this.tempDirectory = options?.tempDirectory || os.tmpdir();
+        const { request } = context;
+        const form = busboy({ headers: request.headers });
+        this._form = form;
+        form.once('error', (e) => {
             this._cancelled = true;
+            this._finished = true;
             if (this.listenerCount('error') > 0)
-                this.emit('error');
+                this.emit('error', e);
         });
-        form.on('field', (fieldName, value) => {
-            const item = { fieldName, type: 'field', value };
+        form.on('close', () => {
+            this._finished = true;
+        });
+        form.on('field', (field, value, info) => {
+            const item = {
+                kind: 'field',
+                field,
+                value,
+                mimeType: info.mimeType,
+                encoding: info.encoding,
+            };
             this._items.push(item);
             this._stack.push(item);
             this.emit('field', item);
             this.emit('item', item);
         });
-        form.on('file', (fieldName, file) => {
-            const item = { fieldName, type: 'file', file };
-            this._items.push(item);
-            this._stack.push(item);
-            this.emit('file', item);
-            this.emit('item', item);
+        form.on('file', (field, file, info) => {
+            const saveTo = nodePath.join(this.tempDirectory, `opra-${generateFileName()}`);
+            file.pipe(fs.createWriteStream(saveTo));
+            file.once('end', () => {
+                const item = {
+                    kind: 'file',
+                    field,
+                    storedPath: saveTo,
+                    filename: info.filename,
+                    mimeType: info.mimeType,
+                    encoding: info.encoding,
+                };
+                this._items.push(item);
+                this._stack.push(item);
+                this.emit('file', item);
+                this.emit('item', item);
+            });
         });
     }
     get items() {
         return this._items;
     }
-    getNext() {
-        if (!this._form.ended)
+    async getNext() {
+        let item = this._stack.shift();
+        if (!item && !this._finished) {
             this.resume();
-        return new Promise((resolve, reject) => {
-            if (this._stack.length)
-                return resolve(this._stack.shift());
-            if (this._form.ended)
-                return resolve(undefined);
-            this.once('item', () => resolve(this._stack.shift()));
-            this.once('error', e => reject(e));
-        });
+            item = await new Promise((resolve, reject) => {
+                let resolved = false;
+                if (this._stack.length)
+                    return resolve(this._stack.shift());
+                if (this._form.ended)
+                    return resolve(undefined);
+                this._form.once('close', () => {
+                    if (resolved)
+                        return;
+                    resolved = true;
+                    resolve(this._stack.shift());
+                });
+                this.once('item', () => {
+                    this.pause();
+                    if (resolved)
+                        return;
+                    resolved = true;
+                    resolve(this._stack.shift());
+                });
+                this.once('error', e => reject(e));
+            });
+        }
+        if (item && this.mediaType) {
+            const field = this.mediaType.findMultipartField(item.field);
+            if (!field)
+                throw new BadRequestError(`Unknown multipart field (${item.field})`);
+            if (item.kind === 'field') {
+                const decode = field.generateCodec('decode', { ignoreReadonlyFields: true, projection: '*' });
+                item.value = decode(item.value, {
+                    onFail: issue => `Multipart field (${item.field}) validation failed: ` + issue.message,
+                });
+            }
+            else if (item.kind === 'file') {
+                if (field.contentType) {
+                    const arr = Array.isArray(field.contentType) ? field.contentType : [field.contentType];
+                    if (!(item.mimeType && arr.find(ct => typeIs.is(item.mimeType, [ct])))) {
+                        throw new BadRequestError(`Multipart field (${item.field}) do not accept this content type`);
+                    }
+                }
+            }
+        }
+        /** if all items received we check for required items */
+        if (this._finished && this.mediaType && this.mediaType.multipartFields?.length > 0) {
+            const fieldsLeft = new Set(this.mediaType.multipartFields);
+            for (const x of this._items) {
+                const field = this.mediaType.findMultipartField(x.field);
+                if (field)
+                    fieldsLeft.delete(field);
+            }
+            let issues;
+            for (const field of fieldsLeft) {
+                if (!field.required)
+                    continue;
+                try {
+                    isNotNullish(null, { onFail: () => `Multi part field "${String(field.fieldName)}" is required` });
+                }
+                catch (e) {
+                    if (!issues) {
+                        issues = e.issues;
+                        this.context.errors.push(e);
+                    }
+                    else
+                        issues.push(...e.issues);
+                }
+            }
+            if (this.context.errors.length)
+                throw this.context.errors[0];
+        }
+        return item;
+    }
+    async getAll() {
+        const items = [...this._items];
+        let item;
+        while (!this._cancelled && (item = await this.getNext())) {
+            items.push(item);
+        }
+        return items;
     }
-    getAll() {
+    getAll_() {
         if (this._form.ended)
             return Promise.resolve([...this._items]);
         this.resume();
@@ -66,29 +166,26 @@ export class MultipartReader extends EventEmitter {
             this.resume();
     }
     resume() {
-        if (!this._started)
-            this._form.parse(this._incoming, () => undefined);
-        if (this._form.req)
-            this._form.resume();
+        if (!this._started) {
+            this._started = true;
+            this.context.request.pipe(this._form);
+        }
+        this.context.request.resume();
     }
     pause() {
-        if (this._form.req)
-            this._form.pause();
+        this.context.request.pause();
     }
-    async deleteTempFiles() {
+    async purge() {
         const promises = [];
         this._items.forEach(item => {
-            if (!item.file)
+            if (item.kind !== 'file')
                 return;
-            const file = item.file;
-            promises.push(new Promise(resolve => {
-                if (file._writeStream.closed)
-                    return resolve();
-                file._writeStream.once('close', resolve);
-            })
-                .then(() => fs.unlink(file.filepath))
-                .then(() => 0));
+            promises.push(fsPromise.unlink(item.storedPath));
         });
         return Promise.allSettled(promises);
     }
 }
+function generateFileName() {
+    const buf = Buffer.alloc(10);
+    return new Date().toISOString().substring(0, 10).replace(/-/g, '') + randomFillSync(buf).toString('hex');
+}

package/esm/http/utils/body-reader.js

@@ -145,7 +145,6 @@ export class BodyReader extends EventEmitter {
             message: 'request aborted',
             code: 'ECONNABORTED',
             details: {
-                length,
                 received: this._receivedSize,
             },
         }));

package/esm/index.js

@@ -6,11 +6,11 @@ import * as HttpOutgoingHost_ from './http/impl/http-outgoing.host.js';
 import * as NodeIncomingMessageHost_ from './http/impl/node-incoming-message.host.js';
 import * as NodeOutgoingMessageHost_ from './http/impl/node-outgoing-message.host.js';
 export * from './execution-context.js';
-export * from './helpers/logger.js';
 export * from './helpers/service-base.js';
 export * from './http/express-adapter.js';
 export * from './http/http-adapter.js';
 export * from './http/http-context.js';
+export * from './http/http-handler.js';
 export * from './http/impl/multipart-reader.js';
 export * from './http/interfaces/http-incoming.interface.js';
 export * from './http/interfaces/http-outgoing.interface.js';

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/platform-adapter.js

@@ -2,7 +2,6 @@ import './augmentation/18n.augmentation.js';
 import { I18n } from '@opra/common';
 import { AsyncEventEmitter } from 'strict-typed-events';
 import { kAssetCache } from './constants.js';
-import { Logger } from './helpers/logger.js';
 import { AssetCache } from './http/impl/asset-cache.js';
 /**
  * @class PlatformAdapter
@@ -12,8 +11,6 @@ export class PlatformAdapter extends AsyncEventEmitter {
         super();
         this[kAssetCache] = new AssetCache();
         this.document = document;
-        this.logger =
-            options?.logger && options.logger instanceof Logger ? options.logger : new Logger({ instance: options?.logger });
         this.i18n = options?.i18n || I18n.defaultInstance;
     }
 }

package/package.json

@@ -1,42 +1,17 @@
 {
   "name": "@opra/core",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0-beta.2",
   "description": "Opra schema package",
   "author": "Panates",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/panates/opra.git",
-    "directory": "packages/core"
-  },
-  "scripts": {
-    "compile": "tsc",
-    "prebuild": "npm run lint && npm run clean",
-    "build": "npm run build:cjs && npm run build:esm",
-    "build:cjs": "tsc -b tsconfig-build-cjs.json",
-    "build:esm": "tsc -b tsconfig-build-esm.json",
-    "postbuild": "npm run _copyi18n && npm run _copy_pkg_files",
-    "_copy_pkg_files": "cp README.md package.json ../../LICENSE ../../build/core && cp ../../package.cjs.json ../../build/core/cjs/package.json",
-    "_copyi18n": "cp -R i18n ../../build/core/i18n",
-    "lint": "eslint . --max-warnings=0",
-    "lint:fix": "eslint . --max-warnings=0 --fix",
-    "format": "prettier . --write --log-level=warn",
-    "check": "madge --circular src/**",
-    "test": "jest --passWithNoTests",
-    "cover": "jest --passWithNoTests --collect-coverage",
-    "clean": "npm run clean:src && npm run clean:test && npm run clean:dist && npm run clean:cover",
-    "clean:src": "ts-cleanup -s src --all",
-    "clean:test": "ts-cleanup -s test --all",
-    "clean:dist": "rimraf ../../build/client",
-    "clean:cover": "rimraf ../../coverage/client"
-  },
   "dependencies": {
-    "@browsery/http-parser": "^0.5.8",
-    "@browsery/type-is": "^1.6.18-r2",
-    "@opra/common": "^1.0.0-alpha.9",
-    "@types/formidable": "^3.4.5",
+    "@browsery/antlr4": "^4.13.3-r1",
+    "@browsery/http-parser": "^0.5.9-r1",
+    "@browsery/type-is": "^1.6.18-r5",
+    "@opra/common": "^1.0.0-beta.2",
     "accepts": "^1.3.8",
     "base64-stream": "^1.0.0",
+    "busboy": "^1.6.0",
     "bytes": "^3.1.2",
     "content-disposition": "^0.5.4",
     "content-type": "^1.0.5",
@@ -44,58 +19,55 @@
     "cookie-signature": "^1.2.1",
     "cppzst": "^2.0.12",
     "encodeurl": "^2.0.0",
-    "formidable": "^3.5.1",
+    "fast-tokenizer": "^1.7.0",
     "fresh": "^0.5.2",
     "iconv-lite": "^0.6.3",
     "mime-types": "^2.1.35",
-    "power-tasks": "^1.7.3",
+    "power-tasks": "^1.11.0",
     "putil-isplainobject": "^1.1.5",
-    "putil-merge": "^3.12.1",
+    "putil-merge": "^3.13.0",
     "putil-varhelpers": "^1.6.5",
     "range-parser": "^1.2.1",
-    "raw-body": "^2.5.2",
+    "raw-body": "^3.0.0",
     "reflect-metadata": "^0.2.2",
-    "strict-typed-events": "^2.3.3",
+    "strict-typed-events": "^2.8.0",
+    "super-fast-md5": "^1.0.3",
+    "tslib": "^2.7.0",
+    "valgen": "^5.9.0",
     "vary": "^1.1.2"
   },
   "optionalDependencies": {
     "express": "^4.x.x || ^5.x.x",
     "fastify": "^4.x.x"
   },
-  "devDependencies": {
-    "@faker-js/faker": "^8.4.1",
-    "@types/accepts": "^1.3.7",
-    "@types/base64-stream": "^1.0.5",
-    "@types/bytes": "^3.1.4",
-    "@types/content-disposition": "^0.5.8",
-    "@types/content-type": "^1.1.8",
-    "@types/cookie": "^0.6.0",
-    "@types/cookie-parser": "^1.4.7",
-    "@types/cookie-signature": "^1.1.2",
-    "@types/encodeurl": "^1.0.2",
-    "@types/express": "^4.17.21",
-    "@types/fresh": "^0.5.2",
-    "@types/mime-types": "^2.1.4",
-    "@types/range-parser": "^1.2.7",
-    "@types/vary": "^1.1.3",
-    "cookie-parser": "^1.4.6",
-    "crypto-browserify": "^3.12.0",
-    "express": "^4.19.2",
-    "fastify": "^4.28.1",
-    "path-browserify": "^1.0.1",
-    "supertest": "^7.0.0",
-    "ts-gems": "^3.4.0"
-  },
   "type": "module",
-  "module": "./esm/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "require": {
+        "types": "./types/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "default": "./esm/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "main": "./cjs/index.js",
+  "module": "./esm/index.js",
   "types": "./types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/panates/opra.git",
+    "directory": "packages/core"
+  },
   "engines": {
     "node": ">=16.0",
     "npm": ">=7.0.0"
   },
   "files": [
-    "bin/",
     "cjs/",
     "esm/",
     "i18n/",
@@ -113,4 +85,4 @@
     "swagger",
     "raml"
   ]
-}
+}

package/types/augmentation/http-controller.augmentation.d.ts

@@ -15,7 +15,6 @@ declare module '@opra/common' {
         }
     }
     namespace HttpOperation {
-        interface Context extends HttpContext {
-        }
+        type Context = HttpContext;
     }
 }

package/types/constants.d.ts

@@ -1,2 +1 @@
-export declare const kHandler: unique symbol;
 export declare const kAssetCache: unique symbol;

package/types/execution-context.d.ts

@@ -1,4 +1,4 @@
-import { ApiDocument, OpraSchema } from '@opra/common';
+import { ApiDocument, OpraHttpError, OpraSchema } from '@opra/common';
 import { AsyncEventEmitter } from 'strict-typed-events';
 /**
  * @namespace ExecutionContext
@@ -18,6 +18,7 @@ export declare abstract class ExecutionContext extends AsyncEventEmitter {
     readonly document: ApiDocument;
     readonly protocol: OpraSchema.Protocol;
     readonly platform: string;
+    errors: OpraHttpError[];
     protected constructor(init: ExecutionContext.Initiator);
     addListener(event: 'finish', listener: ExecutionContext.OnFinishListener): this;
     removeListener(event: 'finish', listener: ExecutionContext.OnFinishListener): this;

package/types/helpers/service-base.d.ts

@@ -1,4 +1,4 @@
-import { Nullish } from 'ts-gems';
+import type { Nullish } from 'ts-gems';
 import type { HttpContext } from '../http/http-context';
 export declare abstract class ServiceBase {
     protected _context: HttpContext;

package/types/http/express-adapter.d.ts

@@ -1,5 +1,5 @@
 import { ApiDocument, HttpController } from '@opra/common';
-import { Application } from 'express';
+import { type Application } from 'express';
 import { HttpAdapter } from './http-adapter.js';
 export declare class ExpressAdapter extends HttpAdapter {
     readonly app: Application;

package/types/http/http-adapter.d.ts

@@ -1,27 +1,54 @@
 import { ApiDocument, HttpApi, OpraSchema } from '@opra/common';
-import { kHandler } from '../constants.js';
 import { PlatformAdapter } from '../platform-adapter.js';
 import { HttpContext } from './http-context.js';
-import { HttpHandler } from './impl/http-handler.js';
+import { HttpHandler } from './http-handler.js';
 export declare namespace HttpAdapter {
+    type NextCallback = () => Promise<void>;
     /**
-     * @type Interceptor
+     * @type InterceptorFunction
      */
-    type Interceptor = (context: HttpContext, next: () => Promise<void>) => Promise<void>;
+    type InterceptorFunction = IHttpInterceptor['intercept'];
+    /**
+     * @interface IHttpInterceptor
+     */
+    type IHttpInterceptor = {
+        intercept(context: HttpContext, next: NextCallback): Promise<void>;
+    };
     interface Options extends PlatformAdapter.Options {
         basePath?: string;
-        interceptors?: HttpAdapter.Interceptor[];
-        onRequest?: (ctx: HttpContext) => void | Promise<void>;
+        interceptors?: (InterceptorFunction | IHttpInterceptor)[];
     }
+    type EventFunction = (context: HttpContext) => void | Promise<void>;
+    interface Events {
+        createContext: EventFunction;
+        error: EventFunction;
+        request: EventFunction;
+    }
+}
+export interface HttpAdapter {
+    addListener<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    addListener(event: string | symbol, listener: (...args: any[]) => void): this;
+    on<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    once<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    once(event: string | symbol, listener: (...args: any[]) => void): this;
+    removeListener<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
+    off<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    off(event: string | symbol, listener: (...args: any[]) => void): this;
+    prependListener<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
+    prependOnceListener<Event extends keyof HttpAdapter.Events>(event: Event, listener: HttpAdapter.Events[Event]): this;
+    prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
 }
 /**
  *
  * @class HttpAdapter
  */
 export declare abstract class HttpAdapter extends PlatformAdapter {
-    protected [kHandler]: HttpHandler;
+    readonly handler: HttpHandler;
     readonly protocol: OpraSchema.Protocol;
-    interceptors: HttpAdapter.Interceptor[];
+    interceptors: (HttpAdapter.InterceptorFunction | HttpAdapter.IHttpInterceptor)[];
     protected constructor(document: ApiDocument, options?: HttpAdapter.Options);
     get api(): HttpApi;
 }

package/types/http/http-context.d.ts

@@ -2,8 +2,8 @@ import { HttpController, HttpMediaType, HttpOperation, OpraSchema } from '@opra/
 import { ExecutionContext } from '../execution-context.js';
 import type { HttpAdapter } from './http-adapter';
 import { MultipartReader } from './impl/multipart-reader.js';
-import type { HttpIncoming } from './interfaces/http-incoming.interface';
-import type { HttpOutgoing } from './interfaces/http-outgoing.interface';
+import type { HttpIncoming } from './interfaces/http-incoming.interface.js';
+import type { HttpOutgoing } from './interfaces/http-outgoing.interface.js';
 export declare namespace HttpContext {
     interface Initiator extends Omit<ExecutionContext.Initiator, 'document' | 'protocol'> {
         adapter: HttpAdapter;
@@ -26,9 +26,9 @@ export declare class HttpContext extends ExecutionContext {
     protected _multipartReader?: MultipartReader;
     readonly protocol: OpraSchema.Protocol;
     readonly adapter: HttpAdapter;
-    readonly controller: HttpController;
+    readonly controller?: HttpController;
     readonly controllerInstance?: any;
-    readonly operation: HttpOperation;
+    readonly operation?: HttpOperation;
     readonly operationHandler?: Function;
     readonly request: HttpIncoming;
     readonly response: HttpOutgoing;

package/types/http/{impl/http-handler.d.ts → http-handler.d.ts}

@@ -1,9 +1,8 @@
-import { HttpOperationResponse } from '@opra/common';
-import { kAssetCache } from '../../constants.js';
-import type { HttpAdapter } from '../http-adapter.js';
-import { HttpContext } from '../http-context.js';
-import { HttpOutgoing } from '../interfaces/http-outgoing.interface.js';
-import { AssetCache } from './asset-cache.js';
+import { HttpOperationResponse, OpraException, OpraHttpError } from '@opra/common';
+import { kAssetCache } from '../constants.js';
+import type { HttpAdapter } from './http-adapter.js';
+import { HttpContext } from './http-context.js';
+import { AssetCache } from './impl/asset-cache.js';
 /**
  * @namespace
  */
@@ -16,6 +15,7 @@ export declare namespace HttpHandler {
         contentType?: string;
         operationResponse?: HttpOperationResponse;
         body?: any;
+        projection?: string[] | '*';
     }
 }
 /**
@@ -24,6 +24,7 @@ export declare namespace HttpHandler {
 export declare class HttpHandler {
     readonly adapter: HttpAdapter;
     protected [kAssetCache]: AssetCache;
+    onError?: (context: HttpContext, error: OpraException) => void | Promise<void>;
     constructor(adapter: HttpAdapter);
     /**
      * Main http request handler
@@ -60,7 +61,9 @@ export declare class HttpHandler {
      * @param responseValue
      * @protected
      */
-    protected _sendResponse(context: HttpContext, responseValue: any): Promise<void>;
+    sendResponse(context: HttpContext, responseValue?: any): Promise<void>;
+    protected _sendErrorResponse(context: HttpContext): Promise<void>;
+    sendDocumentSchema(context: HttpContext): Promise<void>;
     /**
      *
      * @param context
@@ -68,6 +71,5 @@ export declare class HttpHandler {
      * @protected
      */
     protected _determineResponseArgs(context: HttpContext, body: any): HttpHandler.ResponseArgs;
-    sendDocumentSchema(context: HttpContext): Promise<void>;
-    sendErrorResponse(response: HttpOutgoing, errors: any[]): Promise<void>;
+    protected _wrapExceptions(exceptions: any[]): OpraHttpError[];
 }

package/types/http/impl/http-incoming.host.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import parseRange from 'range-parser';
-import type { HttpIncoming } from '../interfaces/http-incoming.interface';
+import type { HttpIncoming } from '../interfaces/http-incoming.interface.js';
 import { BodyReader } from '../utils/body-reader.js';
 export interface HttpIncomingHost extends HttpIncoming {
 }

package/types/http/impl/http-outgoing.host.d.ts

@@ -1,4 +1,4 @@
-import type { CookieOptions, HttpOutgoing } from '../interfaces/http-outgoing.interface';
+import type { CookieOptions, HttpOutgoing } from '../interfaces/http-outgoing.interface.js';
 export interface HttpOutgoingHost extends HttpOutgoing {
 }
 export declare class HttpOutgoingHost {