dyo-tools 0.3.0 → 0.4.0

package/src/constants.ts

@@ -1,85 +1,87 @@
-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,
-  },
-};
+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,
+  syncId: undefined,
+  uniqueKey: false,
+  inheritOwner: false,
+  replaceIndex: false,
+  virtualContainer: false,
+};
+
+/** DTManager constants * */
+export const managerDefaultOptions: DTManagerOptions = {
+  errors: false,
+  syncId: undefined,
+  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

@@ -1,52 +1,54 @@
-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,
-    };
-  }
-}
+import DTComponent from './DTComponent';
+import { DTComponentToObject } from '../types';
+import DTMaster from './DTMaster';
+
+export default abstract class DTAction<Payload = unknown> extends DTComponent {
+  /**
+   * Defining component type to "action".
+   */
+  protected _componentType: string = 'action';
+
+  /**
+   * Returns Master component from context, or undefined.
+   */
+  getMaster(): DTMaster | undefined {
+    return this.getContext<DTMaster>('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,
+    };
+  }
+
+  updateFromDix() {}
+}