dyo-tools 0.3.0 → 0.3.2

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

@@ -1,84 +1,84 @@
-import DYOToolsManager from '../../core/DTManager';
-import DYOToolsPlayer from './DTPlayer.element';
-import { DTBunchFilters, DTManagerOptions, DTPlayerManagerSimpleConfiguration } from '../../types';
-import { DTPlayer } from '../../index';
-
-export default class DYOToolsPlayerManager extends DYOToolsManager<DYOToolsPlayer> {
-  /**
-   * Defining component domain to "player".
-   */
-  protected _domain = 'player';
-
-  /**
-   * Applying the parent constructor. The key is **player** by default.
-   *
-   *
-   * The constructor uses a Configuration JSON Object, with following properties :
-   * * **players** : Default player configuration.
-   * If **players** is a number, it generates this number of DTPlayer instances and add it to the library.
-   * If **players** is an array of DTPlayer instances, it adds these to the library.
-   * * **errors** : Set **errors** option of the Manager.
-   *
-   * @param configuration DTPlayerManagerSimpleConfiguration Optional configuration to apply.
-   */
-  constructor(configuration?: DTPlayerManagerSimpleConfiguration) {
-    super('player');
-
-    // Simple Configuration
-    const finalConfig = configuration ?? {};
-    const finalOptions: DTManagerOptions = this._options;
-    if (finalConfig.players) {
-      if (typeof finalConfig.players === 'number' && finalConfig.players > 0) {
-        let i = 1;
-        while (i <= finalConfig.players) {
-          const player = new DTPlayer(`player${i}`);
-          this._library.add(player);
-          i += 1;
-        }
-      } else if (Array.isArray(finalConfig.players)) {
-        this._library.addMany(finalConfig.players);
-      }
-    }
-
-    if (finalConfig.errors) {
-      finalOptions.errors = finalConfig.errors;
-    }
-  }
-
-  /**
-   * Get one DTPlayer instance by id into the library.
-   *
-   * @param id string _id property of the DTPlayer instance to get.
-   */
-  getPlayer(id: string): DYOToolsPlayer {
-    return this._library.get(id);
-  }
-
-  /**
-   * Add one DTPlayer instance into the library.
-   *
-   * @param player DYOToolsPlayer instance to add.
-   */
-  addPlayer(player: DYOToolsPlayer): void {
-    this._library.add(player);
-  }
-
-  /**
-   * Remove one DTPlayer instance by id from the library.
-   *
-   * @param id string _id property of the DTPlayer instance to remove.
-   */
-  removePlayer(id: string): void {
-    this._library.remove(id);
-  }
-
-  /**
-   * Find DTPlayer instances into the Library.
-   *
-   * @see [find](#find) method for search specifications.
-   * @param filters DTBunchFilters filters to apply.
-   */
-  findPlayers(filters: Partial<DTBunchFilters>): DYOToolsPlayer[] {
-    return this._library.find(filters);
-  }
-}
+import DYOToolsManager from '../../core/DTManager';
+import DYOToolsPlayer from './DTPlayer.element';
+import { DTBunchFilters, DTManagerOptions, DTPlayerManagerSimpleConfiguration } from '../../types';
+import { DTPlayer } from '../../index';
+
+export default class DYOToolsPlayerManager extends DYOToolsManager<DYOToolsPlayer> {
+  /**
+   * Defining component domain to "player".
+   */
+  protected _domain = 'player';
+
+  /**
+   * Applying the parent constructor. The key is **player** by default.
+   *
+   *
+   * The constructor uses a Configuration JSON Object, with following properties :
+   * * **players** : Default player configuration.
+   * If **players** is a number, it generates this number of DTPlayer instances and add it to the library.
+   * If **players** is an array of DTPlayer instances, it adds these to the library.
+   * * **errors** : Set **errors** option of the Manager.
+   *
+   * @param configuration DTPlayerManagerSimpleConfiguration Optional configuration to apply.
+   */
+  constructor(configuration?: DTPlayerManagerSimpleConfiguration) {
+    super('player');
+
+    // Simple Configuration
+    const finalConfig = configuration ?? {};
+    const finalOptions: DTManagerOptions = this._options;
+    if (finalConfig.players) {
+      if (typeof finalConfig.players === 'number' && finalConfig.players > 0) {
+        let i = 1;
+        while (i <= finalConfig.players) {
+          const player = new DTPlayer(`player${i}`);
+          this._library.add(player);
+          i += 1;
+        }
+      } else if (Array.isArray(finalConfig.players)) {
+        this._library.addMany(finalConfig.players);
+      }
+    }
+
+    if (finalConfig.errors) {
+      finalOptions.errors = finalConfig.errors;
+    }
+  }
+
+  /**
+   * Get one DTPlayer instance by id into the library.
+   *
+   * @param id string _id property of the DTPlayer instance to get.
+   */
+  getPlayer(id: string): DYOToolsPlayer {
+    return this._library.get(id);
+  }
+
+  /**
+   * Add one DTPlayer instance into the library.
+   *
+   * @param player DYOToolsPlayer instance to add.
+   */
+  addPlayer(player: DYOToolsPlayer): void {
+    this._library.add(player);
+  }
+
+  /**
+   * Remove one DTPlayer instance by id from the library.
+   *
+   * @param id string _id property of the DTPlayer instance to remove.
+   */
+  removePlayer(id: string): void {
+    this._library.remove(id);
+  }
+
+  /**
+   * Find DTPlayer instances into the Library.
+   *
+   * @see [find](#find) method for search specifications.
+   * @param filters DTBunchFilters filters to apply.
+   */
+  findPlayers(filters: Partial<DTBunchFilters>): DYOToolsPlayer[] {
+    return this._library.find(filters);
+  }
+}

package/src/types/core.ts

@@ -1,169 +1,169 @@
-import { DTBunch, DTComponent } from '../index';
-import DYOToolsElement from '../core/DTElement';
-
-/** Constants Enum * */
-export enum FilterOperatorType {
-  EQ = '$eq',
-  IN = '$in',
-  NIN = '$nin',
-  NE = '$ne',
-  LTE = '$lte',
-  GTE = '$gte',
-  CONTAINS = '$contains',
-  NCONTAINS = '$ncontains',
-}
-
-/** Common Types * */
-export type StandardPrimitiveType = string | number | boolean | null | undefined;
-export type StandardPrimitiveTypeWithArray = string | number | boolean | Array<string | number | boolean> | null | undefined;
-
-/** DYO Finder interfaces * */
-export type DYOFinderConfiguration = Record<string, DYOFinderConfigurationProp>;
-export type DYOFinderComponentType = DTComponent & {
-  getAll: () => DTComponent[],
-};
-
-export interface DYOFinderConfigurationPropDefault {
-  operators: FilterOperatorType[],
-  getValue: (item: DTComponent, ctx?: DTComponent) => StandardPrimitiveType,
-  objectSearch: false,
-}
-
-export interface DYOFinderConfigurationPropObjectSearch {
-  operators: FilterOperatorType[],
-  getValue: (item: DTComponent, ctx?: DTComponent) => Record<string, StandardPrimitiveTypeWithArray>,
-  objectSearch: true,
-}
-export type DYOFinderConfigurationProp = DYOFinderConfigurationPropDefault | DYOFinderConfigurationPropObjectSearch;
-
-export interface DYOFinderFilterOperatorBase {
-  [FilterOperatorType.EQ]: StandardPrimitiveType
-  [FilterOperatorType.IN]: Array<StandardPrimitiveType>
-  [FilterOperatorType.NIN]: Array<StandardPrimitiveType>
-  [FilterOperatorType.NE]: StandardPrimitiveType
-}
-export interface DYOFinderFilterOperatorAdvanced {
-  [FilterOperatorType.LTE]: number
-  [FilterOperatorType.GTE]: number
-  [FilterOperatorType.CONTAINS]: StandardPrimitiveType
-  [FilterOperatorType.NCONTAINS]: StandardPrimitiveType
-}
-
-export type DYOFinderFilterOperator = DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced;
-export type DYOFinderFilterOperatorArgument = Partial<DYOFinderFilterOperator | Record<string, Partial<DYOFinderFilterOperator>>>;
-export type DYOFinderFilters = Record<string, DYOFinderFilterOperatorArgument>;
-
-/** DTComponent interfaces * */
-/**
- * DTComponent default options configuration.
- */
-export interface DTComponentOptions {
-  /**
-   * Default *false*. If *true*, no exception is thrown when an error occurred, a new DTError instance is
-   * added to the _errors property array instead. If *false*, throw the exception with a DTError instance.
-   */
-  errors: boolean
-}
-
-export interface DTComponentToObject {
-  id: string
-  key: string
-  type: string
-}
-
-/** DTComponentWithMeta interfaces * */
-export type DTAcceptedMetaData = Record<
-string,
-StandardPrimitiveTypeWithArray
->;
-
-/** DTElement interfaces * */
-export interface DTElementToObject<IComponentMeta> extends DTComponentToObject {
-  owner?: string
-  meta?: Partial<IComponentMeta>
-}
-
-/** DTBunch interfaces * */
-/**
- * DTBunch option configuration.
- */
-export interface DTBunchOptions extends DTComponentOptions {
-  /**
-   * Default *false*. If *true*, an error occurred when adding a new DTElement with the same key of an
-   * existing element into the bunch.
-   */
-  uniqueKey: boolean
-  /**
-   * Default *false*. If *true*, when a new DTElement is added at existing index (using **addAtIndex**
-   * or **addManyAtIndex** method), this component replaces the old one. If *false*, this component is added at the specified
-   * index and other existing component are reindexed with the following index.
-   */
-  replaceIndex: boolean
-  /**
-   * Default *false*. If *true*, when a new DTElement is added, the owner of this element becomes
-   * automatically the current bunch owner.
-   */
-  inheritOwner: boolean
-  /**
-   * Default *false*. If *true*, the container is not changed when a new DTElement is added.
-   * If *false*, when a new DTElement is added, the container of this element becomes automatically the current bunch instance
-   * and the element is removed from the old container Component (if defined).
-   */
-  virtualContainer: boolean
-}
-
-export interface DTBunchToObject<IComponentMeta> extends DTComponentToObject {
-  items: Array<DTElementToObject<DTAcceptedMetaData>>
-  owner?: string
-  meta?: Partial<IComponentMeta>
-}
-
-export interface DTBunchFilters {
-  id: Partial<DYOFinderFilterOperatorBase>
-  key: Partial<DYOFinderFilterOperatorBase>
-  container: Partial<DYOFinderFilterOperatorBase>
-  owner: Partial<DYOFinderFilterOperatorBase>
-  meta: Record<string, Partial<DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced>>
-}
-
-/** DTManager interfaces * */
-export type DTManagerItemsType<IBunchItem extends DYOToolsElement<DTAcceptedMetaData>> = Record<string, DTManagerItemType<IBunchItem>>;
-export type DTManagerItemType<IBunchItem extends DYOToolsElement<DTAcceptedMetaData>> = {
-  scope: string,
-  item: DTBunch<IBunchItem>,
-};
-
-export interface DTManagerFilters extends DYOFinderFilters {
-  id: Partial<DYOFinderFilterOperatorBase>
-  key: Partial<DYOFinderFilterOperatorBase>
-  owner: Partial<DYOFinderFilterOperatorBase>
-  scope: Partial<DYOFinderFilterOperatorBase>
-  meta: Record<string, Partial<DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced>>
-}
-
-/**
- * DTManager option configuration.
- */
-export interface DTManagerOptions extends DTComponentOptions {
-  /**
-   * Default *false*. If *true*, when a bunch instance is removed from the Manager _items, the process performs also
-   * a removal from the Manager Library of all DTElement instances of the bunch.
-   */
-  libraryDeletion: boolean,
-}
-
-export interface DTManagerToObject extends DTComponentToObject {
-  items: Array<DTBunchToObject<DTAcceptedMetaData> & { scope: string }>
-}
-
-/** DTModule interfaces * */
-export interface DTModuleToObject extends DTComponentToObject {
-  enabled: boolean
-}
-
-/** DTMaster interfaces * */
-export interface DTMasterToObject extends DTComponentToObject {
-  managers: Array<DTManagerToObject>,
-  actions: Array<DTComponentToObject>,
-  modules: Array<DTModuleToObject>,
-}
+import { DTBunch, DTComponent } from '../index';
+import DYOToolsElement from '../core/DTElement';
+
+/** Constants Enum * */
+export enum FilterOperatorType {
+  EQ = '$eq',
+  IN = '$in',
+  NIN = '$nin',
+  NE = '$ne',
+  LTE = '$lte',
+  GTE = '$gte',
+  CONTAINS = '$contains',
+  NCONTAINS = '$ncontains',
+}
+
+/** Common Types * */
+export type StandardPrimitiveType = string | number | boolean | null | undefined;
+export type StandardPrimitiveTypeWithArray = string | number | boolean | Array<string | number | boolean> | null | undefined;
+
+/** DYO Finder interfaces * */
+export type DYOFinderConfiguration = Record<string, DYOFinderConfigurationProp>;
+export type DYOFinderComponentType = DTComponent & {
+  getAll: () => DTComponent[],
+};
+
+export interface DYOFinderConfigurationPropDefault {
+  operators: FilterOperatorType[],
+  getValue: (item: DTComponent, ctx?: DTComponent) => StandardPrimitiveType,
+  objectSearch: false,
+}
+
+export interface DYOFinderConfigurationPropObjectSearch {
+  operators: FilterOperatorType[],
+  getValue: (item: DTComponent, ctx?: DTComponent) => Record<string, StandardPrimitiveTypeWithArray>,
+  objectSearch: true,
+}
+export type DYOFinderConfigurationProp = DYOFinderConfigurationPropDefault | DYOFinderConfigurationPropObjectSearch;
+
+export interface DYOFinderFilterOperatorBase {
+  [FilterOperatorType.EQ]: StandardPrimitiveType
+  [FilterOperatorType.IN]: Array<StandardPrimitiveType>
+  [FilterOperatorType.NIN]: Array<StandardPrimitiveType>
+  [FilterOperatorType.NE]: StandardPrimitiveType
+}
+export interface DYOFinderFilterOperatorAdvanced {
+  [FilterOperatorType.LTE]: number
+  [FilterOperatorType.GTE]: number
+  [FilterOperatorType.CONTAINS]: StandardPrimitiveType
+  [FilterOperatorType.NCONTAINS]: StandardPrimitiveType
+}
+
+export type DYOFinderFilterOperator = DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced;
+export type DYOFinderFilterOperatorArgument = Partial<DYOFinderFilterOperator | Record<string, Partial<DYOFinderFilterOperator>>>;
+export type DYOFinderFilters = Record<string, DYOFinderFilterOperatorArgument>;
+
+/** DTComponent interfaces * */
+/**
+ * DTComponent default options configuration.
+ */
+export interface DTComponentOptions {
+  /**
+   * Default *false*. If *true*, no exception is thrown when an error occurred, a new DTError instance is
+   * added to the _errors property array instead. If *false*, throw the exception with a DTError instance.
+   */
+  errors: boolean
+}
+
+export interface DTComponentToObject {
+  id: string
+  key: string
+  type: string
+}
+
+/** DTComponentWithMeta interfaces * */
+export type DTAcceptedMetaData = Record<
+string,
+StandardPrimitiveTypeWithArray
+>;
+
+/** DTElement interfaces * */
+export interface DTElementToObject<IComponentMeta> extends DTComponentToObject {
+  owner?: string
+  meta?: Partial<IComponentMeta>
+}
+
+/** DTBunch interfaces * */
+/**
+ * DTBunch option configuration.
+ */
+export interface DTBunchOptions extends DTComponentOptions {
+  /**
+   * Default *false*. If *true*, an error occurred when adding a new DTElement with the same key of an
+   * existing element into the bunch.
+   */
+  uniqueKey: boolean
+  /**
+   * Default *false*. If *true*, when a new DTElement is added at existing index (using **addAtIndex**
+   * or **addManyAtIndex** method), this component replaces the old one. If *false*, this component is added at the specified
+   * index and other existing component are reindexed with the following index.
+   */
+  replaceIndex: boolean
+  /**
+   * Default *false*. If *true*, when a new DTElement is added, the owner of this element becomes
+   * automatically the current bunch owner.
+   */
+  inheritOwner: boolean
+  /**
+   * Default *false*. If *true*, the container is not changed when a new DTElement is added.
+   * If *false*, when a new DTElement is added, the container of this element becomes automatically the current bunch instance
+   * and the element is removed from the old container Component (if defined).
+   */
+  virtualContainer: boolean
+}
+
+export interface DTBunchToObject<IComponentMeta> extends DTComponentToObject {
+  items: Array<DTElementToObject<DTAcceptedMetaData>>
+  owner?: string
+  meta?: Partial<IComponentMeta>
+}
+
+export interface DTBunchFilters {
+  id: Partial<DYOFinderFilterOperatorBase>
+  key: Partial<DYOFinderFilterOperatorBase>
+  container: Partial<DYOFinderFilterOperatorBase>
+  owner: Partial<DYOFinderFilterOperatorBase>
+  meta: Record<string, Partial<DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced>>
+}
+
+/** DTManager interfaces * */
+export type DTManagerItemsType<IBunchItem extends DYOToolsElement<DTAcceptedMetaData>> = Record<string, DTManagerItemType<IBunchItem>>;
+export type DTManagerItemType<IBunchItem extends DYOToolsElement<DTAcceptedMetaData>> = {
+  scope: string,
+  item: DTBunch<IBunchItem>,
+};
+
+export interface DTManagerFilters extends DYOFinderFilters {
+  id: Partial<DYOFinderFilterOperatorBase>
+  key: Partial<DYOFinderFilterOperatorBase>
+  owner: Partial<DYOFinderFilterOperatorBase>
+  scope: Partial<DYOFinderFilterOperatorBase>
+  meta: Record<string, Partial<DYOFinderFilterOperatorBase & DYOFinderFilterOperatorAdvanced>>
+}
+
+/**
+ * DTManager option configuration.
+ */
+export interface DTManagerOptions extends DTComponentOptions {
+  /**
+   * Default *false*. If *true*, when a bunch instance is removed from the Manager _items, the process performs also
+   * a removal from the Manager Library of all DTElement instances of the bunch.
+   */
+  libraryDeletion: boolean,
+}
+
+export interface DTManagerToObject extends DTComponentToObject {
+  items: Array<DTBunchToObject<DTAcceptedMetaData> & { scope: string }>
+}
+
+/** DTModule interfaces * */
+export interface DTModuleToObject extends DTComponentToObject {
+  enabled: boolean
+}
+
+/** DTMaster interfaces * */
+export interface DTMasterToObject extends DTComponentToObject {
+  managers: Array<DTManagerToObject>,
+  actions: Array<DTComponentToObject>,
+  modules: Array<DTModuleToObject>,
+}

package/src/types/index.ts

@@ -1,2 +1,2 @@
-export * from './core';
-export * from './player';
+export * from './core';
+export * from './player';

package/src/types/player.ts

@@ -1,6 +1,6 @@
-import { DTPlayer } from '../index';
-
-export interface DTPlayerManagerSimpleConfiguration {
-  players?: number | DTPlayer[];
-  errors?: boolean;
-}
+import { DTPlayer } from '../index';
+
+export interface DTPlayerManagerSimpleConfiguration {
+  players?: number | DTPlayer[];
+  errors?: boolean;
+}

package/test/core/DTBunch.spec.ts

@@ -532,6 +532,19 @@ describe('class DYOToolsBunch', () => {
 
       expect((managerTest.th_get_library().add as any).mock.calls.length).toBe(0);
     });
+
+    test('manager context - not add item into the manager if the caller is the library', () => {
+      const managerTest = new DTManagerStub();
+      jest.spyOn(bunchTest, 'getContext').mockImplementation(
+        (contextType) => contextType === 'manager' && managerTest,
+      );
+      jest.spyOn(managerTest, 'getLibrary').mockImplementation(() => managerTest.th_get_library());
+      jest.spyOn(managerTest.th_get_library(), 'add');
+
+      managerTest.th_get_library().addAtIndex(objectToAdd, 5);
+
+      expect((managerTest.th_get_library().add as any).mock.calls.length).toBe(0);
+    });
   });
 
   describe('add()', () => {