dyo-tools 0.4.0 → 0.4.1

package/src/core/DTMaster.ts

@@ -1,366 +0,0 @@
-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".
-   */
-  protected _componentType: string = 'master';
-
-  /**
-   * DTManager instances handled by the Master.
-   *
-   * The property is an object with _id value of the Manager instance as key, and Manager instance as value.
-   * @protected
-   */
-  protected _managers: Record<string, DTManager>;
-
-  /**
-   * DTAction instances handled by the Master.
-   *
-   * The property is an object with _id value of the Action instance as key, and Action instance as value.
-   * @protected
-   */
-  protected _actions: Record<string, DTAction>;
-
-  /**
-   * DTModule instance handled by the Master.
-   *
-   * The property is an object with _id value of the Module instance as key, and Module instance as value.
-   * @protected
-   */
-  protected _modules: Record<string, DTModule>;
-
-  /**
-   * Applying the parent constructor, and initializing all properties to empty object.
-   *
-   * @param key
-   * @param options
-   */
-  constructor(key?: string, options: Partial<DTComponentOptions> = {}) {
-    super(key, options);
-
-    this._managers = {};
-    this._actions = {};
-    this._modules = {};
-  }
-
-  /**
-   * Add a DTManager **item** into _managers property.
-   *
-   * The adding process has the following specifications :
-   * * If the added manager has the same _id than existing manager, an error occurred (depending on **errors** option).
-   * * If the added manager has the same _key than existing manager, an error occurred (depending on **errors** option).
-   * * The Master instance becomes the new context of the added item.
-   *
-   * @param manager DYOToolsManager instance to add.
-   */
-  addManager(manager: DTManager): void {
-    // Id conflict
-    if (Object.keys(this._managers).includes(manager.getId())) {
-      this.triggerError(new DTError(
-        'id_conflict',
-        'Manager with same id already exists in the Master instance',
-        this,
-        manager,
-      ));
-      return;
-    }
-
-    // Key conflict
-    if (Object.values(this._managers).find((m) => m.getKey() === manager.getKey())) {
-      this.triggerError(new DTError(
-        'key_conflict',
-        'Manager with same key already exists in the Master instance',
-        this,
-        manager,
-      ));
-      return;
-    }
-
-    this._managers[manager.getId()] = manager;
-    manager.setContext<DTMaster>(this);
-  }
-
-  /**
-   * Return one DTManager instance handled by the Master.
-   * It could be selected by _id or _key property of the Manager.
-   *
-   * @param idOrKey String id or key to select.
-   * @returns DYOToolsManager selected Manager instance, or undefined if not found.
-   */
-  getManager(idOrKey: string): DTManager | undefined {
-    let managerFound = this._managers[idOrKey];
-
-    if (!managerFound) {
-      managerFound = Object.values(this._managers).find((m) => m.getKey() === idOrKey);
-    }
-
-    return managerFound;
-  }
-
-  /**
-   * Remove a handled Manager from the Master instance.
-   *
-   * @param idOrKey String id or key to select.
-   */
-  removeManager(idOrKey: string): void {
-    const manager = this.getManager(idOrKey);
-
-    if (manager) {
-      delete this._managers[manager.getId()];
-    }
-  }
-
-  /**
-   * Add a DTAction **item** into _actions property.
-   *
-   * The adding process has the following specifications :
-   * * If the added action has the same _id than existing action, an error occurred (depending on **errors** option).
-   * * If the added action has the same _key than existing action, an error occurred (depending on **errors** option).
-   * * The Master instance becomes the new context of the added item.
-   *
-   * @param action DYOToolsAction instance to add.
-   */
-  addAction(action: DTAction): void {
-    // Id conflict
-    if (Object.keys(this._actions).includes(action.getId())) {
-      this.triggerError(new DTError(
-        'id_conflict',
-        'Action with same id already exists in the Master instance',
-        this,
-        action,
-      ));
-      return;
-    }
-
-    // Key conflict
-    if (Object.values(this._actions).find((m) => m.getKey() === action.getKey())) {
-      this.triggerError(new DTError(
-        'key_conflict',
-        'Action with same key already exists in the Master instance',
-        this,
-        action,
-      ));
-      return;
-    }
-
-    this._actions[action.getId()] = action;
-    action.setContext<DTMaster>(this);
-  }
-
-  /**
-   * Return one DTAction instance handled by the Master.
-   * It could be selected by _id or _key property of the Action.
-   *
-   * @param idOrKey String id or key to select.
-   * @returns DYOToolsAction selected Action instance, or undefined if not found.
-   */
-  getAction(idOrKey: string): DTAction | undefined {
-    let actionFound = this._actions[idOrKey];
-
-    if (!actionFound) {
-      actionFound = Object.values(this._actions).find((a) => a.getKey() === idOrKey);
-    }
-
-    return actionFound;
-  }
-
-  /**
-   * Remove a handled Action from the Master instance.
-   *
-   * @param idOrKey String id or key to select.
-   */
-  removeAction(idOrKey: string): void {
-    const action = this.getAction(idOrKey);
-
-    if (action) {
-      delete this._actions[action.getId()];
-    }
-  }
-
-  /**
-   * Trigger the **execute** process of an action handled by the Master instance.
-   * It could be selected by _id or _key property of the Action.
-   *
-   * @param idOrKey String id or key to select.
-   * @param payload Object payload for the action execution.
-   * @returns Promise action execution.
-   */
-  async executeAction(idOrKey: string, payload: unknown): Promise<void> {
-    const action = this.getAction(idOrKey);
-
-    if (action) {
-      await this.getAction(idOrKey).execute(payload);
-    }
-  }
-
-  /**
-   * Add a DTModule **item** into _modules property.
-   *
-   * The adding process has the following specifications :
-   * * If the added module has the same _id than existing module, an error occurred (depending on **errors** option).
-   * * If the added module has the same _key than existing module, an error occurred (depending on **errors** option).
-   * * The Master instance becomes the new context of the added item.
-   *
-   * @param module DYOToolsModule instance to add.
-   */
-  addModule(module: DTModule): void {
-    // Id conflict
-    if (Object.keys(this._modules).includes(module.getId())) {
-      this.triggerError(new DTError(
-        'id_conflict',
-        'Module with same id already exists in the Master instance',
-        this,
-        module,
-      ));
-      return;
-    }
-
-    // Key conflict
-    if (Object.values(this._modules).find((m) => m.getKey() === module.getKey())) {
-      this.triggerError(new DTError(
-        'key_conflict',
-        'Module with same key already exists in the Master instance',
-        this,
-        module,
-      ));
-      return;
-    }
-
-    this._modules[module.getId()] = module;
-    module.setContext<DTMaster>(this);
-  }
-
-  /**
-   * Return one DTModule instance handled by the Master.
-   * It could be selected by _id or _key property of the Module.
-   *
-   * @param idOrKey String id or key to select.
-   * @returns DYOToolsModule selected Module instance, or undefined if not found.
-   */
-  getModule(idOrKey: string): DTModule | undefined {
-    let moduleFound = this._modules[idOrKey];
-
-    if (!moduleFound) {
-      moduleFound = Object.values(this._modules).find((m) => m.getKey() === idOrKey);
-    }
-
-    return moduleFound;
-  }
-
-  /**
-   * Remove a handled Module from the Master instance.
-   *
-   * @param idOrKey String id or key to select.
-   */
-  removeModule(idOrKey: string): void {
-    const module = this.getModule(idOrKey);
-
-    if (module) {
-      delete this._modules[module.getId()];
-    }
-  }
-
-  /**
-   * Return String representation of the Master instance.
-   *
-   * @returns String representation of the Master.
-   */
-  toString(): string {
-    const managersLabel = `Managers: ${Object.keys(this._managers).length}`;
-    const actionsLabel = `Actions: ${Object.keys(this._actions).length}`;
-    const modulesLabel = `Modules: ${Object.keys(this._modules).length}`;
-
-    return `Component ${this._key} - Type: Master - ${managersLabel} - ${actionsLabel} - ${modulesLabel}`;
-  }
-
-  /**
-   * Return JSON Object representation of the Master instance.
-   *
-   * JSON Object returned has the following structure :
-   * * **id** : _id property of the Master.
-   * * **key** : _key property of the Master.
-   * * **type** : _componentType property of the Master.
-   * * **managers** : Array of JSON Object representation for each DTManager instance in _managers property of the Master.
-   * * **actions** : Array of JSON Object representation for each DTAction instance in _actions property of the Master.
-   * * **modules** : Array of JSON Object representation for each DTModule instance in _modules property of the Master.
-   *
-   * @returns JSON Object representation of the Master.
-   */
-  toObject(): DTMasterToObject {
-    const toObject: DTMasterToObject = {
-      id: this._id,
-      key: this._key,
-      type: this._componentType,
-      managers: [],
-      actions: [],
-      modules: [],
-    };
-
-    if (Object.keys(this._managers).length) {
-      toObject.managers = Object.values(this._managers).map((obj) => obj.toObject());
-    }
-
-    if (Object.keys(this._actions).length) {
-      toObject.actions = Object.values(this._actions).map((obj) => obj.toObject());
-    }
-
-    if (Object.keys(this._modules).length) {
-      toObject.modules = Object.values(this._modules).map((obj) => obj.toObject());
-    }
-
-    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,96 +0,0 @@
-import DTComponent from './DTComponent';
-import { DIXObject, DTModuleToObject } from '../types';
-import DTMaster from './DTMaster';
-
-export default class DTModule extends DTComponent {
-  /**
-   * Defining component type to "module".
-   */
-  protected _componentType: string = 'module';
-
-  /**
-   * Defining if the module is enabled or not.
-   * @protected
-   */
-  protected _enabled: boolean;
-
-  /**
-   * Applying the parent constructor, and initializing _enabled property to true by default.
-   *
-   * @param key
-   */
-  constructor(key?: string) {
-    super(key);
-
-    this._enabled = true;
-  }
-
-  /**
-   * Returns Master component from context, or undefined.
-   */
-  getMaster(): DTMaster | undefined {
-    return this.getContext<DTMaster>('master');
-  }
-
-  /**
-   * Getter for the _enabled property.
-   */
-  isEnabled(): boolean {
-    return this._enabled;
-  }
-
-  /**
-   * Change _enabled property to true.
-   */
-  enable(): void {
-    this._enabled = true;
-  }
-
-  /**
-   * Change _enabled property to false.
-   */
-  disable(): void {
-    this._enabled = false;
-  }
-
-  /**
-   * Return String representation of the Module instance.
-   *
-   * @returns String representation of the Module.
-   */
-  toString(): string {
-    let extraLabel: string = '';
-
-    if (!this._enabled) {
-      extraLabel = ' - Disabled';
-    }
-
-    return `Component ${this._key} - Type: Module${extraLabel}`;
-  }
-
-  /**
-   * Return JSON Object representation of the Module instance.
-   *
-   * JSON Object returned has the following structure :
-   * * **id** : _id property of the Module.
-   * * **key** : _key property of the Module.
-   * * **type** : _componentType property of the Module.
-   * * **enabled** : _enabled property of the Module.
-   *
-   * @returns JSON Object representation of the Module.
-   */
-  toObject(): DTModuleToObject {
-    return {
-      id: this._id,
-      key: this._key,
-      type: this._componentType,
-      enabled: this._enabled,
-    };
-  }
-
-  toDIXObject(): Record<string, DIXObject> {
-    return undefined;
-  }
-
-  updateFromDix(): void {}
-}

package/src/index.ts

@@ -1,17 +0,0 @@
-// 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';

package/src/libs/DYOFinder.ts

@@ -1,175 +0,0 @@
-import {
-  DYOFinderComponentType,
-  DYOFinderConfiguration,
-  DYOFinderFilterOperator,
-  DYOFinderFilters,
-  FilterOperatorType,
-  StandardPrimitiveType,
-  StandardPrimitiveTypeWithArray,
-} from '../types';
-
-export default class DYOFinder {
-  /**
-   * Current DTComponent associated to the Finder.
-   */
-  protected _component: DYOFinderComponentType;
-
-  /**
-   * Current DYOFinder configuration applied.
-   */
-  protected _configuration: DYOFinderConfiguration;
-
-  /**
-   * Set _component and _configuration properties.
-   *
-   * @param component
-   * @param configuration
-   */
-  constructor(component: DYOFinderComponentType, configuration: DYOFinderConfiguration) {
-    this._component = component;
-    this._configuration = configuration;
-  }
-
-  /**
-   * Getter for _component property.
-   */
-  getComponent(): DYOFinderComponentType {
-    return this._component;
-  }
-
-  /**
-   * Return an array of DTComponent from *_component* **_items** property filtered with a **filters** argument.
-   *
-   * Search filters can be applied on properties depending on the current _configuration provided.
-   *
-   * For each search filter provided, an object of specific operators is applied :
-   * * **BASIC OPERATORS**
-   * * **$eq** : The property must be strict equal to the filter value.
-   * * **$in** : The property must be included into the filter array.
-   * * **$nin** : The property must not be included into the filter array.
-   * * **$ne** : The property must be different to the filter value.
-   * * **EXTENDED OPERATORS** (meta only)
-   * * **$lte** : Number property only. The property must be lower or equal than the filter value.
-   * * **$gte** : Number property only. The property must be higher or equal than the filter array.
-   * * **$contains** : Array property only. The property must contain the filter value.
-   * * **$ncontains** : Array property only. The property must not contain the filter value.
-   *
-   * If many operators and / or many properties are passed into the **filters** argument, the logic operator applied is
-   * **AND**.
-   *
-   * @param filters Filters Object. The format is :
-   * { [property_1] : { [operator_1] : filter_value, [operator_2] : filter_value_2, ... }, [property_2] : { ... }, ... }
-   *
-   * For **objectSearch** properties, you have to pass the object key before the operator :
-   * { [property_1]: { [object_key1] : { [operator_1] : filter_value_1, ... }, [object_key2] : { ... }, ...  }, ... }
-   * @returns Array of DTComponent instance corresponding to the filters. Empty if no filter or invalid ones are passed.
-   */
-  execute<ITEM>(filters: DYOFinderFilters): ITEM[] {
-    const items = this._component.getAll();
-    const filteredItems = [];
-
-    for (const item of items) {
-      let validItem = !!(Object.keys(filters).length);
-
-      for (const [propKey, configProp] of Object.entries(this._configuration)) {
-        if (filters[propKey]) {
-          if (configProp.objectSearch) {
-            const objectValue = configProp.getValue(item, this.getComponent());
-            if (objectValue) {
-              for (const [filterK, filterV] of Object.entries(filters[propKey])) {
-                const metaValue = Object.prototype.hasOwnProperty.call(objectValue, filterK) ? objectValue[filterK] : undefined;
-                if (!this.checkAllValidFiltersForProp(metaValue, filterV, configProp.operators)) {
-                  validItem = false;
-                  break;
-                }
-              }
-            } else {
-              validItem = false;
-            }
-          } else if (!this.checkAllValidFiltersForProp(
-            (configProp.getValue(item, this.getComponent()) as StandardPrimitiveType),
-            filters[propKey],
-            configProp.operators,
-          )) {
-            validItem = false;
-          }
-        }
-      }
-
-      if (validItem) {
-        filteredItems.push(item);
-      }
-    }
-
-    return filteredItems;
-  }
-
-  private checkAllValidFiltersForProp = (
-    itemProp: StandardPrimitiveTypeWithArray,
-    operators: Partial<DYOFinderFilterOperator>,
-    validOperators: FilterOperatorType[],
-  ) => {
-    if (Object.keys(operators).length) {
-      for (const operator of Object.keys(operators)) {
-        if (!validOperators.includes(operator as FilterOperatorType)
-          || !this.validFiltersForItem(itemProp, operators[operator], operator as FilterOperatorType)) {
-          return false;
-        }
-      }
-      return true;
-    }
-    return false;
-  };
-
-  private validFiltersForItem(
-    itemProp: StandardPrimitiveTypeWithArray,
-    filter: StandardPrimitiveTypeWithArray,
-    operator: FilterOperatorType,
-  ): boolean {
-    // $eq Filter
-    if (operator === FilterOperatorType.EQ) {
-      return itemProp === filter;
-    }
-    // $in Filter
-    if (operator === FilterOperatorType.IN) {
-      return filter ? (filter as Array<StandardPrimitiveType>).includes(itemProp as StandardPrimitiveType) : false;
-    }
-    // $nin Filter
-    if (operator === FilterOperatorType.NIN) {
-      return filter ? !(filter as Array<StandardPrimitiveType>).includes(itemProp as StandardPrimitiveType) : false;
-    }
-    // $ne Filter
-    /* c8 ignore next */
-    if (operator === FilterOperatorType.NE) {
-      return itemProp !== filter;
-    }
-    // $lte Filter
-    if (operator === FilterOperatorType.LTE) {
-      if (typeof itemProp === 'number' && typeof filter === 'number') {
-        return itemProp <= filter;
-      }
-      return false;
-    }
-    // $gte Filter
-    if (operator === FilterOperatorType.GTE) {
-      if (typeof itemProp === 'number' && typeof filter === 'number') {
-        return itemProp >= filter;
-      }
-      return false;
-    }
-    // $contains Filter
-    if (operator === FilterOperatorType.CONTAINS) {
-      return (itemProp && Array.isArray(itemProp))
-        ? (itemProp as Array<StandardPrimitiveType>).includes(filter as StandardPrimitiveType)
-        : false;
-    }
-    // $ncontains Filter
-    if (operator === FilterOperatorType.NCONTAINS) {
-      return (itemProp && Array.isArray(itemProp))
-        ? !(itemProp as Array<StandardPrimitiveType>).includes(filter as StandardPrimitiveType)
-        : false;
-    }
-
-    return false;
-  }
-}