@opra/common 0.33.13 → 1.0.0-alpha.1

package/esm/document/resource/collection-decorator.js

@@ -1,207 +0,0 @@
-import { omitUndefined } from '../../helpers/index.js';
-import { OpraSchema } from '../../schema/index.js';
-import { createActionDecorator } from './action-decorator.js';
-import { createOperationDecorator } from './crud-operation-decorator.js';
-import { ResourceDecorator } from './resource-decorator.js';
-const operationProperties = ['create', 'delete', 'deleteMany', 'get', 'findMany', 'update', 'updateMany'];
-export function CollectionDecorator(type, options) {
-    return ResourceDecorator(OpraSchema.Collection.Kind, { ...options, type });
-}
-Object.assign(CollectionDecorator, ResourceDecorator);
-/*
- * Action PropertyDecorator
- */
-(function (CollectionDecorator) {
-    /**
-     * Action PropertyDecorator
-     */
-    function Action(options) {
-        const list = [];
-        return createActionDecorator(options, operationProperties, list);
-    }
-    CollectionDecorator.Action = Action;
-    function Create(options) {
-        const list = [];
-        const decorator = createOperationDecorator('create', options, list);
-        decorator.InputMaxContentSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.inputMaxContentSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.InputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputPickFields = fields);
-            return decorator;
-        };
-        decorator.InputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputOmitFields = fields);
-            return decorator;
-        };
-        decorator.InputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.inputOverwriteFields = fields);
-            return decorator;
-        };
-        decorator.OutputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputPickFields = fields);
-            return decorator;
-        };
-        decorator.OutputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputOmitFields = fields);
-            return decorator;
-        };
-        decorator.OutputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.outputOverwriteFields = fields);
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.Create = Create;
-    function Delete(options) {
-        const list = [];
-        return createOperationDecorator('delete', options, list);
-    }
-    CollectionDecorator.Delete = Delete;
-    function DeleteMany(options) {
-        const list = [];
-        const decorator = createOperationDecorator('deleteMany', options, list);
-        decorator.Filter = (field, operators, notes) => {
-            if (typeof operators === 'string')
-                operators = operators.split(/\s*[,| ]\s*/)
-                    .filter(s => s);
-            list.push(operationMeta => {
-                operationMeta.options.filters = operationMeta.options.filters || [];
-                operationMeta.options.filters.push(omitUndefined({ field, operators, notes }));
-            });
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.DeleteMany = DeleteMany;
-    function Get(options) {
-        const list = [];
-        const decorator = createOperationDecorator('get', options, list);
-        decorator.OutputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputPickFields = fields);
-            return decorator;
-        };
-        decorator.OutputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputOmitFields = fields);
-            return decorator;
-        };
-        decorator.OutputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.outputOverwriteFields = fields);
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.Get = Get;
-    function FindMany(options) {
-        const list = [];
-        const decorator = createOperationDecorator('findMany', options, list);
-        decorator.SortFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.sortFields = fields);
-            return decorator;
-        };
-        decorator.DefaultSort = (...fields) => {
-            list.push(operationMeta => operationMeta.options.defaultSort = fields);
-            return decorator;
-        };
-        decorator.Filter = (field, operators, notes) => {
-            if (typeof operators === 'string')
-                operators = operators.split(/\s*[,| ]\s*/);
-            list.push(operationMeta => {
-                operationMeta.options.filters = operationMeta.options.filters || [];
-                operationMeta.options.filters.push(omitUndefined({ field, operators, notes }));
-            });
-            return decorator;
-        };
-        decorator.OutputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputPickFields = fields);
-            return decorator;
-        };
-        decorator.OutputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputOmitFields = fields);
-            return decorator;
-        };
-        decorator.OutputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.outputOverwriteFields = fields);
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.FindMany = FindMany;
-})(CollectionDecorator || (CollectionDecorator = {}));
-/*
- * Update PropertyDecorator
- */
-(function (CollectionDecorator) {
-    function Update(options) {
-        const list = [];
-        const decorator = createOperationDecorator('update', options, list);
-        decorator.InputMaxContentSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.inputMaxContentSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.InputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputPickFields = fields);
-            return decorator;
-        };
-        decorator.InputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputOmitFields = fields);
-            return decorator;
-        };
-        decorator.InputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.inputOverwriteFields = fields);
-            return decorator;
-        };
-        decorator.OutputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputPickFields = fields);
-            return decorator;
-        };
-        decorator.OutputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.outputOmitFields = fields);
-            return decorator;
-        };
-        decorator.OutputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.outputOverwriteFields = fields);
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.Update = Update;
-})(CollectionDecorator || (CollectionDecorator = {}));
-/*
- * UpdateMany PropertyDecorator
- */
-(function (CollectionDecorator) {
-    function UpdateMany(arg0) {
-        const list = [];
-        const options = typeof arg0 === 'string' ? { description: arg0 } : { ...arg0 };
-        const decorator = createOperationDecorator('updateMany', options, list);
-        decorator.InputMaxContentSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.inputMaxContentSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.InputPickFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputPickFields = fields);
-            return decorator;
-        };
-        decorator.InputOmitFields = (...fields) => {
-            list.push(operationMeta => operationMeta.options.inputOmitFields = fields);
-            return decorator;
-        };
-        decorator.InputOverwriteFields = (fields) => {
-            list.push(operationMeta => operationMeta.options.inputOverwriteFields = fields);
-            return decorator;
-        };
-        decorator.Filter = (field, operators, notes) => {
-            if (typeof operators === 'string')
-                operators = operators.split(/\s*[,| ]\s*/);
-            list.push(operationMeta => {
-                operationMeta.options.filters = operationMeta.options.filters || [];
-                operationMeta.options.filters.push(omitUndefined({ field, operators, notes }));
-            });
-            return decorator;
-        };
-        return decorator;
-    }
-    CollectionDecorator.UpdateMany = UpdateMany;
-})(CollectionDecorator || (CollectionDecorator = {}));

package/esm/document/resource/collection.js

@@ -1,21 +0,0 @@
-import merge from 'putil-merge';
-import { DECORATOR } from '../constants.js';
-import { CollectionClass } from './collection-class.js';
-import { CollectionDecorator } from './collection-decorator.js';
-/**
- * @class Collection
- * @decorator Collection
- */
-export const Collection = function (...args) {
-    // ClassDecorator
-    if (!this) {
-        const [type, options] = args;
-        return Collection[DECORATOR].call(undefined, type, options);
-    }
-    // Constructor
-    const [parent, init] = args;
-    merge(this, new CollectionClass(parent, init), { descriptor: true });
-};
-Collection.prototype = CollectionClass.prototype;
-Object.assign(Collection, CollectionDecorator);
-Collection[DECORATOR] = CollectionDecorator;

package/esm/document/resource/container-class.js

@@ -1,80 +0,0 @@
-import { NotAcceptableError, ResourceNotAvailableError } from '../../exception/index.js';
-import { ResponsiveMap } from '../../helpers/index.js';
-import { OpraSchema } from '../../schema/index.js';
-import { Resource } from './resource.js';
-const PATH_PREFIX_PATTERN = /^(\/*)(.+)$/;
-export class ContainerClass extends Resource {
-    constructor(owner, init) {
-        super(owner instanceof ContainerClass ? owner.document : owner, init);
-        this.kind = OpraSchema.Container.Kind;
-        this.resources = new ResponsiveMap();
-        this.parent = owner instanceof ContainerClass ? owner : undefined;
-    }
-    exportSchema(options) {
-        const schema = super.exportSchema(options);
-        if (this.resources.size) {
-            const resources = schema.resources = {};
-            for (const [name, r] of this.resources.entries()) {
-                resources[name] = r.exportSchema(options);
-            }
-        }
-        return schema;
-    }
-    getResource(path, silent) {
-        let resource;
-        path = PATH_PREFIX_PATTERN.exec(path)?.[2] || path;
-        if (path.includes('/')) {
-            const arr = path.split('/');
-            let i;
-            const l = arr.length;
-            let container = this;
-            for (i = 0; i < l; i++) {
-                resource = container.resources.get(arr[i]);
-                if (resource instanceof ContainerClass)
-                    container = resource;
-                else
-                    break;
-            }
-            // If no resource found or walking through path not completed
-            if (!resource || i < l - 1)
-                resource = undefined;
-        }
-        else
-            resource = this.resources.get(path);
-        if (resource || silent)
-            return resource;
-        throw new ResourceNotAvailableError(path);
-    }
-    getContainer(path, silent) {
-        const t = this.getResource(path);
-        if (!t && silent)
-            return;
-        if (t && t.kind === OpraSchema.Container.Kind)
-            return t;
-        throw new NotAcceptableError(`Resource type "${t.name}" is not a Container`);
-    }
-    getCollection(path, silent) {
-        const t = this.getResource(path);
-        if (!t && silent)
-            return;
-        if (t && t.kind === OpraSchema.Collection.Kind)
-            return t;
-        throw new NotAcceptableError(`Resource type "${t.name}" is not a Collection`);
-    }
-    getSingleton(path, silent) {
-        const t = this.getResource(path);
-        if (!t && silent)
-            return;
-        if (t && t.kind === OpraSchema.Singleton.Kind)
-            return t;
-        throw new NotAcceptableError(`Resource type "${t.name}" is not a Singleton`);
-    }
-    getStorage(path, silent) {
-        const t = this.getResource(path);
-        if (!t && silent)
-            return;
-        if (t && t.kind === OpraSchema.Storage.Kind)
-            return t;
-        throw new NotAcceptableError(`Resource type "${t.name}" is not a Storage`);
-    }
-}

package/esm/document/resource/container-decorator.js

@@ -1,20 +0,0 @@
-import { OpraSchema } from '../../schema/index.js';
-import { createActionDecorator } from './action-decorator.js';
-import { ResourceDecorator } from './resource-decorator.js';
-export function ContainerDecorator(options) {
-    return ResourceDecorator(OpraSchema.Container.Kind, options);
-}
-Object.assign(ContainerDecorator, ResourceDecorator);
-/*
- * Action PropertyDecorator
- */
-(function (ContainerDecorator) {
-    /**
-     * Action PropertyDecorator
-     */
-    function Action(options) {
-        const list = [];
-        return createActionDecorator(options, [], list);
-    }
-    ContainerDecorator.Action = Action;
-})(ContainerDecorator || (ContainerDecorator = {}));

package/esm/document/resource/container.js

@@ -1,25 +0,0 @@
-import merge from 'putil-merge';
-import { DECORATOR } from '../constants.js';
-import { ContainerClass } from './container-class.js';
-import { ContainerDecorator } from './container-decorator.js';
-/**
- * @class Container
- * @decorator Container
- */
-export const Container = function (...args) {
-    // ClassDecorator
-    if (!this) {
-        const [options] = args;
-        return Container[DECORATOR].call(undefined, options);
-    }
-    // Constructor
-    const [parent, init] = args;
-    merge(this, new ContainerClass(parent, init), { descriptor: true });
-    if (init.resources) {
-        const container = this;
-        init.resources.forEach(r => container.resources.set(r.name, r));
-    }
-};
-Container.prototype = ContainerClass.prototype;
-Object.assign(Container, ContainerDecorator);
-Container[DECORATOR] = ContainerDecorator;

package/esm/document/resource/crud-operation-decorator.js

@@ -1,24 +0,0 @@
-import { RESOURCE_METADATA } from '../constants.js';
-export function createOperationDecorator(operation, init, list) {
-    const decorator = ((target, propertyKey) => {
-        if (propertyKey !== operation)
-            throw new TypeError(`Name of the handler name should be '${operation}'`);
-        const resourceMetadata = (Reflect.getOwnMetadata(RESOURCE_METADATA, target.constructor) || {});
-        resourceMetadata.operations = resourceMetadata.operations || {};
-        const operationMeta = { ...init };
-        operationMeta.options = operationMeta.options || {};
-        resourceMetadata.operations[operation] = operationMeta;
-        for (const fn of list)
-            fn(operationMeta, target, propertyKey);
-        Reflect.defineMetadata(RESOURCE_METADATA, resourceMetadata, target.constructor);
-    });
-    decorator.Parameter = (name, arg0) => {
-        const parameterOptions = typeof arg0 === 'string' || typeof arg0 === 'function' ? { type: arg0 } : { ...arg0 };
-        list.push((operationMeta) => {
-            operationMeta.parameters = operationMeta.parameters || {};
-            operationMeta.parameters[name] = { ...parameterOptions };
-        });
-        return decorator;
-    };
-    return decorator;
-}

package/esm/document/resource/crud-operation.js

@@ -1,45 +0,0 @@
-import { vg } from 'valgen';
-import { DataType } from '../data-type/data-type.js';
-import { ApiField } from '../data-type/field.js';
-import { Endpoint } from './endpoint.js';
-/**
- *
- * @class CrudOperation
- */
-export class CrudOperation extends Endpoint {
-    constructor(resource, name, init) {
-        super(resource, name, init);
-        this.resource = resource;
-        this.name = name;
-        this.kind = 'operation';
-        this.decodeInput = vg.isAny();
-        this.encodeReturning = vg.isAny();
-        if (init.returnType)
-            this.returnType = init.returnType instanceof DataType
-                ? init.returnType : this.resource.document.getDataType(init.returnType);
-        this.encodeReturning = this.returnType?.generateCodec('encode', { operation: 'read', partial: true }) || vg.isAny();
-        this.inputOverwriteFields = init.options?.inputOverwriteFields;
-        this.outputOverwriteFields = init.options?.outputOverwriteFields;
-    }
-    exportSchema(options) {
-        const schema = super.exportSchema(options);
-        if (this.returnType)
-            schema.returnType = this.returnType.name && !this.returnType.isEmbedded ?
-                this.returnType.name : this.returnType.exportSchema(options);
-        if (this.inputOverwriteFields) {
-            const trg = schema.options.inputOverwriteFields = {};
-            Object.keys(this.inputOverwriteFields)
-                .forEach(([k, o]) => {
-                trg[k] = ApiField.prototype.exportSchema.call(o, options);
-            });
-        }
-        if (this.outputOverwriteFields) {
-            const trg = schema.options.outputOverwriteFields = {};
-            Object.keys(this.outputOverwriteFields)
-                .forEach(([k, o]) => {
-                trg[k] = ApiField.prototype.exportSchema.call(o, options);
-            });
-        }
-        return schema;
-    }
-}

package/esm/document/resource/crud-resource.js

@@ -1,30 +0,0 @@
-import { ResponsiveMap } from '../../helpers/index.js';
-import { CrudOperation } from './crud-operation.js';
-import { Resource } from './resource.js';
-export class CrudResource extends Resource {
-    constructor(parent, init) {
-        super(parent, init);
-        this.operations = new ResponsiveMap();
-        if (init.operations) {
-            for (const [name, meta] of Object.entries(init.operations)) {
-                this.operations.set(name, new CrudOperation(this, name, meta));
-            }
-        }
-    }
-    getOperation(operation) {
-        const op = this.operations.get(operation);
-        if (!op)
-            throw new Error(`${this.name} resource does not support "${operation}" operations`);
-        return op;
-    }
-    exportSchema(options) {
-        const schema = super.exportSchema(options);
-        if (this.operations.size) {
-            schema.operations = {};
-            for (const operation of this.operations.values()) {
-                schema.operations[operation.name] = operation.exportSchema(options);
-            }
-        }
-        return schema;
-    }
-}

package/esm/document/resource/endpoint.js

@@ -1,55 +0,0 @@
-import { omitUndefined, ResponsiveMap } from '../../helpers/index.js';
-import { DataType } from '../data-type/data-type.js';
-import { Parameter } from './parameter.js';
-/**
- *
- * @class Endpoint
- */
-export class Endpoint {
-    constructor(resource, name, init) {
-        this.resource = resource;
-        this.name = name;
-        this.options = {};
-        Object.assign(this, init);
-        this.parameters = new ResponsiveMap();
-        if (init.parameters) {
-            for (const [n, p] of Object.entries(init.parameters)) {
-                this.defineParameter(n, p);
-            }
-        }
-    }
-    getFullPath(documentPath) {
-        return this.resource.getFullPath(documentPath) +
-            (this.kind === 'action' ? (documentPath ? '/actions/' : '/') + this.name : '');
-    }
-    defineParameter(name, init) {
-        const type = init.type && init.type instanceof DataType
-            ? init.type : this.resource.document.getDataType(init.type || 'any');
-        const prm = new Parameter(name, {
-            ...init,
-            type
-        });
-        this.parameters.set(prm.name, prm);
-        return prm;
-    }
-    exportSchema(options) {
-        const schema = omitUndefined({
-            description: this.description
-        });
-        if (Object.keys(this.options).length)
-            schema.options = { ...this.options };
-        if (this.parameters.size) {
-            let i = 0;
-            const parameters = {};
-            for (const [name, param] of this.parameters.entries()) {
-                if (!param.isBuiltin) {
-                    parameters[name] = param.exportSchema(options);
-                    i++;
-                }
-            }
-            if (i)
-                schema.parameters = parameters;
-        }
-        return schema;
-    }
-}

package/esm/document/resource/enums/metadata-mode.enum.js

@@ -1,16 +0,0 @@
-import { EnumType } from '../../data-type/enum-type.js';
-export var MetadataMode;
-(function (MetadataMode) {
-    MetadataMode["none"] = "none";
-    MetadataMode["minimal"] = "minimal";
-    MetadataMode["full"] = "full";
-})(MetadataMode || (MetadataMode = {}));
-EnumType(MetadataMode, {
-    name: 'MetadataMode',
-    description: 'Parameter "enumeration" that controls how metadata information sent',
-    meanings: {
-        'none': 'Specifies that the service will include NO metadata information in the response',
-        'minimal': 'Specifies that the service will include ALL metadata information in the response',
-        'full': 'Specifies that the service will include MINIMAL metadata information in the response',
-    }
-});

package/esm/document/resource/parameter.js

@@ -1,46 +0,0 @@
-import { vg } from 'valgen';
-import { omitUndefined } from '../../helpers/index.js';
-/**
- *
- * @class Parameter
- */
-export class Parameter {
-    constructor(name, init) {
-        this.name = name;
-        this.type = init.type;
-        this.description = init.description;
-        this.isArray = init.isArray;
-        this.default = init.default;
-        this.required = init.required;
-        this.deprecated = init.deprecated;
-        this.examples = init.examples;
-        this.isBuiltin = init.isBuiltin;
-    }
-    exportSchema(options) {
-        return omitUndefined({
-            type: this.type.name ? this.type.name : this.type.exportSchema(options),
-            description: this.description,
-            isArray: this.isArray,
-            default: this.default,
-            required: this.required,
-            deprecated: this.deprecated,
-            examples: this.examples
-        });
-    }
-    getDecoder() {
-        if (!this._decoder)
-            this._decoder = this.generateCodec('decode');
-        return this._decoder;
-    }
-    getEncoder() {
-        if (!this._encoder)
-            this._encoder = this.generateCodec('encode');
-        return this._encoder;
-    }
-    generateCodec(codec, options) {
-        let fn = this.type.generateCodec(codec, options);
-        if (this.isArray)
-            fn = vg.stringSplit(',');
-        return !options?.partial && this.required ? vg.required(fn) : vg.optional(fn);
-    }
-}

package/esm/document/resource/resource-decorator.js

@@ -1,28 +0,0 @@
-import omit from 'lodash.omit';
-import merge from 'putil-merge';
-import { RESOURCE_METADATA } from '../constants.js';
-export function ResourceDecorator(kind, meta) {
-    const namePattern = new RegExp(`^(.*)(${kind}|Resource|Controller)$`);
-    return function (target) {
-        let name = meta?.name;
-        if (!name) {
-            name = namePattern.exec(target.name)?.[1] || target.name;
-            // Containers may start with lowercase
-            if (kind === 'Container')
-                name = name.charAt(0).toLowerCase() + name.substring(1);
-        }
-        const metadata = { kind, name };
-        const baseMetadata = Reflect.getOwnMetadata(RESOURCE_METADATA, Object.getPrototypeOf(target));
-        if (baseMetadata)
-            merge(metadata, baseMetadata, { deep: true });
-        const oldMetadata = Reflect.getOwnMetadata(RESOURCE_METADATA, target);
-        if (oldMetadata)
-            merge(metadata, oldMetadata, { deep: true });
-        merge(metadata, {
-            kind,
-            name,
-            ...omit(meta, ['kind', 'name', 'controller'])
-        }, { deep: true });
-        Reflect.defineMetadata(RESOURCE_METADATA, metadata, target);
-    };
-}

package/esm/document/resource/resource.js

@@ -1,56 +0,0 @@
-import { ResponsiveMap } from '../../helpers/index.js';
-import { omitUndefined } from '../../helpers/object-utils.js';
-import { colorFgMagenta, colorFgYellow, colorReset, nodeInspectCustom } from '../utils/inspect.util.js';
-import { Action } from './action.js';
-export class Resource {
-    constructor(parent, init) {
-        this.actions = new ResponsiveMap();
-        if (parent instanceof Resource) {
-            this.document = parent.document;
-            this.parent = parent;
-        }
-        else
-            this.document = parent;
-        this.name = init.name;
-        this.description = init.description;
-        this.controller = init.controller;
-        if (this.controller) {
-            this.ctor = Object.getPrototypeOf(this.controller).constructor;
-        }
-        else
-            this.ctor = init.ctor;
-        if (init.actions) {
-            for (const [name, meta] of Object.entries(init.actions)) {
-                this.actions.set(name, new Action(this, name, meta));
-            }
-        }
-    }
-    getFullPath(documentPath) {
-        if (this === this.document.root)
-            return documentPath ? '/root' : '/';
-        let out = this.parent?.getFullPath(documentPath);
-        if (!out?.endsWith('/'))
-            out += '/';
-        return out + (documentPath ? 'resources/' : '') + this.name;
-    }
-    exportSchema(options) {
-        const schema = omitUndefined({
-            kind: this.kind,
-            description: this.description,
-        });
-        if (this.actions.size) {
-            schema.actions = {};
-            for (const action of this.actions.values()) {
-                schema.actions[action.name] = action.exportSchema(options);
-            }
-        }
-        return schema;
-    }
-    toString() {
-        return `[${Object.getPrototypeOf(this).constructor.name} ${this.name || '#Embedded'}]`;
-    }
-    [nodeInspectCustom]() {
-        return `[${colorFgYellow + Object.getPrototypeOf(this).constructor.name + colorReset}` +
-            ` ${colorFgMagenta + this.name + colorReset}]`;
-    }
-}