@adaas/a-utils 0.0.9 → 0.1.1

package/src/global/ASEID.class.ts

@@ -1,208 +0,0 @@
-import { A_CONSTANTS__DEFAULT_ERRORS } from "../constants/errors.constants";
-import { A_CommonHelper } from "../helpers/A_Common.helper";
-import { A_TYPES__ASEID_Constructor, A_TYPES__ASEID_JSON } from "../types/ASEID.types";
-import { A_Error } from "./A_Error.class";
-
-
-/**
- *  A - ADAAS
- *  S - System 
- *  E - Entity
- *  I - Identifier
- *  D - iDentifier
- * 
- * 
- *  adaas-sso@scope:usr:0000000001
- * 
- *  APP_NAMESPACE + @ + SCOPE + : ENTITY_NAME + : + ID + @ + VERSION 
- */
-export class ASEID {
-
-    static regexp: RegExp = new RegExp(`^[a-z|A-Z|0-9|-]+@[a-z|A-Z|0-9|-]+:[a-z|A-Z|0-9|-]+:[a-z|A-Z|0-9|-]+(@v[0-9]+|@lts)?$`)
-
-
-    /**
-     * Namespace for the ASEID 
-     * Generally it is the application name or code, should correspond to the namespace of the application
-     * Could be ID or ASEID
-     */
-    private _namespace!: string;
-
-    /**
-     * Entity Scope the primary location of the resource 
-     * Organization, or organization Unit
-     * Could be ID or ASEID
-     * 
-     */
-    private _scope!: string
-
-    /**
-     * Entity Type the type of the resource
-     */
-    private _entity!: string
-
-    /**
-     * Entity ID the unique identifier of the resource
-     */
-    private _id!: string
-
-
-    /**
-     * Version of the entity (optional)
-     */
-    private _version?: string
-
-    /**
-     * Shard of the entity (optional)
-     */
-    private _shard?: string
-
-
-    constructor(
-        aseid: string
-    )
-    constructor(
-        props: A_TYPES__ASEID_Constructor
-    )
-    constructor(param1: string | A_TYPES__ASEID_Constructor) {
-
-        if (typeof param1 === 'string' && !ASEID.isASEID(param1)) {
-            throw new A_Error(A_CONSTANTS__DEFAULT_ERRORS.INVALID_ASEID)
-        }
-
-        const aseidString = typeof param1 === 'string' ? param1 : ASEID.generateASEID(param1);
-
-        const { namespace, scope, entity, id, version, shard } = ASEID.parseASEID(aseidString);
-
-        this._namespace = namespace;
-        this._scope = scope;
-        this._entity = entity;
-        this._id = id;
-        this._version = version;
-        this._shard = shard;
-    }
-
-
-    get namespace(): string {
-        return this._namespace;
-    }
-
-    get scope(): string {
-        return this._scope;
-    }
-
-    get entity(): string {
-        return this._entity;
-    }
-
-    get id(): string {
-        return this._id;
-    }
-
-    get version(): string | undefined {
-        return this._version;
-    }
-
-    get shard(): string | undefined {
-        return this._shard;
-    }
-
-
-    /**
-     * Tests if the identity string is an ASEID
-     * 
-     * @param identity 
-     * @returns 
-     */
-    static isASEID(identity: string): boolean {
-        return this.regexp.test(
-            identity
-        )
-    }
-
-    /**
-  * Generate an ASEID from a namespace, entity, and id
-  * 
-  * @param props 
-  * @returns 
-  */
-    static generateASEID(
-        props: A_TYPES__ASEID_Constructor
-    ): string {
-
-        const namespace = props.namespace
-            ? this.isASEID(props.namespace)
-                ? this.parseASEID(props.namespace).id
-                : props.namespace
-            : process.env.A_NAMESPACE;
-
-        const scope = typeof props.scope === 'number'
-            ? A_CommonHelper.formatWithLeadingZeros(props.scope) :
-            this.isASEID(props.scope)
-                ? this.parseASEID(props.scope).id
-                : props.scope;
-
-        const entity = props.entity;
-
-        const id = typeof props.id === 'number'
-            ? A_CommonHelper.formatWithLeadingZeros(props.id)
-            : props.id;
-
-        const version = props.version;
-
-        const shard = !props.shard ? undefined : props.shard;
-
-
-        return `${namespace}@${scope}:${entity}:${shard ? (shard + '--' + id) : id}${version ? ('@' + version) : ''}`
-    }
-
-
-    /**
-     * Parse ASEID into its components
-     * 
-     * 
-     * @param identity 
-     * @returns 
-     */
-    static parseASEID(identity: string): A_TYPES__ASEID_JSON {
-
-        const [namespace, body, version] = identity.split('@');
-        const [scope, entity, idCandidate] = body.split(':');
-
-        const shard = idCandidate.includes('--') ? idCandidate.split('--')[0] : undefined;
-        const id = idCandidate.includes('--') ? idCandidate.split('--')[1] : idCandidate;
-
-        return {
-            namespace,
-            scope: scope,
-            entity,
-            id: id,
-            version: version ? version : undefined,
-            shard
-        };
-    }
-
-
-    toString(): string {
-        return ASEID.generateASEID({
-            namespace: this._namespace,
-            scope: this._scope,
-            entity: this._entity,
-            id: this._id,
-            version: this._version,
-            shard: this._shard
-        })
-    }
-
-
-    toJSON(): A_TYPES__ASEID_JSON {
-        return {
-            namespace: this._namespace,
-            scope: this._scope,
-            entity: this._entity,
-            id: this._id,
-            version: this._version,
-            shard: this._shard
-        }
-    }
-}

package/src/global/A_Error.class.ts

@@ -1,88 +0,0 @@
-import { A_TYPES__ServerError } from '../types/A_ServerError.types';
-import { AxiosError } from 'axios';
-import { A_TYPES__Error } from '../types/A_Error.types';
-import { A_CONSTANTS__ERROR_CODES } from '../constants/errors.constants';
-
-
-export class A_Error extends Error {
-
-    code!: string;
-    description!: string;
-    originalError?: Error | any
-    link?: string;
-
-
-    constructor(
-        params: A_TYPES__Error | Error | AxiosError | string | any
-    ) {
-        super(
-            typeof params === 'string'
-                ? params :
-                params?.message || 'Oops... Something went wrong'
-        );
-
-        this.identifyErrorType(params);
-
-    }
-
-
-    get id(): string | undefined {
-        return this.code.split('@')[1]
-    }
-
-
-    protected identifyErrorType(error: Error | AxiosError | A_TYPES__Error | string | any) {
-        if (typeof error === 'string') {
-            this.message = error;
-            this.code = A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR;
-            this.description = 'If you see this error please let us know.';
-            this.link = 'https://support.adaas.org/error/' + this.id;
-            return;
-        }
-
-
-        if ((error as A_TYPES__ServerError).code &&
-            (error as A_TYPES__ServerError).description &&
-            (error as A_TYPES__ServerError).serverCode) {
-
-            const target = error as A_TYPES__ServerError;
-
-            this.message = target.message;
-            this.code = target.code;
-            this.description = target.description;
-            this.originalError = target.originalError;
-            this.link = target.link;
-        }
-        else if (error instanceof Error) {
-            this.message = error.message;
-            this.code = A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR;
-            this.description = 'If you see this error please let us know.';
-            this.originalError = error;
-            this.link = 'https://support.adaas.org/error/' + this.id;
-
-
-        } else if (error instanceof AxiosError) {
-            this.message = error.response?.data.message || error.message;
-            this.code = error.response?.data.code || A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR;
-            this.description = error.response?.data.description || 'If you see this error please let us know.';
-            this.originalError = error.response;
-            this.link = 'https://support.adaas.org/error/' + this.id;
-        }
-    }
-
-
-    get compilingData(): A_TYPES__Error {
-        return {
-            message: this.message,
-            code: this.code,
-            description: this.description,
-            originalError: this.originalError
-        }
-    }
-
-    toJSON(): A_TYPES__Error {
-        return this.compilingData;
-    }
-}
-
-

package/src/global/A_ServerError.class.ts

@@ -1,70 +0,0 @@
-import { A_TYPES__ServerError } from '../types/A_ServerError.types';
-import { AxiosError } from 'axios';
-import { A_Error } from './A_Error.class';
-import { A_CONSTANTS__ERROR_CODES } from '../constants/errors.constants';
-
-
-export class A_ServerError extends A_Error {
-
-    code!: string;
-    description!: string;
-    serverCode: number = 500;
-    originalError: Error | any
-
-
-    constructor(params: A_TYPES__ServerError | Error | AxiosError | any) {
-        super(params);
-        this.identifyErrorType(params);
-    }
-
-
-    protected identifyErrorType(error: Error | AxiosError | A_TYPES__ServerError) {
-
-        if ((error as A_TYPES__ServerError).code &&
-            (error as A_TYPES__ServerError).description &&
-            (error as A_TYPES__ServerError).serverCode) {
-
-            const target = error as A_TYPES__ServerError;
-
-            this.message = target.message;
-            this.code = target.code;
-            this.description = target.description;
-            this.serverCode = target.serverCode;
-            this.originalError = target.originalError;
-            this.link = target.link;
-        }
-        else if (error instanceof Error) {
-            this.message = error.message;
-            this.code = A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR;
-            this.description = 'If you see this error please let us know.';
-            this.serverCode = 500;
-            this.originalError = error;
-            this.link = 'https://support.adaas.org/error/' + this.id;
-
-        } else if (error instanceof AxiosError) {
-            this.message = error.response?.data.message || error.message;
-            this.code = error.response?.data.code || A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR;
-            this.description = error.response?.data.description || 'If you see this error please let us know.';
-            this.serverCode = error.response?.status || 500;
-            this.originalError = error.response;
-            this.link = 'https://support.adaas.org/error/' + this.id;
-        }
-    }
-
-
-    get compilingData(): A_TYPES__ServerError {
-        return {
-            message: this.message,
-            code: this.code,
-            description: this.description,
-            serverCode: this.serverCode,
-            originalError: this.originalError
-        }
-    }
-
-    toJSON(): A_TYPES__ServerError {
-        return this.compilingData;
-    }
-}
-
-

package/src/helpers/A_Common.helper.ts

@@ -1,265 +0,0 @@
-import { A_Error } from "../global/A_Error.class";
-import { A_TYPES__DeepPartial } from "../types/A_Common.types";
-
-export class A_CommonHelper {
-
-    static resolve() {
-        return new Promise<void>((resolve) => resolve());
-    }
-
-    static omitArrayProperties<T, S extends string>(array: Array<T>, fields: string[]): Omit<T, S>[] {
-
-        return array;
-    }
-
-    static sanitizeHTML(html: string): string {
-        // Define the regular expression pattern to match all tags except <span>
-        const regex = /<(?!\/?span(?=>|\s.*>))\/?.*?>/g;
-
-        // Replace all matched tags with an empty string
-        return html.replace(regex, '');
-    }
-
-
-
-
-    /**
-     * Check if a class is inherited from another class
-     * 
-     * @param childClass 
-     * @param parentClass 
-     * @returns 
-     */
-    static isInheritedFrom(childClass: any, parentClass: any): boolean {
-        let current = childClass;
-
-        // Traverse the prototype chain
-        while (current) {
-            if (current === parentClass) {
-                return true;
-            }
-            current = Object.getPrototypeOf(current);
-        }
-        return false;
-    }
-
-
-    /**
-     *  Omit properties from an object or array with nested objects
-     * 
-     * @param input 
-     * @param paths 
-     * @returns 
-     */
-    static omitProperties<T, S extends string>(
-        input: T,
-        paths: string[]
-
-    ): Omit<T, S> {
-
-        // Deep clone the input object or array
-        const result = JSON.parse(JSON.stringify(input));
-
-        // Helper function to recursively remove properties
-        function removeProperties(target: Record<string, any> | any[], currPath: string[]) {
-            const currKey = currPath[0];
-            if (currPath.length === 1) {
-                // If current path has only one key, delete the property
-                delete target[currKey];
-            } else if (target[currKey] !== undefined && typeof target[currKey] === 'object') {
-                // If current key exists and is an object, recursively call removeProperties
-                removeProperties(target[currKey], currPath.slice(1));
-            }
-        }
-
-        // Iterate through each path and remove corresponding properties from the result
-        paths.forEach(path => {
-            const pathKeys = path.split('.');
-            removeProperties(result, pathKeys);
-        });
-
-        return result as Omit<T, S>;
-    }
-
-
-    /**
-     *  Format a number with leading zeros to a fixed length
-     * 
-     * @param number 
-     * @param maxZeros 
-     * @returns 
-     */
-    static formatWithLeadingZeros(number, maxZeros = 10) {
-        const formattedNumber = String(number).padStart(maxZeros + 1, '0');
-        return formattedNumber.slice(-maxZeros);
-    }
-
-    /**
-     * Remove leading zeros from a formatted number
-     */
-    static removeLeadingZeros(formattedNumber) {
-        return String(Number(formattedNumber)); // Convert to number and back to string to remove leading zeros
-    }
-
-
-
-    static toUpperSnakeCase(str: string): string {
-        return str
-            .replace(/([a-z])([A-Z])/g, '$1_$2')  // Handle lowercase followed by uppercase
-            .replace(/[-\s]([A-Z])/g, '_$1')      // Handle non-alphabetical followed by uppercase
-            .replace(/-/g, '_')
-            .toUpperCase();
-    }
-
-    static toCamelCase(str: string): string {
-        return str.toLowerCase().replace(/_([a-z])/g, (match, letter) => letter.toUpperCase());
-    }
-
-
-    static toPascalCase(str: string): string {
-        const camelCase = this.toCamelCase(str);
-        return camelCase.charAt(0).toUpperCase() + camelCase.slice(1);
-    }
-
-    static toKebabCase(str: string): string {
-        return str
-            .replace(/([a-z])([A-Z])/g, '$1-$2')  // Handle lowercase followed by uppercase
-            .replace(/[_\s]([A-Z])/g, '-$1')      // Handle non-alphabetical followed by uppercase
-            .replace(/_/g, '-')
-            .toLowerCase();
-    }
-
-    static isObject(item: unknown): item is Record<string, any> {
-        return item !== null && typeof item === 'object' && !Array.isArray(item);
-    }
-
-    static deepMerge<T = any>(target: any, source: any, visited = new Map<any, any>()): T {
-        if (this.isObject(target) && this.isObject(source)) {
-            for (const key in source) {
-                if (this.isObject(source[key])) {
-                    if (!target[key]) {
-                        target[key] = {};
-                    }
-                    // Check if the source object has already been visited
-                    if (!visited.has(source[key])) {
-                        visited.set(source[key], {});
-                        this.deepMerge(target[key], source[key], visited);
-                    } else {
-                        target[key] = visited.get(source[key]);
-                    }
-                } else {
-                    target[key] = source[key];
-                }
-            }
-        }
-        return target;
-    }
-
-
-    static deepClone<T>(target: T): T {
-        // Check if the value is null or undefined
-        if (target === null || target === undefined) {
-            return target;
-        }
-
-        // Handle primitive types (string, number, boolean, etc.)
-        if (typeof target !== 'object') {
-            return target;
-        }
-
-        // Handle Date
-        if (target instanceof Date) {
-            return new Date(target.getTime()) as T;
-        }
-
-        // Handle Array
-        if (Array.isArray(target)) {
-            return target.map(item => this.deepClone(item)) as unknown as T;
-        }
-
-        // Handle Function
-        if (typeof target === 'function') {
-            return target;
-        }
-
-        // Handle Object
-        if (target instanceof Object) {
-            const clone = {} as T;
-            for (const key in target) {
-                if (target.hasOwnProperty(key)) {
-                    clone[key] = this.deepClone(target[key]);
-                }
-            }
-            return clone;
-        }
-
-        // For any other cases
-        throw new Error('Unable to clone the object. Unsupported type.');
-    }
-
-
-    static deepCloneAndMerge<T>(target: A_TYPES__DeepPartial<T>, source: T): T {
-        if (
-            (source === null || source === undefined) &&
-            (target === null || target === undefined))
-            return target;
-
-        // Check if the value is null or undefined
-        if ((target === null || target === undefined) &&
-            source
-        ) {
-            return this.deepClone(source);
-        }
-
-        // Handle primitive types (string, number, boolean, etc.)
-        if (typeof target !== 'object') {
-            return target
-        }
-
-
-        // Handle Date
-        if (target instanceof Date) {
-            return new Date(target.getTime()) as T;
-        }
-
-        // Handle Array
-        if (Array.isArray(target)) {
-            return target.map(item => this.deepCloneAndMerge(item, source)) as unknown as T;
-        }
-
-        // Handle Function
-        if (typeof target === 'function') {
-            return target;
-        }
-
-        // Handle Object
-        if (target instanceof Object) {
-            const clone = {} as T;
-            for (const key in target) {
-                if (
-                    source[key] !== null
-                    &&
-                    source[key] !== undefined
-                )
-                    clone[key] = this.deepCloneAndMerge(target[key as any], source[key]);
-                else
-                    clone[key as any] = this.deepClone(target[key]);
-            }
-
-            for (const key in source) {
-                if (
-                    target[key] !== undefined
-                    &&
-                    target[key] !== null
-                )
-                    clone[key] = this.deepCloneAndMerge(target[key], source[key]);
-                else
-                    clone[key] = this.deepClone(source[key]);
-            }
-            return clone;
-        }
-
-        // For any other cases
-        throw new A_Error('Unable to clone the object. Unsupported type.');
-    }
-}

package/src/helpers/A_ID.helper.ts

@@ -1,32 +0,0 @@
-
-export type A_ID_TYPES__TimeId_Parts = {
-    timestamp: Date;
-    random: string;
-}
-
-
-export class A_IdentityHelper {
-    /**
-   * Generates a short, time-based unique ID.
-   * Encodes current time (ms since epoch) and random bits in base36.
-   * Example: "mb4f1g-7f9a1c"
-   */
-    static generateTimeId(
-        parts: A_ID_TYPES__TimeId_Parts = { timestamp: new Date(), random: Math.random().toString(36).slice(2, 8) }
-    ): string {
-        const time = parts.timestamp.getTime().toString(36); // base36-encoded timestamp
-        const random = parts.random; // use provided random string
-        return `${time}-${random}`;
-    }
-
-    /**
-     * Parses a short ID back into its parts.
-     * Returns an object with the original timestamp (as Date) and random string.
-     */
-    static parseTimeId(id: string): A_ID_TYPES__TimeId_Parts {
-        const [timePart, randomPart] = id.split('-');
-        const timestamp = new Date(parseInt(timePart, 36));
-        return { timestamp, random: randomPart };
-    }
-
-}

package/src/helpers/A_Schedule.helper.ts

@@ -1,25 +0,0 @@
-import { A_ScheduleObject } from "../global/A_ScheduleObject.class";
-import { A_TYPES__ScheduleObjectConfig } from "../types/A_ScheduleObject.types";
-
-export class A_ScheduleHelper {
-
-    static delay<T = void>(ms = 1000, resolver?: Promise<T>) {
-        return new Promise<T>((resolve, reject) => setTimeout(() => {
-            if (resolver) {
-                resolver.then(resolve).catch(reject);
-            }
-            else {
-                resolve(0 as T);
-            }
-        }, ms))
-    }
-
-
-    static schedule<T = void>(
-        ms = 1000,
-        resolver: () => Promise<T>,
-        config?: A_TYPES__ScheduleObjectConfig
-    ): A_ScheduleObject<T> {
-        return new A_ScheduleObject<T>(ms, resolver, config);
-    }
-}