@futdevpro/fsm-dynamo 1.16.27 → 1.16.29

package/src/_models/data-models/metadata.data-model.spec.ts

@@ -1,184 +1,184 @@
-import { DyFM_Metadata } from './metadata.data-model';
-
-describe('| DyFM_Metadata', (): void => {
-  it('| should create an instance without initial data', (): void => {
-    const instance = new DyFM_Metadata();
-    expect(instance).toBeTruthy();
-    expect(instance.__created).toBeInstanceOf(Date);
-    expect(instance.__lastModified).toBeInstanceOf(Date);
-    expect(instance.__v).toBe(0);
-  });
-
-  it('| should create an instance with initial data', (): void => {
-    const initialData: DyFM_Metadata = {
-      _id: 'test-id',
-      __created: new Date('2023-01-01'),
-      __createdBy: 'user1',
-      __lastModified: new Date('2023-01-02'),
-      __lastModifiedBy: 'user2',
-      __v: 1
-    };
-    const instance = new DyFM_Metadata(initialData);
-
-    expect(instance._id).toBe('test-id');
-    expect(instance.__created).toEqual(new Date('2023-01-01'));
-    expect(instance.__createdBy).toBe('user1');
-    expect(instance.__lastModified).toEqual(new Date('2023-01-02'));
-    expect(instance.__lastModifiedBy).toBe('user2');
-    expect(instance.__v).toBe(1);
-  });
-
-  it('| should set default values when not provided', (): void => {
-    const instance = new DyFM_Metadata({});
-
-    expect(instance.__created).toBeInstanceOf(Date);
-    expect(instance.__lastModified).toBeInstanceOf(Date);
-    expect(instance.__v).toBe(0);
-  });
-
-  it('| should handle init parameter with id and issuer', (): void => {
-    const instance = new DyFM_Metadata(undefined, {
-      id: 'init-id',
-      issuer: 'init-user'
-    });
-
-    expect(instance._id).toBe('init-id');
-    expect(instance.__createdBy).toBe('init-user');
-    expect(instance.__lastModifiedBy).toBe('init-user');
-  });
-
-  it('| should not override existing _id with init id', (): void => {
-    const instance = new DyFM_Metadata(
-      { _id: 'existing-id' },
-      { id: 'init-id', issuer: 'user' }
-    );
-
-    expect(instance._id).toBe('existing-id');
-  });
-
-  it('| should not override existing __createdBy with init issuer', (): void => {
-    const instance = new DyFM_Metadata(
-      { __createdBy: 'existing-user' },
-      { issuer: 'init-user' }
-    );
-
-    expect(instance.__createdBy).toBe('existing-user');
-  });
-
-  it('| should handle archived data', (): void => {
-    const archivedDate = new Date('2023-01-01');
-    const instance = new DyFM_Metadata({
-      _archived: archivedDate,
-      _originalId: 'original-id'
-    });
-
-    expect(instance._archived).toEqual(archivedDate);
-    expect(instance._originalId).toBe('original-id');
-  });
-
-  it('| should handle deleted data', (): void => {
-    const deletedDate = new Date('2023-01-01');
-    const instance = new DyFM_Metadata({
-      _deleted: deletedDate,
-      _deletedBy: 'deleter'
-    } as any);
-    instance._deleted = deletedDate;
-    instance._deletedBy = 'deleter';
-
-    expect(instance._deleted).toEqual(deletedDate);
-    expect(instance._deletedBy).toBe('deleter');
-  });
-
-  it('| should set _id to undefined when _id is falsy but not undefined', (): void => {
-    // Test case for line 40-42: if (!set._id && set._id !== undefined)
-    // This happens when _id is null, empty string, 0, false, etc.
-    const instance1 = new DyFM_Metadata({ _id: null as any });
-    expect(instance1._id).toBeUndefined();
-
-    const instance2 = new DyFM_Metadata({ _id: '' as any });
-    expect(instance2._id).toBeUndefined();
-
-    const instance3 = new DyFM_Metadata({ _id: 0 as any });
-    expect(instance3._id).toBeUndefined();
-  });
-
-  describe('| updateMetadata', (): void => {
-    it('| should update metadata correctly', (): void => {
-      const data = new DyFM_Metadata();
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
-
-      expect(updated._id).toBe('new-id');
-      expect(updated.__createdBy).toBe('updater');
-      expect(updated.__lastModifiedBy).toBe('updater');
-      expect(updated.__lastModified).toBeInstanceOf(Date);
-      expect(updated.__v).toBe(1);
-    });
-
-    it('| should increment version on update', (): void => {
-      const data = new DyFM_Metadata({ __v: 5 });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__v).toBe(6);
-    });
-
-    it('| should set version to 1 if not present', (): void => {
-      const data = new DyFM_Metadata({ __v: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__v).toBe(1);
-    });
-
-    it('| should not override existing _id if id not provided', (): void => {
-      const data = new DyFM_Metadata({ _id: 'existing-id' });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated._id).toBe('existing-id');
-    });
-
-    it('| should set _id if not present and id provided', (): void => {
-      const data = new DyFM_Metadata({ _id: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
-
-      expect(updated._id).toBe('new-id');
-    });
-
-    it('| should throw error when updating deleted data', (): void => {
-      const data = new DyFM_Metadata({ _deleted: new Date() } as any);
-      data._deleted = new Date();
-
-      expect(() => {
-        DyFM_Metadata.updateMetadata!(data, 'updater');
-      }).toThrowError('Cannot update metadata of deleted data');
-    });
-
-    it('| should return data as-is if data is null', (): void => {
-      const result = DyFM_Metadata.updateMetadata!(null as any, 'updater');
-
-      expect(result).toBeNull();
-    });
-
-    it('| should set __created if not present', (): void => {
-      const data = new DyFM_Metadata({ __created: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__created).toBeInstanceOf(Date);
-    });
-
-    it('| should set __createdBy if not present', (): void => {
-      const data = new DyFM_Metadata({ __createdBy: undefined });
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__createdBy).toBe('updater');
-    });
-
-    it('| should set __created if not present (branch coverage)', (): void => {
-      // Test case for line 114-116: if (!data.__created)
-      const data = new DyFM_Metadata();
-      data.__created = undefined as any;
-      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
-
-      expect(updated.__created).toBeInstanceOf(Date);
-    });
-  });
-});
-
+import { DyFM_Metadata } from './metadata.data-model';
+
+describe('| DyFM_Metadata', (): void => {
+  it('| should create an instance without initial data', (): void => {
+    const instance = new DyFM_Metadata();
+    expect(instance).toBeTruthy();
+    expect(instance.__created).toBeInstanceOf(Date);
+    expect(instance.__lastModified).toBeInstanceOf(Date);
+    expect(instance.__v).toBe(0);
+  });
+
+  it('| should create an instance with initial data', (): void => {
+    const initialData: DyFM_Metadata = {
+      _id: 'test-id',
+      __created: new Date('2023-01-01'),
+      __createdBy: 'user1',
+      __lastModified: new Date('2023-01-02'),
+      __lastModifiedBy: 'user2',
+      __v: 1
+    };
+    const instance = new DyFM_Metadata(initialData);
+
+    expect(instance._id).toBe('test-id');
+    expect(instance.__created).toEqual(new Date('2023-01-01'));
+    expect(instance.__createdBy).toBe('user1');
+    expect(instance.__lastModified).toEqual(new Date('2023-01-02'));
+    expect(instance.__lastModifiedBy).toBe('user2');
+    expect(instance.__v).toBe(1);
+  });
+
+  it('| should set default values when not provided', (): void => {
+    const instance = new DyFM_Metadata({});
+
+    expect(instance.__created).toBeInstanceOf(Date);
+    expect(instance.__lastModified).toBeInstanceOf(Date);
+    expect(instance.__v).toBe(0);
+  });
+
+  it('| should handle init parameter with id and issuer', (): void => {
+    const instance = new DyFM_Metadata(undefined, {
+      id: 'init-id',
+      issuer: 'init-user'
+    });
+
+    expect(instance._id).toBe('init-id');
+    expect(instance.__createdBy).toBe('init-user');
+    expect(instance.__lastModifiedBy).toBe('init-user');
+  });
+
+  it('| should not override existing _id with init id', (): void => {
+    const instance = new DyFM_Metadata(
+      { _id: 'existing-id' },
+      { id: 'init-id', issuer: 'user' }
+    );
+
+    expect(instance._id).toBe('existing-id');
+  });
+
+  it('| should not override existing __createdBy with init issuer', (): void => {
+    const instance = new DyFM_Metadata(
+      { __createdBy: 'existing-user' },
+      { issuer: 'init-user' }
+    );
+
+    expect(instance.__createdBy).toBe('existing-user');
+  });
+
+  it('| should handle archived data', (): void => {
+    const archivedDate = new Date('2023-01-01');
+    const instance = new DyFM_Metadata({
+      _archived: archivedDate,
+      _originalId: 'original-id'
+    });
+
+    expect(instance._archived).toEqual(archivedDate);
+    expect(instance._originalId).toBe('original-id');
+  });
+
+  it('| should handle deleted data', (): void => {
+    const deletedDate = new Date('2023-01-01');
+    const instance = new DyFM_Metadata({
+      _deleted: deletedDate,
+      _deletedBy: 'deleter'
+    } as any);
+    instance._deleted = deletedDate;
+    instance._deletedBy = 'deleter';
+
+    expect(instance._deleted).toEqual(deletedDate);
+    expect(instance._deletedBy).toBe('deleter');
+  });
+
+  it('| should set _id to undefined when _id is falsy but not undefined', (): void => {
+    // Test case for line 40-42: if (!set._id && set._id !== undefined)
+    // This happens when _id is null, empty string, 0, false, etc.
+    const instance1 = new DyFM_Metadata({ _id: null as any });
+    expect(instance1._id).toBeUndefined();
+
+    const instance2 = new DyFM_Metadata({ _id: '' as any });
+    expect(instance2._id).toBeUndefined();
+
+    const instance3 = new DyFM_Metadata({ _id: 0 as any });
+    expect(instance3._id).toBeUndefined();
+  });
+
+  describe('| updateMetadata', (): void => {
+    it('| should update metadata correctly', (): void => {
+      const data = new DyFM_Metadata();
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
+
+      expect(updated._id).toBe('new-id');
+      expect(updated.__createdBy).toBe('updater');
+      expect(updated.__lastModifiedBy).toBe('updater');
+      expect(updated.__lastModified).toBeInstanceOf(Date);
+      expect(updated.__v).toBe(1);
+    });
+
+    it('| should increment version on update', (): void => {
+      const data = new DyFM_Metadata({ __v: 5 });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated.__v).toBe(6);
+    });
+
+    it('| should set version to 1 if not present', (): void => {
+      const data = new DyFM_Metadata({ __v: undefined });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated.__v).toBe(1);
+    });
+
+    it('| should not override existing _id if id not provided', (): void => {
+      const data = new DyFM_Metadata({ _id: 'existing-id' });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated._id).toBe('existing-id');
+    });
+
+    it('| should set _id if not present and id provided', (): void => {
+      const data = new DyFM_Metadata({ _id: undefined });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater', 'new-id');
+
+      expect(updated._id).toBe('new-id');
+    });
+
+    it('| should throw error when updating deleted data', (): void => {
+      const data = new DyFM_Metadata({ _deleted: new Date() } as any);
+      data._deleted = new Date();
+
+      expect(() => {
+        DyFM_Metadata.updateMetadata!(data, 'updater');
+      }).toThrowError('Cannot update metadata of deleted data');
+    });
+
+    it('| should return data as-is if data is null', (): void => {
+      const result = DyFM_Metadata.updateMetadata!(null as any, 'updater');
+
+      expect(result).toBeNull();
+    });
+
+    it('| should set __created if not present', (): void => {
+      const data = new DyFM_Metadata({ __created: undefined });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated.__created).toBeInstanceOf(Date);
+    });
+
+    it('| should set __createdBy if not present', (): void => {
+      const data = new DyFM_Metadata({ __createdBy: undefined });
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated.__createdBy).toBe('updater');
+    });
+
+    it('| should set __created if not present (branch coverage)', (): void => {
+      // Test case for line 114-116: if (!data.__created)
+      const data = new DyFM_Metadata();
+      data.__created = undefined as any;
+      const updated = DyFM_Metadata.updateMetadata!(data, 'updater');
+
+      expect(updated.__created).toBeInstanceOf(Date);
+    });
+  });
+});
+

package/src/_models/data-models/metadata.data-model.ts

@@ -1,153 +1,153 @@
-
-export type DyFM_MetaD = DyFM_Metadata;
-
-/**
- * This class is the base class for all data models.
- * It contains the metadata for the data model.
- * 
- * @example
- * ```ts
- * const metadata: DyFM_Metadata = new DyFM_Metadata({
- *   _id: '123',
- * });
- * ```
- */
-export class DyFM_Metadata {
-  _id?: string;
-
-  __created?: Date;
-  __createdBy?: string;
-  __lastModified?: Date;
-  __lastModifiedBy?: string;
-  __v?: number;
-
-  _deleted?: Date;
-  _deletedBy?: string;
-
-  _archived?: Date;
-  //_archivedBy?: string;
-  //_archiveId?: string;
-  _originalId?: string;
-
-  constructor(
-    set?: DyFM_Metadata,
-    init?: {
-      id?: string,
-      issuer: string,
-    },
-  ){
-    // a metadata-init logika a statikus applyMetadata-ban el — igy a `DyFM_Error extends Error`
-    // (ami NEM tudja super()-rel hivni ezt a constructort) ugyanezt a target-en futtathatja.
-    DyFM_Metadata.applyMetadata(this, set, init);
-  }
-
-  /**
-   * Applies the metadata fields onto a target object.
-   *
-   * Kiemelt statikus a constructor-torzsbol: a viselkedes BIT-RE azonos a korabbi
-   * constructorral, de igy a `DyFM_Error extends Error implements DyFM_Metadata` is meg
-   * tudja hivni (az Error-bol orokolt osztaly nem tud `super(set, init)`-tel a
-   * DyFM_Metadata constructorba lepni, ezert target-alapon kell elerni az init-logikat).
-   *
-   * @param target - The object the metadata fields are written onto (`this`)
-   * @param set - The source metadata to copy from
-   * @param init - Optional id + issuer defaults
-   */
-  static applyMetadata(
-    target: DyFM_Metadata,
-    set?: DyFM_Metadata,
-    init?: {
-      id?: string,
-      issuer: string,
-    },
-  ): void {
-    if (set) {
-      if (!set._id && set._id !== undefined) {
-        set._id = undefined;
-      }
-
-      target._id = set._id;
-      target.__created = set.__created;
-      target.__createdBy = set.__createdBy;
-      target.__lastModified = set.__lastModified;
-      target.__lastModifiedBy = set.__lastModifiedBy;
-      target.__v = set.__v;
-
-      if (set._archived) {
-        target._archived = set._archived;
-        target._originalId = set._originalId;
-      }
-    }
-
-    if (!target.__created) {
-      target.__created = new Date();
-    }
-
-    if (!target.__lastModified) {
-      target.__lastModified = new Date();
-    }
-
-    if (!target.__v) {
-      target.__v = 0;
-    }
-
-    if (init) {
-      if (!target._id && init?.id) {
-        target._id = init.id;
-      }
-
-      if (init?.issuer) {
-        if (!target.__createdBy) {
-          target.__createdBy = init.issuer;
-        }
-
-        if (!target.__lastModifiedBy) {
-          target.__lastModifiedBy = init.issuer;
-        }
-      }
-    }
-  }
-  
-  /**
-   * Updates the metadata of a data model
-   * @param data - The data model to update
-   * @param issuer - The issuer of the data model
-   * @param id - The id of the data model
-   * @returns The updated data model
-   *
-   * @example
-   * ```ts
-   * const metadata: DyFM_Metadata = new DyFM_Metadata({
-   *   _id: '123',
-   * });
-   * const updatedMetadata = DyFM_Metadata.updateMetadata(metadata, 'user', '456');
-   * ```
-   */
-  static updateMetadata?<T extends DyFM_Metadata>(data: T, issuer: string, id?: string): T {
-    if (!data) {
-      return data;
-    }
-
-    if (data._deleted) {
-      throw new Error('Cannot update metadata of deleted data');
-    }
-
-    if (!data._id && id) {
-      data._id = id;
-    }
-
-    if (!data.__created) {
-      data.__created = new Date();
-    }
-    
-    if (!data.__createdBy) {
-      data.__createdBy = issuer;
-    }
-
-    data.__lastModified = new Date();
-    data.__lastModifiedBy = issuer;
-    data.__v = data.__v ? data.__v + 1 : 1;
-
-    return data;
-  }
-}
+
+export type DyFM_MetaD = DyFM_Metadata;
+
+/**
+ * This class is the base class for all data models.
+ * It contains the metadata for the data model.
+ * 
+ * @example
+ * ```ts
+ * const metadata: DyFM_Metadata = new DyFM_Metadata({
+ *   _id: '123',
+ * });
+ * ```
+ */
+export class DyFM_Metadata {
+  _id?: string;
+
+  __created?: Date;
+  __createdBy?: string;
+  __lastModified?: Date;
+  __lastModifiedBy?: string;
+  __v?: number;
+
+  _deleted?: Date;
+  _deletedBy?: string;
+
+  _archived?: Date;
+  //_archivedBy?: string;
+  //_archiveId?: string;
+  _originalId?: string;
+
+  constructor(
+    set?: DyFM_Metadata,
+    init?: {
+      id?: string,
+      issuer: string,
+    },
+  ){
+    // a metadata-init logika a statikus applyMetadata-ban el — igy a `DyFM_Error extends Error`
+    // (ami NEM tudja super()-rel hivni ezt a constructort) ugyanezt a target-en futtathatja.
+    DyFM_Metadata.applyMetadata(this, set, init);
+  }
+
+  /**
+   * Applies the metadata fields onto a target object.
+   *
+   * Kiemelt statikus a constructor-torzsbol: a viselkedes BIT-RE azonos a korabbi
+   * constructorral, de igy a `DyFM_Error extends Error implements DyFM_Metadata` is meg
+   * tudja hivni (az Error-bol orokolt osztaly nem tud `super(set, init)`-tel a
+   * DyFM_Metadata constructorba lepni, ezert target-alapon kell elerni az init-logikat).
+   *
+   * @param target - The object the metadata fields are written onto (`this`)
+   * @param set - The source metadata to copy from
+   * @param init - Optional id + issuer defaults
+   */
+  static applyMetadata(
+    target: DyFM_Metadata,
+    set?: DyFM_Metadata,
+    init?: {
+      id?: string,
+      issuer: string,
+    },
+  ): void {
+    if (set) {
+      if (!set._id && set._id !== undefined) {
+        set._id = undefined;
+      }
+
+      target._id = set._id;
+      target.__created = set.__created;
+      target.__createdBy = set.__createdBy;
+      target.__lastModified = set.__lastModified;
+      target.__lastModifiedBy = set.__lastModifiedBy;
+      target.__v = set.__v;
+
+      if (set._archived) {
+        target._archived = set._archived;
+        target._originalId = set._originalId;
+      }
+    }
+
+    if (!target.__created) {
+      target.__created = new Date();
+    }
+
+    if (!target.__lastModified) {
+      target.__lastModified = new Date();
+    }
+
+    if (!target.__v) {
+      target.__v = 0;
+    }
+
+    if (init) {
+      if (!target._id && init?.id) {
+        target._id = init.id;
+      }
+
+      if (init?.issuer) {
+        if (!target.__createdBy) {
+          target.__createdBy = init.issuer;
+        }
+
+        if (!target.__lastModifiedBy) {
+          target.__lastModifiedBy = init.issuer;
+        }
+      }
+    }
+  }
+  
+  /**
+   * Updates the metadata of a data model
+   * @param data - The data model to update
+   * @param issuer - The issuer of the data model
+   * @param id - The id of the data model
+   * @returns The updated data model
+   *
+   * @example
+   * ```ts
+   * const metadata: DyFM_Metadata = new DyFM_Metadata({
+   *   _id: '123',
+   * });
+   * const updatedMetadata = DyFM_Metadata.updateMetadata(metadata, 'user', '456');
+   * ```
+   */
+  static updateMetadata?<T extends DyFM_Metadata>(data: T, issuer: string, id?: string): T {
+    if (!data) {
+      return data;
+    }
+
+    if (data._deleted) {
+      throw new Error('Cannot update metadata of deleted data');
+    }
+
+    if (!data._id && id) {
+      data._id = id;
+    }
+
+    if (!data.__created) {
+      data.__created = new Date();
+    }
+    
+    if (!data.__createdBy) {
+      data.__createdBy = issuer;
+    }
+
+    data.__lastModified = new Date();
+    data.__lastModifiedBy = issuer;
+    data.__v = data.__v ? data.__v + 1 : 1;
+
+    return data;
+  }
+}