@opra/core 0.14.0 → 0.16.0

package/esm/index.js

@@ -1,11 +1,13 @@
-import "reflect-metadata";
-export * from './types.js';
-export * from './interfaces/execution-context.interface.js';
-export * from './interfaces/resource.interface.js';
-export * from './interfaces/i18n-options.interface.js';
-export * from './adapter/request-contexts/single-request-context.js';
-export * from './adapter/adapter.js';
-export * from './adapter/http-adapter.js';
-export * from './adapter/express-adapter.js';
-export * from './services/data-service.js';
-export * from './services/json-singleton-service.js';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("reflect-metadata");
+require("./augmentation/resource.augmentation.js");
+tslib_1.__exportStar(require("./types.js"), exports);
+tslib_1.__exportStar(require("./adapter/adapter.js"), exports);
+tslib_1.__exportStar(require("./adapter/http/express-adapter.js"), exports);
+tslib_1.__exportStar(require("./adapter/http/http-adapter.js"), exports);
+tslib_1.__exportStar(require("./adapter/interfaces/request-context.interface.js"), exports);
+tslib_1.__exportStar(require("./adapter/interfaces/logger.interface.js"), exports);
+tslib_1.__exportStar(require("./adapter/interfaces/request.interface.js"), exports);
+tslib_1.__exportStar(require("./adapter/interfaces/response.interface.js"), exports);

package/esm/types.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/i18n/en/error.json

@@ -8,8 +8,8 @@
   "NOT_FOUND": "Not found",
   "UNAUTHORIZED": "You have not been authenticated to perform this action",
   "UNPROCESSABLE_ENTITY": "Unprocessable entity",
-  "RESOURCE_NOT_FOUND": "The resource '{{resource}}' could not be found",
+  "RESOURCE_NOT_FOUND": "Resource not found: '{{resource}}'",
   "RESOURCE_CONFLICT": "There is already an other {{resource}} resource with same field values ({{fields}})",
-  "RESOLVER_FORBIDDEN": "The resource endpoint does not accept '{{method}}' operations",
+  "RESOLVER_FORBIDDEN": "The resource endpoint does not accept '{{operation}}' operations",
   "UNACCEPTED_SORT_FIELD": "Field '{{field}}' is not available for sort operation"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/core",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Opra schema package",
   "author": "Panates",
   "license": "MIT",
@@ -19,36 +19,38 @@
     "_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",
-    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest",
-    "cover": "NODE_OPTIONS=--experimental-vm-modules npx jest --collect-coverage",
+    "test": "jest",
+    "cover": "jest --collect-coverage",
     "clean": "npm run clean:src && npm run clean:dist && npm run clean:cover",
     "clean:src": "ts-cleanup -s src --all && ts-cleanup -s test --all",
     "clean:dist": "rimraf ../../build/core",
     "clean:cover": "rimraf ../../coverage/core"
   },
   "dependencies": {
-    "@opra/common": "^0.14.0",
+    "@opra/common": "^0.16.0",
+    "content-type": "^1.0.5",
     "lodash.isnil": "^4.0.0",
     "lodash.omitby": "^4.6.0",
     "power-tasks": "^1.6.4",
     "putil-isplainobject": "^1.1.5",
-    "putil-merge": "^3.10.1",
+    "putil-merge": "^3.10.3",
     "putil-varhelpers": "^1.6.5",
     "strict-typed-events": "^2.3.1"
   },
   "peerDependencies": {
-    "body-parser": ">= 1.0.0",
+    "body-parser": "^1.20.2",
     "express": "^4.x.x || ^5.x.x"
   },
   "devDependencies": {
     "@faker-js/faker": "^7.6.0",
+    "@types/content-type": "^1.1.5",
     "@types/dicer": "^0.2.2",
-    "@types/express": "^4.17.16",
+    "@types/express": "^4.17.17",
     "cors": "^2.8.5",
     "ts-gems": "^2.3.0"
   },
   "type": "module",
-  "types": "esm/index.d.ts",
+  "types": "types/index.d.ts",
   "exports": {
     ".": {
       "require": "./cjs/index.js",
@@ -66,6 +68,7 @@
     "cjs/",
     "esm/",
     "i18n/",
+    "types/",
     "LICENSE",
     "README.md"
   ],

package/types/adapter/adapter.d.ts

@@ -0,0 +1,63 @@
+import { AsyncEventEmitter } from 'strict-typed-events';
+import { ApiDocument, FallbackLng, I18n, LanguageResource } from '@opra/common';
+import { ILogger } from './interfaces/logger.interface.js';
+import { RequestContext } from './interfaces/request-context.interface.js';
+/**
+ * @namespace OpraAdapter
+ */
+export declare namespace OpraAdapter {
+    interface Options {
+        i18n?: I18n | I18nOptions | (() => Promise<I18n>);
+        logger?: ILogger;
+        onRequest?: (ctx: RequestContext) => void | Promise<void>;
+    }
+    interface I18nOptions {
+        /**
+         * Language to use
+         * @default undefined
+         */
+        lng?: string;
+        /**
+         * Language to use if translations in user language are not available.
+         * @default 'dev'
+         */
+        fallbackLng?: false | FallbackLng;
+        /**
+         * Default namespace used if not passed to translation function
+         * @default 'translation'
+         */
+        defaultNS?: string;
+        /**
+         * Resources to initialize with
+         * @default undefined
+         */
+        resources?: LanguageResource;
+        /**
+         * Resource directories to initialize with (if not using loading or not appending using addResourceBundle)
+         * @default undefined
+         */
+        resourceDirs?: string[];
+    }
+}
+/**
+ * @class OpraAdapter
+ */
+export declare abstract class OpraAdapter extends AsyncEventEmitter {
+    readonly api: ApiDocument;
+    protected _internalDoc: ApiDocument;
+    i18n: I18n;
+    logger?: ILogger;
+    protected constructor(api: ApiDocument);
+    /**
+     * Initializes the adapter
+     * @param options
+     * @protected
+     */
+    protected init(options?: OpraAdapter.Options): Promise<void>;
+    /**
+     * Calls shutDown hook for all resources
+     */
+    close(): Promise<void>;
+    protected executeRequest(context: RequestContext): Promise<void>;
+    protected _createI18n(options?: OpraAdapter.I18nOptions): Promise<I18n>;
+}

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

@@ -0,0 +1,11 @@
+import type { Application } from 'express';
+import { ApiDocument } from '@opra/common';
+import { OpraHttpAdapter } from './http-adapter.js';
+export declare namespace OpraExpressAdapter {
+    interface Options extends OpraHttpAdapter.Options {
+    }
+}
+export declare class OpraExpressAdapter extends OpraHttpAdapter {
+    protected platform: string;
+    static create(app: Application, document: ApiDocument, options?: OpraExpressAdapter.Options): Promise<OpraExpressAdapter>;
+}

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

@@ -0,0 +1,37 @@
+import { HttpRequestMessage, HttpResponseMessage } from '@opra/common';
+import { OpraAdapter } from '../adapter.js';
+import { ILogger } from '../interfaces/logger.interface.js';
+import { Request } from '../interfaces/request.interface.js';
+import { RequestContext } from '../interfaces/request-context.interface.js';
+/**
+ * @namespace OpraHttpAdapter
+ */
+export declare namespace OpraHttpAdapter {
+    type Options = OpraAdapter.Options & {
+        prefix?: string;
+    };
+}
+/**
+ *
+ * @class OpraHttpAdapter
+ */
+export declare abstract class OpraHttpAdapter extends OpraAdapter {
+    protected abstract platform: string;
+    /**
+     * Main http request handler
+     * @param incoming
+     * @param outgoing
+     * @protected
+     */
+    protected handler(incoming: HttpRequestMessage, outgoing: HttpResponseMessage): Promise<void>;
+    protected errorHandler(incoming: HttpRequestMessage, outgoing: HttpResponseMessage, errors: any[]): Promise<void>;
+    protected log(logType: keyof ILogger, incoming: HttpRequestMessage, message: string, ...optionalParams: any[]): void;
+    protected executeRequest(context: RequestContext): Promise<void>;
+    /**
+     *
+     * @param incoming
+     * @protected
+     */
+    protected parseRequest(incoming: HttpRequestMessage): Promise<Request>;
+    protected sendResponse(context: RequestContext): Promise<void>;
+}

package/types/adapter/http/http-request-context.host.d.ts

@@ -0,0 +1,16 @@
+import { ApiDocument } from '@opra/common';
+import { Request } from '../interfaces/request.interface.js';
+import { HttpRequestContext, RpcRequestContext, WsRequestContext } from '../interfaces/request-context.interface.js';
+import { Response } from '../interfaces/response.interface.js';
+import { RequestContextHost } from '../request-context.host.js';
+export declare class HttpRequestContextHost extends RequestContextHost {
+    readonly platform: string;
+    readonly api: ApiDocument;
+    protected _request: Request;
+    protected _response: Response;
+    user?: any;
+    constructor(platform: string, api: ApiDocument, _request: Request, _response: Response);
+    switchToHttp(): HttpRequestContext;
+    switchToWs(): WsRequestContext;
+    switchToRpc(): RpcRequestContext;
+}

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

@@ -0,0 +1,7 @@
+import { HttpRequestMessage } from '@opra/common';
+import { RequestHost } from '../request.host.js';
+export declare class HttpRequestHost extends RequestHost {
+    protected _incoming: HttpRequestMessage;
+    constructor(init: RequestHost.Initiator, _incoming: HttpRequestMessage);
+    switchToHttp(): HttpRequestMessage;
+}

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

@@ -0,0 +1,7 @@
+import { HttpResponseMessage } from '@opra/common';
+import { ResponseHost } from '../response.host.js';
+export declare class HttpResponseHost extends ResponseHost {
+    protected _outgoing: HttpResponseMessage;
+    constructor(init: ResponseHost.Initiator, _outgoing: HttpResponseMessage);
+    switchToHttp(): HttpResponseMessage;
+}

package/{esm → types/adapter}/interfaces/logger.interface.d.ts

@@ -1,6 +1,7 @@
 export interface ILogger {
     log(message: any, ...optionalParams: any[]): any;
     error(message: any, ...optionalParams: any[]): any;
+    fatal?(message: any, ...optionalParams: any[]): any;
     warn(message: any, ...optionalParams: any[]): any;
     debug?(message: any, ...optionalParams: any[]): any;
     verbose?(message: any, ...optionalParams: any[]): any;

package/types/adapter/interfaces/request-context.interface.d.ts

@@ -0,0 +1,25 @@
+import { ApiDocument, HttpRequestMessage, HttpResponseMessage } from '@opra/common';
+import { Request } from './request.interface.js';
+import { Response } from './response.interface.js';
+export declare namespace RequestContext {
+    type Protocol = 'http' | 'ws' | 'rpc';
+}
+export interface RequestContext {
+    readonly protocol: RequestContext.Protocol;
+    readonly platform: string;
+    readonly api: ApiDocument;
+    readonly request: Request;
+    readonly response: Response;
+    user?: any;
+    switchToHttp(): HttpRequestContext;
+    switchToWs(): WsRequestContext;
+    switchToRpc(): RpcRequestContext;
+}
+export interface HttpRequestContext extends Omit<RequestContext, 'request' | 'response'> {
+    readonly request: HttpRequestMessage;
+    readonly response: HttpResponseMessage;
+}
+export interface WsRequestContext extends Omit<RequestContext, 'request' | 'response'> {
+}
+export interface RpcRequestContext extends Omit<RequestContext, 'request' | 'response'> {
+}

package/types/adapter/interfaces/request.interface.d.ts

@@ -0,0 +1,13 @@
+import { HttpRequestMessage, OpraSchema, Resource } from '@opra/common';
+export interface Request {
+    readonly kind: string;
+    readonly resource: Resource;
+    readonly resourceKind: OpraSchema.Resource.Kind;
+    readonly operation: string;
+    readonly crud: 'create' | 'read' | 'update' | 'delete';
+    readonly many: boolean;
+    readonly args: any;
+    switchToHttp(): HttpRequestMessage;
+    switchToWs(): never;
+    switchToRpc(): never;
+}

package/types/adapter/interfaces/response.interface.d.ts

@@ -0,0 +1,22 @@
+import { HttpResponseMessage } from '@opra/common';
+export interface Response {
+    /**
+     * Result value
+     */
+    value?: any;
+    /**
+     * List of errors
+     */
+    errors: Error[];
+    /**
+     *
+     */
+    continueOnError?: boolean;
+    /**
+     * Total count of matched entities. (Used in "search" operation with "count" option
+     */
+    count?: number;
+    switchToHttp(): HttpResponseMessage;
+    switchToWs(): never;
+    switchToRpc(): never;
+}

package/types/adapter/internal/metadata.resource.d.ts

@@ -0,0 +1,7 @@
+import { ApiDocument } from '@opra/common';
+export declare class MetadataResource {
+    readonly document: ApiDocument;
+    private _schema;
+    constructor(document: ApiDocument);
+    get(): import("@opra/common/types/schema/document.interface").ApiDocument;
+}

package/types/adapter/request-context.host.d.ts

@@ -0,0 +1,19 @@
+import { AsyncEventEmitter } from 'strict-typed-events';
+import { ApiDocument } from '@opra/common';
+import { Request } from './interfaces/request.interface.js';
+import { HttpRequestContext, RequestContext, RpcRequestContext, WsRequestContext } from './interfaces/request-context.interface.js';
+import { Response } from './interfaces/response.interface.js';
+export declare abstract class RequestContextHost extends AsyncEventEmitter implements RequestContext {
+    readonly protocol: RequestContext.Protocol;
+    readonly platform: string;
+    readonly api: ApiDocument;
+    protected _request: Request;
+    protected _response: Response;
+    user?: any;
+    protected constructor(protocol: RequestContext.Protocol, platform: string, api: ApiDocument, _request: Request, _response: Response);
+    get request(): Request;
+    get response(): Response;
+    switchToHttp(): HttpRequestContext;
+    switchToWs(): WsRequestContext;
+    switchToRpc(): RpcRequestContext;
+}

package/types/adapter/request.host.d.ts

@@ -0,0 +1,26 @@
+import type { HttpRequestMessage, Resource } from '@opra/common';
+import { OpraSchema } from '@opra/common';
+import type { Request } from './interfaces/request.interface.js';
+export declare namespace RequestHost {
+    interface Initiator {
+        kind: string;
+        resource: Resource;
+        operation: string;
+        crud: 'create' | 'read' | 'update' | 'delete';
+        many: boolean;
+        args: any;
+    }
+}
+export declare abstract class RequestHost implements Request {
+    readonly kind: string;
+    readonly resource: Resource;
+    readonly resourceKind: OpraSchema.Resource.Kind;
+    readonly operation: string;
+    readonly crud: 'create' | 'read' | 'update' | 'delete';
+    readonly many: boolean;
+    readonly args: any;
+    protected constructor(init: RequestHost.Initiator);
+    switchToHttp(): HttpRequestMessage;
+    switchToWs(): never;
+    switchToRpc(): never;
+}

package/types/adapter/response.host.d.ts

@@ -0,0 +1,20 @@
+import { HttpResponseMessage } from '@opra/common';
+import { Response } from './interfaces/response.interface.js';
+export declare namespace ResponseHost {
+    interface Initiator {
+        value?: any;
+        errors?: Error[];
+        continueOnError?: boolean;
+        count?: number;
+    }
+}
+export declare abstract class ResponseHost implements Response {
+    value?: any;
+    errors: Error[];
+    continueOnError?: boolean;
+    count?: number;
+    protected constructor(init: ResponseHost.Initiator);
+    switchToHttp(): HttpResponseMessage;
+    switchToWs(): never;
+    switchToRpc(): never;
+}

package/types/augmentation/resource.augmentation.d.ts

@@ -0,0 +1,33 @@
+declare module "@opra/common" {
+    interface CollectionConstructor {
+        OnInit(): any;
+        OnShutdown(): any;
+    }
+    interface SingletonConstructor {
+        OnInit(): any;
+        OnShutdown(): any;
+    }
+    interface Resource {
+        onInit?: (resource: Resource) => void | Promise<void>;
+        onShutdown?: (resource: Resource) => void | Promise<void>;
+    }
+    namespace Resource {
+        interface InitArguments {
+            onInit?: (resource: Resource) => void | Promise<void>;
+            onShutdown?: (resource: Resource) => void | Promise<void>;
+        }
+    }
+    namespace Collection {
+        interface Metadata {
+            onInit?: (resource: Collection) => void | Promise<void>;
+            onShutdown?: (resource: Collection) => void | Promise<void>;
+        }
+    }
+    namespace Singleton {
+        interface Metadata {
+            onInit?: (resource: Singleton) => void | Promise<void>;
+            onShutdown?: (resource: Singleton) => void | Promise<void>;
+        }
+    }
+}
+export {};

package/types/index.d.ts

@@ -0,0 +1,10 @@
+import "reflect-metadata";
+import './augmentation/resource.augmentation.js';
+export * from './types.js';
+export * from './adapter/adapter.js';
+export * from './adapter/http/express-adapter.js';
+export * from './adapter/http/http-adapter.js';
+export * from './adapter/interfaces/request-context.interface.js';
+export * from './adapter/interfaces/logger.interface.js';
+export * from './adapter/interfaces/request.interface.js';
+export * from './adapter/interfaces/response.interface.js';

package/cjs/adapter/classes/execution-context.host.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecutionContextHost = void 0;
-const strict_typed_events_1 = require("strict-typed-events");
-class ExecutionContextHost extends strict_typed_events_1.AsyncEventEmitter {
-    constructor() {
-        super();
-    }
-    switchToHttp() {
-        throw new Error(`This is not an http context`);
-    }
-    onFinish(fn) {
-        this.on('finish', fn);
-    }
-}
-exports.ExecutionContextHost = ExecutionContextHost;

package/cjs/adapter/classes/express-request-wrapper.host.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExpressRequestWrapperHost = void 0;
-class ExpressRequestWrapperHost {
-    constructor(instance) {
-        this.instance = instance;
-    }
-    getInstance() {
-        return this.instance;
-    }
-    getMethod() {
-        return this.instance.method;
-    }
-    getUrl() {
-        return this.instance.url;
-    }
-    getHeaderNames() {
-        return Object.keys(this.instance.headers);
-    }
-    getHeader(name) {
-        return this.instance.get(name);
-    }
-    getHeaders() {
-        return this.instance.headers;
-    }
-    getBody() {
-        return this.instance.body;
-    }
-    isCompleted() {
-        return this.instance.complete;
-    }
-    getStream() {
-        return this.instance;
-    }
-}
-exports.ExpressRequestWrapperHost = ExpressRequestWrapperHost;

package/cjs/adapter/classes/express-response-wrapper.host.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExpressResponseWrapperHost = void 0;
-class ExpressResponseWrapperHost {
-    constructor(instance) {
-        this.instance = instance;
-    }
-    getInstance() {
-        return this.instance;
-    }
-    getHeader(name) {
-        return this.instance.get(name);
-    }
-    getHeaders() {
-        return this.instance.getHeaders();
-    }
-    getHeaderNames() {
-        return this.instance.getHeaderNames();
-    }
-    hasHeader(name) {
-        return this.instance.hasHeader(name);
-    }
-    removeHeader(name) {
-        return this.instance.removeHeader(name);
-    }
-    setHeader(name, value) {
-        this.instance.setHeader(name, value);
-        return this;
-    }
-    getStatus() {
-        return this.instance.statusCode;
-    }
-    setStatus(value) {
-        // noinspection SuspiciousTypeOfGuard
-        this.instance.status(typeof value === 'number'
-            ? value
-            : parseInt(value, 10) || 500);
-        return this;
-    }
-    getStream() {
-        return this.instance;
-    }
-    send(body) {
-        if (typeof body === 'string' || Buffer.isBuffer(body))
-            this.instance.send(body);
-        else
-            this.instance.json(body);
-        return this;
-    }
-    end() {
-        this.instance.end();
-        return this;
-    }
-}
-exports.ExpressResponseWrapperHost = ExpressResponseWrapperHost;

package/cjs/adapter/classes/http-execution-context.host.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpExecutionContextHost = void 0;
-const execution_context_host_js_1 = require("./execution-context.host.js");
-class HttpExecutionContextHost extends execution_context_host_js_1.ExecutionContextHost {
-    constructor(_platform, _request, _response) {
-        super();
-        this._platform = _platform;
-        this._request = _request;
-        this._response = _response;
-    }
-    getType() {
-        return 'http';
-    }
-    getPlatform() {
-        return this._platform;
-    }
-    getRequest() {
-        return this._request;
-    }
-    getResponse() {
-        return this._response;
-    }
-    switchToHttp() {
-        return this;
-    }
-}
-exports.HttpExecutionContextHost = HttpExecutionContextHost;

package/cjs/adapter/classes/metadata.resource.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetadataResource = void 0;
-const tslib_1 = require("tslib");
-const common_1 = require("@opra/common");
-const json_singleton_service_js_1 = require("../../services/json-singleton-service.js");
-let MetadataResource = class MetadataResource {
-    init(resource) {
-        this.service = new json_singleton_service_js_1.JsonSingletonService(resource.dataType, {
-            data: resource.document.getMetadata(true)
-        });
-    }
-    get() {
-        return this.service.get();
-    }
-};
-MetadataResource = tslib_1.__decorate([
-    (0, common_1.OprSingletonResource)(Object, {
-        name: '$metadata'
-    })
-], MetadataResource);
-exports.MetadataResource = MetadataResource;

package/cjs/adapter/express-adapter.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpraExpressAdapter = void 0;
-const tslib_1 = require("tslib");
-const body_parser_1 = tslib_1.__importDefault(require("body-parser"));
-const common_1 = require("@opra/common");
-const express_request_wrapper_host_js_1 = require("./classes/express-request-wrapper.host.js");
-const express_response_wrapper_host_js_1 = require("./classes/express-response-wrapper.host.js");
-const http_execution_context_host_js_1 = require("./classes/http-execution-context.host.js");
-const http_adapter_js_1 = require("./http-adapter.js");
-class OpraExpressAdapter extends http_adapter_js_1.OpraHttpAdapter {
-    static async init(app, document, options) {
-        const adapter = new OpraExpressAdapter(document);
-        await adapter._init(options);
-        const prefix = '/' + (0, common_1.normalizePath)(options?.prefix, true);
-        app.use(prefix, body_parser_1.default.json());
-        app.use(prefix, (request, response, next) => {
-            (async () => {
-                const executionContext = new http_execution_context_host_js_1.HttpExecutionContextHost('express', new express_request_wrapper_host_js_1.ExpressRequestWrapperHost(request), new express_response_wrapper_host_js_1.ExpressResponseWrapperHost(response));
-                await adapter.handler(executionContext);
-            })().catch(e => next(e));
-        });
-        return adapter;
-    }
-}
-exports.OpraExpressAdapter = OpraExpressAdapter;