@opra/common 0.23.0 → 0.23.2

package/esm/document/utils/generate-codec.js

@@ -26,7 +26,7 @@ export function _generateDecoder(type, codec, options) {
     }
     return vg.isObject(schema, {
         ctor: type.ctor,
-        additionalFields: type.additionalFields ?? 'ignore',
+        additionalFields: type.additionalFields ?? false,
         name: type.name,
         caseInSensitive: true,
     });

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

@@ -10,10 +10,9 @@ export class BadRequestError extends OpraException {
         super(...arguments);
         this.status = 400;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:BAD_REQUEST', 'Bad request'),
-            severity: 'error',
             code: 'BAD_REQUEST',
             ...issue
         });

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

@@ -9,10 +9,9 @@ export class FailedDependencyError extends OpraException {
         super(...arguments);
         this.status = 424;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:FAILED_DEPENDENCY', 'The request failed due to failure of a previous request'),
-            severity: 'error',
             code: 'FAILED_DEPENDENCY',
             ...issue
         });

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

@@ -11,10 +11,9 @@ export class ForbiddenError extends OpraException {
         super(...arguments);
         this.status = 403;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:FORBIDDEN', 'You are not authorized to perform this action'),
-            severity: 'error',
             code: 'FORBIDDEN',
             ...issue
         });

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

@@ -9,10 +9,9 @@ export class InternalServerError extends OpraException {
         super(...arguments);
         this.status = 500;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:INTERNAL_SERVER_ERROR', 'Internal server error'),
-            severity: 'error',
             code: 'INTERNAL_SERVER_ERROR',
             ...issue
         });

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

@@ -10,10 +10,9 @@ export class MethodNotAllowedError extends OpraException {
         super(...arguments);
         this.status = 405;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:METHOD_NOT_ALLOWED', 'Method not allowed'),
-            severity: 'error',
             code: 'METHOD_NOT_ALLOWED',
             ...issue
         });

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

@@ -10,10 +10,9 @@ export class NotAcceptableError extends OpraException {
         super(...arguments);
         this.status = 406;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:NOT_ACCEPTABLE', 'Not Acceptable'),
-            severity: 'error',
             code: 'NOT_ACCEPTABLE',
             ...issue
         });

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

@@ -13,10 +13,9 @@ export class NotFoundError extends OpraException {
         super(...arguments);
         this.status = 404;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:NOT_FOUND', 'Not found'),
-            severity: 'error',
             code: 'NOT_FOUND',
             ...issue
         });

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

@@ -10,10 +10,9 @@ export class UnauthorizedError extends OpraException {
         super(...arguments);
         this.status = 401;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:UNAUTHORIZED', 'You have not been authenticated to perform this action'),
-            severity: 'error',
             code: 'UNAUTHORIZED',
             ...issue
         });

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

@@ -9,8 +9,8 @@ export class UnprocessableEntityError extends OpraException {
         super(...arguments);
         this.status = 422;
     }
-    setIssue(issue) {
-        super.setIssue({
+    init(issue) {
+        super.init({
             message: translate('error:UNPROCESSABLE_ENTITY', 'Unprocessable entity'),
             severity: 'error',
             code: 'UNPROCESSABLE_ENTITY',

package/esm/exception/opra-exception.js

@@ -1,52 +1,67 @@
+import { omitUndefined } from '../helpers/index.js';
 import { i18n } from '../i18n/index.js';
+const inDevelopment = (process.env.NODE_ENV || '').startsWith('dev');
 /**
  * Defines the base Opra exception, which is handled by the default Exceptions Handler.
  */
 export class OpraException extends Error {
-    constructor(issue, cause) {
-        super('');
+    constructor(issue, arg1, arg2) {
+        super('Unknown error');
         this.status = 500;
-        this._initName();
+        let cause = arg1 && arg1 instanceof Error ? arg1 : undefined;
+        this.status = (typeof arg1 === 'number' ? arg1 : Number(arg2)) || 500;
         if (issue instanceof Error)
             cause = issue;
-        if (cause) {
+        // noinspection SuspiciousTypeOfGuard
+        if (cause && cause instanceof Error) {
             this.cause = cause;
             if (cause.stack)
                 this.stack = cause.stack;
         }
-        this._init(issue || cause || 'Unknown error');
-        this.message = i18n.deep(this.issue.message);
-    }
-    get issue() {
-        return this._issue;
-    }
-    setIssue(issue) {
-        this._issue = {
-            message: 'Unknown error',
-            severity: 'error',
-            ...issue,
-        };
+        if (typeof issue === 'string')
+            this.initString(issue);
+        else if (issue instanceof Error)
+            this.initError(issue);
+        else if (issue && typeof issue === 'object')
+            this.init(issue);
+        this.message = this.message || this.constructor.name;
     }
     setStatus(status) {
         this.status = status;
         return this;
     }
-    _initName() {
-        this.name = this.constructor.name;
+    toString() {
+        return i18n.deep(this.message);
     }
-    _init(issue) {
-        if (issue instanceof Error) {
-            if (typeof issue.status === 'number')
-                this.status = issue.status;
-            else if (typeof issue.getStatus === 'function')
-                this.status = issue.getStatus();
-            this.setIssue({ message: issue.message });
-        }
-        else if (typeof issue === 'object') {
-            this.setIssue(issue);
-        }
-        else {
-            this.setIssue({ message: String(issue) });
-        }
+    toJSON() {
+        return omitUndefined({
+            message: this.message,
+            severity: this.severity,
+            system: this.system,
+            code: this.code,
+            details: this.details,
+            stack: inDevelopment ? this.stack?.split('\n') : undefined
+        }, true);
+    }
+    init(issue) {
+        this.message = issue.message || this.constructor.name;
+        this.severity = issue.severity || 'error';
+        this.system = issue.system;
+        this.code = issue.code;
+        this.details = issue.details;
+    }
+    initString(issue) {
+        this.message = String(issue || '') || this.constructor.name;
+        this.severity = 'error';
+        this.code = this.constructor.name;
+    }
+    initError(issue) {
+        if (typeof issue.status === 'number')
+            this.status = issue.status;
+        else if (typeof issue.getStatus === 'function')
+            this.status = issue.getStatus();
+        this.message = issue.message;
+        this.severity = issue.severity || 'error';
+        this.code = issue.code || (issue.constructor.name);
     }
 }

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

@@ -14,7 +14,6 @@ export class ResourceNotFoundError extends OpraException {
                 resource,
                 key: keyValue
             }
-        }, cause);
-        this.status = 404;
+        }, cause, 404);
     }
 }

package/esm/exception/wrap-exception.js

@@ -7,32 +7,32 @@ import { NotFoundError } from './http-errors/not-found.error.js';
 import { UnauthorizedError } from './http-errors/unauthorized.error.js';
 import { UnprocessableEntityError } from './http-errors/unprocessable-entity.error.js';
 import { OpraException } from './opra-exception.js';
-export function wrapException(e) {
-    if (e instanceof OpraException)
-        return e;
+export function wrapException(error) {
+    if (error instanceof OpraException)
+        return error;
     let status = 500;
-    if (typeof e.status === 'number')
-        status = e.status;
-    else if (typeof e.getStatus === 'function')
-        status = e.getStatus();
+    if (typeof error.status === 'number')
+        status = error.status;
+    else if (typeof error.getStatus === 'function')
+        status = error.getStatus();
     switch (status) {
         case 400:
-            return new BadRequestError(e);
+            return new BadRequestError(error);
         case 401:
-            return new UnauthorizedError(e);
+            return new UnauthorizedError(error);
         case 403:
-            return new ForbiddenError(e);
+            return new ForbiddenError(error);
         case 404:
-            return new NotFoundError(e);
+            return new NotFoundError(error);
         case 405:
-            return new MethodNotAllowedError(e);
+            return new MethodNotAllowedError(error);
         case 406:
-            return new NotAcceptableError(e);
+            return new NotAcceptableError(error);
         case 422:
-            return new UnprocessableEntityError(e);
+            return new UnprocessableEntityError(error);
         case 424:
-            return new FailedDependencyError(e);
+            return new FailedDependencyError(error);
         default:
-            return new FailedDependencyError(e);
+            return new FailedDependencyError(error);
     }
 }

package/esm/helpers/is-url-string.js

@@ -1,4 +1,3 @@
-import { URL } from 'url';
 const URL_PATTERN = /^(https?:\/\/.)[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_+.~#?&/=]*)$/i;
 export function isUrlString(url) {
     return URL_PATTERN.test(url);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "0.23.0",
+  "version": "0.23.2",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",
@@ -49,20 +49,20 @@
     "lodash.omit": "^4.5.0",
     "putil-isplainobject": "^1.1.5",
     "putil-merge": "^3.10.3",
-    "putil-promisify": "^1.10.0",
+    "putil-promisify": "^1.10.1",
     "putil-varhelpers": "^1.6.5",
     "reflect-metadata": "^0.1.13",
     "uid": "^2.0.1",
-    "valgen": "^4.0.0-alpha.6"
+    "valgen": "^4.0.0"
   },
   "devDependencies": {
     "@browsery/fs": "^0.4.0",
     "@browsery/stream": "^0.5.0",
     "@browsery/util": "^0.4.0",
     "@types/encodeurl": "^1.0.0",
-    "@types/validator": "^13.7.17",
+    "@types/validator": "^13.11.1",
     "path-browserify": "^1.0.1",
-    "ts-gems": "^2.4.0"
+    "ts-gems": "^2.4.1"
   },
   "engines": {
     "node": ">=16.0",

package/types/document/data-type/complex-type.d.ts

@@ -37,7 +37,7 @@ declare class ComplexTypeClass extends DataType {
     readonly own: ComplexType.OwnProperties;
     readonly fields: ResponsiveMap<ApiField>;
     readonly abstract?: boolean;
-    readonly additionalFields?: boolean | vg.Validator<any, any> | 'ignore';
+    readonly additionalFields?: boolean | vg.Validator | 'error';
     constructor(document: ApiDocument, init: ComplexType.InitArguments);
     addField(init: ApiField.InitArguments): ApiField;
     findField(nameOrPath: string): ApiField | undefined;

package/types/document/data-type/mapped-type.d.ts

@@ -29,7 +29,7 @@ declare class MappedTypeClass extends DataType {
     readonly kind = "MappedType";
     readonly own: MappedType.OwnProperties;
     readonly type: ComplexType;
-    readonly additionalFields?: boolean | vg.Validator<any, any> | 'ignore';
+    readonly additionalFields?: boolean | vg.Validator | 'error';
     readonly fields: ResponsiveMap<ApiField>;
     readonly omit?: Field.Name[];
     readonly pick?: Field.Name[];

package/types/document/data-type/union-type.d.ts

@@ -1,5 +1,6 @@
 import 'reflect-metadata';
 import { Class, StrictOmit, Type } from 'ts-gems';
+import * as vg from 'valgen';
 import { ResponsiveMap } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import type { ApiDocument } from '../api-document.js';
@@ -25,7 +26,7 @@ declare class UnionTypeClass extends DataType {
     readonly kind = "UnionType";
     readonly own: UnionType.OwnProperties;
     readonly types: (ComplexType | UnionType | MappedType)[];
-    readonly additionalFields?: boolean;
+    readonly additionalFields?: boolean | vg.Validator | 'error';
     readonly fields: ResponsiveMap<ApiField>;
     constructor(document: ApiDocument, init: UnionType.InitArguments);
     exportSchema(): OpraSchema.UnionType;

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

@@ -3,7 +3,7 @@ import { OpraSchema } from '../../schema/index.js';
 import type { ApiDocument } from '../api-document.js';
 import { nodeInspectCustom } from '../utils/inspect.util.js';
 export declare namespace Resource {
-    interface InitArguments extends StrictOmit<OpraSchema.ResourceBase, 'kind' | 'operations'> {
+    interface InitArguments extends StrictOmit<OpraSchema.ResourceBase, 'kind'> {
         name: string;
         controller?: object | Type;
     }

package/types/exception/error-issue.d.ts

@@ -2,8 +2,9 @@ import { IssueSeverity } from './issue-severity.enum.js';
 export interface ErrorIssue {
     message: string;
     severity: IssueSeverity.Type;
+    system?: string;
     code?: string;
     details?: any;
     diagnostics?: string | string[];
-    debugInfo?: string;
+    stack?: string[];
 }

package/types/exception/http-errors/bad-request.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 400 Bad Request
@@ -6,5 +7,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class BadRequestError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/failed-dependency.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 424 Failed Dependency
@@ -5,5 +6,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class FailedDependencyError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/forbidden.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 403 Forbidden
@@ -7,5 +8,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class ForbiddenError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/internal-server.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 500 Internal Server Error
@@ -5,5 +6,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class InternalServerError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/method-not-allowed.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 405 Method Not Allowed
@@ -6,5 +7,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class MethodNotAllowedError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/not-acceptable.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 406 Not Acceptable
@@ -6,5 +7,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class NotAcceptableError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/not-found.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 404 Not Found
@@ -9,5 +10,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class NotFoundError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/unauthorized.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 401 Unauthorized
@@ -6,5 +7,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class UnauthorizedError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/http-errors/unprocessable-entity.error.d.ts

@@ -1,3 +1,4 @@
+import { ErrorIssue } from '../error-issue.js';
 import { OpraException } from '../opra-exception.js';
 /**
  * 422 Unprocessable Entity
@@ -5,5 +6,5 @@ import { OpraException } from '../opra-exception.js';
  */
 export declare class UnprocessableEntityError extends OpraException {
     status: number;
-    setIssue(issue: any): void;
+    protected init(issue: Partial<ErrorIssue>): void;
 }

package/types/exception/opra-exception.d.ts

@@ -1,17 +1,22 @@
 import { ErrorIssue } from './error-issue.js';
+import { IssueSeverity } from './issue-severity.enum.js';
 /**
  * Defines the base Opra exception, which is handled by the default Exceptions Handler.
  */
 export declare class OpraException extends Error {
-    protected _issue: ErrorIssue;
-    status: number;
     cause?: Error;
+    status: number;
+    severity: IssueSeverity.Type;
+    system?: string;
+    code?: string;
+    details?: any;
     constructor();
-    constructor(issue: string | Partial<ErrorIssue> | Error);
-    constructor(issue: string | Partial<ErrorIssue>, cause?: Error);
-    get issue(): ErrorIssue;
-    setIssue(issue: Partial<ErrorIssue>): void;
+    constructor(issue: string | Partial<ErrorIssue> | Error, status?: number);
+    constructor(issue: string | Partial<ErrorIssue>, cause?: Error, status?: number);
     setStatus(status: number): this;
-    protected _initName(): void;
-    protected _init(issue: any): void;
+    toString(): string;
+    toJSON(): ErrorIssue;
+    protected init(issue: Partial<ErrorIssue>): void;
+    protected initString(issue: string): void;
+    protected initError(issue: Error): void;
 }

package/types/exception/wrap-exception.d.ts

@@ -1,2 +1,2 @@
 import { OpraException } from './opra-exception.js';
-export declare function wrapException(e: any): OpraException;
+export declare function wrapException(error: any): OpraException;

package/types/helpers/object-utils.d.ts

@@ -1,2 +1,2 @@
 export declare function cloneObject<T extends {}>(obj: T, jsonOnly?: boolean): T;
-export declare function omitUndefined(obj: any, recursive?: boolean): any;
+export declare function omitUndefined<T>(obj: T, recursive?: boolean): T;

package/types/schema/data-type/complex-type.interface.d.ts

@@ -8,7 +8,7 @@ export interface ComplexType extends DataTypeBase {
     base?: DataType.Name | ComplexType | UnionType | MappedType;
     abstract?: boolean;
     fields?: Record<Field.Name, Field | DataType.Name>;
-    additionalFields?: boolean;
+    additionalFields?: boolean | 'error';
 }
 export declare namespace ComplexType {
     const Kind = "ComplexType";

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

@@ -10,5 +10,4 @@ export declare namespace Resource {
 export interface ResourceBase {
     kind: string;
     description?: string;
-    operations: any;
 }

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

@@ -31,7 +31,7 @@ export declare namespace Storage {
         /**
          * limit the size of the batch of uploaded files
          *
-         * @default options.maxFileSize
+         * @default maxFileSize
          */
         maxTotalFileSize?: number | undefined;
         /**