@opra/common 0.33.13 → 1.0.0-alpha.10

package/esm/document/http/http-operation.js

@@ -0,0 +1,102 @@
+import nodePath from 'node:path';
+import { asMutable } from 'ts-gems';
+import { cloneObject, omitUndefined } from '../../helpers/index.js';
+import { OpraSchema } from '../../schema/index.js';
+import { DataTypeMap } from '../common/data-type-map.js';
+import { DocumentElement } from '../common/document-element.js';
+import { CLASS_NAME_PATTERN, DECORATOR, kDataTypeMap } from '../constants.js';
+import { HttpOperationDecoratorFactory } from '../decorators/http-operation.decorator.js';
+/**
+ *  HttpOperation
+ */
+export const HttpOperation = function (...args) {
+    // Decorator
+    if (!this) {
+        const [options] = args;
+        const decoratorChain = [];
+        return HttpOperation[DECORATOR].call(undefined, decoratorChain, options);
+    }
+    // Constructor
+    const [resource, initArgs] = args;
+    DocumentElement.call(this, resource);
+    if (!CLASS_NAME_PATTERN.test(initArgs.name))
+        throw new TypeError(`Invalid operation name (${initArgs.name})`);
+    const _this = asMutable(this);
+    _this.parameters = [];
+    _this.responses = [];
+    _this.types = _this.node[kDataTypeMap] = new DataTypeMap();
+    _this.name = initArgs.name;
+    _this.path = initArgs.path;
+    _this.method = initArgs.method || 'GET';
+    _this.description = initArgs.description;
+    _this.composition = initArgs.composition;
+    _this.compositionOptions = initArgs.compositionOptions ? cloneObject(initArgs.compositionOptions) : undefined;
+};
+/**
+ * @class HttpOperation
+ */
+class HttpOperationClass extends DocumentElement {
+    findParameter(paramName, location) {
+        const paramNameLower = paramName.toLowerCase();
+        let prm;
+        for (prm of this.parameters) {
+            if (location && location !== prm.location)
+                continue;
+            if (typeof prm.name === 'string') {
+                prm._nameLower = prm._nameLower || prm.name.toLowerCase();
+                if (prm._nameLower === paramNameLower)
+                    return prm;
+            }
+            if (prm.name instanceof RegExp && prm.name.test(paramName))
+                return prm;
+        }
+    }
+    getFullUrl() {
+        const out = this.owner.getFullUrl();
+        return out ? (this.path ? nodePath.posix.join(out, this.path) : out) : this.path || '/';
+    }
+    toJSON() {
+        const out = omitUndefined({
+            kind: OpraSchema.HttpOperation.Kind,
+            description: this.description,
+            method: this.method,
+            composition: this.composition,
+            requestBody: this.requestBody?.toJSON(),
+        });
+        if (this.parameters.length) {
+            out.parameters = [];
+            for (const prm of this.parameters) {
+                out.parameters.push(prm.toJSON());
+            }
+        }
+        if (this.responses.length)
+            out.responses = this.responses.map(r => r.toJSON());
+        return out;
+    }
+}
+HttpOperation.prototype = HttpOperationClass.prototype;
+HttpOperation[DECORATOR] = HttpOperationDecoratorFactory;
+HttpOperation.GET = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'GET' });
+};
+HttpOperation.DELETE = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'DELETE' });
+};
+HttpOperation.HEAD = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'HEAD' });
+};
+HttpOperation.OPTIONS = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'OPTIONS' });
+};
+HttpOperation.PATCH = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'PATCH' });
+};
+HttpOperation.POST = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'POST' });
+};
+HttpOperation.PUT = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'PUT' });
+};
+HttpOperation.SEARCH = function (options) {
+    return HttpOperationDecoratorFactory([], { ...options, method: 'SEARCH' });
+};

package/esm/document/http/http-parameter.js

@@ -0,0 +1,43 @@
+import { asMutable } from 'ts-gems';
+import { omitUndefined } from '../../helpers/index.js';
+import { Value } from '../common/value.js';
+import { parseRegExp } from '../utils/parse-regexp.util.js';
+export const HttpParameter = function (owner, initArgs) {
+    if (!this)
+        throw new TypeError('"this" should be passed to call class constructor');
+    Value.call(this, owner, initArgs);
+    const _this = asMutable(this);
+    if (initArgs.name) {
+        _this.name =
+            initArgs.name instanceof RegExp
+                ? initArgs.name
+                : initArgs.name.startsWith('/')
+                    ? parseRegExp(initArgs.name, {
+                        includeFlags: 'i',
+                        excludeFlags: 'm',
+                    })
+                    : initArgs.name;
+    }
+    _this.location = initArgs.location;
+    _this.deprecated = initArgs.deprecated;
+    _this.required = initArgs.required;
+    _this.arraySeparator = initArgs.arraySeparator;
+    _this.keyParam = initArgs.keyParam;
+};
+/**
+ * @class HttpParameter
+ */
+class HttpParameterClass extends Value {
+    toJSON() {
+        return omitUndefined({
+            ...super.toJSON(),
+            name: this.name,
+            location: this.location,
+            arraySeparator: this.arraySeparator,
+            keyParam: this.keyParam,
+            required: this.required,
+            deprecated: this.deprecated,
+        });
+    }
+}
+HttpParameter.prototype = HttpParameterClass.prototype;

package/esm/document/http/http-request-body.js

@@ -0,0 +1,21 @@
+import { omitUndefined } from '../../helpers/index.js';
+import { DocumentElement } from '../common/document-element.js';
+/**
+ * @class HttpRequestBody
+ */
+export class HttpRequestBody extends DocumentElement {
+    constructor(owner) {
+        super(owner);
+        this.owner = owner;
+        this.content = [];
+    }
+    toJSON() {
+        return omitUndefined({
+            description: this.description,
+            required: this.required,
+            maxContentSize: this.maxContentSize,
+            content: this.content.length ? this.content.map(x => x.toJSON()) : [],
+            partial: this.partial,
+        });
+    }
+}

package/esm/document/http/http-status-range.js

@@ -0,0 +1,36 @@
+const STATUS_RANGE_PATTERN = /^([1-6]\d{2})(?:-([1-6]\d{2}))?$/;
+/**
+ * @class HttpStatusRange
+ */
+export class HttpStatusRange {
+    constructor(arg0, arg1) {
+        this.start = 0;
+        this.end = 0;
+        if (arg0 && typeof arg0 === 'object') {
+            this.start = arg0.start || 0;
+            this.end = arg0.end || 0;
+        }
+        if (typeof arg0 === 'number') {
+            this.start = arg0;
+            this.end = arg1 || this.start;
+        }
+        if (typeof arg0 === 'string') {
+            const m = STATUS_RANGE_PATTERN.exec(arg0);
+            if (!m)
+                throw new TypeError(`"${arg0}" is not a valid Status Code range`);
+            this.start = parseInt(m[1], 10);
+            this.end = m[2] ? parseInt(m[2], 10) : this.start;
+        }
+    }
+    get distance() {
+        return this.end - this.start;
+    }
+    toString() {
+        if (this.start === this.end)
+            return String(this.start);
+        return String(this.start) + '-' + String(this.end);
+    }
+    toJSON() {
+        return !this.end || this.start === this.end ? this.start : { start: this.start, end: this.end };
+    }
+}

package/esm/document/index.js

@@ -1,28 +1,40 @@
 import 'reflect-metadata';
-export * from './constants.js';
+import * as DataTypeFactory_ from './factory/data-type.factory.js';
+import * as HttpApiFactory_ from './factory/http-api.factory.js';
 export * from './api-document.js';
-export * from './type-document.js';
-export * from './factory/type-document-factory.js';
-export * from './factory/api-document-factory.js';
-export * from './data-type/data-type.js';
+export * from './common/api-base.js';
+export * from './common/data-type-map.js';
+export * from './common/document-element.js';
+export * from './common/document-init-context.js';
+export * from './common/document-node.js';
+export * from './common/opra-document-error.js';
+export * from './constants.js';
+export * from './data-type/api-field.js';
 export * from './data-type/complex-type.js';
-export * from './data-type/field.js';
+export * from './data-type/data-type.js';
 export * from './data-type/enum-type.js';
+export * from './data-type/extended-types/index.js';
 export * from './data-type/mapped-type.js';
-export * from './data-type/simple-type.js';
 export * from './data-type/mixin-type.js';
-export * from './resource/action.js';
-export * from './resource/collection.js';
-export * from './resource/container.js';
-export * from './resource/crud-resource.js';
-export * from './resource/endpoint.js';
-export * from './resource/crud-operation.js';
-export * from './resource/parameter.js';
-export * from './resource/resource.js';
-export * from './resource/singleton.js';
-export * from './resource/storage.js';
-export * from './resource/enums/metadata-mode.enum.js';
-export * from './resource/types/operation-result.type.js';
-export * from './interfaces/collection.interface.js';
-export * from './interfaces/singleton.interface.js';
-export * from './interfaces/storage.interface.js';
+export * from './data-type/omit-type.js';
+export * from './data-type/partial-type.js';
+export * from './data-type/pick-type.js';
+export * from './data-type/primitive-types/index.js';
+export * from './data-type/required-type.js';
+export * from './data-type/simple-type.js';
+export * from './decorators/http-operation-entity.decorator.js';
+export * from './factory/api-document.factory.js';
+export * from './http/http-api.js';
+export * from './http/http-controller.js';
+export * from './http/http-media-type.js';
+export * from './http/http-multipart-field.js';
+export * from './http/http-operation.js';
+export * from './http/http-operation-response.js';
+export * from './http/http-parameter.js';
+export * from './http/http-request-body.js';
+export * from './http/http-status-range.js';
+export var classes;
+(function (classes) {
+    classes.HttpApiFactory = HttpApiFactory_.HttpApiFactory;
+    classes.DataTypeFactory = DataTypeFactory_.DataTypeFactory;
+})(classes || (classes = {}));

package/esm/document/utils/inspect.util.js

@@ -1,4 +1,4 @@
 export const nodeInspectCustom = Symbol.for('nodejs.util.inspect.custom');
-export const colorReset = "\x1b[0m";
-export const colorFgYellow = "\x1b[33m";
-export const colorFgMagenta = "\x1b[35m";
+export const colorReset = '\x1b[0m';
+export const colorFgYellow = '\x1b[33m';
+export const colorFgMagenta = '\x1b[35m';

package/esm/document/utils/parse-regexp.util.js

@@ -0,0 +1,18 @@
+export function parseRegExp(str, options) {
+    const i = str.lastIndexOf('/');
+    if (str.startsWith('/') && i) {
+        const s = str.substring(1, i);
+        let flags = str.substring(i + 1);
+        if (options?.includeFlags) {
+            for (const f of options?.includeFlags)
+                if (!flags.includes(f))
+                    flags += f;
+        }
+        if (options?.excludeFlags) {
+            for (const f of options?.excludeFlags)
+                flags.replace(f, '');
+        }
+        return new RegExp(s, flags);
+    }
+    throw new TypeError(`"${str}" is not a valid RegExp string`);
+}

package/esm/exception/http-errors/bad-request.error.js

@@ -1,11 +1,11 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 400 Bad Request
  * The server cannot or will not process the request due to something that is perceived to be a client error
  * (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
  */
-export class BadRequestError extends OpraException {
+export class BadRequestError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 400;
@@ -14,7 +14,7 @@ export class BadRequestError extends OpraException {
         super.init({
             message: translate('error:BAD_REQUEST', 'Bad request'),
             code: 'BAD_REQUEST',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/conflict.error.js

@@ -1,10 +1,10 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 409 Conflict
  * This response is sent when a request conflicts with the current state of the server.
  */
-export class ConflictError extends OpraException {
+export class ConflictError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 409;
@@ -13,7 +13,7 @@ export class ConflictError extends OpraException {
         super.init({
             message: translate('error:CONFLICT', 'Conflict'),
             code: 'CONFLICT',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/failed-dependency.error.js

@@ -1,10 +1,10 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 424 Failed Dependency
  * The request failed due to failure of a previous request.
  */
-export class FailedDependencyError extends OpraException {
+export class FailedDependencyError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 424;
@@ -13,7 +13,7 @@ export class FailedDependencyError extends OpraException {
         super.init({
             message: translate('error:FAILED_DEPENDENCY', 'The request failed due to failure of a previous request'),
             code: 'FAILED_DEPENDENCY',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/forbidden.error.js

@@ -1,13 +1,13 @@
 import { HttpStatusCode } from '../../http/index.js';
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 403 Forbidden
  * The client does not have access rights to the content; that is, it is unauthorized,
  * so the server is refusing to give the requested resource. Unlike 401 Unauthorized,
  * the client's identity is known to the server.
  */
-export class ForbiddenError extends OpraException {
+export class ForbiddenError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = HttpStatusCode.FORBIDDEN;
@@ -16,7 +16,7 @@ export class ForbiddenError extends OpraException {
         super.init({
             message: translate('error:FORBIDDEN', 'You are not authorized to perform this action'),
             code: 'FORBIDDEN',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/internal-server.error.js

@@ -1,10 +1,10 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 500 Internal Server Error
  * The server has encountered a situation it does not know how to handle.
  */
-export class InternalServerError extends OpraException {
+export class InternalServerError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 500;
@@ -14,7 +14,7 @@ export class InternalServerError extends OpraException {
             message: translate('error:INTERNAL_SERVER_ERROR', 'Internal server error'),
             code: 'INTERNAL_SERVER_ERROR',
             severity: 'fatal',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/method-not-allowed.error.js

@@ -1,11 +1,11 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 405 Method Not Allowed
  * The request method is known by the server but is not supported by the target resource.
  * For example, an API may not allow calling DELETE to remove a resource.
  */
-export class MethodNotAllowedError extends OpraException {
+export class MethodNotAllowedError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 405;
@@ -14,7 +14,7 @@ export class MethodNotAllowedError extends OpraException {
         super.init({
             message: translate('error:METHOD_NOT_ALLOWED', 'Method not allowed'),
             code: 'METHOD_NOT_ALLOWED',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/not-acceptable.error.js

@@ -1,11 +1,11 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 406 Not Acceptable
  * This response is sent when the web server, after performing server-driven content negotiation,
  * doesn't find any content that conforms to the criteria given by the user agent.
  */
-export class NotAcceptableError extends OpraException {
+export class NotAcceptableError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 406;
@@ -14,7 +14,7 @@ export class NotAcceptableError extends OpraException {
         super.init({
             message: translate('error:NOT_ACCEPTABLE', 'Not Acceptable'),
             code: 'NOT_ACCEPTABLE',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/not-found.error.js

@@ -1,5 +1,5 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 404 Not Found
  * The server can not find the requested resource. In the browser, this means the URL is not recognized.
@@ -8,7 +8,7 @@ import { OpraException } from '../opra-exception.js';
  * from an unauthorized client. This response code is probably the most well known due to its
  * frequent occurrence on the web.
  */
-export class NotFoundError extends OpraException {
+export class NotFoundError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 404;
@@ -17,7 +17,7 @@ export class NotFoundError extends OpraException {
         super.init({
             message: translate('error:NOT_FOUND', 'Not found'),
             code: 'NOT_FOUND',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/{resource-errors → http-errors}/permission.error.js

@@ -1,5 +1,5 @@
 import { translate } from '../../i18n/index.js';
-import { ForbiddenError } from '../http-errors/forbidden.error.js';
+import { ForbiddenError } from './forbidden.error.js';
 /**
  * 403 Forbidden
  * The client does not have access rights to the content; that is, it is unauthorized,
@@ -11,7 +11,7 @@ export class PermissionError extends ForbiddenError {
         super.init({
             message: translate('error:PERMISSION_ERROR', 'You dont have permission for this operation'),
             code: 'PERMISSION_ERROR',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/{resource-errors → http-errors}/resource-conflict.error.js

@@ -1,6 +1,6 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
-export class ResourceConflictError extends OpraException {
+import { OpraHttpError } from '../opra-http-error.js';
+export class ResourceConflictError extends OpraHttpError {
     constructor(resource, fields, cause) {
         super({
             message: translate(`error:RESOURCE_CONFLICT`, { resource, fields }, `There is already an other {{resource}} resource with same values ({{fields}})`),
@@ -8,7 +8,7 @@ export class ResourceConflictError extends OpraException {
             code: 'RESOURCE_CONFLICT',
             details: {
                 resource,
-                location: fields
+                location: fields,
             },
         }, cause);
         this.status = 409;

package/esm/exception/{resource-errors → http-errors}/resource-not.available.error.js

@@ -1,20 +1,20 @@
 import { HttpStatusCode } from '../../http/index.js';
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * The server cannot find the requested resource.
  * This can also mean that the endpoint is valid but the resource itself does not exist.
  */
-export class ResourceNotAvailableError extends OpraException {
+export class ResourceNotAvailableError extends OpraHttpError {
     constructor(resource, keyValue, cause) {
         super({
-            message: translate(`error:RESOURCE_NOT_AVAILABLE`, `Resource "${resource}${keyValue ? '/' + keyValue : ''}" is not available or you dont have access`),
+            message: translate(`error:RESOURCE_NOT_AVAILABLE`, `Resource "${resource}${keyValue ? '/' + keyValue : ''}" is not available`),
             severity: 'error',
             code: 'RESOURCE_NOT_AVAILABLE',
             details: {
                 resource,
-                key: keyValue
-            }
+                key: keyValue,
+            },
         }, cause, HttpStatusCode.UNPROCESSABLE_ENTITY);
     }
 }

package/esm/exception/http-errors/unauthorized.error.js

@@ -1,11 +1,11 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 401 Unauthorized
  * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
  * That is, the client must authenticate itself to get the requested response.
  */
-export class UnauthorizedError extends OpraException {
+export class UnauthorizedError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 401;
@@ -14,7 +14,7 @@ export class UnauthorizedError extends OpraException {
         super.init({
             message: translate('error:UNAUTHORIZED', 'You have not been authenticated to perform this action'),
             code: 'UNAUTHORIZED',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/http-errors/unprocessable-entity.error.js

@@ -1,10 +1,10 @@
 import { translate } from '../../i18n/index.js';
-import { OpraException } from '../opra-exception.js';
+import { OpraHttpError } from '../opra-http-error.js';
 /**
  * 422 Unprocessable Entity
  * The request was well-formed but was unable to be followed due to semantic errors.
  */
-export class UnprocessableEntityError extends OpraException {
+export class UnprocessableEntityError extends OpraHttpError {
     constructor() {
         super(...arguments);
         this.status = 422;
@@ -14,7 +14,7 @@ export class UnprocessableEntityError extends OpraException {
             message: translate('error:UNPROCESSABLE_ENTITY', 'Unprocessable entity'),
             severity: 'error',
             code: 'UNPROCESSABLE_ENTITY',
-            ...issue
+            ...issue,
         });
     }
 }

package/esm/exception/index.js

@@ -1,7 +1,4 @@
-export * from './opra-exception.js';
 export * from './error-issue.js';
-export * from './wrap-exception.js';
-export * from './issue-severity.enum.js';
 export * from './http-errors/bad-request.error.js';
 export * from './http-errors/conflict.error.js';
 export * from './http-errors/failed-dependency.error.js';
@@ -10,8 +7,11 @@ export * from './http-errors/internal-server.error.js';
 export * from './http-errors/method-not-allowed.error.js';
 export * from './http-errors/not-acceptable.error.js';
 export * from './http-errors/not-found.error.js';
+export * from './http-errors/permission.error.js';
+export * from './http-errors/resource-conflict.error.js';
+export * from './http-errors/resource-not.available.error.js';
 export * from './http-errors/unauthorized.error.js';
 export * from './http-errors/unprocessable-entity.error.js';
-export * from './resource-errors/permission.error.js';
-export * from './resource-errors/resource-conflict.error.js';
-export * from './resource-errors/resource-not.available.error.js';
+export * from './issue-severity.enum.js';
+export * from './opra-exception.js';
+export * from './opra-http-error.js';

package/esm/exception/issue-severity.enum.js

@@ -15,6 +15,6 @@ export var IssueSeverity;
         error: 'The issue is sufficiently important to cause the action to fail',
         warning: 'The issue is not important enough to cause the action to fail but ' +
             'may cause it to be performed suboptimally or in a way that is not as desired',
-        info: 'The issue has no relation to the degree of success of the action'
+        info: 'The issue has no relation to the degree of success of the action',
     };
 })(IssueSeverity || (IssueSeverity = {}));