@opra/common 1.0.0-alpha.1 → 1.0.0-alpha.3

package/esm/document/factory/http-api.factory.js

@@ -205,7 +205,7 @@ export class HttpApiFactory {
             });
         }
         if (metadata.requestBody) {
-            await context.enter('.requestBody', async () => {
+            await context.enterAsync('.requestBody', async () => {
                 const requestBody = new HttpRequestBody(operation);
                 await this._initHttpRequestBody(context, requestBody, metadata.requestBody);
                 operation.requestBody = requestBody;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.3",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",
@@ -55,7 +55,7 @@
     "@browsery/util": "^0.12.5",
     "@types/encodeurl": "^1.0.2",
     "@types/lodash.omit": "^4.5.9",
-    "@types/validator": "^13.11.10",
+    "@types/validator": "^13.12.0",
     "path-browserify": "^1.0.1",
     "ts-gems": "^3.4.0"
   },

package/types/document/api-document.d.ts

@@ -7,17 +7,13 @@ import { kTypeNSMap } from './constants.js';
 import { DataType } from './data-type/data-type.js';
 import type { EnumType } from './data-type/enum-type.js';
 import type { HttpApi } from './http/http-api.js';
-export declare namespace ApiDocument {
-    interface ExportOptions {
-        references?: 'inline' | 'relative-url' | 'external-url';
-    }
-}
 /**
  *
  * @class ApiDocument
  */
 export declare class ApiDocument extends DocumentElement {
     protected [kTypeNSMap]: WeakMap<DataType, string>;
+    readonly id: string;
     url?: string;
     info: OpraSchema.DocumentInfo;
     references: ResponsiveMap<ApiDocument>;
@@ -29,10 +25,11 @@ export declare class ApiDocument extends DocumentElement {
      * @param nameOrCtor
      */
     getDataTypeNs(nameOrCtor: string | Type | Function | EnumType.EnumArray | EnumType.EnumObject | DataType): string | undefined;
+    findDocument(id: string): ApiDocument | undefined;
     toJSON(): OpraSchema.ApiDocument;
     /**
      * Export as Opra schema definition object
      */
-    export(options?: ApiDocument.ExportOptions): OpraSchema.ApiDocument;
+    export(): OpraSchema.ApiDocument;
     protected _findDataType(nameOrCtor: string | Type | Function | EnumType.EnumArray | EnumType.EnumObject, visitedRefs?: WeakMap<ApiDocument, boolean>): DataType | undefined;
 }

package/types/document/factory/api-document.factory.d.ts

@@ -5,7 +5,7 @@ import { DocumentInitContext } from '../common/document-init-context.js';
 import { DataTypeFactory } from './data-type.factory.js';
 import { HttpApiFactory } from './http-api.factory.js';
 export declare namespace ApiDocumentFactory {
-    interface InitArguments extends PartialSome<StrictOmit<OpraSchema.ApiDocument, 'references' | 'types' | 'api'>, 'spec'> {
+    interface InitArguments extends PartialSome<StrictOmit<OpraSchema.ApiDocument, 'id' | 'references' | 'types' | 'api'>, 'spec'> {
         references?: Record<string, ReferenceThunk>;
         types?: DataTypeInitSources;
         api?: HttpApiFactory.InitArguments;

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

@@ -7,9 +7,10 @@ export type Protocol = 'http' | 'ws' | 'rpc';
  */
 export interface Document extends DataTypeContainer {
     spec: SpecVersion;
+    id: string;
     url?: string;
     info?: DocumentInfo;
-    references?: Record<string, string | Document>;
+    references?: Record<string, DocumentReference>;
     api?: HttpApi;
 }
 /**
@@ -39,6 +40,14 @@ export interface LicenseInfo {
     url?: string;
     content?: string;
 }
+/**
+ * @interface DocumentReference
+ */
+export interface DocumentReference extends Pick<Document, 'id' | 'url' | 'info'> {
+}
+/**
+ * @interface Api
+ */
 export interface Api extends DataTypeContainer {
     protocol: Protocol;
     /**
@@ -47,6 +56,9 @@ export interface Api extends DataTypeContainer {
     name: string;
     description?: string;
 }
+/**
+ * @interface HttpApi
+ */
 export interface HttpApi extends Api {
     protocol: 'http';
     description?: string;

package/types/schema/index.d.ts

@@ -26,6 +26,7 @@ export declare namespace OpraSchema {
     export import DocumentInfo = apiDocument_.DocumentInfo;
     export import ContactPerson = apiDocument_.ContactPerson;
     export import LicenseInfo = apiDocument_.LicenseInfo;
+    export import DocumentReference = apiDocument_.DocumentReference;
     export import HttpApi = apiDocument_.HttpApi;
     export import Api = apiDocument_.Api;
     export import HttpMethod = types_.HttpMethod;

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

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiFieldDecorator = 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");
-function ApiFieldDecorator(options) {
-    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,
-        });
-        if (designType === Array) {
-            elemMeta.isArray = true;
-        }
-        else
-            elemMeta.type = elemMeta.type || designType;
-        Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, (0, index_js_1.omitUndefined)(metadata), target.constructor);
-    };
-}
-exports.ApiFieldDecorator = ApiFieldDecorator;

package/cjs/document/data-type/decorators/complex-type.decorator.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComplexTypeDecorator = void 0;
-const tslib_1 = require("tslib");
-const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
-const index_js_1 = require("../../../schema/index.js");
-const constants_js_1 = require("../../constants.js");
-function ComplexTypeDecorator(options) {
-    return function (target) {
-        let name;
-        if (!options?.embedded) {
-            if (options?.name) {
-                if (!constants_js_1.CLASS_NAME_PATTERN.test(options.name))
-                    throw new TypeError(`"${options.name}" is not a valid type name`);
-                name = options.name;
-            }
-            else {
-                name = target.name.match(constants_js_1.EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
-            }
-        }
-        let metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target);
-        if (!metadata) {
-            metadata = {};
-            Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target);
-        }
-        metadata.kind = index_js_1.OpraSchema.ComplexType.Kind;
-        metadata.name = name;
-        // Merge options
-        if (options)
-            Object.assign(metadata, (0, lodash_omit_1.default)(options, ['kind', 'name', 'base', 'fields']));
-    };
-}
-exports.ComplexTypeDecorator = ComplexTypeDecorator;

package/cjs/document/data-type/decorators/simple-type.decorator.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AttributeDecoratorFactory = exports.SimpleTypeDecoratorFactory = void 0;
-const tslib_1 = require("tslib");
-const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
-const index_js_1 = require("../../../schema/index.js");
-const constants_js_1 = require("../../constants.js");
-function SimpleTypeDecoratorFactory(options) {
-    const decoratorChain = [];
-    /**
-     *
-     */
-    const decorator = function (target) {
-        let name;
-        if (!options?.embedded) {
-            if (options?.name) {
-                if (!constants_js_1.CLASS_NAME_PATTERN.test(options.name))
-                    throw new TypeError(`"${options.name}" is not a valid type name`);
-                name = options.name;
-            }
-            else {
-                name = target.name.match(constants_js_1.EXTRACT_TYPENAME_PATTERN)?.[1] || target.name;
-                name = name.toLowerCase();
-            }
-        }
-        const metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target) || {};
-        metadata.kind = index_js_1.OpraSchema.SimpleType.Kind;
-        metadata.name = name;
-        if (options)
-            Object.assign(metadata, (0, lodash_omit_1.default)(options, ['kind', 'name']));
-        Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target);
-    };
-    decorator.Example = (value, description) => {
-        decoratorChain.push((meta) => {
-            meta.examples = meta.examples || [];
-            meta.examples.push({
-                description,
-                value,
-            });
-        });
-        return decorator;
-    };
-    return decorator;
-}
-exports.SimpleTypeDecoratorFactory = SimpleTypeDecoratorFactory;
-function AttributeDecoratorFactory(options) {
-    return (target, propertyKey) => {
-        if (typeof propertyKey !== 'string')
-            throw new TypeError(`Symbol properties can't be decorated with Attribute`);
-        const metadata = Reflect.getOwnMetadata(constants_js_1.DATATYPE_METADATA, target.constructor) || {};
-        const designType = Reflect.getMetadata('design:type', target, propertyKey);
-        let format = 'string';
-        if (designType === Boolean)
-            format = 'boolean';
-        else if (designType === Number)
-            format = 'number';
-        metadata.kind = index_js_1.OpraSchema.SimpleType.Kind;
-        metadata.attributes = metadata.attributes || {};
-        metadata.attributes[propertyKey] = {
-            format: options?.format || format,
-            description: options?.description,
-            deprecated: options?.deprecated,
-        };
-        Reflect.defineMetadata(constants_js_1.DATATYPE_METADATA, metadata, target.constructor);
-    };
-}
-exports.AttributeDecoratorFactory = AttributeDecoratorFactory;

package/cjs/document/http/decorators/http-controller.decorator.js

@@ -1,117 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpControllerDecoratorFactory = void 0;
-const tslib_1 = require("tslib");
-const lodash_omit_1 = tslib_1.__importDefault(require("lodash.omit"));
-const putil_merge_1 = tslib_1.__importDefault(require("putil-merge"));
-const index_js_1 = require("../../../schema/index.js");
-const constants_js_1 = require("../../constants.js");
-const CLASS_NAME_PATTERN = /^(.*)(Collection|Singleton|Resource|Controller)$/;
-function HttpControllerDecoratorFactory(options) {
-    const decoratorChain = [];
-    /**
-     *
-     */
-    const decorator = function (target) {
-        let name = options?.name;
-        if (!name)
-            name = CLASS_NAME_PATTERN.exec(target.name)?.[1] || target.name;
-        const metadata = {};
-        const baseMetadata = Reflect.getOwnMetadata(constants_js_1.HTTP_CONTROLLER_METADATA, Object.getPrototypeOf(target));
-        if (baseMetadata)
-            (0, putil_merge_1.default)(metadata, baseMetadata, { deep: true });
-        const oldMetadata = Reflect.getOwnMetadata(constants_js_1.HTTP_CONTROLLER_METADATA, target);
-        if (oldMetadata)
-            (0, putil_merge_1.default)(metadata, oldMetadata, { deep: true });
-        (0, putil_merge_1.default)(metadata, {
-            kind: index_js_1.OpraSchema.HttpController.Kind,
-            name,
-            path: name,
-            ...(0, lodash_omit_1.default)(options, ['kind', 'name', 'instance', 'endpoints', 'key']),
-        }, { deep: true });
-        Reflect.defineMetadata(constants_js_1.HTTP_CONTROLLER_METADATA, metadata, target);
-        for (const fn of decoratorChain)
-            fn(metadata);
-        Reflect.defineMetadata(constants_js_1.HTTP_CONTROLLER_METADATA, metadata, target);
-    };
-    /**
-     *
-     */
-    decorator.Cookie = (name, arg1) => {
-        decoratorChain.push((meta) => {
-            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
-                ? {
-                    name,
-                    location: 'cookie',
-                    type: arg1,
-                }
-                : { ...arg1, name, location: 'cookie' };
-            meta.parameters = meta.parameters || [];
-            meta.parameters.push(paramMeta);
-        });
-        return decorator;
-    };
-    /**
-     *
-     */
-    decorator.Header = (name, arg1) => {
-        decoratorChain.push((meta) => {
-            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
-                ? {
-                    name,
-                    location: 'header',
-                    type: arg1,
-                }
-                : { ...arg1, name, location: 'header' };
-            meta.parameters = meta.parameters || [];
-            meta.parameters.push(paramMeta);
-        });
-        return decorator;
-    };
-    /**
-     *
-     */
-    decorator.QueryParam = (name, arg1) => {
-        decoratorChain.push((meta) => {
-            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
-                ? {
-                    name,
-                    location: 'query',
-                    type: arg1,
-                }
-                : { ...arg1, name, location: 'query' };
-            meta.parameters = meta.parameters || [];
-            meta.parameters.push(paramMeta);
-        });
-        return decorator;
-    };
-    /**
-     *
-     */
-    decorator.PathParam = (name, arg1) => {
-        decoratorChain.push((meta) => {
-            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
-                ? {
-                    name,
-                    location: 'path',
-                    type: arg1,
-                }
-                : { ...arg1, name, location: 'path' };
-            meta.parameters = meta.parameters || [];
-            meta.parameters.push(paramMeta);
-        });
-        return decorator;
-    };
-    /**
-     *
-     */
-    decorator.UseType = (...type) => {
-        decoratorChain.push((meta) => {
-            meta.types = meta.types || [];
-            meta.types.push(...type);
-        });
-        return decorator;
-    };
-    return decorator;
-}
-exports.HttpControllerDecoratorFactory = HttpControllerDecoratorFactory;