@opra/common 0.25.5 → 0.26.0

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

@@ -0,0 +1,178 @@
+import { omitUndefined } from '../../helpers/index.js';
+import { OpraSchema } from '../../schema/index.js';
+import { createActionDecorator } from './action-decorator.js';
+import { createOperationDecorator } from './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.inputMaxContentSize = sizeInBytes);
+            return decorator;
+        };
+        decorator.InputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputPickFields = fields);
+            return decorator;
+        };
+        decorator.InputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputOmitFields = fields);
+            return decorator;
+        };
+        decorator.OutputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputPickFields = fields);
+            return decorator;
+        };
+        decorator.OutputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputOmitFields = 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*/);
+            list.push(operationMeta => {
+                operationMeta.filters = operationMeta.filters || [];
+                operationMeta.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.outputPickFields = fields);
+            return decorator;
+        };
+        decorator.OutputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputOmitFields = 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.sortFields = fields);
+            return decorator;
+        };
+        decorator.DefaultSort = (...fields) => {
+            list.push(operationMeta => operationMeta.defaultSort = fields);
+            return decorator;
+        };
+        decorator.Filter = (field, operators, notes) => {
+            if (typeof operators === 'string')
+                operators = operators.split(/\s*[,| ]\s*/);
+            list.push(operationMeta => {
+                operationMeta.filters = operationMeta.filters || [];
+                operationMeta.filters.push(omitUndefined({ field, operators, notes }));
+            });
+            return decorator;
+        };
+        decorator.OutputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputPickFields = fields);
+            return decorator;
+        };
+        decorator.OutputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputOmitFields = 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.inputMaxContentSize = sizeInBytes);
+            return decorator;
+        };
+        decorator.InputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputPickFields = fields);
+            return decorator;
+        };
+        decorator.InputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputOmitFields = fields);
+            return decorator;
+        };
+        decorator.OutputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputPickFields = fields);
+            return decorator;
+        };
+        decorator.OutputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.outputOmitFields = 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.inputMaxContentSize = sizeInBytes);
+            return decorator;
+        };
+        decorator.InputPickFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputPickFields = fields);
+            return decorator;
+        };
+        decorator.InputOmitFields = (...fields) => {
+            list.push(operationMeta => operationMeta.inputOmitFields = fields);
+            return decorator;
+        };
+        decorator.Filter = (field, operators, notes) => {
+            if (typeof operators === 'string')
+                operators = operators.split(/\s*[,| ]\s*/);
+            list.push(operationMeta => {
+                operationMeta.filters = operationMeta.filters || [];
+                operationMeta.filters.push(omitUndefined({ field, operators, notes }));
+            });
+            return decorator;
+        };
+        return decorator;
+    }
+    CollectionDecorator.UpdateMany = UpdateMany;
+})(CollectionDecorator || (CollectionDecorator = {}));

package/esm/document/resource/collection.js

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

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

@@ -0,0 +1,78 @@
+import { NotAcceptableError, ResourceNotFoundError } from '../../exception/index.js';
+import { ResponsiveMap } from '../../helpers/index.js';
+import { OpraSchema } from '../../schema/index.js';
+import { Resource } from './resource.js';
+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;
+        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 ResourceNotFoundError(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

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,25 @@
+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-resource.js

@@ -0,0 +1,27 @@
+import { ResponsiveMap } from '../../helpers/index.js';
+import { Endpoint } from './endpoint.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 Endpoint(this, name, meta));
+            }
+        }
+    }
+    getOperation(name) {
+        return this.operations.get(name);
+    }
+    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,44 +1,46 @@
+import * as vg from 'valgen';
 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(init) {
+    constructor(resource, name, init) {
+        this.resource = resource;
+        this.name = name;
+        this.decode = vg.isAny();
+        this.encode = vg.isAny();
         Object.assign(this, init);
         this.parameters = new ResponsiveMap();
         if (init.parameters) {
             for (const [n, p] of Object.entries(init.parameters)) {
-                this.parameters.set(n, new EndpointParameter(p));
+                this.defineParameter(n, p);
             }
         }
     }
-    exportSchema() {
+    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 (this.parameters.size) {
             schema.parameters = {};
             for (const [name, param] of this.parameters.entries()) {
-                schema.parameters[name] = param.exportSchema();
+                if (!param.isBuiltin)
+                    schema.parameters[name] = param.exportSchema(options);
             }
         }
         return schema;
     }
 }
-/**
- *
- * @class EndpointParameter
- */
-export class EndpointParameter {
-    constructor(init) {
-        Object.assign(this, init);
-    }
-    exportSchema() {
-        return omitUndefined({
-            type: typeof this.type === 'string' ? this.type : this.type.exportSchema(),
-            description: this.description,
-            isArray: this.isArray
-        });
-    }
-}

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

@@ -0,0 +1,23 @@
+import { RESOURCE_METADATA } from '../constants.js';
+export function createOperationDecorator(operation, options, 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 = { ...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/parameter.js

@@ -0,0 +1,46 @@
+import * as 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

@@ -0,0 +1,28 @@
+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

@@ -3,19 +3,34 @@ import { omitUndefined } from '../../helpers/object-utils.js';
 import { colorFgMagenta, colorFgYellow, colorReset, nodeInspectCustom } from '../utils/inspect.util.js';
 import { Endpoint } from './endpoint.js';
 export class Resource {
-    constructor(document, init) {
+    constructor(parent, init) {
         this.actions = new ResponsiveMap();
-        this.document = document;
+        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 Endpoint({ ...meta, name }));
+                this.actions.set(name, new Endpoint(this, name, meta));
             }
         }
     }
-    exportSchema() {
+    getFullPath() {
+        if (this.parent && this.parent.name)
+            return this.parent?.getFullPath() + '/' + this.name;
+        return this.name;
+    }
+    exportSchema(options) {
         const schema = omitUndefined({
             kind: this.kind,
             description: this.description,
@@ -23,7 +38,7 @@ export class Resource {
         if (this.actions.size) {
             schema.actions = {};
             for (const action of this.actions.values()) {
-                schema.actions[action.name] = action.exportSchema();
+                schema.actions[action.name] = action.exportSchema(options);
             }
         }
         return schema;

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

@@ -1,49 +1,69 @@
-import { omitUndefined } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
-import { generateCodec } from '../utils/generate-codec.js';
-import { Resource } from './resource.js';
-export class SingletonClass extends Resource {
-    constructor(document, init) {
-        super(document, init);
-        this._decoders = {};
-        this._encoders = {};
+import { CrudResource } from './crud-resource.js';
+export class SingletonClass extends CrudResource {
+    constructor(parent, init) {
+        super(parent, init);
         this.kind = OpraSchema.Singleton.Kind;
-        this.controller = init.controller;
-        this.operations = { ...init.operations };
         this.type = init.type;
+        // ------------------
+        let endpoint = this.operations.get('create');
+        if (endpoint) {
+            endpoint.returnType = this.type;
+            endpoint.decode = this.type.generateCodec('decode', {
+                partial: true,
+                pick: endpoint.inputPickFields,
+                omit: endpoint.inputOmitFields,
+            });
+            endpoint.encode = this.type.generateCodec('encode', {
+                partial: true,
+                pick: endpoint.outputPickFields,
+                omit: endpoint.outputOmitFields,
+            });
+            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 = this.operations.get('get');
+        if (endpoint) {
+            endpoint.returnType = this.type;
+            endpoint.encode = this.type.generateCodec('encode', {
+                partial: true,
+                pick: endpoint.outputPickFields,
+                omit: endpoint.outputOmitFields,
+            });
+            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 = this.operations.get('update');
+        if (endpoint) {
+            endpoint.returnType = this.type;
+            endpoint.decode = this.type.generateCodec('decode', {
+                pick: endpoint.inputPickFields,
+                omit: endpoint.inputOmitFields,
+            });
+            endpoint.encode = this.type.generateCodec('encode', {
+                partial: true,
+                pick: endpoint.outputPickFields,
+                omit: endpoint.outputOmitFields,
+            });
+            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 });
+        }
     }
-    exportSchema() {
+    getOperation(name) {
+        return super.getOperation(name);
+    }
+    exportSchema(options) {
         return {
-            ...super.exportSchema(),
-            ...omitUndefined({
-                type: this.type.name || 'any',
-                operations: this.operations
-            })
+            ...super.exportSchema(options),
+            type: this.type.name || 'any'
         };
     }
     normalizeFieldPath(path) {
         return this.type.normalizeFieldPath(path);
     }
-    getDecoder(endpoint) {
-        let decoder = this._decoders[endpoint];
-        if (decoder)
-            return decoder;
-        const options = {
-            partial: endpoint !== 'create'
-        };
-        decoder = generateCodec(this.type, 'decode', options);
-        this._decoders[endpoint] = decoder;
-        return decoder;
-    }
-    getEncoder(endpoint) {
-        let encoder = this._encoders[endpoint];
-        if (encoder)
-            return encoder;
-        const options = {
-            partial: true
-        };
-        encoder = generateCodec(this.type, 'encode', options);
-        this._encoders[endpoint] = encoder;
-        return encoder;
-    }
 }