@opra/common 0.5.0 → 0.7.0

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

@@ -0,0 +1,18 @@
+import { translate } from '../../i18n/index.js';
+import { OpraException } from '../opra-exception.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 {
+    status = 405;
+    setIssue(issue) {
+        super.setIssue({
+            message: translate('error:METHOD_NOT_ALLOWED', 'Method not allowed'),
+            severity: 'error',
+            code: 'METHOD_NOT_ALLOWED',
+            ...issue
+        });
+    }
+}

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

@@ -0,0 +1,10 @@
+import { OpraException } from '../opra-exception.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 declare class NotAcceptableError extends OpraException {
+    status: number;
+    setIssue(issue: any): void;
+}

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

@@ -0,0 +1,18 @@
+import { translate } from '../../i18n/index.js';
+import { OpraException } from '../opra-exception.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 {
+    status = 406;
+    setIssue(issue) {
+        super.setIssue({
+            message: translate('error:NOT_ACCEPTABLE', 'Not Acceptable'),
+            severity: 'error',
+            code: 'NOT_ACCEPTABLE',
+            ...issue
+        });
+    }
+}

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

@@ -0,0 +1,13 @@
+import { OpraException } from '../opra-exception.js';
+/**
+ * 404 Not Found
+ * The server can not find the requested resource. In the browser, this means the URL is not recognized.
+ * In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
+ * Servers may also send this response instead of 403 Forbidden to hide the existence of a resource
+ * from an unauthorized client. This response code is probably the most well known due to its
+ * frequent occurrence on the web.
+ */
+export declare class NotFoundError extends OpraException {
+    status: number;
+    setIssue(issue: any): void;
+}

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

@@ -0,0 +1,21 @@
+import { translate } from '../../i18n/index.js';
+import { OpraException } from '../opra-exception.js';
+/**
+ * 404 Not Found
+ * The server can not find the requested resource. In the browser, this means the URL is not recognized.
+ * In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
+ * Servers may also send this response instead of 403 Forbidden to hide the existence of a resource
+ * 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 {
+    status = 404;
+    setIssue(issue) {
+        super.setIssue({
+            message: translate('error:NOT_FOUND', 'Not found'),
+            severity: 'error',
+            code: 'NOT_FOUND',
+            ...issue
+        });
+    }
+}

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

@@ -0,0 +1,10 @@
+import { OpraException } from '../opra-exception.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 declare class UnauthorizedError extends OpraException {
+    status: number;
+    setIssue(issue: any): void;
+}

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

@@ -0,0 +1,18 @@
+import { translate } from '../../i18n/index.js';
+import { OpraException } from '../opra-exception.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 {
+    status = 401;
+    setIssue(issue) {
+        super.setIssue({
+            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.d.ts

@@ -0,0 +1,9 @@
+import { OpraException } from '../opra-exception.js';
+/**
+ * 422 Unprocessable Entity
+ * The request was well-formed but was unable to be followed due to semantic errors.
+ */
+export declare class UnprocessableEntityError extends OpraException {
+    status: number;
+    setIssue(issue: any): void;
+}

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

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

package/esm/exception/index.d.ts

@@ -0,0 +1,15 @@
+export * from './opra-exception.js';
+export * from './error-issue.js';
+export * from './wrap-exception.js';
+export * from './enums/issue-severity.enum.js';
+export * from './http-errors/bad-request.error.js';
+export * from './http-errors/failed-dependency.error.js';
+export * from './http-errors/forbidden.error.js';
+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/unauthorized.error.js';
+export * from './http-errors/unprocessable-entity.error.js';
+export * from './resource-errors/resource-conflict.error.js';
+export * from './resource-errors/resource-not-found.error.js';

package/esm/exception/index.js

@@ -0,0 +1,15 @@
+export * from './opra-exception.js';
+export * from './error-issue.js';
+export * from './wrap-exception.js';
+export * from './enums/issue-severity.enum.js';
+export * from './http-errors/bad-request.error.js';
+export * from './http-errors/failed-dependency.error.js';
+export * from './http-errors/forbidden.error.js';
+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/unauthorized.error.js';
+export * from './http-errors/unprocessable-entity.error.js';
+export * from './resource-errors/resource-conflict.error.js';
+export * from './resource-errors/resource-not-found.error.js';

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

@@ -0,0 +1,15 @@
+import { ErrorIssue } from './error-issue.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;
+    constructor(issue?: string | Partial<ErrorIssue>, cause?: Error);
+    get issue(): ErrorIssue;
+    setIssue(issue: Partial<ErrorIssue>): void;
+    setStatus(status: number): this;
+    protected _initName(): void;
+    protected _init(issue: Error | Partial<ErrorIssue> | string): void;
+}

package/esm/exception/opra-exception.js

@@ -0,0 +1,52 @@
+import { i18n } from '../i18n/index.js';
+/**
+ * Defines the base Opra exception, which is handled by the default Exceptions Handler.
+ */
+export class OpraException extends Error {
+    _issue;
+    status = 500;
+    cause;
+    constructor(issue, cause) {
+        super('');
+        this._initName();
+        if (cause) {
+            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,
+        };
+    }
+    setStatus(status) {
+        this.status = status;
+        return this;
+    }
+    _initName() {
+        this.name = this.constructor.name;
+    }
+    _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) });
+        }
+    }
+}

package/esm/exception/resource-errors/resource-conflict.error.d.ts

@@ -0,0 +1,5 @@
+import { OpraException } from '../opra-exception.js';
+export declare class ResourceConflictError extends OpraException {
+    status: number;
+    constructor(resource: string, fields: string | string[], cause?: Error);
+}

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

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

package/esm/exception/resource-errors/resource-not-found.error.d.ts

@@ -0,0 +1,4 @@
+import { OpraException } from '../opra-exception.js';
+export declare class ResourceNotFoundError extends OpraException {
+    constructor(resource: string, keyValue?: any, cause?: Error);
+}

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

@@ -0,0 +1,16 @@
+import { translate } from '../../i18n/index.js';
+import { OpraException } from '../opra-exception.js';
+export class ResourceNotFoundError extends OpraException {
+    constructor(resource, keyValue, cause) {
+        super({
+            message: translate(`error:RESOURCE_NOT_FOUND`, { resource: resource + (keyValue ? '@' + keyValue : '') }, `The resource '{{resource}}' could not be found`),
+            severity: 'error',
+            code: 'RESOURCE_NOT_FOUND',
+            details: {
+                resource,
+                key: keyValue
+            }
+        }, cause);
+        this.status = 404;
+    }
+}

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

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

package/esm/exception/wrap-exception.js

@@ -0,0 +1,38 @@
+import { BadRequestError } from './http-errors/bad-request.error.js';
+import { FailedDependencyError } from './http-errors/failed-dependency.error.js';
+import { ForbiddenError } from './http-errors/forbidden.error.js';
+import { MethodNotAllowedError } from './http-errors/method-not-allowed.error.js';
+import { NotAcceptableError } from './http-errors/not-acceptable.error.js';
+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;
+    let status = 500;
+    if (typeof e.status === 'number')
+        status = e.status;
+    else if (typeof e.getStatus === 'function')
+        status = e.getStatus();
+    switch (status) {
+        case 400:
+            return new BadRequestError(e);
+        case 401:
+            return new UnauthorizedError(e);
+        case 403:
+            return new ForbiddenError(e);
+        case 404:
+            return new NotFoundError(e);
+        case 405:
+            return new MethodNotAllowedError(e);
+        case 406:
+            return new NotAcceptableError(e);
+        case 422:
+            return new UnprocessableEntityError(e);
+        case 424:
+            return new FailedDependencyError(e);
+        default:
+            return new FailedDependencyError(e);
+    }
+}

package/esm/filter/antlr/OpraFilterLexer.d.ts

@@ -0,0 +1,78 @@
+import { ATN } from "antlr4ts/atn/ATN";
+import { CharStream } from "antlr4ts/CharStream";
+import { Lexer } from "antlr4ts/Lexer";
+import { Vocabulary } from "antlr4ts/Vocabulary";
+export declare class OpraFilterLexer extends Lexer {
+    static readonly T__0 = 1;
+    static readonly T__1 = 2;
+    static readonly T__2 = 3;
+    static readonly T__3 = 4;
+    static readonly T__4 = 5;
+    static readonly T__5 = 6;
+    static readonly T__6 = 7;
+    static readonly T__7 = 8;
+    static readonly T__8 = 9;
+    static readonly T__9 = 10;
+    static readonly T__10 = 11;
+    static readonly T__11 = 12;
+    static readonly T__12 = 13;
+    static readonly T__13 = 14;
+    static readonly T__14 = 15;
+    static readonly T__15 = 16;
+    static readonly T__16 = 17;
+    static readonly T__17 = 18;
+    static readonly T__18 = 19;
+    static readonly T__19 = 20;
+    static readonly T__20 = 21;
+    static readonly T__21 = 22;
+    static readonly T__22 = 23;
+    static readonly T__23 = 24;
+    static readonly T__24 = 25;
+    static readonly T__25 = 26;
+    static readonly T__26 = 27;
+    static readonly T__27 = 28;
+    static readonly T__28 = 29;
+    static readonly T__29 = 30;
+    static readonly T__30 = 31;
+    static readonly T__31 = 32;
+    static readonly T__32 = 33;
+    static readonly T__33 = 34;
+    static readonly T__34 = 35;
+    static readonly T__35 = 36;
+    static readonly T__36 = 37;
+    static readonly T__37 = 38;
+    static readonly T__38 = 39;
+    static readonly T__39 = 40;
+    static readonly T__40 = 41;
+    static readonly T__41 = 42;
+    static readonly T__42 = 43;
+    static readonly T__43 = 44;
+    static readonly T__44 = 45;
+    static readonly T__45 = 46;
+    static readonly DATE = 47;
+    static readonly DATETIME = 48;
+    static readonly TIME = 49;
+    static readonly IDENTIFIER = 50;
+    static readonly STRING = 51;
+    static readonly NUMBER = 52;
+    static readonly INTEGER = 53;
+    static readonly WHITESPACE = 54;
+    static readonly COMMENT = 55;
+    static readonly LINE_COMMENT = 56;
+    static readonly channelNames: string[];
+    static readonly modeNames: string[];
+    static readonly ruleNames: string[];
+    private static readonly _LITERAL_NAMES;
+    private static readonly _SYMBOLIC_NAMES;
+    static readonly VOCABULARY: Vocabulary;
+    get vocabulary(): Vocabulary;
+    constructor(input: CharStream);
+    get grammarFileName(): string;
+    get ruleNames(): string[];
+    get serializedATN(): string;
+    get channelNames(): string[];
+    get modeNames(): string[];
+    static readonly _serializedATN: string;
+    static __ATN: ATN;
+    static get _ATN(): ATN;
+}