@adaas/a-utils 0.0.2

package/dist/src/types/ASEID.types.d.ts

@@ -0,0 +1,65 @@
+export interface A_TYPES__ASEID_Constructor {
+    /**
+     * 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
+     */
+    namespace?: string;
+    /**
+     * Entity Scope the primary location of the resource
+     * Organization, or organization Unit
+     * Could be ID or ASEID
+     *
+     */
+    scope: number | string;
+    /**
+     * Entity Type the type of the resource
+     */
+    entity: string;
+    /**
+     * Entity ID the unique identifier of the resource
+     */
+    id: number | string;
+    /**
+     * Version of the entity (optional)
+     */
+    version?: string;
+    /**
+     * Shard of the entity (optional)
+     */
+    shard?: string;
+}
+export interface A_TYPES__ASEID_ConstructorConfig {
+    /**
+     * If true, the entity ASEID will be distributed across multiple shards.
+     * In this case SHARD should be provided via Environment Variables (A_SHARD) or Configurations
+     *
+     */
+    sharding?: boolean;
+}
+export type A_TYPES__ASEID_JSON = {
+    /**
+     * Namespace for the ASEID
+     */
+    namespace: string;
+    /**
+     * Entity Scope the primary location of the resource
+     */
+    scope: string;
+    /**
+     * Entity Type the type of the resource
+     */
+    entity: string;
+    /**
+     * Entity ID the unique identifier of the resource
+     */
+    id: string;
+    /**
+     * Version of the entity (optional)
+     */
+    version?: string;
+    /**
+     * Shard of the entity (optional)
+     */
+    shard?: string;
+};

package/dist/src/types/ASEID.types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+//# sourceMappingURL=ASEID.types.js.map

package/dist/src/types/ASEID.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ASEID.types.js","sourceRoot":"","sources":["../../../src/types/ASEID.types.ts"],"names":[],"mappings":";;AAqCC,CAAC;AAYD,CAAC"}

package/dist/src/types/A_Common.types.d.ts

@@ -0,0 +1,59 @@
+export type A_AUTH_RequestParam = {
+    id?: string;
+    /**
+     * The issuer of the parameter. Could be system, custom, proxy, credentials or SIC to data provider service(e.g. CSS)
+     */
+    issuer?: 'system' | 'custom' | 'proxy' | 'credentials' | string;
+    /**
+     * Common internal value, uses for proper mapping
+     */
+    key?: string;
+    /**
+     * Allows to define the type of the parameter to convert input during the execution
+     */
+    type: 'json' | 'array' | 'number' | 'string' | 'boolean' | 'base_64' | 'file' | 'file_url';
+    /**
+     * The name of the parameter
+     */
+    name: string;
+    /**
+     * The value of the parameter
+     */
+    value: string;
+};
+type Decrement = [never, 0, 1, 2, 3, 4, 5];
+export type A_TYPES__DeepPartial<T, D extends number = 5> = {
+    [P in keyof Required<T>]?: [
+        D
+    ] extends [never] ? any : Required<T>[P] extends Array<infer U> ? Array<A_TYPES__DeepPartial<U, Decrement[D]>> : Required<T>[P] extends Function ? Required<T>[P] : Required<T>[P] extends object ? A_TYPES__DeepPartial<T[P], Decrement[D]> : T[P];
+};
+export type A_TYPES__ObjectKeyEnum<T, E> = {
+    [P in keyof Required<T>]?: T[P] extends object ? A_TYPES__ObjectKeyEnum<T[P], E> : E;
+};
+export type A_TYPES__Dictionary<T> = {
+    [Key: string]: T;
+};
+export type A_TYPES__NonObjectPaths<T> = T extends object ? {
+    [K in keyof T]: `${Exclude<K, symbol>}${""}`;
+}[keyof T] : never;
+export type A_TYPES__Paths<T, D extends number = 5> = [D] extends [never] ? never : (T extends object ? {
+    [K in keyof T]: `${Exclude<K, symbol>}${"" | `.${A_TYPES__Paths<T[K], Decrement[D]>}`}`;
+}[keyof T] : never);
+export type A_TYPES__UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export type A_TYPES__PathsToObject<_Obj, T extends readonly string[]> = A_TYPES__UnionToIntersection<{
+    [K in keyof T]: T[K] extends `${infer Key}.${infer Rest}` ? {
+        [P in Key]: P extends keyof _Obj ? A_TYPES__PathsToObject<Required<_Obj>[P], [Rest]> : any;
+    } : {
+        [P in T[K]]: `${T[K]}` extends keyof Required<_Obj> ? Required<_Obj>[`${T[K]}`] : never;
+    };
+}[number]>;
+export type A_TYPES__Required<T, arr extends (A_TYPES__Paths<T>)[] = (A_TYPES__Paths<T>)[]> = A_TYPES__PathsToObject<T, arr> & T;
+export type A_TYPES__ExtractNested<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? {
+    [Key in K]: A_TYPES__ExtractNested<T[K], Rest>;
+} : never : P extends keyof T ? {
+    [Key in P]: T[P];
+} : never;
+export type A_TYPES__ExtractProperties<T, P extends A_TYPES__Paths<T>[]> = A_TYPES__UnionToIntersection<{
+    [K in keyof P]: P[K] extends string ? A_TYPES__ExtractNested<T, P[K]> : never;
+}[number]>;
+export {};

package/dist/src/types/A_Common.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=A_Common.types.js.map

package/dist/src/types/A_Common.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_Common.types.js","sourceRoot":"","sources":["../../../src/types/A_Common.types.ts"],"names":[],"mappings":""}

package/dist/src/types/A_Entity.types.d.ts

@@ -0,0 +1,13 @@
+import { ASEID } from "../global/ASEID.class";
+export interface A_TYPES__IAEntity {
+    /**
+     * The ASEID of the entity
+     */
+    aseid: ASEID;
+}
+export type A_TYPES__AEntity_JSON = {
+    /**
+     * The ASEID of the entity
+     */
+    aseid: string;
+};

package/dist/src/types/A_Entity.types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+//# sourceMappingURL=A_Entity.types.js.map

package/dist/src/types/A_Entity.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_Entity.types.js","sourceRoot":"","sources":["../../../src/types/A_Entity.types.ts"],"names":[],"mappings":";;AAOC,CAAC"}

package/dist/src/types/A_Error.type.d.ts

@@ -0,0 +1,7 @@
+export type A_TYPES__Error = {
+    message: string;
+    code: string;
+    description: string;
+    link?: string;
+    originalError?: Error | unknown;
+};

package/dist/src/types/A_Error.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=A_Error.type.js.map

package/dist/src/types/A_Error.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_Error.type.js","sourceRoot":"","sources":["../../../src/types/A_Error.type.ts"],"names":[],"mappings":""}

package/dist/src/types/A_Error.types.d.ts

@@ -0,0 +1,7 @@
+export type A_TYPES__Error = {
+    message: string;
+    code: string;
+    description: string;
+    link?: string;
+    originalError?: Error | unknown;
+};

package/dist/src/types/A_Error.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=A_Error.types.js.map

package/dist/src/types/A_Error.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_Error.types.js","sourceRoot":"","sources":["../../../src/types/A_Error.types.ts"],"names":[],"mappings":""}

package/dist/src/types/A_ScheduleObject.types.d.ts

@@ -0,0 +1,9 @@
+export type A_TYPES__ScheduleObjectConfig = {
+    /**
+     * If the timeout is cleared, should the promise resolve or reject?
+     * BY Default it rejects
+     *
+     * !!!NOTE: If the property is set to true, the promise will resolve with undefined
+     */
+    resolveOnClear: boolean;
+};

package/dist/src/types/A_ScheduleObject.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=A_ScheduleObject.types.js.map

package/dist/src/types/A_ScheduleObject.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_ScheduleObject.types.js","sourceRoot":"","sources":["../../../src/types/A_ScheduleObject.types.ts"],"names":[],"mappings":""}

package/dist/src/types/A_ServerError.types.d.ts

@@ -0,0 +1,4 @@
+import { A_TYPES__Error } from "./A_Error.types";
+export type A_TYPES__ServerError = {
+    serverCode: number;
+} & A_TYPES__Error;

package/dist/src/types/A_ServerError.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=A_ServerError.types.js.map

package/dist/src/types/A_ServerError.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"A_ServerError.types.js","sourceRoot":"","sources":["../../../src/types/A_ServerError.types.ts"],"names":[],"mappings":""}

package/index.ts

@@ -0,0 +1,64 @@
+
+
+// ====================== EXPORTS ======================
+
+
+// --- Helpers ---
+export { A_CommonHelper } from './src/helpers/A_Common.helper';
+export { A_ScheduleHelper } from './src/helpers/A_Schedule.helper';
+
+
+// --- Global ---
+export { A_Error } from './src/global/A_Error.class';
+export { A_ServerError } from './src/global/A_ServerError.class';
+
+export { ASEID } from './src/global/ASEID.class';
+export { A_Entity } from './src/global/A_Entity.class';
+
+export { A_ScheduleObject } from './src/global/A_ScheduleObject.class';
+
+
+
+export {
+    A_Polyfills
+} from './src/global/A_Polyfills'
+
+// --- Constants ---
+export { A_CONSTANTS__ERROR_CODES } from './src/constants/errors.constants';
+
+
+// --- Types ---
+export {
+    A_TYPES__DeepPartial,
+    A_TYPES__Dictionary,
+    A_TYPES__ObjectKeyEnum,
+    A_TYPES__Required,
+    A_TYPES__Paths,
+    A_TYPES__PathsToObject,
+    A_TYPES__UnionToIntersection,
+    A_TYPES__ExtractProperties,
+    A_TYPES__ExtractNested,
+    A_TYPES__NonObjectPaths
+} from './src/types/A_Common.types';
+export {
+    A_TYPES__IAEntity,
+    A_TYPES__AEntity_JSON
+} from './src/types/A_Entity.types';
+export {
+    A_TYPES__ScheduleObjectConfig
+} from './src/types/A_ScheduleObject.types';
+export {
+    A_TYPES__Error
+} from './src/types/A_Error.types';
+export {
+    A_TYPES__ServerError
+} from './src/types/A_ServerError.types';
+export {
+    A_TYPES__ASEID_Constructor,
+    A_TYPES__ASEID_ConstructorConfig,
+    A_TYPES__ASEID_JSON
+} from './src/types/ASEID.types';
+
+
+
+

package/jest.config.ts

@@ -0,0 +1,19 @@
+import type { Config } from '@jest/types';
+
+// Sync object
+const config: Config.InitialOptions = {
+    verbose: true,
+
+    transform: {
+        '^.+\\.tsx?$': 'ts-jest'
+    },
+    moduleNameMapper: {
+        "@adaas/a-utils/constants/(.*)": ["<rootDir>/src/constants/$1"],
+        "@adaas/a-utils/global/(.*)": ["<rootDir>/src/global/$1"],
+        "@adaas/a-utils/types/(.*)": ["<rootDir>/src/types/$1"],
+        "@adaas/a-utils/helpers/(.*)": ["<rootDir>/src/helpers/$1"],
+        "@adaas/a-utils/decorators/(.*)": ["<rootDir>/src/decorators/$1"],
+    }
+
+};
+export default config;

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@adaas/a-utils",
+  "version": "0.0.2",
+  "description": "A-Utils is a set of utilities that are used across the ADAAS ecosystem. This package is designed to be a collection of utilities that are used across the ADAAS ecosystem.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "nodemonConfig": {
+    "ignore": [
+      "**/*.test.ts",
+      "**/*.spec.ts",
+      ".git",
+      "node_modules"
+    ],
+    "watch": [
+      "config",
+      "constants",
+      "src",
+      "lib",
+      "db",
+      "shared"
+    ],
+    "exec": "node -r tsconfig-paths/register -r ts-node/register ",
+    "ext": "ts, js"
+  },
+  "scripts": {
+    "test": "jest",
+    "start": "nodemon ./tests/log.ts",
+    "publish": "npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public",
+    "preversion": "echo test",
+    "version": "echo git add .",
+    "postversion": "git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ",
+    "echo-version": "echo $npm_package_version",
+    "build": "tsc --declaration --project tsconfig.json && tscpaths -p tsconfig.json -s ./ -o ./dist && rm -r ./dist/tests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ADAAS-org/adaas-adf-auth.git"
+  },
+  "keywords": [
+    "sdk",
+    "ai",
+    "rag"
+  ],
+  "author": "adaas.org",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ADAAS-org/adaas-adf-auth/issues"
+  },
+  "homepage": "https://github.com/ADAAS-org/adaas-adf-auth#readme",
+  "dependencies": {
+    "@types/node": "^20.10.0",
+    "axios": "^1.6.2"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.14",
+    "@types/jest": "^29.5.12",
+    "@types/mocha": "^10.0.6",
+    "chai": "^5.1.0",
+    "dotenv": "^16.4.5",
+    "jest": "^29.7.0",
+    "mocha": "^10.4.0",
+    "nodemon": "^3.1.4",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "tscpaths": "^0.0.9"
+  },
+  "directories": {
+    "doc": "docs",
+    "test": "tests"
+  }
+}

package/src/constants/errors.constants.ts

@@ -0,0 +1,78 @@
+
+export enum A_CONSTANTS__ERROR_CODES {
+    // Default Utils Errors 
+    INCORRECT_A_ENTITY_CONSTRUCTOR = 'ERR-A-Entity-0001',
+    INVALID_ASEID = 'ERR-ASEID-0001',
+
+
+    UNEXPECTED_ERROR = 'ERR-0001',
+    METHOD_NOT_IMPLEMENTED = 'ERR-0002',
+    ROUTE_NOT_FOUND = 'ERR-0003',
+    TOKEN_NOT_PROVIDED = 'ERR-0004',
+    NOT_ALL_PARAMS_WAS_PROVIDED = 'ERR-0005',
+    CREDENTIALS_NOT_PROVIDED = 'ERR-0006',
+    CONFIGURATION_PROPERTY_NOT_EXISTS_OR_NOT_ALLOWED_TO_READ = 'ERR-0007',
+};
+
+
+export const A_CONSTANTS__DEFAULT_ERRORS = {
+    // Default A-Utils Errors
+    INCORRECT_A_ENTITY_CONSTRUCTOR: {
+        code: A_CONSTANTS__ERROR_CODES.INCORRECT_A_ENTITY_CONSTRUCTOR,
+        description: 'The A_Entity constructor was called with incorrect parameters.',
+        message: 'Incorrect A_Entity constructor parameters.'
+    },
+    INVALID_ASEID: {
+        code: A_CONSTANTS__ERROR_CODES.INVALID_ASEID,
+        description: 'The provided ASEID is invalid.',
+        message: 'Invalid ASEID provided.'
+    },
+
+
+    // Default Utils Server Errors
+    UNEXPECTED_ERROR: {
+        serverCode: 500,
+        code: A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR,
+        description: 'If you see this error please let us know.',
+        message: 'Oops... Something went wrong',
+    },
+    METHOD_NOT_IMPLEMENTED: {
+        serverCode: 500,
+        code: A_CONSTANTS__ERROR_CODES.METHOD_NOT_IMPLEMENTED,
+        description: 'If you see this error please let us know.',
+        message: 'Oops... Something went wrong',
+        link: 'https://support.adaas.org/error/' + A_CONSTANTS__ERROR_CODES.UNEXPECTED_ERROR
+    },
+    ROUTE_NOT_FOUND: {
+        serverCode: 404,
+        code: A_CONSTANTS__ERROR_CODES.ROUTE_NOT_FOUND,
+        description: 'We can not find the route you\'re looking for. Please make sure that you\'re using the correct path.',
+        message: 'The target route is not found.'
+    },
+    TOKEN_NOT_PROVIDED: {
+        serverCode: 401,
+        code: A_CONSTANTS__ERROR_CODES.TOKEN_NOT_PROVIDED,
+        description: 'The token is missed in the Authorization header. Please make sure that it\'s presented.',
+        message: 'Token has not found in the authorization header.'
+    },
+    NOT_ALL_PARAMS_WAS_PROVIDED: {
+        serverCode: 409,
+        code: A_CONSTANTS__ERROR_CODES.NOT_ALL_PARAMS_WAS_PROVIDED,
+        description: 'Not all required params provided in the request',
+        message: 'Conflict in request'
+    },
+    CREDENTIALS_NOT_PROVIDED: {
+        code: A_CONSTANTS__ERROR_CODES.CREDENTIALS_NOT_PROVIDED,
+        description: 'The credentials are missed. Please make sure that they are presented.',
+        message: 'Credentials has not found in the request.'
+    },
+    CONFIGURATION_PROPERTY_NOT_EXISTS_OR_NOT_ALLOWED_TO_READ: {
+        serverCode: 403,
+        code: A_CONSTANTS__ERROR_CODES.CONFIGURATION_PROPERTY_NOT_EXISTS_OR_NOT_ALLOWED_TO_READ,
+        description: 'The configuration property is not exists or not allowed to read.',
+        message: 'Configuration property is not exists or not allowed to read.'
+    }
+
+
+
+}