dyo-tools 0.2.0 → 0.3.0

package/src/core/DTElement.ts

@@ -1,69 +1,102 @@
-import { DTAcceptedMetaData, DTElementToObject } from '../types';
-import DYOToolsComponentPhysical from './DTComponentPhysical';
-
-export default class DYOToolsElement<
-  IComponentMeta extends DTAcceptedMetaData,
-  > extends DYOToolsComponentPhysical<IComponentMeta> {
-  /**
-   * Defining component type to "element".
-   */
-  protected _componentType = 'element';
-
-  /**
-   * 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.getKey()}`;
-    }
-
-    return `Component ${this._key} - Type: Element${ownerKey}`;
-  }
-}
+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 +1,78 @@
-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;
-  }
-}
+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;
+  }
+}