@opra/common 0.24.2 → 0.25.1

package/types/document/resource/resource.d.ts

@@ -1,8 +1,22 @@
 import { StrictOmit, Type } from 'ts-gems';
+import { ResponsiveMap } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import type { ApiDocument } from '../api-document.js';
 import { nodeInspectCustom } from '../utils/inspect.util.js';
-import { Action } from './action.js';
+import { Endpoint } from './endpoint.js';
+export declare abstract class Resource {
+    readonly document: ApiDocument;
+    abstract readonly kind: OpraSchema.Resource.Kind;
+    readonly name: string;
+    description?: string;
+    controller?: object | Type;
+    abstract operations: Record<string, any>;
+    actions: ResponsiveMap<Endpoint>;
+    protected constructor(document: ApiDocument, init: Resource.InitArguments);
+    exportSchema(): OpraSchema.ResourceBase;
+    toString(): string;
+    [nodeInspectCustom](): string;
+}
 export declare namespace Resource {
     interface InitArguments extends StrictOmit<OpraSchema.ResourceBase, 'kind'> {
         name: string;
@@ -16,16 +30,3 @@ export declare namespace Resource {
     interface ActionOptions {
     }
 }
-export declare abstract class Resource {
-    readonly document: ApiDocument;
-    abstract readonly kind: OpraSchema.Resource.Kind;
-    readonly name: string;
-    readonly description?: string;
-    readonly controller?: object | Type;
-    abstract readonly operations: Record<string, any>;
-    readonly actions: Record<string, Action>;
-    protected constructor(document: ApiDocument, init: Resource.InitArguments);
-    exportSchema(): OpraSchema.ResourceBase;
-    toString(): string;
-    [nodeInspectCustom](): string;
-}

package/types/document/resource/singleton.d.ts

@@ -3,9 +3,23 @@ import { OpraSchema } from '../../schema/index.js';
 import type { TypeThunkAsync } from '../../types.js';
 import type { ApiDocument } from '../api-document.js';
 import { ComplexType } from '../data-type/complex-type.js';
+import { SingletonDecorator } from '../decorators/singleton.decorator.js';
 import type { Resource } from './resource.js';
 import { SingletonClass } from './singleton-class.js';
-import { SingletonDecorator } from './singleton-decorator.js';
+export interface SingletonConstructor extends SingletonDecorator {
+    prototype: SingletonClass;
+    new (document: ApiDocument, init: Singleton.InitArguments): SingletonClass;
+}
+export interface Singleton extends SingletonClass {
+}
+/**
+ * @class Singleton
+ * @decorator Singleton
+ */
+export declare const Singleton: SingletonConstructor;
+/**
+ * @namespace Singleton
+ */
 export declare namespace Singleton {
     interface InitArguments extends Resource.InitArguments, StrictOmit<OpraSchema.Singleton, 'kind' | 'type'> {
         type: ComplexType;
@@ -28,10 +42,3 @@ export declare namespace Singleton {
     type GetEndpointOptions = OpraSchema.Singleton.GetEndpoint;
     type UpdateEndpointOptions = OpraSchema.Singleton.UpdateEndpoint;
 }
-export interface SingletonConstructor extends SingletonDecorator {
-    prototype: Singleton;
-    new (document: ApiDocument, init: Singleton.InitArguments): Singleton;
-}
-export interface Singleton extends SingletonClass {
-}
-export declare const Singleton: SingletonConstructor;

package/types/document/resource/storage-class.d.ts

@@ -1,4 +1,3 @@
-import { Type } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
 import type { ApiDocument } from '../api-document.js';
 import { Resource } from './resource.js';
@@ -6,7 +5,6 @@ import type { Storage } from './storage.js';
 export declare class StorageClass extends Resource {
     readonly kind = "Storage";
     readonly operations: OpraSchema.Storage.Operations;
-    readonly controller?: object | Type;
     constructor(document: ApiDocument, init: Storage.InitArguments);
     exportSchema(): OpraSchema.Storage;
 }

package/types/document/resource/storage.d.ts

@@ -1,9 +1,20 @@
 import { StrictOmit } from 'ts-gems';
 import { OpraSchema } from '../../schema/index.js';
 import type { ApiDocument } from '../api-document.js';
+import { StorageDecorator } from '../decorators/storage.decorator.js';
 import type { Resource } from './resource.js';
 import { StorageClass } from './storage-class.js';
-import { StorageDecorator } from './storage-decorator.js';
+export interface StorageConstructor extends StorageDecorator {
+    prototype: StorageClass;
+    new (document: ApiDocument, init: Storage.InitArguments): StorageClass;
+}
+export interface Storage extends StorageClass {
+}
+/**
+ * @class Storage
+ * @decorator Storage
+ */
+export declare const Storage: StorageConstructor;
 export declare namespace Storage {
     interface InitArguments extends Resource.InitArguments, StrictOmit<OpraSchema.Storage, 'kind'> {
     }
@@ -21,10 +32,3 @@ export declare namespace Storage {
     type GetEndpointOptions = OpraSchema.Storage.GetEndpoint;
     type PostEndpointOptions = OpraSchema.Storage.PostEndpoint;
 }
-export interface StorageConstructor extends StorageDecorator {
-    prototype: Storage;
-    new (document: ApiDocument, init: Storage.InitArguments): Storage;
-}
-export interface Storage extends StorageClass {
-}
-export declare const Storage: StorageConstructor;

package/types/filter/ast/terms/qualified-identifier.d.ts

@@ -1,5 +1,5 @@
-import type { ApiField } from '../../../document/data-type/api-field.js';
 import { DataType } from '../../../document/data-type/data-type.js';
+import type { ApiField } from '../../../document/data-type/field.js';
 import { Literal } from '../abstract/literal.js';
 export declare class QualifiedIdentifier extends Literal {
     dataType: DataType;

package/types/schema/opra-schema.ns.d.ts

@@ -5,6 +5,7 @@ export * from './data-type/field.interface.js';
 export * from './data-type/simple-type.interface.js';
 export * from './data-type/mapped-type.interface.js';
 export * from './data-type/union-type.interface.js';
+export * from './resource/endpoint.interface.js';
 export * from './resource/collection.interface.js';
 export * from './resource/container.interface.js';
 export * from './resource/resource.interface.js';

package/types/schema/resource/collection.interface.d.ts

@@ -1,7 +1,8 @@
 import type { OpraFilter } from '../../filter/index.js';
 import type { DataType } from '../data-type/data-type.interface.js';
 import type { Field } from '../data-type/field.interface';
-import type { Endpoint, ResourceBase } from './resource.interface.js';
+import type { Endpoint } from './endpoint.interface.js';
+import type { ResourceBase } from './resource.interface.js';
 export interface Collection extends ResourceBase {
     kind: Collection.Kind;
     type: DataType.Name;

package/types/schema/resource/endpoint.interface.d.ts

@@ -0,0 +1,12 @@
+import { Field } from '../data-type/field.interface.js';
+export interface Endpoint {
+    description?: string;
+    parameters?: Record<Endpoint.Parameter.Name, Endpoint.Parameter>;
+}
+export declare namespace Endpoint {
+    interface Parameter extends Pick<Field, 'type' | 'description' | 'isArray' | 'default' | 'required' | 'deprecated' | 'examples'> {
+    }
+    namespace Parameter {
+        type Name = string;
+    }
+}

package/types/schema/resource/resource.interface.d.ts

@@ -1,8 +1,8 @@
-import type { Field } from '../data-type/field.interface.js';
 import type { Collection } from './collection.interface.js';
 import type { Container } from './container.interface.js';
+import type { Endpoint } from './endpoint.interface.js';
 import type { Singleton } from './singleton.interface.js';
-import type { Storage } from './storage.interface';
+import type { Storage } from './storage.interface.js';
 export type Resource = Collection | Singleton | Storage | Container;
 export declare namespace Resource {
     type Name = string;
@@ -11,17 +11,5 @@ export declare namespace Resource {
 export interface ResourceBase {
     kind: string;
     description?: string;
-    actions?: Record<Action.Name, Action>;
-}
-export interface Endpoint {
-    description?: string;
-}
-export interface Action {
-    parameters?: Record<Action.ParameterName, Action.Parameter>;
-}
-export declare namespace Action {
-    type Name = string;
-    type ParameterName = string;
-    interface Parameter extends Pick<Field, 'type' | 'description' | 'isArray' | 'default' | 'required' | 'deprecated' | 'examples'> {
-    }
+    actions?: Record<string, Endpoint>;
 }

package/types/schema/resource/storage.interface.d.ts

@@ -1,4 +1,5 @@
-import type { Endpoint, ResourceBase } from './resource.interface.js';
+import type { Endpoint } from './endpoint.interface.js';
+import type { ResourceBase } from './resource.interface.js';
 export interface Storage extends ResourceBase {
     kind: Storage.Kind;
     operations: Storage.Operations;

package/cjs/document/data-type/api-field.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiField = void 0;
-const index_js_1 = require("../../helpers/index.js");
-const index_js_2 = require("../../schema/index.js");
-const constants_js_1 = require("../constants.js");
-const enum_type_js_1 = require("./enum-type.js");
-/**
- * @class ComplexType
- */
-exports.ApiField = function (...args) {
-    // ClassDecorator
-    if (!this) {
-        const [options] = args;
-        return function (target, propertyKey) {
-            if (typeof propertyKey !== 'string')
-                throw new TypeError(`Symbol properties can't be used as a field`);
-            const metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target.constructor) || {};
-            metadata.kind = index_js_2.OpraSchema.ComplexType.Kind;
-            metadata.fields = metadata.fields || {};
-            const designType = Reflect.getMetadata('design:type', target, propertyKey);
-            const elemMeta = metadata.fields[propertyKey] = {
-                ...options,
-                enum: undefined,
-                designType
-            };
-            if (designType === Array) {
-                elemMeta.isArray = true;
-                delete elemMeta.designType;
-            }
-            if (options?.enum) {
-                elemMeta.type = undefined;
-                if (Array.isArray(options.enum)) {
-                    const enumObj = options.enum.reduce((o, v) => {
-                        o[v] = v;
-                        return o;
-                    }, {});
-                    (0, enum_type_js_1.EnumType)(enumObj);
-                    elemMeta.enum = enumObj;
-                }
-                else {
-                    const m = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, options?.enum);
-                    if (!index_js_2.OpraSchema.isEnumType(m))
-                        throw new TypeError(`Invalid "enum" value. Did you forget to set metadata using EnumType() method?`);
-                    elemMeta.enum = options.enum;
-                }
-            }
-            Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, (0, index_js_1.omitUndefined)(metadata), target.constructor);
-        };
-    }
-    // Constructor
-    const [owner, init] = args;
-    const _this = this;
-    _this.owner = owner;
-    _this.name = init.name;
-    _this.origin = init.origin || owner;
-    _this.type = init.type;
-    if (init?.description)
-        this.description = init?.description;
-    if (init?.isArray != null)
-        this.isArray = init?.isArray;
-    this.default = init?.default;
-    this.fixed = init?.fixed;
-    if (init?.deprecated != null)
-        this.deprecated = init?.deprecated;
-    if (init?.exclusive != null)
-        this.exclusive = init?.exclusive;
-    if (init?.required != null)
-        this.required = init?.required;
-};
-const proto = {
-    exportSchema() {
-        return (0, index_js_1.omitUndefined)({
-            type: this.type.name ? this.type.name : this.type.exportSchema(),
-            description: this.description,
-            isArray: this.isArray,
-            default: this.default,
-            fixed: this.fixed,
-            required: this.required
-        });
-    }
-};
-Object.assign(exports.ApiField.prototype, proto);

package/cjs/document/resource/action.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Action = void 0;
-class Action {
-    constructor(init) {
-        this.name = init.name;
-    }
-    exportSchema() {
-        return {};
-    }
-}
-exports.Action = Action;

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

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceDecorator = void 0;
-const constants_js_1 = require("../constants.js");
-exports.ResourceDecorator = {};
-exports.ResourceDecorator.Action = function (options) {
-    return (target, propertyKey) => {
-        if (typeof propertyKey !== 'string')
-            throw new TypeError(`This decorator can't be used for Symbol keys'`);
-        const actionMeta = { ...options };
-        const resourceMetadata = (Reflect.getOwnMetadata(constants_js_1.RESOURCE_METADATA, target.constructor) || {});
-        resourceMetadata.actions = resourceMetadata.actions || {};
-        resourceMetadata.actions[propertyKey] = actionMeta;
-        Reflect.defineMetadata(constants_js_1.RESOURCE_METADATA, resourceMetadata, target.constructor);
-    };
-};

package/esm/document/data-type/api-field.js

@@ -1,80 +0,0 @@
-import { omitUndefined } from '../../helpers/index.js';
-import { OpraSchema } from '../../schema/index.js';
-import { DATATYPE_METADATA } from '../constants.js';
-import { EnumType } from './enum-type.js';
-/**
- * @class ComplexType
- */
-export const ApiField = function (...args) {
-    // ClassDecorator
-    if (!this) {
-        const [options] = args;
-        return function (target, propertyKey) {
-            if (typeof propertyKey !== 'string')
-                throw new TypeError(`Symbol properties can't be used as a field`);
-            const metadata = Reflect.getOwnMetadata(DATATYPE_METADATA, target.constructor) || {};
-            metadata.kind = OpraSchema.ComplexType.Kind;
-            metadata.fields = metadata.fields || {};
-            const designType = Reflect.getMetadata('design:type', target, propertyKey);
-            const elemMeta = metadata.fields[propertyKey] = {
-                ...options,
-                enum: undefined,
-                designType
-            };
-            if (designType === Array) {
-                elemMeta.isArray = true;
-                delete elemMeta.designType;
-            }
-            if (options?.enum) {
-                elemMeta.type = undefined;
-                if (Array.isArray(options.enum)) {
-                    const enumObj = options.enum.reduce((o, v) => {
-                        o[v] = v;
-                        return o;
-                    }, {});
-                    EnumType(enumObj);
-                    elemMeta.enum = enumObj;
-                }
-                else {
-                    const m = Reflect.getOwnMetadata(DATATYPE_METADATA, options?.enum);
-                    if (!OpraSchema.isEnumType(m))
-                        throw new TypeError(`Invalid "enum" value. Did you forget to set metadata using EnumType() method?`);
-                    elemMeta.enum = options.enum;
-                }
-            }
-            Reflect.defineMetadata(DATATYPE_METADATA, omitUndefined(metadata), target.constructor);
-        };
-    }
-    // Constructor
-    const [owner, init] = args;
-    const _this = this;
-    _this.owner = owner;
-    _this.name = init.name;
-    _this.origin = init.origin || owner;
-    _this.type = init.type;
-    if (init?.description)
-        this.description = init?.description;
-    if (init?.isArray != null)
-        this.isArray = init?.isArray;
-    this.default = init?.default;
-    this.fixed = init?.fixed;
-    if (init?.deprecated != null)
-        this.deprecated = init?.deprecated;
-    if (init?.exclusive != null)
-        this.exclusive = init?.exclusive;
-    if (init?.required != null)
-        this.required = init?.required;
-};
-const proto = {
-    exportSchema() {
-        return omitUndefined({
-            type: this.type.name ? this.type.name : this.type.exportSchema(),
-            description: this.description,
-            isArray: this.isArray,
-            default: this.default,
-            fixed: this.fixed,
-            required: this.required
-        });
-    }
-};
-Object.assign(ApiField.prototype, proto);

package/esm/document/resource/action.js

@@ -1,8 +0,0 @@
-export class Action {
-    constructor(init) {
-        this.name = init.name;
-    }
-    exportSchema() {
-        return {};
-    }
-}

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

@@ -1,13 +0,0 @@
-import { RESOURCE_METADATA } from '../constants.js';
-export const ResourceDecorator = {};
-ResourceDecorator.Action = function (options) {
-    return (target, propertyKey) => {
-        if (typeof propertyKey !== 'string')
-            throw new TypeError(`This decorator can't be used for Symbol keys'`);
-        const actionMeta = { ...options };
-        const resourceMetadata = (Reflect.getOwnMetadata(RESOURCE_METADATA, target.constructor) || {});
-        resourceMetadata.actions = resourceMetadata.actions || {};
-        resourceMetadata.actions[propertyKey] = actionMeta;
-        Reflect.defineMetadata(RESOURCE_METADATA, resourceMetadata, target.constructor);
-    };
-};

package/types/document/resource/action.d.ts

@@ -1,11 +0,0 @@
-import { OpraSchema } from '../../schema/index.js';
-export declare namespace Action {
-    interface InitArguments extends OpraSchema.Action {
-        name: string;
-    }
-}
-export declare class Action {
-    readonly name: string;
-    constructor(init: Action.InitArguments);
-    exportSchema(): OpraSchema.Action;
-}

package/types/document/resource/resource-decorator.d.ts

@@ -1,5 +0,0 @@
-import type { Resource } from './resource.js';
-export interface ResourceDecorator {
-    Action: (options?: Resource.ActionOptions) => PropertyDecorator;
-}
-export declare const ResourceDecorator: ResourceDecorator;