@opra/common 0.33.13 → 1.0.0-alpha.10

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}]`;
-    }
-}

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

@@ -1,79 +0,0 @@
-import { OpraSchema } from '../../schema/index.js';
-import { CrudResource } from './crud-resource.js';
-export class SingletonClass extends CrudResource {
-    constructor(parent, init) {
-        super(parent, init);
-        this.kind = OpraSchema.Singleton.Kind;
-        this.type = init.type;
-        // ------------------
-        let endpoint = this.operations.get('create');
-        if (endpoint) {
-            endpoint.defineParameter('pick', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('omit', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('include', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.decodeInput = this.type.generateCodec('decode', {
-                partial: true,
-                pick: endpoint.options.inputPickFields,
-                omit: endpoint.options.inputOmitFields,
-                operation: 'write',
-                overwriteFields: endpoint.inputOverwriteFields
-            });
-            endpoint.returnType = this.type;
-            endpoint.encodeReturning = endpoint.returnType.generateCodec('encode', {
-                partial: true,
-                pick: endpoint.options.outputPickFields,
-                omit: endpoint.options.outputOmitFields,
-                operation: 'read',
-                overwriteFields: endpoint.outputOverwriteFields
-            });
-        }
-        // ------------------
-        endpoint = this.operations.get('get');
-        if (endpoint) {
-            endpoint.defineParameter('pick', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('omit', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('include', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.returnType = this.type;
-            endpoint.encodeReturning = endpoint.returnType.generateCodec('encode', {
-                partial: true,
-                pick: endpoint.options.outputPickFields,
-                omit: endpoint.options.outputOmitFields,
-                operation: 'read',
-                overwriteFields: endpoint.outputOverwriteFields
-            });
-        }
-        // ------------------
-        endpoint = this.operations.get('update');
-        if (endpoint) {
-            endpoint.defineParameter('pick', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('omit', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.defineParameter('include', { type: 'string', isArray: true, isBuiltin: true });
-            endpoint.decodeInput = this.type.generateCodec('decode', {
-                pick: endpoint.options.inputPickFields,
-                omit: endpoint.options.inputOmitFields,
-                operation: 'write',
-                overwriteFields: endpoint.inputOverwriteFields
-            });
-            endpoint.returnType = this.type;
-            endpoint.encodeReturning = endpoint.returnType.generateCodec('encode', {
-                partial: true,
-                pick: endpoint.options.outputPickFields,
-                omit: endpoint.options.outputOmitFields,
-                operation: 'read',
-                overwriteFields: endpoint.outputOverwriteFields
-            });
-        }
-    }
-    getOperation(name) {
-        return super.getOperation(name);
-    }
-    exportSchema(options) {
-        return {
-            ...super.exportSchema(options),
-            type: this.type.name || 'any'
-        };
-    }
-    normalizeFieldNames(path) {
-        return this.type.normalizeFieldNames(path);
-    }
-}

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

@@ -1,53 +0,0 @@
-import { OpraSchema } from '../../schema/index.js';
-import { createActionDecorator } from './action-decorator.js';
-import { CollectionDecorator } from './collection-decorator.js';
-import { ResourceDecorator } from './resource-decorator.js';
-const operationProperties = ['create', 'delete', 'get', 'update'];
-export function SingletonDecorator(type, options) {
-    return ResourceDecorator(OpraSchema.Singleton.Kind, { ...options, type });
-}
-Object.assign(SingletonDecorator, ResourceDecorator);
-/*
- * Action PropertyDecorator
- */
-(function (SingletonDecorator) {
-    /**
-     * Action PropertyDecorator
-     */
-    function Action(options) {
-        const list = [];
-        return createActionDecorator(options, operationProperties, list);
-    }
-    SingletonDecorator.Action = Action;
-    function Create(options) {
-        return CollectionDecorator.Create(options);
-    }
-    SingletonDecorator.Create = Create;
-})(SingletonDecorator || (SingletonDecorator = {}));
-/*
- * Get PropertyDecorator
- */
-(function (SingletonDecorator) {
-    function Get(options) {
-        return CollectionDecorator.Get(options);
-    }
-    SingletonDecorator.Get = Get;
-})(SingletonDecorator || (SingletonDecorator = {}));
-/*
- * Delete PropertyDecorator
- */
-(function (SingletonDecorator) {
-    function Delete(options) {
-        return CollectionDecorator.Delete(options);
-    }
-    SingletonDecorator.Delete = Delete;
-})(SingletonDecorator || (SingletonDecorator = {}));
-/*
- * Update PropertyDecorator
- */
-(function (SingletonDecorator) {
-    function Update(options) {
-        return CollectionDecorator.Update(options);
-    }
-    SingletonDecorator.Update = Update;
-})(SingletonDecorator || (SingletonDecorator = {}));

package/esm/document/resource/singleton.js

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

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

@@ -1,14 +0,0 @@
-import { OpraSchema } from '../../schema/index.js';
-import { CrudResource } from './crud-resource.js';
-export class StorageClass extends CrudResource {
-    constructor(parent, init) {
-        super(parent, init);
-        this.kind = OpraSchema.Storage.Kind;
-    }
-    getOperation(name) {
-        return super.getOperation(name);
-    }
-    exportSchema(options) {
-        return super.exportSchema(options);
-    }
-}

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

@@ -1,66 +0,0 @@
-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 = ['delete', 'get', 'post'];
-export function StorageDecorator(options) {
-    return ResourceDecorator(OpraSchema.Storage.Kind, options);
-}
-Object.assign(StorageDecorator, ResourceDecorator);
-/*
- * Action PropertyDecorator
- */
-(function (StorageDecorator) {
-    /**
-     * Action PropertyDecorator
-     */
-    function Action(options) {
-        const list = [];
-        return createActionDecorator(options, operationProperties, list);
-    }
-    StorageDecorator.Action = Action;
-    function Delete(options) {
-        const list = [];
-        return createOperationDecorator('delete', options, list);
-    }
-    StorageDecorator.Delete = Delete;
-    function Get(options) {
-        const list = [];
-        return createOperationDecorator('get', options, list);
-    }
-    StorageDecorator.Get = Get;
-    function Post(options) {
-        const list = [];
-        const decorator = createOperationDecorator('post', options, list);
-        decorator.MaxFields = (amount) => {
-            list.push(operationMeta => operationMeta.options.maxFields = amount);
-            return decorator;
-        };
-        decorator.MaxFieldSize = (amount) => {
-            list.push(operationMeta => operationMeta.options.maxFieldsSize = amount);
-            return decorator;
-        };
-        decorator.MaxFiles = (amount) => {
-            list.push(operationMeta => operationMeta.options.maxFiles = amount);
-            return decorator;
-        };
-        decorator.MaxFileSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.maxFileSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.MaxTotalFileSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.maxTotalFileSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.MinFileSize = (sizeInBytes) => {
-            list.push(operationMeta => operationMeta.options.minFileSize = sizeInBytes);
-            return decorator;
-        };
-        decorator.Returns = (t) => {
-            list.push(operationMeta => operationMeta.returnType = t);
-            return decorator;
-        };
-        return decorator;
-    }
-    StorageDecorator.Post = Post;
-})(StorageDecorator || (StorageDecorator = {}));

package/esm/document/resource/storage.js

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

package/esm/document/resource/types/operation-result.type.js

@@ -1,42 +0,0 @@
-import { __decorate } from "tslib";
-import { ComplexType } from '../../data-type/complex-type.js';
-import { ApiField } from '../../data-type/field.js';
-let OperationResult = class OperationResult {
-    constructor(init) {
-        if (init)
-            Object.assign(this, init);
-    }
-};
-__decorate([
-    ApiField()
-], OperationResult.prototype, "context", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "contextUrl", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "type", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "typeUrl", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "affected", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "count", void 0);
-__decorate([
-    ApiField()
-], OperationResult.prototype, "totalMatches", void 0);
-__decorate([
-    ApiField({ type: 'any' })
-], OperationResult.prototype, "payload", void 0);
-__decorate([
-    ApiField({ type: 'object' })
-], OperationResult.prototype, "errors", void 0);
-OperationResult = __decorate([
-    ComplexType({
-        description: 'Operation result'
-    })
-], OperationResult);
-export { OperationResult };