dyo-tools 0.3.2 → 0.4.0

package/src/core/DTManager.ts

@@ -1,7 +1,8 @@
-import DYOToolsComponent from './DTComponent';
-import DYOToolsBunch from './DTBunch';
-import DYOToolsError from './DTError';
+import DTComponent from './DTComponent';
+import DTBunch from './DTBunch';
+import DTError from './DTError';
 import {
+  DIXObject,
   DTAcceptedMetaData,
   DTComponentOptions,
   DTManagerFilters,
@@ -13,12 +14,13 @@ import {
 } from '../types';
 import DYOFinder from '../libs/DYOFinder';
 import { componentManagerDefaultFinderConfiguration, managerDefaultOptions as defaultOptions } from '../constants';
-import DYOToolsElement from './DTElement';
-import DYOToolsMaster from './DTMaster';
+import DTElement from './DTElement';
+import DTMaster from './DTMaster';
+import DTDIXModule from '../libs/dix/DIXModule.module';
 
-export default class DYOToolsManager<
-  IBunchItem extends DYOToolsElement<DTAcceptedMetaData> = DYOToolsElement<DTAcceptedMetaData>,
-> extends DYOToolsComponent<DTManagerOptions> {
+export default class DTManager<
+  IBunchItem extends DTElement<DTAcceptedMetaData> = DTElement<DTAcceptedMetaData>,
+> extends DTComponent<DTManagerOptions> {
   /**
    * Defining component type to "manager".
    */
@@ -50,7 +52,7 @@ export default class DYOToolsManager<
    * The purpose is the guarantee of id uniqueness when transferring elements between bunches.
    * It also facilitates searching elements in all Manager bunches.
    */
-  protected _library: DYOToolsBunch<IBunchItem>;
+  protected _library: DTBunch<IBunchItem>;
 
   /**
    * Current DYOFinder instance.
@@ -73,8 +75,6 @@ export default class DYOToolsManager<
    */
   constructor(key?: string, elements: IBunchItem[] = [], scopes: string[] = [], options: Partial<DTManagerOptions> = {}) {
     super(key, { ...defaultOptions, ...options });
-    // Use default _domain as _key
-    this._key = !key ? (this.getDomain() || this._id) : key;
 
     this._items = {};
     this._scopes = [
@@ -82,7 +82,7 @@ export default class DYOToolsManager<
       'virtual',
       ...scopes,
     ];
-    this._library = new DYOToolsBunch('library', elements, { virtualContainer: true });
+    this._library = new DTBunch('library', elements, { virtualContainer: true });
     this._library.setContext(this);
 
     this._finder = new DYOFinder(this, this.getFinderConfiguration());
@@ -102,7 +102,7 @@ export default class DYOToolsManager<
   /**
    * Getter for _library property.
    */
-  getLibrary(): DYOToolsBunch<IBunchItem> {
+  getLibrary(): DTBunch<IBunchItem> {
     return this._library;
   }
 
@@ -144,10 +144,10 @@ export default class DYOToolsManager<
    * @param item A DTBunch instance to add into the Manager.
    * @param targetScope Optional scope for affectation.
    */
-  add(item: DYOToolsBunch<IBunchItem>, targetScope?: string): void {
+  add(item: DTBunch<IBunchItem>, targetScope?: string): void {
     // Id conflict
     if (Object.keys(this._items).includes(item.getId())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'id_conflict',
         'Bunch with same id already exists in the manager',
         this,
@@ -165,7 +165,7 @@ export default class DYOToolsManager<
       const { code: errorCode, message: errorMessage } = this.getErrorDataForScope(targetScope, virtualContainer);
 
       if (errorCode && errorMessage) {
-        this.triggerError(new DYOToolsError(errorCode, errorMessage, this, item));
+        this.triggerError(new DTError(errorCode, errorMessage, this, item));
         return;
       }
       scope = targetScope;
@@ -182,15 +182,15 @@ export default class DYOToolsManager<
 
     // Update context
     // Bunch
-    item.setContext<DYOToolsManager<IBunchItem>>(this);
     const oldContext = item.getContext();
     if (oldContext && oldContext.getComponentType() === 'manager') {
-      (oldContext as DYOToolsManager<IBunchItem>).remove(item.getId());
+      (oldContext as DTManager<IBunchItem>).remove(item.getId());
     }
+    item.setContext<DTManager<IBunchItem>>(this);
 
     // Elements children
     item.getAll().forEach((element) => {
-      element.setContext<DYOToolsManager<IBunchItem>>(this);
+      element.setContext<DTManager<IBunchItem>>(this);
     });
 
     // Add the new item
@@ -207,12 +207,12 @@ export default class DYOToolsManager<
    * @param items An array of DTBunch instances to add into the Manager.
    * @param targetScope Optional scope for affectation (all added items are affected).
    */
-  addMany(items: DYOToolsBunch<IBunchItem>[], targetScope?: string): void {
+  addMany(items: DTBunch<IBunchItem>[], targetScope?: string): void {
     const previousItems = { ...this._items };
     const { errors }: DTComponentOptions = this._options;
 
     try {
-      items.forEach((item: DYOToolsBunch<IBunchItem>) => {
+      items.forEach((item: DTBunch<IBunchItem>) => {
         this.add(item, targetScope);
       });
     } catch (err: unknown) {
@@ -234,7 +234,7 @@ export default class DYOToolsManager<
    */
   moveToScope(bunchId: string, targetScope: string): void {
     if (!Object.keys(this._items).includes(bunchId)) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'invalid_id',
         'Bunch id provided doesn\'t exist in the manager',
         this,
@@ -247,7 +247,7 @@ export default class DYOToolsManager<
     const { virtualContainer } = bunch.getOptions();
     const { code: errorCode, message: errorMessage } = this.getErrorDataForScope(targetScope, virtualContainer);
     if (errorCode && errorMessage) {
-      this.triggerError(new DYOToolsError(errorCode, errorMessage, this, bunch));
+      this.triggerError(new DTError(errorCode, errorMessage, this, bunch));
       return;
     }
 
@@ -260,7 +260,7 @@ export default class DYOToolsManager<
    * @param id bunch id to return.
    * @returns DYOToolsBunch instance that corresponds to the id provided, or undefined if not found.
    */
-  get(id: string): DYOToolsBunch<IBunchItem> | undefined {
+  get(id: string): DTBunch<IBunchItem> | undefined {
     return this._items[id]?.item ?? undefined;
   }
 
@@ -270,7 +270,7 @@ export default class DYOToolsManager<
    * @param scope Optional parameter **scope** to return only bunches which are affected to a specific scope.
    * @returns DYOToolsBunch array.
    */
-  getAll(scope?: string): DYOToolsBunch<IBunchItem>[] {
+  getAll(scope?: string): DTBunch<IBunchItem>[] {
     const finalItems = [];
     Object.values(this._items).forEach((item: DTManagerItemType<IBunchItem>) => {
       if (!scope || item.scope === scope) {
@@ -294,8 +294,8 @@ export default class DYOToolsManager<
   /**
    * Returns Master component from context, or undefined.
    */
-  getMaster(): DYOToolsMaster | undefined {
-    return this.getContext<DYOToolsMaster>('master');
+  getMaster(): DTMaster | undefined {
+    return this.getContext<DTMaster>('master');
   }
 
   /**
@@ -329,7 +329,7 @@ export default class DYOToolsManager<
           if (libraryDeletion) {
             this._library.remove(item.getId());
           }
-          item.removeContext();
+          item.removeContainer();
         });
 
         this._items[id].item.removeContext();
@@ -375,8 +375,8 @@ export default class DYOToolsManager<
    * @returns Array of DTBunch instance corresponding to the filters. Empty if no filter or invalid ones are passed.
    * @see DYOFinder
    */
-  find(filters: Partial<DTManagerFilters>): DYOToolsBunch<IBunchItem>[] {
-    return this._finder.execute<DYOToolsBunch<IBunchItem>>(filters);
+  find(filters: Partial<DTManagerFilters>): DTBunch<IBunchItem>[] {
+    return this._finder.execute<DTBunch<IBunchItem>>(filters);
   }
 
   /**
@@ -462,4 +462,94 @@ export default class DYOToolsManager<
 
     return response;
   }
+
+  /**
+   * Return DIX Object representation of the DTManager instance.
+   *
+   * @returns DIX Object representation of the DTManager.
+   */
+  toDIXObject(): Record<string, DIXObject> {
+    const parentDixObject = super.toDIXObject();
+    const dixObject: DIXObject = {
+      ...parentDixObject[this._id],
+      items: Object.keys(this._items),
+      library: this._library.getId(),
+    };
+
+    // Library Dix Object
+    // Empty string for options because not relevant
+    const libraryDix: DIXObject = {
+      ...this._library.toDIXObject()[this._library.getId()],
+      options: '',
+    };
+
+    // Add Scopes
+    // Only non default scopes
+    const scopesForDix = this._scopes.filter((sc) => !['default', 'virtual'].includes(sc));
+    if (scopesForDix.length > 0) {
+      dixObject.scopes = scopesForDix;
+    }
+
+    const finalDix = {
+      [this._id]: dixObject,
+      ...this._library.toDIXObject(),
+      [this._library.getId()]: libraryDix,
+    };
+
+    Object.values(this._items).forEach((item) => {
+      const itemDix = item.item.toDIXObject();
+      itemDix[item.item.getId()].scope = item.scope;
+
+      Object.assign(finalDix, {
+        ...itemDix,
+      });
+    });
+
+    return finalDix;
+  }
+
+  /**
+   * Update the DTManager instance with a DIX Object.
+   *
+   * @param dix DIX Object to use for updating.
+   */
+  updateFromDix(dix: Record<string, DIXObject>): void {
+    const dixObject = dix[this._id];
+    const dixModule = this.getMaster()?.getModule('dix') as DTDIXModule;
+
+    if (dixObject && dixModule?.isEnabled()) {
+      // Synchronize Library
+      if (dixObject.library) {
+        this._library = new DTBunch('library', [], { virtualContainer: true, syncId: dixObject.library });
+        this._library.setContext(this);
+        this._library.updateFromDix(dix);
+      }
+
+      // Synchronize Bunches
+      if (dixObject.items) {
+        // Remove items
+        this.getAll().forEach((it) => {
+          if (!dixObject.items.includes(it.getId())) {
+            this.remove(it.getId());
+          }
+        });
+
+        // Add and update existing items
+        dixObject.items.forEach((itemId) => {
+          if (this.get(itemId)) {
+            this.get(itemId).updateFromDix(dix);
+          } else {
+            const newBunch = dixModule.syncNewItem(itemId, dix) as DTBunch<IBunchItem>;
+            this.add(newBunch);
+            newBunch.updateFromDix(dix);
+          }
+          // Move to scope
+          const bunchDixObject = dix[itemId];
+          if (bunchDixObject) {
+            this.moveToScope(itemId, bunchDixObject.scope);
+          }
+        });
+      }
+    }
+  }
 }

package/src/core/DTMaster.ts

@@ -1,11 +1,12 @@
-import DYOToolsComponent from './DTComponent';
-import DYOToolsError from './DTError';
-import DYOToolsManager from './DTManager';
-import DYOToolsAction from './DTAction';
-import DYOToolsModule from './DTModule';
-import { DTMasterToObject } from '../types';
-
-export default class DYOToolsMaster extends DYOToolsComponent {
+import DTComponent from './DTComponent';
+import DTError from './DTError';
+import DTManager from './DTManager';
+import DTAction from './DTAction';
+import DTModule from './DTModule';
+import { DIXObject, DTComponentOptions, DTMasterToObject } from '../types';
+import DTDIXModule from '../libs/dix/DIXModule.module';
+
+export default class DTMaster extends DTComponent {
   /**
    * Defining component type to "master".
    */
@@ -17,7 +18,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * The property is an object with _id value of the Manager instance as key, and Manager instance as value.
    * @protected
    */
-  protected _managers: Record<string, DYOToolsManager>;
+  protected _managers: Record<string, DTManager>;
 
   /**
    * DTAction instances handled by the Master.
@@ -25,7 +26,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * The property is an object with _id value of the Action instance as key, and Action instance as value.
    * @protected
    */
-  protected _actions: Record<string, DYOToolsAction>;
+  protected _actions: Record<string, DTAction>;
 
   /**
    * DTModule instance handled by the Master.
@@ -33,15 +34,16 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * The property is an object with _id value of the Module instance as key, and Module instance as value.
    * @protected
    */
-  protected _modules: Record<string, DYOToolsModule>;
+  protected _modules: Record<string, DTModule>;
 
   /**
    * Applying the parent constructor, and initializing all properties to empty object.
    *
    * @param key
+   * @param options
    */
-  constructor(key?: string) {
-    super(key);
+  constructor(key?: string, options: Partial<DTComponentOptions> = {}) {
+    super(key, options);
 
     this._managers = {};
     this._actions = {};
@@ -58,10 +60,10 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    *
    * @param manager DYOToolsManager instance to add.
    */
-  addManager(manager: DYOToolsManager): void {
+  addManager(manager: DTManager): void {
     // Id conflict
     if (Object.keys(this._managers).includes(manager.getId())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'id_conflict',
         'Manager with same id already exists in the Master instance',
         this,
@@ -72,7 +74,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
 
     // Key conflict
     if (Object.values(this._managers).find((m) => m.getKey() === manager.getKey())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'key_conflict',
         'Manager with same key already exists in the Master instance',
         this,
@@ -82,7 +84,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
     }
 
     this._managers[manager.getId()] = manager;
-    manager.setContext<DYOToolsMaster>(this);
+    manager.setContext<DTMaster>(this);
   }
 
   /**
@@ -92,7 +94,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * @param idOrKey String id or key to select.
    * @returns DYOToolsManager selected Manager instance, or undefined if not found.
    */
-  getManager(idOrKey: string): DYOToolsManager | undefined {
+  getManager(idOrKey: string): DTManager | undefined {
     let managerFound = this._managers[idOrKey];
 
     if (!managerFound) {
@@ -125,10 +127,10 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    *
    * @param action DYOToolsAction instance to add.
    */
-  addAction(action: DYOToolsAction): void {
+  addAction(action: DTAction): void {
     // Id conflict
     if (Object.keys(this._actions).includes(action.getId())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'id_conflict',
         'Action with same id already exists in the Master instance',
         this,
@@ -139,7 +141,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
 
     // Key conflict
     if (Object.values(this._actions).find((m) => m.getKey() === action.getKey())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'key_conflict',
         'Action with same key already exists in the Master instance',
         this,
@@ -149,7 +151,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
     }
 
     this._actions[action.getId()] = action;
-    action.setContext<DYOToolsMaster>(this);
+    action.setContext<DTMaster>(this);
   }
 
   /**
@@ -159,7 +161,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * @param idOrKey String id or key to select.
    * @returns DYOToolsAction selected Action instance, or undefined if not found.
    */
-  getAction(idOrKey: string): DYOToolsAction | undefined {
+  getAction(idOrKey: string): DTAction | undefined {
     let actionFound = this._actions[idOrKey];
 
     if (!actionFound) {
@@ -208,10 +210,10 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    *
    * @param module DYOToolsModule instance to add.
    */
-  addModule(module: DYOToolsModule): void {
+  addModule(module: DTModule): void {
     // Id conflict
     if (Object.keys(this._modules).includes(module.getId())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'id_conflict',
         'Module with same id already exists in the Master instance',
         this,
@@ -222,7 +224,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
 
     // Key conflict
     if (Object.values(this._modules).find((m) => m.getKey() === module.getKey())) {
-      this.triggerError(new DYOToolsError(
+      this.triggerError(new DTError(
         'key_conflict',
         'Module with same key already exists in the Master instance',
         this,
@@ -232,7 +234,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
     }
 
     this._modules[module.getId()] = module;
-    module.setContext<DYOToolsMaster>(this);
+    module.setContext<DTMaster>(this);
   }
 
   /**
@@ -242,7 +244,7 @@ export default class DYOToolsMaster extends DYOToolsComponent {
    * @param idOrKey String id or key to select.
    * @returns DYOToolsModule selected Module instance, or undefined if not found.
    */
-  getModule(idOrKey: string): DYOToolsModule | undefined {
+  getModule(idOrKey: string): DTModule | undefined {
     let moduleFound = this._modules[idOrKey];
 
     if (!moduleFound) {
@@ -315,4 +317,50 @@ export default class DYOToolsMaster extends DYOToolsComponent {
 
     return toObject;
   }
+
+  /**
+   * Return DIX Object representation of the DTManager instance.
+   *
+   * @returns DIX Object representation of the DTManager.
+   */
+  toDIXObject(): Record<string, DIXObject> {
+    const parentDixObject = super.toDIXObject();
+    const dixObject: DIXObject = {
+      ...parentDixObject[this._id],
+      items: Object.keys(this._managers),
+    };
+
+    const finalDix = {
+      [this._id]: dixObject,
+    };
+    Object.values(this._managers).forEach((item) => {
+      Object.assign(finalDix, {
+        ...item.toDIXObject(),
+      });
+    });
+
+    return finalDix;
+  }
+
+  /**
+   * Update the DTMaster instance with a DIX Object.
+   *
+   * @param dix DIX Object to use for updating.
+   */
+  updateFromDix(dix: Record<string, DIXObject>): void {
+    const dixObject = dix[this._id];
+    const dixModule = this.getModule('dix') as DTDIXModule;
+    if (dixObject && dixObject.items && dixModule?.isEnabled()) {
+      // Synchronize Managers
+      dixObject.items.forEach((itemId) => {
+        if (this.getManager(itemId)) {
+          this.getManager(itemId).updateFromDix(dix);
+        } else {
+          const newManager = dixModule.syncNewItem(itemId, dix) as DTManager;
+          this.addManager(newManager);
+          newManager.updateFromDix(dix);
+        }
+      });
+    }
+  }
 }

package/src/core/DTModule.ts

@@ -1,8 +1,8 @@
-import DYOToolsComponent from './DTComponent';
-import { DTModuleToObject } from '../types';
-import DYOToolsMaster from './DTMaster';
+import DTComponent from './DTComponent';
+import { DIXObject, DTModuleToObject } from '../types';
+import DTMaster from './DTMaster';
 
-export default class DYOToolsModule extends DYOToolsComponent {
+export default class DTModule extends DTComponent {
   /**
    * Defining component type to "module".
    */
@@ -28,8 +28,8 @@ export default class DYOToolsModule extends DYOToolsComponent {
   /**
    * Returns Master component from context, or undefined.
    */
-  getMaster(): DYOToolsMaster | undefined {
-    return this.getContext<DYOToolsMaster>('master');
+  getMaster(): DTMaster | undefined {
+    return this.getContext<DTMaster>('master');
   }
 
   /**
@@ -87,4 +87,10 @@ export default class DYOToolsModule extends DYOToolsComponent {
       enabled: this._enabled,
     };
   }
+
+  toDIXObject(): Record<string, DIXObject> {
+    return undefined;
+  }
+
+  updateFromDix(): void {}
 }

package/src/index.ts

@@ -1,17 +1,17 @@
-// All exports
-// CORE
-export { default as DTComponent } from './core/DTComponent';
-export { default as DTComponentWithMeta } from './core/DTComponentWithMeta';
-export { default as DTComponentPhysical } from './core/DTComponentPhysical';
-export { default as DTElement } from './core/DTElement';
-export { default as DTBunch } from './core/DTBunch';
-export { default as DTManager } from './core/DTManager';
-export { default as DTMaster } from './core/DTMaster';
-export { default as DTError } from './core/DTError';
-export { default as DTAction } from './core/DTAction';
-export { default as DTModule } from './core/DTModule';
-
-// LIBS
-// PLAYER
-export { default as DTPlayer } from './libs/player/DTPlayer.element';
-export { default as DTPlayerManager } from './libs/player/DTPlayer.manager';
+// All exports
+// CORE
+export { default as DTComponent } from './core/DTComponent';
+export { default as DTComponentWithMeta } from './core/DTComponentWithMeta';
+export { default as DTComponentPhysical } from './core/DTComponentPhysical';
+export { default as DTElement } from './core/DTElement';
+export { default as DTBunch } from './core/DTBunch';
+export { default as DTManager } from './core/DTManager';
+export { default as DTMaster } from './core/DTMaster';
+export { default as DTError } from './core/DTError';
+export { default as DTAction } from './core/DTAction';
+export { default as DTModule } from './core/DTModule';
+
+// LIBS
+// PLAYER
+export { default as DTPlayer } from './libs/player/DTPlayer.element';
+export { default as DTPlayerManager } from './libs/player/DTPlayer.manager';