dyo-tools 0.3.2 → 0.4.1

package/src/types/core.ts

@@ -1,169 +0,0 @@
-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/player.ts

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

package/test/core/DTAction.double.ts

@@ -1,78 +0,0 @@
-import {DTAction} from "../../src";
-import {DTComponentToObject} from "../../src/types";
-
-/** ****************** STUB PROPERTIES CONSTANTS
- * Fixed properties to use with double classes, avoid auto generated and easy checking on test
- * **** */
-export const IDTest = 'DTAction-id-1234567';
-export const KeyTest = 'DTAction-key-1234567';
-
-// Specific Manager constants
-export const action1IDTest = `${IDTest}_1`;
-export const action1KeyTest = `${KeyTest}_1`;
-
-export const action1ToObject: DTComponentToObject = {
-  id: action1IDTest,
-  key: action1KeyTest,
-  type: 'action'
-}
-
-/******************** STUB ABSTRACT IMPLEMENTATION
- * Implementation of abstract component class for tests
- * *****/
-export class DTActionImpl extends DTAction<string> {
-  async execute(payload: string): Promise<void> {
-    throw `${this._key} : ${payload}`;
-  }
-}
-
-/** ****************** HELPER TEST CLASS
- * Helper test class, inherits the main component
- * Providing methods to property access and other facilities, in order to avoid using class methods
- * **** */
-export class DTActionTest extends DTActionImpl {
-  th_get_id(): string {
-    return this._id;
-  }
-
-  th_set_id(id: string): void {
-    this._id = id;
-  }
-
-  th_get_key(): string {
-    return this._key;
-  }
-
-  th_set_key(key: string): void {
-    this._key = key;
-  }
-
-  th_get_componentType(): string {
-    return this._componentType;
-  }
-}
-
-
-/** ****************** STUB CLASS
- * Stub class, for using in other component
- * **** */
-export class DTActionStub extends DTActionTest {
-  constructor() {
-    super();
-    this._id = IDTest;
-    this._key = KeyTest;
-    this._errors = [];
-  }
-
-  getId(): string {
-    return IDTest;
-  }
-
-  getKey(): string {
-    return KeyTest;
-  }
-}
-
-/** ****************** HELPER METHODS
- * Additional helper methods to use with testing
- * **** */

package/test/core/DTAction.spec.ts

@@ -1,76 +0,0 @@
-import {DTComponent, DTAction} from "../../src";
-import {mockOverriddenMethods} from "./DTComponent.double";
-import {afterEach, beforeEach, describe, expect, jest, test} from "@jest/globals";
-import {DTActionTest, IDTest, KeyTest} from "./DTAction.double";
-
-/** ****************** MOCK DEPENDENCIES
- * Dependencies used by the component are mocked with Jest
- * **** */
-jest.mock('../../src/core/DTComponent');
-jest.mock('../../src/core/DTError');
-// Add specific mock for inherited methods to have a basic implementation
-mockOverriddenMethods(DTComponent);
-
-/** *********************** TESTS SUITES ****************************** */
-describe('class DYOToolsAction', () => {
-  let actionTest: DTActionTest;
-
-  beforeEach(() => {
-    actionTest = new DTActionTest();
-    actionTest.th_set_id(IDTest);
-    actionTest.th_set_key(KeyTest);
-  });
-
-  afterEach(() => {
-    jest.resetAllMocks();
-  });
-
-  describe('inheritance', () => {
-    test('check good inheritance for class', () => {
-      expect(DTAction.prototype instanceof DTComponent).toBeTruthy();
-    });
-  });
-
-  describe('_componentType', () => {
-    test('componentType must be "action"', () => {
-      expect(actionTest.th_get_componentType()).toBe('action');
-    });
-  });
-
-  describe('getMaster', () => {
-    test('call get context with master accessor', () => {
-      actionTest.getMaster();
-
-      expect((actionTest.getContext as any).mock.calls.length).toBe(1);
-      expect((actionTest.getContext as any).mock.calls[0][0]).toBe('master');
-    });
-  });
-
-  describe('execute', () => {
-    test('throw payload in test implementation', async () => {
-      const payload = `execute action`;
-      const expectedPayload = `${KeyTest} : execute action`;
-
-      await expect(actionTest.execute(payload)).rejects.toBe(expectedPayload);
-    });
-  });
-
-  describe('toString', () => {
-    test('string output standard', () => {
-      const toStringAction = actionTest.toString();
-
-      expect(toStringAction).toBe(`Component ${KeyTest} - Type: Action`);
-    });
-  });
-
-  describe('toObject', () => {
-    test('toObject output standard', () => {
-      const toObjectAction: any = actionTest.toObject();
-
-      expect(Object.keys(toObjectAction)).toStrictEqual(['id', 'key', 'type']);
-      expect(toObjectAction.id).toBe(IDTest);
-      expect(toObjectAction.key).toBe(KeyTest);
-      expect(toObjectAction.type).toBe('action');
-    });
-  });
-});

package/test/core/DTBunch.double.ts

@@ -1,261 +0,0 @@
-import {DTBunch, DTComponent} from '../../src';
-import {bunchDefaultOptions as DTBunchDefaultOptions} from '../../src/constants';
-import {
-  HaileiMetaData,
-  IldressMetaData,
-  IMetaDataTest,
-  MaydenaMetaData,
-  MeldrineMetaData,
-  YssaliaMetaData,
-} from './DTComponentWithMeta.double';
-import DYOToolsElement from '../../src/core/DTElement';
-import {DTBunchOptions, DTElementToObject} from '../../src/types';
-import {
-  HaileiIdTest,
-  HaileiKeyTest,
-  HaileiToObjectTest,
-  IldressIdTest,
-  IldressKeyTest,
-  IldressToObjectTest,
-  MaydenaIdTest,
-  MaydenaKeyTest,
-  MaydenaToObjectTest,
-  MeldrineIdTest,
-  MeldrineKeyTest,
-  MeldrineToObjectTest,
-  YssaliaIdTest,
-  YssaliaKeyTest,
-  YssaliaToObjectTest,
-} from './DTElement.double';
-import {DTErrorStub} from './DTError.double';
-import DYOFinder from '../../src/libs/DYOFinder';
-import Mocked = jest.Mocked;
-
-/** ****************** STUB PROPERTIES CONSTANTS
- * Fixed properties to use with double classes, avoid auto generated and easy checking on test
- * **** */
-// Global Bunch constants
-export const IDTest = 'DTBunch-id-1234567';
-export const IDTestLibrary = 'DTBunch-id-library-1234567';
-export const KeyTest = 'DTBunch-key-1234567';
-export const defaultOptions: DTBunchOptions = DTBunchDefaultOptions;
-
-// Specific Bunch constants
-export const bunch1IdTest = `${IDTest}_1`;
-export const bunch1toObjectTest = {
-  id: bunch1IdTest, key: 'bunch1-key-test', type: 'bunch', items: [HaileiToObjectTest],
-};
-export const bunch2IdTest = `${IDTest}_2`;
-export const bunch2toObjectTest = {
-  id: bunch2IdTest, key: 'bunch2-key-test', type: 'bunch', items: [],
-};
-export const bunch3IdTest = `${IDTest}_3`;
-export const bunch3toObjectTest = {
-  id: bunch3IdTest, key: 'bunch3-key-test', type: 'bunch', items: [],
-};
-
-/** ****************** HELPER TEST CLASS
- * Helper test class, inherits the main component
- * Providing methods to property access and other facilities, in order to avoid using class methods
- * **** */
-export class DTBunchTest extends DTBunch<Mocked<DYOToolsElement<IMetaDataTest>>, IMetaDataTest> {
-  th_get_id(): string {
-    return this._id;
-  }
-
-  th_set_id(id: string): void {
-    this._id = id;
-  }
-
-  th_get_key(): string {
-    return this._key;
-  }
-
-  th_set_key(key: string): void {
-    this._key = key;
-  }
-
-  th_get_componentType(): string {
-    return this._componentType;
-  }
-
-  th_get_context(): DTComponent | undefined {
-    return this._context;
-  }
-
-  th_set_context(context: DTComponent): void {
-    this._context = context;
-  }
-
-  th_get_items(): Mocked<DYOToolsElement<IMetaDataTest>>[] {
-    return this._items;
-  }
-
-  th_set_items(items: Mocked<DYOToolsElement<IMetaDataTest>>[]): void {
-    this._items = items;
-  }
-
-  th_set_errors(errors: Array<DTErrorStub>): void {
-    this._errors = errors;
-  }
-
-  th_get_options(): any {
-    return this._options;
-  }
-
-  th_set_options(options: any): void {
-    this._options = {
-      ...this._options,
-      ...options,
-    };
-  }
-
-  th_get_owner(): string {
-    return this._owner;
-  }
-
-  th_set_owner(owner: string): void {
-    this._owner = owner;
-  }
-
-  th_set_meta(meta: IMetaDataTest): void {
-    this._meta = meta;
-  }
-
-  th_get_finder(): DYOFinder {
-    return this._finder;
-  }
-}
-
-/** ****************** STUB CLASS
- * Stub class, for using in other component
- * **** */
-export class DTBunchStub extends DTBunchTest {
-  constructor(items: Array<Mocked<DYOToolsElement<IMetaDataTest>>> = []) {
-    super();
-    this._id = IDTest;
-    this._key = KeyTest;
-    this._errors = [];
-    this._items = items;
-    this._options = DTBunchDefaultOptions;
-  }
-
-  getId(): string {
-    return IDTest;
-  }
-
-  getKey(): string {
-    return KeyTest;
-  }
-
-  getAll(): Array<Mocked<DYOToolsElement<IMetaDataTest>>> {
-    return this._items;
-  }
-
-  getAllKeys(): string[] {
-    return this._items.map((item: DYOToolsElement<IMetaDataTest>) => item.getKey());
-  }
-}
-
-// Specific Stub Library for Manager
-export class DTBunchStubLibrary extends DTBunchStub {
-  constructor(items: Array<Mocked<DYOToolsElement<IMetaDataTest>>> = []) {
-    super(items);
-    this._id = IDTestLibrary;
-    this._key = 'library';
-    this._errors = [];
-    this._items = items;
-    this._options = {
-      ...DTBunchDefaultOptions,
-      virtualContainer: true,
-    };
-  }
-
-  getId(): string {
-    return IDTestLibrary;
-  }
-
-  getKey(): string {
-    return 'library';
-  }
-
-  get(id: string): Mocked<DYOToolsElement<IMetaDataTest>> | undefined {
-    const itemFiltered = this._items.filter((item: Mocked<DYOToolsElement<IMetaDataTest>>) => item.getId() === id);
-    return itemFiltered.length > 0 ? itemFiltered[0] : undefined;
-  }
-}
-
-/** ****************** HELPER METHODS
- * Additional helper methods to use with testing
- * **** */
-
-// Function to generate Mocked DTElement collection
-// Warning : DYOToolsElement class must be MOCKED to use this !
-export const generateMockedElements = (numberElements: number): Array<Mocked<DYOToolsElement<IMetaDataTest>>> => {
-  const mockedElements = [];
-  const mockedData: Array<{ id: string, key: string, meta: IMetaDataTest, toObject: DTElementToObject<IMetaDataTest> }> = [
-    {
-      id: HaileiIdTest,
-      key: HaileiKeyTest,
-      meta: HaileiMetaData,
-      toObject: HaileiToObjectTest,
-    },
-    {
-      id: MeldrineIdTest,
-      key: MeldrineKeyTest,
-      meta: MeldrineMetaData,
-      toObject: MeldrineToObjectTest,
-    },
-    {
-      id: MaydenaIdTest,
-      key: MaydenaKeyTest,
-      meta: MaydenaMetaData,
-      toObject: MaydenaToObjectTest,
-    },
-    {
-      id: IldressIdTest,
-      key: IldressKeyTest,
-      meta: IldressMetaData,
-      toObject: IldressToObjectTest,
-    },
-    {
-      id: YssaliaIdTest,
-      key: YssaliaKeyTest,
-      meta: YssaliaMetaData,
-      toObject: YssaliaToObjectTest,
-    },
-  ];
-
-  for (let i = 0; i < numberElements; i++) {
-    const mockedElement = new DYOToolsElement() as Mocked<DYOToolsElement<IMetaDataTest>>;
-    const selectedMock = i % 5;
-
-    mockedElement.getId.mockReturnValue(`${mockedData[selectedMock].id}-${i}`);
-    mockedElement.getKey.mockReturnValue(mockedData[selectedMock].key);
-    mockedElement.getManyMeta.mockReturnValue(mockedData[selectedMock].meta);
-    mockedElement.setContext.mockImplementation(function (context) {
-      this._context = context;
-    });
-    mockedElement.getContext.mockImplementation(function () {
-      return this._context;
-    });
-    mockedElement.setOwner.mockImplementation(function (owner) {
-      this._owner = owner;
-    });
-    mockedElement.getOwner.mockImplementation(function () {
-      return this._owner;
-    });
-    mockedElement.setContainer.mockImplementation(function (container) {
-      this._container = container;
-    });
-    mockedElement.getContainer.mockImplementation(function () {
-      return this._container;
-    });
-    mockedElement.copy.mockReturnValue(mockedElement);
-    mockedElement.toObject.mockReturnValue(mockedData[selectedMock].toObject);
-
-    mockedElements.push(mockedElement);
-  }
-
-  return mockedElements;
-};