dyo-tools 0.3.0 → 0.3.2

package/src/core/DTModule.ts

@@ -1,90 +1,90 @@
-import DYOToolsComponent from './DTComponent';
-import { DTModuleToObject } from '../types';
-import DYOToolsMaster from './DTMaster';
-
-export default class DYOToolsModule extends DYOToolsComponent {
-  /**
-   * 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(): DYOToolsMaster | undefined {
-    return this.getContext<DYOToolsMaster>('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,
-    };
-  }
-}
+import DYOToolsComponent from './DTComponent';
+import { DTModuleToObject } from '../types';
+import DYOToolsMaster from './DTMaster';
+
+export default class DYOToolsModule extends DYOToolsComponent {
+  /**
+   * 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(): DYOToolsMaster | undefined {
+    return this.getContext<DYOToolsMaster>('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,
+    };
+  }
+}

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';

package/src/libs/DYOFinder.ts

@@ -1,175 +1,175 @@
-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;
-  }
-}
+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;
+  }
+}

package/src/libs/player/DTPlayer.element.ts

@@ -1,9 +1,9 @@
-import { DTAcceptedMetaData } from '../../types';
-import DYOToolsElement from '../../core/DTElement';
-
-export default class DYOToolsPlayer<IComponentMeta extends DTAcceptedMetaData = DTAcceptedMetaData> extends DYOToolsElement<IComponentMeta> {
-  /**
-   * Defining component domain to "player".
-   */
-  protected _domain = 'player';
-}
+import { DTAcceptedMetaData } from '../../types';
+import DYOToolsElement from '../../core/DTElement';
+
+export default class DYOToolsPlayer<IComponentMeta extends DTAcceptedMetaData = DTAcceptedMetaData> extends DYOToolsElement<IComponentMeta> {
+  /**
+   * Defining component domain to "player".
+   */
+  protected _domain = 'player';
+}