@opra/core 0.33.13 → 1.0.0-alpha.2

package/esm/interfaces/interceptor.interface.js

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

package/esm/interfaces/request-handler.interface.js

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

package/esm/platform-adapter.host.js

@@ -1,149 +0,0 @@
-import './augmentation/18n.augmentation.js';
-import path from 'path';
-import { pascalCase } from 'putil-varhelpers';
-import { AsyncEventEmitter } from 'strict-typed-events';
-import { BadRequestError, Container, CrudResource, ForbiddenError, getStackFileName, I18n, Resource, translate } from '@opra/common';
-import { Logger } from './services/logger.js';
-const resourceInitialized = Symbol.for('opra.resource.initialized');
-/**
- * @class PlatformAdapterHost
- */
-export class PlatformAdapterHost extends AsyncEventEmitter {
-    constructor() {
-        super(...arguments);
-        this._controllers = new Map();
-    }
-    get api() {
-        return this._api;
-    }
-    get platform() {
-        return this._platform;
-    }
-    get protocol() {
-        return this._protocol;
-    }
-    get serviceName() {
-        return this._serviceName;
-    }
-    get i18n() {
-        return this._i18n;
-    }
-    async close() {
-        const promises = [];
-        for (const r of this._controllers.values()) {
-            const onShutdown = r?.onShutdown;
-            if (onShutdown)
-                promises.push((async () => onShutdown.call(r.controller, r))());
-        }
-        await Promise.allSettled(promises);
-        this._controllers.clear();
-    }
-    /**
-     * Initializes the adapter
-     */
-    async init(api, options) {
-        if (this._api)
-            throw new Error(`Already initialized`);
-        this._api = api;
-        this._interceptors = [...(options?.interceptors || [])];
-        this._logger = options?.logger && options.logger instanceof Logger
-            ? options.logger
-            : new Logger({ instance: options?.logger });
-        // Assign events
-        if (options?.on) {
-            for (const [event, fn] of Object.entries(options.on)) {
-                /* istanbul ignore next */
-                if (typeof fn === 'function')
-                    this.on(event, fn);
-            }
-        }
-        // Make a safe service name
-        this._serviceName = pascalCase((api.info.title || '').replace(/[^a-z0-9_ ]/ig, '')) || 'OpraService';
-        if (!/^[a-z]/i.test(this._serviceName))
-            this._serviceName = 'X' + this._serviceName;
-        // Init I18n
-        if (options?.i18n instanceof I18n)
-            this._i18n = options.i18n;
-        else if (typeof options?.i18n === 'function')
-            this._i18n = await options.i18n();
-        else
-            this._i18n = await this._createI18n(options?.i18n);
-        this._i18n = this._i18n || I18n.defaultInstance;
-        if (!this._i18n.isInitialized)
-            await this._i18n.init();
-        // Initialize all resources
-        await this.getController(this.api.root);
-    }
-    async getController(resource) {
-        resource = typeof resource === 'object' && resource instanceof Resource
-            ? resource : this.api.getResource(resource);
-        let controller = this._controllers.get(resource);
-        if (!controller) {
-            controller = resource.controller;
-            if (!controller && resource.ctor) {
-                controller = new resource.ctor();
-            }
-            this._controllers.set(resource, controller);
-        }
-        if (controller && !controller[resourceInitialized]) {
-            controller[resourceInitialized] = true;
-            // Initialize controller
-            if (typeof controller.onInit === 'function')
-                await controller.onInit.call(controller);
-            // Initialize sub resources of Container
-            if (resource instanceof Container) {
-                for (const r of resource.resources.values()) {
-                    await this.getController(r);
-                }
-            }
-        }
-        return controller;
-    }
-    async getActionHandler(resource, name) {
-        resource = typeof resource === 'object' && resource instanceof Resource
-            ? resource
-            : this.api.getResource(resource);
-        const controller = await this.getController(resource);
-        const endpoint = resource.actions.get(name);
-        if (endpoint) {
-            const handler = typeof controller[endpoint.name] === 'function' ? controller[endpoint.name] : undefined;
-            if (handler)
-                return { controller, endpoint, handler };
-        }
-        throw new BadRequestError({
-            message: translate('error:ACTION_NOT_FOUND', { resource: resource.name, action: name }),
-            severity: 'error',
-            code: 'ACTION_NOT_FOUND'
-        });
-    }
-    async getOperationHandler(resource, name) {
-        resource = typeof resource === 'object' && resource instanceof Resource
-            ? resource
-            : this.api.getResource(resource);
-        const controller = await this.getController(resource);
-        const endpoint = resource instanceof CrudResource && resource.operations.get(name);
-        if (endpoint) {
-            const handler = typeof controller[endpoint.name] === 'function' ? controller[endpoint.name] : undefined;
-            if (handler)
-                return { controller, endpoint, handler };
-        }
-        throw new ForbiddenError({
-            message: translate('error:OPERATION_FORBIDDEN', { resource: resource.name, operation: name }),
-            severity: 'error',
-            code: 'OPERATION_FORBIDDEN'
-        });
-    }
-    async _createI18n(options) {
-        const opts = {
-            ...options,
-        };
-        delete opts.resourceDirs;
-        const instance = I18n.createInstance(opts);
-        await instance.init();
-        await instance.loadResourceDir(path.resolve(getStackFileName(), '../../../i18n'));
-        if (options?.resourceDirs)
-            for (const dir of options.resourceDirs)
-                await instance.loadResourceDir(dir);
-        return instance;
-    }
-}

package/esm/request-context.js

@@ -1,22 +0,0 @@
-import { ApiDocument } from '@opra/common';
-import { ExecutionContext } from './execution-context.js';
-export var RequestContext;
-(function (RequestContext) {
-    function from(executionContext, api, request, response) {
-        const out = {
-            api,
-            request,
-            response
-        };
-        Object.setPrototypeOf(out, executionContext);
-        return out;
-    }
-    RequestContext.from = from;
-    function is(v) {
-        return ExecutionContext.is(v) &&
-            v.api instanceof ApiDocument &&
-            v.request &&
-            v.response;
-    }
-    RequestContext.is = is;
-})(RequestContext || (RequestContext = {}));

package/esm/request.host.js

@@ -1,20 +0,0 @@
-export class RequestHost {
-    constructor(init) {
-        Object.assign(this, init);
-        this.params = this.params || {};
-    }
-    get resource() {
-        return this.endpoint.resource;
-    }
-    switchToHttp() {
-        if (this.http)
-            return this.http;
-        throw new TypeError('Not executing in an "Http" context');
-    }
-    switchToWs() {
-        throw new TypeError('Not executing in an "WebSocket" context');
-    }
-    switchToRpc() {
-        throw new TypeError('Not executing in an "RPC" context');
-    }
-}

package/esm/request.js

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

package/esm/response.host.js

@@ -1,18 +0,0 @@
-export class ResponseHost {
-    constructor(init) {
-        if (init)
-            Object.assign(this, init);
-        this.errors = this.errors || [];
-    }
-    switchToHttp() {
-        if (this.http)
-            return this.http;
-        throw new TypeError('Not executing in an "Http" context');
-    }
-    switchToWs() {
-        throw new TypeError('Not executing in an "WebSocket" context');
-    }
-    switchToRpc() {
-        throw new TypeError('Not executing in an "RPC" context');
-    }
-}

package/esm/response.js

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

package/i18n/i18n/en/error.json

@@ -1,21 +0,0 @@
-{
-  "BAD_REQUEST": "Bad request",
-  "FAILED_DEPENDENCY": "The request failed due to failure of a previous request",
-  "FORBIDDEN": "You are not authorized to perform this action",
-  "INTERNAL_SERVER_ERROR": "Internal server error",
-  "METHOD_NOT_ALLOWED": "Method not allowed",
-  "NOT_ACCEPTABLE": "Not acceptable",
-  "NOT_FOUND": "Not found",
-  "UNAUTHORIZED": "You have not been authenticated to perform this action",
-  "UNPROCESSABLE_ENTITY": "Unprocessable entity",
-  "REQUEST_VALIDATION": "Request validation failed",
-  "RESPONSE_VALIDATION": "Response validation failed",
-  "RESOURCE_NOT_AVAILABLE": "Resource is not available or you dont have access",
-  "RESOURCE_CONFLICT": "There is already an other {{resource}} resource with same field values ({{fields}})",
-  "OPERATION_FORBIDDEN": "The {{resource}} resource does not accept '{{operation}}' operations",
-  "ACTION_NOT_FOUND": "The {{resource}} resource doesn't have an action named '{{action}}'",
-  "UNKNOWN_FIELD": "Unknown field '{{field}}'",
-  "UNACCEPTED_SORT_FIELD": "Field '{{field}}' is not available for sort operation",
-  "UNACCEPTED_FILTER_FIELD": "Field '{{field}}' is not available for filter operation",
-  "UNACCEPTED_FILTER_OPERATION": "'{{operation}}' for field '{{field}}' is not available for filter operation"
-}

package/types/augmentation/collection.augmentation.d.ts

@@ -1,146 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { Action as _Action, CrudOperation as _Operation, PartialDTO } from '@opra/common';
-import type { Request as _Request } from '../request.js';
-import type { RequestContext } from '../request-context';
-declare module "@opra/common" {
-    namespace Collection {
-        namespace Action {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Action;
-                params: {
-                    [key: string]: any;
-                };
-            }
-            interface Context extends Resource.Context {
-            }
-        }
-        namespace Create {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'create';
-                };
-                data: any;
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Delete {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'delete';
-                };
-                key: any;
-                params: {
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace DeleteMany {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'deleteMany';
-                };
-                params: {
-                    filter?: any;
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace FindMany {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'findMany';
-                };
-                params: {
-                    filter?: any;
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    sort?: string[];
-                    limit?: number;
-                    skip?: number;
-                    distinct?: boolean;
-                    count?: boolean;
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Get {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'get';
-                };
-                key: any;
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Update {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'update';
-                };
-                key: any;
-                data: any;
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace UpdateMany {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'updateMany';
-                };
-                data: any;
-                params: {
-                    filter?: any;
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-    }
-    interface ICollection<T> {
-        create?(context: Collection.Create.Context): Promise<PartialDTO<T>>;
-        delete?(context: Collection.Delete.Context): Promise<number> | undefined;
-        deleteMany?(context: Collection.DeleteMany.Context): Promise<number> | undefined;
-        findMany?(context: Collection.FindMany.Context): Promise<PartialDTO<T>[] | undefined>;
-        get?(context: Collection.Get.Context): Promise<PartialDTO<T> | undefined>;
-        update?(context: Collection.Update.Context): Promise<PartialDTO<T> | undefined>;
-        updateMany?(context: Collection.UpdateMany.Context): Promise<number> | undefined;
-        onInit?(): Promise<void>;
-        onShutdown?(): Promise<void>;
-    }
-}

package/types/augmentation/container.augmentation.d.ts

@@ -1,14 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import { Action as _Action } from '@opra/common';
-import type { Request as _Request } from '../request.js';
-declare module "@opra/common" {
-    namespace Container {
-        namespace Action {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Action;
-            }
-            interface Context extends Resource.Context {
-            }
-        }
-    }
-}

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

@@ -1,38 +0,0 @@
-import { RequestContext } from '../request-context.js';
-declare module "@opra/common" {
-    interface CollectionConstructor {
-        OnInit(): any;
-        OnShutdown(): any;
-    }
-    interface SingletonConstructor {
-        OnInit(): any;
-        OnShutdown(): any;
-    }
-    namespace Resource {
-        interface Context extends RequestContext {
-            params: Record<string, 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>;
-        }
-    }
-}

package/types/augmentation/singleton.augmentation.d.ts

@@ -1,83 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { Action as _Action, CrudOperation as _Operation, PartialDTO } from '@opra/common';
-import type { Request as _Request } from '../request.js';
-import type { RequestContext } from '../request-context.js';
-declare module "@opra/common" {
-    namespace Singleton {
-        namespace Action {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Action;
-            }
-            interface Context extends Resource.Context {
-            }
-        }
-        namespace Create {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'create';
-                };
-                data: any;
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Delete {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'delete';
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Get {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'get';
-                };
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Update {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'update';
-                };
-                data: any;
-                params: {
-                    pick?: string[];
-                    omit?: string[];
-                    include?: string[];
-                    [key: string]: any;
-                };
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-    }
-    interface ISingleton<T> {
-        create?(context: Singleton.Create.Context): Promise<PartialDTO<T>>;
-        delete?(context: Singleton.Delete.Context): Promise<number> | undefined;
-        get?(context: Singleton.Get.Context): Promise<PartialDTO<T> | undefined>;
-        update?(context: Singleton.Update.Context): Promise<PartialDTO<T> | undefined>;
-        onInit?(): Promise<void>;
-        onShutdown?(): Promise<void>;
-    }
-}

package/types/augmentation/storage.augmentation.d.ts

@@ -1,50 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import type { Action as _Action, CrudOperation as _Operation } from '@opra/common';
-import type { MultipartIterator } from '../http/helpers/multipart-helper';
-import type { Request as _Request } from '../request.js';
-import type { RequestContext } from '../request-context.js';
-declare module "@opra/common" {
-    namespace Storage {
-        namespace Action {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Action;
-            }
-            interface Context extends Resource.Context {
-            }
-        }
-        namespace Delete {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'delete';
-                };
-                path?: string;
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Get {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'get';
-                };
-                path?: string;
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-        namespace Post {
-            interface Request extends StrictOmit<_Request, 'endpoint'> {
-                endpoint: _Operation & {
-                    name: 'post';
-                };
-                path?: string;
-                parts: MultipartIterator;
-            }
-            interface Context extends RequestContext {
-                request: Request;
-            }
-        }
-    }
-}

package/types/execution-context.host.d.ts

@@ -1,25 +0,0 @@
-import { AsyncEventEmitter } from 'strict-typed-events';
-import type { ApiDocument } from '@opra/common';
-import type { ExecutionContext, HttpMessageContext, RpcMessageContext, WsMessageContext } from './execution-context.js';
-import type { HttpServerRequest } from './http/http-server-request.js';
-import type { HttpServerResponse } from './http/http-server-response.js';
-import { Protocol } from './platform-adapter.js';
-export declare class ExecutionContextHost extends AsyncEventEmitter implements ExecutionContext {
-    readonly api: ApiDocument;
-    readonly platform: string;
-    readonly protocol: Protocol;
-    readonly http?: HttpMessageContext;
-    readonly ws?: WsMessageContext;
-    readonly rpc?: RpcMessageContext;
-    constructor(api: ApiDocument, platform: string, protocol: {
-        http?: {
-            incoming: HttpServerRequest;
-            outgoing: HttpServerResponse;
-        };
-        ws?: WsMessageContext;
-        rpc?: RpcMessageContext;
-    });
-    switchToHttp(): HttpMessageContext;
-    switchToWs(): WsMessageContext;
-    switchToRpc(): RpcMessageContext;
-}

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

@@ -1,15 +0,0 @@
-import type { Application } from 'express';
-import type { ApiDocument } from '@opra/common';
-import type { PlatformAdapter } from '../../platform-adapter';
-import type { NodeHttpAdapter } from './node-http-adapter';
-export interface ExpressAdapter extends PlatformAdapter {
-    readonly app: Application;
-}
-/**
- * @namespace
- */
-export declare namespace ExpressAdapter {
-    interface Options extends NodeHttpAdapter.Options {
-    }
-    function create(app: Application, api: ApiDocument, options?: ExpressAdapter.Options): Promise<ExpressAdapter>;
-}

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

@@ -1,12 +0,0 @@
-import type { Application } from 'express';
-import { ApiDocument } from '@opra/common';
-import { HttpAdapterHost } from '../http-adapter-host.js';
-import type { ExpressAdapter } from './express-adapter.js';
-export declare class ExpressAdapterHost extends HttpAdapterHost implements ExpressAdapter {
-    protected _platform: string;
-    protected _app: Application;
-    constructor(app: Application);
-    get app(): Application;
-    protected init(api: ApiDocument, options?: ExpressAdapter.Options): Promise<void>;
-    static create(app: Application, api: ApiDocument, options?: ExpressAdapter.Options): Promise<ExpressAdapter>;
-}

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

@@ -1,17 +0,0 @@
-/// <reference types="node" />
-import http from 'http';
-import type { ApiDocument, OpraURLPath } from '@opra/common';
-import type { PlatformAdapter } from '../../platform-adapter';
-export interface NodeHttpAdapter extends PlatformAdapter {
-    readonly basePath: OpraURLPath;
-    readonly server: http.Server;
-}
-/**
- * @namespace NodeHttpAdapter
- */
-export declare namespace NodeHttpAdapter {
-    type Options = PlatformAdapter.Options & {
-        basePath?: string;
-    };
-    function create(api: ApiDocument, options?: Options): Promise<NodeHttpAdapter>;
-}

package/types/http/adapters/node-http-adapter.host.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="node" />
-import http from 'http';
-import { ApiDocument, OpraURLPath } from '@opra/common';
-import { HttpAdapterHost } from '../http-adapter-host.js';
-import type { NodeHttpAdapter } from './node-http-adapter';
-/**
- * @class NodeHttpAdapterHost
- */
-export declare class NodeHttpAdapterHost extends HttpAdapterHost implements NodeHttpAdapter {
-    protected _platform: string;
-    protected _basePath: OpraURLPath;
-    protected _server: http.Server;
-    get basePath(): OpraURLPath;
-    get server(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
-    close(): Promise<void>;
-    protected init(api: ApiDocument, options?: NodeHttpAdapter.Options): Promise<void>;
-    protected _serverListener(incomingMessage: http.IncomingMessage, serverResponse: http.ServerResponse): void;
-    static create(api: ApiDocument, options?: NodeHttpAdapter.Options): Promise<NodeHttpAdapter>;
-}