@adaas/a-utils 0.1.13 → 0.1.15

package/src/lib/A-Channel/A-Channel.constants.ts

@@ -0,0 +1,76 @@
+
+
+// ===============================================================
+// ADAAS A-Channel Constants
+// ===============================================================
+export enum A_ChannelFeatures {
+    /**
+     * Allows to extend timeout logic and behavior
+     */
+    onTimeout = 'onTimeout',
+    /**
+     * Allows to extend retry logic and behavior
+     */
+    onRetry = 'onRetry',
+    /**
+     * Allows to extend circuit breaker logic and behavior
+     */
+    onCircuitBreakerOpen = 'onCircuitBreakerOpen',
+    /**
+     * Allows to extend cache logic and behavior
+     */
+    onCache = 'onCache',
+    /**
+     * Allows to extend connection logic and behavior
+     */
+    onConnect = 'onConnect',
+    /**
+     * Allows to extend disconnection logic and behavior
+     */
+    onDisconnect = 'onDisconnect',
+    /**
+     * Allows to extend request preparation logic and behavior
+     */
+    onBeforeRequest = 'onBeforeRequest',
+    /**
+     * Allows to extend request sending logic and behavior
+     */
+    onRequest = 'onRequest',
+    /**
+     * Allows to extend request post-processing logic and behavior
+     */
+    onAfterRequest = 'onAfterRequest',
+    /**
+     * Allows to extend error handling logic and behavior
+     * 
+     * [!] The same approach uses for ALL errors within the channel
+     */
+    onError = 'onError',
+    /**
+     * Allows to extend send logic and behavior
+     */
+    onSend = 'onSend',
+    /**
+     * Allows to extend consume logic and behavior
+     */
+    onConsume = 'onConsume',
+}
+
+
+// ==============================================================
+// A-Channel Request Constants
+// ===============================================================
+export enum A_ChannelRequestStatuses {
+    /**
+     * Request is pending
+     */
+    PENDING = 'PENDING',
+    /***
+     * Request was successful
+     */
+    SUCCESS = 'SUCCESS',
+    /**
+     * Request failed
+     */
+    FAILED = 'FAILED',
+}

package/src/lib/A-Channel/A-Channel.error.ts

@@ -1,8 +1,49 @@
-import { A_Error } from "@adaas/a-concept";
+import { A_Error, A_TypeGuards } from "@adaas/a-concept";
+import { A_ChannelRequest } from "./A-ChannelRequest.context";
 
 
 export class A_ChannelError extends A_Error {
 
+    // ==========================================================
+    // ==================== Error Types =========================
+    // ==========================================================
+
+
     static readonly MethodNotImplemented = 'A-Channel Method Not Implemented';
 
+    // ==========================================================
+    // ==================== Properties ==========================
+    // ==========================================================
+
+    protected _context?: A_ChannelRequest
+
+
+    /**
+     * Channel Error allows to keep track of errors within a channel if something goes wrong
+     * 
+     * 
+     * @param originalError 
+     * @param context 
+     */
+    constructor(
+        originalError: string | A_Error | Error | any,
+        context?: A_ChannelRequest | string
+    ) {
+        if (A_TypeGuards.isString(context))
+            super(originalError, context);
+        else
+            super(originalError);
+
+        if (context instanceof A_ChannelRequest)
+            this._context = context
+    }
+
+    /***
+     * Returns Context of the error
+     */
+    get context(): A_ChannelRequest | undefined {
+        return this._context
+    }
+
+
 }

package/src/lib/A-Channel/A-Channel.types.ts

@@ -0,0 +1,11 @@
+
+
+export type A_ChannelRequestContext_Serialized<
+    _ParamsType extends Record<string, any> = Record<string, any>,
+    _ResultType extends Record<string, any> = Record<string, any>,
+> = {
+    params: _ParamsType;
+    result?: _ResultType;
+    status: string;
+    errors?: string[];
+};

package/src/lib/A-Channel/A-ChannelRequest.context.ts

@@ -0,0 +1,91 @@
+import { A_Error, A_Fragment } from "@adaas/a-concept";
+import { A_ChannelRequestStatuses } from "./A-Channel.constants";
+import { A_ChannelRequestContext_Serialized } from "./A-Channel.types";
+
+
+export class A_ChannelRequest<
+    _ParamsType extends Record<string, any> = Record<string, any>,
+    _ResultType extends Record<string, any> = Record<string, any>,
+> extends A_Fragment {
+
+
+    protected _params: _ParamsType;
+    protected _result?: _ResultType;
+    protected _errors: Set<Error> = new Set();
+
+    protected _status: A_ChannelRequestStatuses = A_ChannelRequestStatuses.PENDING;
+
+
+    constructor(
+        params: Partial<_ParamsType> = {}
+    ) {
+        super();
+        this._params = params as _ParamsType;
+    }
+
+    /**
+     * Returns the status of the request
+     */
+    get status(): A_ChannelRequestStatuses {
+        return this._status;
+    }
+
+    /**
+     * Returns the parameters of the request
+     */
+    get failed(): boolean {
+        return this._errors.size > 0;
+    }
+    /**
+     * Returns the Params of the Request
+     */
+    get params() {
+        return this._params;
+    }
+    /**
+     * Returns the Result of the Request
+     */
+    get data() {
+        return this._result;
+    }
+
+    get errors(): Set<Error> | undefined {
+        return this._errors.size > 0 ? this._errors : undefined;
+    }
+
+    // ==========================================================
+    // ==================== Mutations ===========================
+    // ==========================================================
+    /**
+     * Adds an error to the context
+     * 
+     * @param error 
+     */
+    fail(error: A_Error) {
+        this._status = A_ChannelRequestStatuses.FAILED;
+        this._errors.add(error);
+    }
+    /**
+     * Sets the result of the request
+     * 
+     * @param result 
+     */
+    succeed(result: _ResultType) {
+        this._status = A_ChannelRequestStatuses.SUCCESS;
+        this._result = result;
+    }
+
+    /**
+     * Serializes the context to a JSON object
+     * 
+     * @returns 
+     */
+    toJSON(): A_ChannelRequestContext_Serialized<_ParamsType, _ResultType> {
+        return {
+            params: this._params,
+            result: this._result,
+            status: this._status,
+            errors: this.errors ? Array.from(this._errors).map(err => err.toString()) : undefined,
+        }
+    }
+}