dyo-tools 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyo-tools",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -13,8 +13,7 @@
     "test": "jest",
     "test:coverage": "c8 --check-coverage npm test",
     "test:coverage:verify": "c8 --check-coverage --lines 97 --functions 97 --branches 97 --statements 97 npm test",
-    "e2e": "cucumber-js --config cucumber.js",
-    "typedoc": "typedoc --tsconfig tsconfig.dev.json src/**/*.ts"
+    "typedoc": "typedoc --plugin typedoc-plugin-rename-defaults --entryPointStrategy expand ./src --exclude 'src/index.ts'"
   },
   "repository": {
     "type": "git",
@@ -30,23 +29,23 @@
   },
   "homepage": "https://gitlab.com/dyo-system/dyo-tools#readme",
   "devDependencies": {
-    "@babel/preset-env": "^7.22.5",
-    "@types/jest": "^27.5.2",
-    "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.59.11",
-    "@typescript-eslint/parser": "^5.59.11",
-    "c8": "^8.0.0",
-    "eslint": "^8.42.0",
+    "@babel/preset-env": "^7.23.9",
+    "@types/jest": "^29.5.12",
+    "@types/uuid": "^9.0.8",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "c8": "^9.1.0",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "jest": "^27.5.1",
-    "ts-jest": "^27.1.5",
-    "typedoc": "^0.24.8",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typedoc": "^0.25.8",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@cucumber/cucumber": "^9.1.2",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.1"
   }
 }

package/src/constants.ts

@@ -1,85 +1,85 @@
-import {
-  DTAcceptedMetaData,
-  DTBunchOptions,
-  DTManagerOptions,
-  DYOFinderConfiguration,
-  FilterOperatorType,
-  StandardPrimitiveType,
-} from './types';
-import {
-  DTBunch, DTComponentPhysical, DTElement, DTManager,
-} from './index';
-
-/* ********************** CORE CONSTANTS ********************** */
-/** DTBunch constants * */
-export const bunchDefaultOptions: DTBunchOptions = {
-  errors: false,
-  uniqueKey: false,
-  inheritOwner: false,
-  replaceIndex: false,
-  virtualContext: false,
-};
-
-/** DTManager constants * */
-export const managerDefaultOptions: DTManagerOptions = {
-  errors: false,
-  libraryDeletion: false,
-};
-
-/** DYOFinder configuration constants * */
-const baseOperators = [
-  FilterOperatorType.EQ,
-  FilterOperatorType.IN,
-  FilterOperatorType.NIN,
-  FilterOperatorType.NE,
-];
-const advancedOperators = [
-  ...baseOperators,
-  FilterOperatorType.GTE,
-  FilterOperatorType.LTE,
-  FilterOperatorType.CONTAINS,
-  FilterOperatorType.NCONTAINS,
-];
-
-export const componentPhysicalDefaultFinderConfiguration: DYOFinderConfiguration = {
-  id: {
-    operators: baseOperators,
-    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getId(),
-    objectSearch: false,
-  },
-  key: {
-    operators: baseOperators,
-    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getKey(),
-    objectSearch: false,
-  },
-  owner: {
-    operators: baseOperators,
-    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => (item.getOwner() ? item.getOwner().getId() : null),
-    objectSearch: false,
-  },
-  meta: {
-    operators: advancedOperators,
-    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getManyMeta(),
-    objectSearch: true,
-  },
-};
-
-export const componentManagerDefaultFinderConfiguration: DYOFinderConfiguration = {
-  ...componentPhysicalDefaultFinderConfiguration,
-  scope: {
-    operators: baseOperators,
-    getValue(item: DTBunch<DTElement<DTAcceptedMetaData>>, ctx: DTManager<DTElement<DTAcceptedMetaData>>): StandardPrimitiveType {
-      return ctx.getScope(item.getId());
-    },
-    objectSearch: false,
-  },
-};
-
-export const componentBunchDefaultFinderConfiguration: DYOFinderConfiguration = {
-  ...componentPhysicalDefaultFinderConfiguration,
-  context: {
-    operators: baseOperators,
-    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => (item.getContext() ? item.getContext().getId() : null),
-    objectSearch: false,
-  },
-};
+import {
+  DTAcceptedMetaData,
+  DTBunchOptions,
+  DTManagerOptions,
+  DYOFinderConfiguration,
+  FilterOperatorType,
+  StandardPrimitiveType,
+} from './types';
+import {
+  DTBunch, DTComponentPhysical, DTElement, DTManager,
+} from './index';
+
+/* ********************** CORE CONSTANTS ********************** */
+/** DTBunch constants * */
+export const bunchDefaultOptions: DTBunchOptions = {
+  errors: false,
+  uniqueKey: false,
+  inheritOwner: false,
+  replaceIndex: false,
+  virtualContainer: false,
+};
+
+/** DTManager constants * */
+export const managerDefaultOptions: DTManagerOptions = {
+  errors: false,
+  libraryDeletion: false,
+};
+
+/** DYOFinder configuration constants * */
+const baseOperators = [
+  FilterOperatorType.EQ,
+  FilterOperatorType.IN,
+  FilterOperatorType.NIN,
+  FilterOperatorType.NE,
+];
+const advancedOperators = [
+  ...baseOperators,
+  FilterOperatorType.GTE,
+  FilterOperatorType.LTE,
+  FilterOperatorType.CONTAINS,
+  FilterOperatorType.NCONTAINS,
+];
+
+export const componentPhysicalDefaultFinderConfiguration: DYOFinderConfiguration = {
+  id: {
+    operators: baseOperators,
+    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getId(),
+    objectSearch: false,
+  },
+  key: {
+    operators: baseOperators,
+    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getKey(),
+    objectSearch: false,
+  },
+  owner: {
+    operators: baseOperators,
+    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getOwner(),
+    objectSearch: false,
+  },
+  meta: {
+    operators: advancedOperators,
+    getValue: (item: DTComponentPhysical<DTAcceptedMetaData>) => item.getManyMeta(),
+    objectSearch: true,
+  },
+};
+
+export const componentManagerDefaultFinderConfiguration: DYOFinderConfiguration = {
+  ...componentPhysicalDefaultFinderConfiguration,
+  scope: {
+    operators: baseOperators,
+    getValue(item: DTBunch<DTElement<DTAcceptedMetaData>>, ctx: DTManager<DTElement<DTAcceptedMetaData>>): StandardPrimitiveType {
+      return ctx.getScope(item.getId());
+    },
+    objectSearch: false,
+  },
+};
+
+export const componentBunchDefaultFinderConfiguration: DYOFinderConfiguration = {
+  ...componentPhysicalDefaultFinderConfiguration,
+  container: {
+    operators: baseOperators,
+    getValue: (item: DTElement<DTAcceptedMetaData>) => (item.getContainer() ? item.getContainer().getId() : null),
+    objectSearch: false,
+  },
+};

package/src/core/DTAction.ts

@@ -0,0 +1,52 @@
+import DYOToolsComponent from './DTComponent';
+import { DTComponentToObject } from '../types';
+import DYOToolsMaster from './DTMaster';
+
+export default abstract class DYOToolsAction<Payload = unknown> extends DYOToolsComponent {
+  /**
+   * Defining component type to "action".
+   */
+  protected _componentType: string = 'action';
+
+  /**
+   * Returns Master component from context, or undefined.
+   */
+  getMaster(): DYOToolsMaster | undefined {
+    return this.getContext<DYOToolsMaster>('master');
+  }
+
+  /**
+   * Abstract method for action execution process.
+   *
+   * @param payload Object Payload to pass for action execution.
+   * @returns Promise
+   */
+  abstract execute(payload: Payload): Promise<void>;
+
+  /**
+   * Return String representation of the Action instance.
+   *
+   * @returns String representation of the Action.
+   */
+  toString(): string {
+    return `Component ${this._key} - Type: Action`;
+  }
+
+  /**
+   * Return JSON Object representation of the Action instance.
+   *
+   * JSON Object returned has the following structure :
+   * * **id** : _id property of the Action.
+   * * **key** : _key property of the Action.
+   * * **type** : _componentType property of the Action.
+   *
+   * @returns JSON Object representation of the Action.
+   */
+  toObject(): DTComponentToObject {
+    return {
+      id: this._id,
+      key: this._key,
+      type: this._componentType,
+    };
+  }
+}