dyo-tools 0.3.2 → 0.4.1

package/src/core/DTComponentPhysical.ts

@@ -1,54 +0,0 @@
-import { DTAcceptedMetaData, DTComponentOptions } from '../types';
-import DYOToolsComponentWithMeta from './DTComponentWithMeta';
-import DYOToolsMaster from './DTMaster';
-import DYOToolsManager from "./DTManager";
-
-export default abstract class DYOToolsComponentPhysical<
-  IComponentMeta extends DTAcceptedMetaData,
-  IComponentOptions extends DTComponentOptions = DTComponentOptions,
-  > extends DYOToolsComponentWithMeta<IComponentMeta, IComponentOptions> {
-  /**
-   * Owner string representation, if defined.
-   */
-  protected _owner?: string;
-
-  /**
-   * Returns Manager component from context, or undefined.
-   */
-  getManager(): DYOToolsManager | undefined {
-    return this.getContext<DYOToolsManager>('manager');
-  }
-
-  /**
-   * Returns Master component from context, or undefined.
-   */
-  getMaster(): DYOToolsMaster | undefined {
-    return this.getContext<DYOToolsMaster>('master');
-  }
-
-  /**
-   * Getter for _owner property.
-   */
-  getOwner(): string {
-    return this._owner;
-  }
-
-  /**
-   * Setter for _owner property.
-   */
-  setOwner(value: string): void {
-    this._owner = value;
-  }
-
-  /**
-   * Remove the current owner of element.
-   */
-  removeOwner(): void {
-    this._owner = undefined;
-  }
-
-  /**
-   * Abstract method for copying the Component and returning it.
-   */
-  abstract copy(): DYOToolsComponentPhysical<IComponentMeta, IComponentOptions>;
-}

package/src/core/DTComponentWithMeta.ts

@@ -1,65 +0,0 @@
-import DYOToolsComponent from './DTComponent';
-import { DTAcceptedMetaData, DTComponentOptions } from '../types';
-
-export default abstract class DYOToolsComponentWithMeta<
-  IComponentMeta extends DTAcceptedMetaData,
-  IComponentOptions extends DTComponentOptions = DTComponentOptions,
-  > extends DYOToolsComponent<IComponentOptions> {
-  /**
-   * Component meta data.
-   * Defined by generic type IComponentMeta.
-   * @default {}
-   */
-  protected _meta : Partial<IComponentMeta> = {} as Partial<IComponentMeta>;
-
-  /**
-   * Getter for one meta by key.
-   *
-   * @param metaKey Key name of one meta data.
-   *
-   * @returns Associated meta **metaKey** value or undefined if not found.
-   */
-  getMeta<K extends keyof IComponentMeta>(metaKey : K) : IComponentMeta[K] | undefined {
-    return this._meta && this._meta[metaKey];
-  }
-
-  /**
-   * Setter for one meta by key.
-   *
-   * @param metaKey Key name of the meta data to update.
-   * @param metaValue New value to set into the meta data.
-   */
-  setMeta<K extends keyof IComponentMeta>(metaKey : K, metaValue : IComponentMeta[K]) : void {
-    this._meta[metaKey] = metaValue;
-  }
-
-  /**
-   * Returns multiple defined keys values of meta data.
-   *
-   * @param metaKeys Array of keys to filter for meta data. If not provided or empty, returns all keys.
-   *
-   * @returns Meta data object with **metaKeys** provided keys only.
-   */
-  getManyMeta(metaKeys : Array<keyof IComponentMeta> = []) : Partial<IComponentMeta> {
-    const arrayMeta: Partial<IComponentMeta> = {} as Partial<IComponentMeta>;
-    if (!metaKeys.length) {
-      return this._meta;
-    }
-
-    metaKeys.forEach((key) => {
-      if (this._meta && this._meta[key]) {
-        arrayMeta[key] = this._meta[key];
-      }
-    });
-    return arrayMeta;
-  }
-
-  /**
-   * Set multiple meta data.
-   *
-   * @param metaValues Object of meta data to set, according to the meta data property type.
-   */
-  setManyMeta(metaValues : Partial<IComponentMeta>) : void {
-    this._meta = { ...this._meta, ...metaValues };
-  }
-}

package/src/core/DTElement.ts

@@ -1,102 +0,0 @@
-import { DTAcceptedMetaData, DTElementToObject } from '../types';
-import DYOToolsComponentPhysical from './DTComponentPhysical';
-import DYOToolsBunch from './DTBunch';
-
-export default class DYOToolsElement<
-  IComponentMeta extends DTAcceptedMetaData,
-  > extends DYOToolsComponentPhysical<IComponentMeta> {
-  /**
-   * Defining component type to "element".
-   */
-  protected _componentType = 'element';
-
-  /**
-   * Component current **Container**.
-   *
-   * A container is a parent component which "contains" the current instance.
-   * **Context** and **container** are different components, with different purpose.
-   * For DYOToolsElement instances, a container is a DYOToolsBunch instance.
-   * @protected
-   */
-  protected _container: DYOToolsBunch;
-
-  /**
-   * Getter for _container property.
-   */
-  getContainer(): DYOToolsBunch | undefined {
-    return this._container;
-  }
-
-  /**
-   * Setter for _container property.
-   */
-  setContainer(container: DYOToolsBunch): void {
-    this._container = container;
-  }
-
-  /**
-   * Remove the current container of Element instance.
-   */
-  removeContainer(): void {
-    this._container = undefined;
-  }
-
-  /**
-   * Create and return a new DTElement instance by applying from current instance :
-   * - Copy _key property
-   * - Copy _meta property
-   *
-   * @returns New DTElement instance copied.
-   */
-  copy(): DYOToolsElement<IComponentMeta> {
-    const copyElement = new DYOToolsElement<IComponentMeta>(this._key, this._options);
-    copyElement.setManyMeta({ ...this.getManyMeta() });
-
-    return copyElement;
-  }
-
-  /**
-   * Return JSON Object representation of the Element instance.
-   *
-   * JSON Object returned has the following structure :
-   * * **id** : _id property of the Element.
-   * * **key** : _key property of the Element.
-   * * **type** : _componentType property of the Element.
-   * * **owner** : String representation of the current _owner property of the Element (only if defined).
-   * * **meta** : JSON Object of all current metadata in _meta property of the Element (only if not empty).
-   *
-   * @returns JSON Object representation of the Element.
-   */
-  toObject(): DTElementToObject<IComponentMeta> {
-    const objectElement: DTElementToObject<IComponentMeta> = {
-      id: this._id,
-      key: this._key,
-      type: this._componentType,
-    };
-
-    if (this._owner) {
-      objectElement.owner = this._owner.toString();
-    }
-
-    if (this._meta && Object.keys(this._meta).length > 0) {
-      objectElement.meta = { ...this.getManyMeta() };
-    }
-
-    return objectElement;
-  }
-
-  /**
-   * Return String representation of the Element instance.
-   *
-   * @returns String representation of the Element.
-   */
-  toString(): string {
-    let ownerKey = '';
-    if (this._owner) {
-      ownerKey = ` - Owner: ${this._owner}`;
-    }
-    const domainLabel = this._domain ? ` ${this._domain}` : '';
-
-    return `Component${domainLabel} ${this._key} - Type: Element${ownerKey}`;
-  }
-}

package/src/core/DTError.ts

@@ -1,78 +0,0 @@
-import DYOToolsComponent from './DTComponent';
-
-export default class DYOToolsError extends Error {
-  /**
-   * Error code.
-   *
-   * Available error codes are :
-   * * **id_conflict** : _id property conflict between two DTComponent in the same context.
-   * * **key_conflict** : _key property conflict between two DTComponent in the same context.
-   */
-  protected code: string;
-
-  /**
-   * Error trigger date.
-   */
-  protected timestamp: Date;
-
-  /**
-   * DTComponent which trigger the error during its current execution process.
-   */
-  protected initiator?: DYOToolsComponent;
-
-  /**
-   * DTComponent which is directly involved in the error trigger.
-   */
-  protected convicted?: DYOToolsComponent;
-
-  /**
-   * Set all property for a new DTError.
-   *
-   * @param code
-   * @param message
-   * @param initiator
-   * @param convicted
-   */
-  constructor(code: string, message: string, initiator?: DYOToolsComponent, convicted?: DYOToolsComponent) {
-    super(message);
-    this.code = code;
-    this.timestamp = new Date();
-    this.initiator = initiator;
-    this.convicted = convicted;
-  }
-
-  /**
-   * Getter for code property.
-   */
-  getCode(): string {
-    return this.code;
-  }
-
-  /**
-   * Getter for message property (inherited from Error).
-   */
-  getMessage(): string {
-    return this.message;
-  }
-
-  /**
-   * Getter for timestamp property.
-   */
-  getTimestamp(): Date {
-    return this.timestamp;
-  }
-
-  /**
-   * Getter for initiator property.
-   */
-  getInitiator(): DYOToolsComponent {
-    return this.initiator;
-  }
-
-  /**
-   * Getter for convicted property.
-   */
-  getConvicted(): DYOToolsComponent {
-    return this.convicted;
-  }
-}