@adaas/a-concept 0.0.59 → 0.0.61

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaas/a-concept",
-  "version": "0.0.59",
+  "version": "0.0.61",
   "description": "A-Concept is a framework to build new Applications within or outside the ADAAS ecosystem. This framework is designed to be modular structure regardless environment and program goal.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -51,7 +51,7 @@
   },
   "homepage": "https://github.com/ADAAS-org/adaas-adf-auth#readme",
   "dependencies": {
-    "@adaas/a-utils": "^0.0.7",
+    "@adaas/a-utils": "^0.0.8",
     "@types/node": "^20.10.0"
   },
   "devDependencies": {

package/src/decorators/A-Feature/A-Feature-Define.decorator.ts

@@ -14,6 +14,9 @@ import { A_ComponentMeta } from "@adaas/a-concept/global/A-Component/A-Component
 import { A_TYPES__EntityMetaKey } from "@adaas/a-concept/global/A-Entity/A-Entity.types";
 import { A_TYPES__ComponentMetaKey } from "@adaas/a-concept/global/A-Component/A-Component.types";
 import { A_Meta } from "@adaas/a-concept/global/A-Meta/A-Meta.class";
+import { A_Command } from "@adaas/a-concept/global/A-Command/A-Command.class";
+import { A_TYPES__CommandMetaKey } from "@adaas/a-concept/global/A-Command/A-Command.types";
+import { A_CommandMeta } from "@adaas/a-concept/global/A-Command/A-Command.meta";
 
 /**
  * A-Feature decorator
@@ -32,12 +35,12 @@ export function A_Feature_Define(
     config: Partial<A_TYPES__A_FeatureDecoratorConfig> = {}
 ) {
     return function (
-        target: A_Container | A_Entity | A_Component,
+        target: A_Container | A_Entity | A_Component | A_Command,
         propertyKey: string,
         descriptor: A_TYPES__A_FeatureDecoratorDescriptor
     ) {
 
-        const meta: A_EntityMeta | A_ContainerMeta | A_ComponentMeta = A_Context.meta(target.constructor as any);
+        const meta: A_EntityMeta | A_ContainerMeta | A_ComponentMeta | A_CommandMeta = A_Context.meta(target.constructor as any);
 
         let metaKey;
 
@@ -52,8 +55,13 @@ export function A_Feature_Define(
             case target instanceof A_Component:
                 metaKey = A_TYPES__ComponentMetaKey.FEATURES
                 break;
-            default:
-                throw new Error(`A-Feature cannot be defined on the ${target} level`);
+            case target instanceof A_Command:
+                metaKey = A_TYPES__CommandMetaKey.FEATURES
+                break;
+            default: {
+                console.log(target);
+                throw new Error(`A-Feature cannot be defined on the ${(target as any).constructor.name} level`);
+            }
         }
 
 
@@ -72,7 +80,7 @@ export function A_Feature_Define(
         const handlerName = config.name || propertyKey;
         //  default to false
         const invoke = config.invoke || false;
- 
+
 
         // Set the metadata of the method to define a custom Feature with name 
         existedMeta.set(propertyKey, {
@@ -102,7 +110,6 @@ export function A_Feature_Define(
         const originalMethod = descriptor.value!;
 
 
-
         // Wrap the original method to add the call to `call`
         // this helps to automatically call the container/entity/component method when it's called
         descriptor.value = function (...args: any[]) {

package/src/{base/A-Command/A_Command.entity.ts → global/A-Command/A-Command.class.ts}

@@ -1,21 +1,69 @@
-import { A_Entity } from "@adaas/a-concept/global/A-Entity/A-Entity.class";
-import { A_TYPES__Command_Constructor, A_TYPES__Command_Listener, A_TYPES__Command_Serialized } from "./A_Command.types";
-import { A_Error } from "@adaas/a-utils";
+import { A_TYPES__Command_Constructor, A_TYPES__Command_Listener, A_TYPES__Command_Serialized } from "./A-Command.types";
+import { A_CommonHelper, A_Error, ASEID } from "@adaas/a-utils";
 import { A_Scope } from "@adaas/a-concept/global/A-Scope/A-Scope.class";
-import { A_Feature } from "@adaas/a-concept/global/A-Feature/A-Feature.class";
 import { A_CommandContext } from "./context/A_Command.context";
-import { A_CONSTANTS__A_Command_Event, A_CONSTANTS__A_Command_Status, A_CONSTANTS_A_Command_Features } from "./A_Command.constants";
+import { A_CONSTANTS__A_Command_Event, A_CONSTANTS__A_Command_Status } from "./A-Command.constants";
+import { A_Context } from "../A-Context/A-Context.class";
+import { A_CONSTANTS__DEFAULT_ENV_VARIABLES } from "@adaas/a-concept/constants/env.constants";
 
 
 export class A_Command<
     InvokeType extends A_TYPES__Command_Constructor = A_TYPES__Command_Constructor,
     ResultType extends Record<string, any> = Record<string, any>
-> extends A_Entity<
-    InvokeType,
-    A_TYPES__Command_Serialized<ResultType>
 > {
 
-    protected _scope!: A_Scope;
+    // ====================================================================
+    // ================== Static A-Command Information ====================
+    // ====================================================================
+
+    /**
+     * Command Identifier that corresponds to the class name
+     */
+    static get code(): string {
+        return A_CommonHelper.toKebabCase(this.name);
+    }
+
+    /**
+     * DEFAULT Namespace of the command from environment variable A_CONCEPT_NAMESPACE
+     * [!] If environment variable is not set, it will default to 'a-concept'
+     */
+    static get namespace(): string {
+        return A_Context.root.name;
+    }
+
+    /**
+     * DEFAULT Scope of the command from environment variable A_CONCEPT_DEFAULT_SCOPE
+     * [!] If environment variable is not set, it will default to 'core'
+     * [!] Scope is an application specific identifier that can be used to group commands together
+     * [!] e.g. 'default', 'core', 'public', 'internal', etc
+     */
+    static get scope(): string {
+        return process && process.env ? process.env[A_CONSTANTS__DEFAULT_ENV_VARIABLES.A_CONCEPT_DEFAULT_SCOPE] || 'core' : 'core';
+    }
+
+    // ====================================================================
+    // ================ Instance A-Command Information ====================
+    // ====================================================================
+
+    /**
+     * ASEID is a command identifier that is unique across the system
+     * A - A_Concept or Application
+     * S - System or Scope
+     * E - Entity
+     * ID - Identifier
+     * 
+     * [!] ASEID is immutable and should not be changed after the entity is created
+     * 
+     * [!] ASEID is composed of the following parts:
+     * - namespace: an application specific identifier from where the command is coming from
+     * - scope: the scope of the command from Application Namespace
+     * - entity: the name of the command from Application Namespace
+     * - id: the unique identifier of the command
+     *
+     * [!] For more information about ASEID, please refer to the ASEID class documentation
+     */
+    aseid!: ASEID;
+
     protected _result?: ResultType;
     protected _errors?: Set<A_Error>;
 
@@ -45,7 +93,7 @@ export class A_Command<
      * Command execution context is stored in A_CommandContext fragment within this scope
      */
     get Scope(): A_Scope {
-        return this._scope;
+        return A_Context.scope(this);
     }
 
     /**
@@ -54,7 +102,7 @@ export class A_Command<
      * 
      */
     get Code(): string {
-        return (this.constructor as typeof A_Command).name;
+        return (this.constructor as typeof A_Command).code;
     }
     /**
      * Current status of the command
@@ -111,7 +159,44 @@ export class A_Command<
          */
         params: InvokeType | A_TYPES__Command_Serialized<ResultType>
     ) {
-        super(params as any);
+        if (params && typeof params === 'object' && 'aseid' in params) {
+            this.fromJSON(params);
+        } else {
+            this.fromNew(params);
+        }
+    }
+
+    /**
+     * Extracts the ID from the ASEID
+     * ID is the unique identifier of the entity
+     */
+    get id(): string | number {
+        return this.aseid.id;
+    }
+
+    /**
+     * Extracts the namespace from the ASEID
+     * namespace is an application specific identifier from where the entity is coming from
+     */
+    get namespace(): string {
+        return this.aseid.namespace
+    }
+
+    /**
+     * Extracts the scope from the ASEID
+     * scope is the scope of the entity from Application Namespace
+     */
+    get scope(): string {
+        return this.aseid.scope;
+    }
+
+    /**
+     * Extracts the entity from the ASEID
+     * entity is the name of the entity from Application Namespace
+     * 
+     */
+    get entity(): string {
+        return this.aseid.entity;
     }
 
 
@@ -123,13 +208,14 @@ export class A_Command<
     /**
      * Executes the command logic.
      */
-    @A_Feature.Define()
-    async [A_CONSTANTS_A_Command_Features.EXECUTE](): Promise<any> {
+    async execute(): Promise<any> {
         this._status = A_CONSTANTS__A_Command_Status.IN_PROGRESS;
         this._startTime = new Date();
+
         try {
-            await this.call('execute', this._scope);
+            await this.call('execute');
             await this.complete();
+
         } catch (error) {
             await this.fail();
         }
@@ -138,26 +224,24 @@ export class A_Command<
     /**
      * Marks the command as completed
      */
-    @A_Feature.Define()
-    async [A_CONSTANTS_A_Command_Features.COMPLETE]() {
+    async complete() {
         this._status = A_CONSTANTS__A_Command_Status.COMPLETED;
         this._endTime = new Date();
         this._result = this.Scope.resolve(A_CommandContext).toJSON() as ResultType;
 
-        this.call('complete', this._scope);
+        this.call('complete');
     }
 
 
     /**
      * Marks the command as failed
      */
-    @A_Feature.Define()
-    async [A_CONSTANTS_A_Command_Features.FAIL]() {
+    async fail() {
         this._status = A_CONSTANTS__A_Command_Status.FAILED;
         this._endTime = new Date();
         this._errors = this.Scope.resolve(A_CommandContext).Errors;
 
-        this.call('fail', this._scope);
+        this.call('fail');
     }
 
 
@@ -211,19 +295,24 @@ export class A_Command<
      * @param newEntity 
      */
     fromNew(newEntity: InvokeType): void {
-        super.fromNew(newEntity);
 
+        this.aseid = new ASEID({
+            namespace: (this.constructor as typeof A_Command).namespace,
+            scope: (this.constructor as typeof A_Command).scope,
+            entity: (this.constructor as typeof A_Command).code,
+            id: `${new Date().getTime().toString()}-${Math.floor(Math.random() * 10000000).toString()}`,
+        });
 
-        this._params = newEntity;
-
-        this._status = A_CONSTANTS__A_Command_Status.INITIALIZED;
-
-        this._scope = new A_Scope({
+        A_Context.allocate(this, {
             name: `a-command-scope::${this.id}`,
             fragments: [
                 new A_CommandContext<ResultType>()
             ]
         });
+
+        this._params = newEntity;
+
+        this._status = A_CONSTANTS__A_Command_Status.INITIALIZED;
     }
 
 
@@ -236,19 +325,21 @@ export class A_Command<
      * @param serialized 
      */
     fromJSON(serialized: A_TYPES__Command_Serialized<ResultType>): void {
-        super.fromJSON(serialized);
-        if (serialized.startedAt) this._startTime = new Date(serialized.startedAt);
-        if (serialized.endedAt) this._endTime = new Date(serialized.endedAt);
-
-
+        this.aseid = new ASEID(serialized.aseid);
         const context = new A_CommandContext<ResultType>();
 
-        this._scope = new A_Scope({
+        A_Context.allocate(this, {
             name: `a-command-scope::${this.id}`,
             fragments: [
                 context
             ]
-        })
+        });
+
+        if (serialized.startedAt) this._startTime = new Date(serialized.startedAt);
+        if (serialized.endedAt) this._endTime = new Date(serialized.endedAt);
+
+
+
         // Restore result and errors in the context
         if (serialized.result) {
             Object.entries(serialized.result).forEach(([key, value]) => {
@@ -273,7 +364,7 @@ export class A_Command<
      */
     toJSON(): A_TYPES__Command_Serialized<ResultType> {
         return {
-            ...super.toJSON(),
+            aseid: this.aseid.toString(),
             code: this.Code,
             status: this._status,
             startedAt: this._startTime ? this._startTime.toISOString() : undefined,
@@ -284,4 +375,27 @@ export class A_Command<
         }
     };
 
+
+
+    /**
+     * Call a feature of the component with the provided scope
+     * 
+     * [!] If the provided scope is not inherited from the entity scope, it will be inherited
+     * 
+     * @param lifecycleMethod 
+     * @param args 
+     */
+    async call(
+        feature: string,
+        scope: A_Scope = this.Scope
+    ) {
+        if (scope && !scope.isInheritedFrom(this.Scope)) {
+            scope = scope.inherit(this.Scope);
+        }
+
+        const newFeature = A_Context.feature(this, feature, scope);
+
+        return await newFeature.process();
+    }
+
 }

package/src/global/A-Command/A-Command.meta.ts

@@ -0,0 +1,22 @@
+import { A_Meta } from "../A-Meta/A-Meta.class";
+import { A_TYPES__CommandMeta, A_TYPES__CommandMetaKey } from "./A-Command.types";
+import { A_TYPES__A_DefineDecorator_Meta } from "@adaas/a-concept/decorators/A-Feature/A-Feature.decorator.types";
+
+
+export class A_CommandMeta extends A_Meta<A_TYPES__CommandMeta> {
+
+    /**
+     * Returns all features defined in the Container
+     * 
+     * @returns 
+     */
+    features(): Array<A_TYPES__A_DefineDecorator_Meta> {
+
+        const features = this.get(A_TYPES__CommandMetaKey.FEATURES);
+
+        return features?.toArray()
+            // returns all extensions that match the feature
+            .map(([, feature]) => feature) || [];
+    }
+
+}

package/src/global/A-Command/A-Command.types.ts

@@ -0,0 +1,71 @@
+import { A_Command } from "./A-Command.class";
+import { A_CONSTANTS__A_Command_Status } from "./A-Command.constants";
+import { A_TYPES__Error } from "@adaas/a-utils";
+import { A_Meta } from "../A-Meta/A-Meta.class";
+import { A_TYPES__A_DefineDecorator_Meta, A_TYPES__A_ExtendDecorator_Meta } from "@adaas/a-concept/decorators/A-Feature/A-Feature.decorator.types";
+
+
+
+export type A_TYPES__Command_Constructor = {
+}
+
+
+
+export type A_TYPES__Command_Serialized<
+    ResultType extends Record<string, any> = Record<string, any>
+> = {
+    aseid: string,
+    code: string;
+    status: A_CONSTANTS__A_Command_Status;
+
+    startedAt?: string;
+    endedAt?: string;
+    duration?: number;
+
+    result?: ResultType;
+    errors?: Array<A_TYPES__Error>;
+
+}
+
+
+
+
+export type A_TYPES__Command_Listener<
+    T extends Record<string, any> = Record<string, any>
+> = (command?: A_Command<any, T>) => void;
+
+
+
+
+
+
+export type A_TYPES__CommandMeta = {
+    [A_TYPES__CommandMetaKey.EXTENSIONS]: A_Meta<{
+
+        /**
+         * Where Key the regexp for what to apply the extension
+         * A set of container names or a wildcard, or a regexp
+         * 
+         *
+         * Where value is the extension instructions
+         */
+        [Key: string]: A_TYPES__A_ExtendDecorator_Meta[]
+
+    }>, case
+
+
+    [A_TYPES__CommandMetaKey.FEATURES]: A_Meta<{
+        /**
+         * Where Key is the name of the feature
+         * 
+         * Where value is the list of features
+         */
+        [Key: string]: A_TYPES__A_DefineDecorator_Meta
+    }>
+}
+
+export enum A_TYPES__CommandMetaKey {
+    EXTENSIONS = 'a-command-extensions',
+    FEATURES = 'a-command-features',
+    ABSTRACTIONS = 'a-command-abstractions',
+}

package/src/global/A-Concept/A_Concept.class.ts

@@ -106,6 +106,9 @@ export class A_Concept<
         if (props.entities && props.entities.length)
             props.entities.forEach(entity => this.Scope.register(entity))
 
+        if (props.commands && props.commands.length)
+            props.commands.forEach(command => this.Scope.register(command))
+
         this.containers = props.containers || [];
     }
 

package/src/global/A-Concept/A_Concept.types.ts

@@ -4,6 +4,7 @@ import { A_Fragment } from "../A-Fragment/A-Fragment.class";
 import { A_Entity } from "../A-Entity/A-Entity.class";
 import { A_Component } from "../A-Component/A-Component.class";
 import { A_TYPES__A_ExtendDecorator_BehaviorConfig } from "@adaas/a-concept/decorators/A-Feature/A-Feature.decorator.types";
+import { A_Command } from "../A-Command/A-Command.class";
 
 
 export enum A_TYPES__ConceptStage {
@@ -68,6 +69,15 @@ export interface A_TYPES__IConceptConstructor<
      * [!] Note that these components will be available in all containers and fragments in the concept.
      */
     components?: Array<{ new(...args: any[]): A_Component }>
+
+
+    /**
+     * A set of Commands available for all containers and fragments in the concept. 
+     * These commands will be registered in the root scope of the concept.
+     * 
+     * [!] Note that these commands will be available in all containers and fragments in the concept.
+     */
+    commands?: Array<{ new(...args: any[]): A_Command }>
 }
 
 

package/src/global/A-Context/A-Context.class.ts

@@ -22,6 +22,8 @@ import { A_TYPES__ComponentMetaKey } from "../A-Component/A-Component.types";
 import { A_TYPES__ConceptStage } from "../A-Concept/A_Concept.types";
 import { A_TYPES__A_DefineDecorator_Meta } from "@adaas/a-concept/decorators/A-Feature/A-Feature.decorator.types";
 import { A_CONSTANTS__DEFAULT_ENV_VARIABLES } from "@adaas/a-concept/constants/env.constants";
+import { A_Command } from "../A-Command/A-Command.class";
+import { A_TYPES__CommandMetaKey } from "../A-Command/A-Command.types";
 
 
 
@@ -47,6 +49,9 @@ export class A_Context {
     protected features: WeakMap<A_Feature, A_Scope> = new WeakMap();
 
 
+    protected commands: WeakMap<A_Command, A_Scope> = new WeakMap();
+
+
     /**
      * Uses to store the scope of every element in the program. 
      */
@@ -164,6 +169,11 @@ export class A_Context {
 
                 break;
 
+            case param1 instanceof A_Command:
+                instance.commands.set(param1, newScope);
+
+                break;
+
             default:
                 throw new Error(`[!] A-Concept Context: Unknown type of the parameter.`);
         }
@@ -356,6 +366,9 @@ export class A_Context {
             case param1 instanceof A_Fragment:
                 return instance.registry.get(param1);
 
+            case param1 instanceof A_Command:
+                return instance.commands.get(param1);
+
             default:
                 throw new Error(`[!] A-Concept Context: Unknown type of the parameter.`);
         }
@@ -444,10 +457,13 @@ export class A_Context {
             case component instanceof A_Container:
                 metaKey = A_TYPES__ContainerMetaKey.FEATURES
                 break;
-            case component instanceof A_Component: {
+            case component instanceof A_Component:
                 metaKey = A_TYPES__ComponentMetaKey.FEATURES
-            }
                 break;
+            case component instanceof A_Command:
+                metaKey = A_TYPES__CommandMetaKey.FEATURES
+                break;
+
             default:
                 throw new Error(`A-Feature cannot be defined on the ${component} level`);
         }
@@ -499,7 +515,7 @@ export class A_Context {
      * @returns 
      */
     static abstractionDefinition(
-        component: A_Component | A_Container | A_Entity,
+        component: A_Component | A_Container | A_Entity | A_Command,
         abstraction: A_TYPES__ConceptStage,
         scope: A_Scope
     ): A_TYPES__FeatureConstructor {
@@ -516,9 +532,11 @@ export class A_Context {
             case component instanceof A_Container:
                 metaKey = A_TYPES__ContainerMetaKey.ABSTRACTIONS
                 break;
-            case component instanceof A_Component: {
+            case component instanceof A_Component:
                 metaKey = A_TYPES__ComponentMetaKey.ABSTRACTIONS
-            }
+                break;
+            case component instanceof A_Command:
+                metaKey = A_TYPES__CommandMetaKey.ABSTRACTIONS
                 break;
             default:
                 throw new Error(`A-Feature cannot be defined on the ${component} level`);

package/src/global/A-Entity/A-Entity.class.ts

@@ -36,10 +36,7 @@ export class A_Entity<
      * Entity Identifier that corresponds to the class name
      */
     static get entity(): string {
-        return A_CommonHelper
-            .toUpperSnakeCase(this.name)
-            .toLocaleLowerCase()
-            .replace(/_/g, '-');
+        return A_CommonHelper.toKebabCase(this.name);
     }
 
     /**

package/src/global/A-Feature/A-FeatureCaller.class.ts

@@ -1,3 +1,4 @@
+import { A_Command } from "../A-Command/A-Command.class";
 import { A_Component } from "../A-Component/A-Component.class";
 import { A_Container } from "../A-Container/A-Container.class";
 import { A_Feature } from "./A-Feature.class";
@@ -15,10 +16,10 @@ import { A_Feature } from "./A-Feature.class";
 export class A_FeatureCaller {
 
 
-    protected _component: A_Component | A_Feature | A_Container;
+    protected _component: A_Component | A_Feature | A_Container | A_Command;
 
     constructor(
-        component: A_Component | A_Feature | A_Container
+        component: A_Component | A_Feature | A_Container | A_Command
     ) {
         this._component = component;
     }
@@ -29,7 +30,7 @@ export class A_FeatureCaller {
      * 
      * @returns 
      */
-    resolve(): A_Component | A_Feature | A_Container {
+    resolve(): A_Component | A_Feature | A_Container | A_Command {
         return this._component;
     }