@futdevpro/nts-dynamo 1.14.65 → 1.14.68

package/src/_modules/local-vector-search/_services/lvs-vector-pool.control-service.spec.ts

@@ -0,0 +1,393 @@
+import { LVS_Search_Mode } from '../_enums/lvs-search-mode.enum';
+import { LVS_SearchResult } from '../_models/lvs-search-result.interface';
+import { LVS_VectorPool_ControlService } from './lvs-vector-pool.control-service';
+
+describe('| LVS_VectorPool_ControlService', () => {
+  let vectorPool: LVS_VectorPool_ControlService;
+
+  beforeEach(() => {
+    vectorPool = new LVS_VectorPool_ControlService();
+  });
+
+  describe('| Constructor/Initialization', () => {
+    it('| should initialize with empty pools', () => {
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(0);
+    });
+  });
+
+  describe('| addVector', () => {
+    it('| should add a valid vector to the pool', () => {
+      const id: string = 'vector1';
+      const vector: number[] = [1, 2, 3];
+
+      vectorPool.addVector(id, vector);
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(1);
+      expect(all.has(id)).toBeTrue();
+      expect(all.get(id)).toEqual(vector);
+    });
+
+    it('| should add multiple vectors to the pool', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      vectorPool.addVector('vector2', [4, 5, 6]);
+      vectorPool.addVector('vector3', [7, 8, 9]);
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(3);
+    });
+
+    it('| should throw error when ID is empty string', () => {
+      expect(() => {
+        vectorPool.addVector('', [1, 2, 3]);
+      }).toThrowError('Vector ID is required');
+    });
+
+    it('| should throw error when vector is empty array', () => {
+      expect(() => {
+        vectorPool.addVector('vector1', []);
+      }).toThrowError('Vector must be a non-empty array');
+    });
+
+    it('| should throw error when vector is not an array', () => {
+      expect(() => {
+        vectorPool.addVector('vector1', null as any);
+      }).toThrowError('Vector must be a non-empty array');
+    });
+
+    it('| should throw error when vector contains non-finite number', () => {
+      expect(() => {
+        vectorPool.addVector('vector1', [1, 2, Infinity]);
+      }).toThrowError('Vector must contain only finite numbers at index 2');
+    });
+
+    it('| should throw error when vector contains NaN', () => {
+      expect(() => {
+        vectorPool.addVector('vector1', [1, 2, NaN]);
+      }).toThrowError('Vector must contain only finite numbers at index 2');
+    });
+
+    it('| should store normalized vector internally', () => {
+      const id: string = 'vector1';
+      const vector: number[] = [3, 4]; // Magnitude = 5, normalized = [0.6, 0.8]
+
+      vectorPool.addVector(id, vector);
+
+      // Verify original vector is stored
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.get(id)).toEqual(vector);
+    });
+  });
+
+  describe('| removeVector', () => {
+    it('| should remove an existing vector from the pool', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      vectorPool.addVector('vector2', [4, 5, 6]);
+
+      vectorPool.removeVector('vector1');
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(1);
+      expect(all.has('vector1')).toBeFalse();
+      expect(all.has('vector2')).toBeTrue();
+    });
+
+    it('| should not throw when removing non-existent vector', () => {
+      expect(() => {
+        vectorPool.removeVector('non-existent');
+      }).not.toThrow();
+    });
+
+    it('| should remove vector from both pools', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      vectorPool.removeVector('vector1');
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(0);
+    });
+  });
+
+  describe('| updateVector', () => {
+    it('| should update an existing vector', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      const newVector: number[] = [4, 5, 6];
+
+      vectorPool.updateVector('vector1', newVector);
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.get('vector1')).toEqual(newVector);
+    });
+
+    it('| should throw error when updating non-existent vector', () => {
+      expect(() => {
+        vectorPool.updateVector('non-existent', [1, 2, 3]);
+      }).toThrowError('Vector with ID "non-existent" does not exist');
+    });
+  });
+
+  describe('| clearPool', () => {
+    it('| should clear a populated pool', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      vectorPool.addVector('vector2', [4, 5, 6]);
+      vectorPool.addVector('vector3', [7, 8, 9]);
+
+      vectorPool.clearPool();
+
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(0);
+    });
+
+    it('| should not throw when clearing empty pool', () => {
+      expect(() => {
+        vectorPool.clearPool();
+      }).not.toThrow();
+    });
+  });
+
+  describe('| getAll', () => {
+    it('| should return a copy of the pool, not a reference', () => {
+      vectorPool.addVector('vector1', [1, 2, 3]);
+      const all1: Map<string, number[]> = vectorPool.getAll();
+      const all2: Map<string, number[]> = vectorPool.getAll();
+
+      expect(all1).not.toBe(all2);
+      expect(all1.size).toBe(all2.size);
+    });
+
+    it('| should return empty map when pool is empty', () => {
+      const all: Map<string, number[]> = vectorPool.getAll();
+      expect(all.size).toBe(0);
+    });
+  });
+
+  describe('| cosineSimilarity (static)', () => {
+    it('| should return 1 for identical vectors', () => {
+      const vector: number[] = [1, 2, 3];
+      const similarity: number = LVS_VectorPool_ControlService.cosineSimilarity(vector, vector);
+      expect(similarity).toBeCloseTo(1, 10);
+    });
+
+    it('| should return approximately 0 for orthogonal vectors', () => {
+      const vector1: number[] = [1, 0, 0];
+      const vector2: number[] = [0, 1, 0];
+      const similarity: number = 
+        LVS_VectorPool_ControlService.cosineSimilarity(vector1, vector2);
+      expect(similarity).toBeCloseTo(0, 10);
+    });
+
+    it('| should throw error for vectors with different dimensions', () => {
+      const vector1: number[] = [1, 2, 3];
+      const vector2: number[] = [1, 2];
+
+      expect(() => {
+        LVS_VectorPool_ControlService.cosineSimilarity(vector1, vector2);
+      }).toThrowError('Vectors must have the same dimension. Got 3 and 2');
+    });
+
+    it('| should calculate correct cosine similarity for known vectors', () => {
+      // Two vectors pointing in similar direction
+      const vector1: number[] = [1, 1, 0];
+      const vector2: number[] = [1, 0, 0];
+      // Normalized: [1/√2, 1/√2, 0] and [1, 0, 0]
+      // Dot product: 1/√2 ≈ 0.707
+      const similarity: number = 
+        LVS_VectorPool_ControlService.cosineSimilarity(vector1, vector2);
+      expect(similarity).toBeCloseTo(1 / Math.sqrt(2), 10);
+    });
+
+    it('| should handle zero vector', () => {
+      const vector1: number[] = [0, 0, 0];
+      const vector2: number[] = [1, 2, 3];
+      const similarity: number = 
+        LVS_VectorPool_ControlService.cosineSimilarity(vector1, vector2);
+      expect(similarity).toBeCloseTo(0, 10);
+    });
+  });
+
+  describe('| l2Distance (static)', () => {
+    it('| should return 0 for identical vectors', () => {
+      const vector: number[] = [1, 2, 3];
+      const distance: number = LVS_VectorPool_ControlService.l2Distance(vector, vector);
+      expect(distance).toBe(0);
+    });
+
+    it('| should throw error for vectors with different dimensions', () => {
+      const vector1: number[] = [1, 2, 3];
+      const vector2: number[] = [1, 2];
+
+      expect(() => {
+        LVS_VectorPool_ControlService.l2Distance(vector1, vector2);
+      }).toThrowError('Vectors must have the same dimension. Got 3 and 2');
+    });
+
+    it('| should calculate correct L2 distance for known vectors', () => {
+      const vector1: number[] = [0, 0, 0];
+      const vector2: number[] = [3, 4, 0];
+      // Distance = √(3² + 4² + 0²) = √25 = 5
+      const distance: number = LVS_VectorPool_ControlService.l2Distance(vector1, vector2);
+      expect(distance).toBe(5);
+    });
+
+    it('| should calculate correct L2 distance for 1D vectors', () => {
+      const vector1: number[] = [5];
+      const vector2: number[] = [2];
+      const distance: number = LVS_VectorPool_ControlService.l2Distance(vector1, vector2);
+      expect(distance).toBe(3);
+    });
+  });
+
+  describe('| search', () => {
+    beforeEach(() => {
+      // Add test vectors
+      vectorPool.addVector('vec1', [1, 0, 0]);
+      vectorPool.addVector('vec2', [0, 1, 0]);
+      vectorPool.addVector('vec3', [0, 0, 1]);
+      vectorPool.addVector('vec4', [1, 1, 0]);
+    });
+
+    it('| should return empty array for empty pool', () => {
+      const emptyPool: LVS_VectorPool_ControlService = new LVS_VectorPool_ControlService();
+      const results: LVS_SearchResult[] = emptyPool.search([1, 0, 0], 3, LVS_Search_Mode.cosineSimilarity);
+      expect(results.length).toBe(0);
+    });
+
+    it('| should return results in descending order for cosine similarity', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        4, 
+        LVS_Search_Mode.cosineSimilarity
+      );
+
+      expect(results.length).toBe(4);
+      // vec1 should be most similar (identical)
+      expect(results[0].id).toBe('vec1');
+      expect(results[0].score).toBeCloseTo(1, 10);
+      // Results should be in descending order
+      for (let i: number = 0; i < results.length - 1; i++) {
+        expect(results[i].score).toBeGreaterThanOrEqual(results[i + 1].score);
+      }
+    });
+
+    it('| should return results in ascending order for L2 distance', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        4, 
+        LVS_Search_Mode.l2Distance
+      );
+
+      expect(results.length).toBe(4);
+      // vec1 should be closest (distance = 0)
+      expect(results[0].id).toBe('vec1');
+      expect(results[0].score).toBe(0);
+      // Results should be in ascending order
+      for (let i: number = 0; i < results.length - 1; i++) {
+        expect(results[i].score).toBeLessThanOrEqual(results[i + 1].score);
+      }
+    });
+
+    it('| should limit results to top-K when k < pool size', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        2, 
+        LVS_Search_Mode.cosineSimilarity
+      );
+
+      expect(results.length).toBe(2);
+    });
+
+    it('| should return all results when k > pool size', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        10, 
+        LVS_Search_Mode.cosineSimilarity
+      );
+
+      expect(results.length).toBe(4);
+    });
+
+    it('| should return all results when k = pool size', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        4, 
+        LVS_Search_Mode.cosineSimilarity
+      );
+
+      expect(results.length).toBe(4);
+    });
+
+    it('| should throw error for dimension mismatch', () => {
+      const query: number[] = [1, 0]; // 2D query, pool has 3D vectors
+
+      expect(() => {
+        vectorPool.search(query, 3, LVS_Search_Mode.cosineSimilarity);
+      }).toThrowError('Query vector dimension (2) does not match pool vector dimension (3)');
+    });
+
+    it('| should throw error for empty query vector', () => {
+      expect(() => {
+        vectorPool.search([], 3, LVS_Search_Mode.cosineSimilarity);
+      }).toThrowError('Query vector must be a non-empty array');
+    });
+
+    it('| should throw error for non-array query', () => {
+      expect(() => {
+        vectorPool.search(null as any, 3, LVS_Search_Mode.cosineSimilarity);
+      }).toThrowError('Query vector must be a non-empty array');
+    });
+
+    it('| should throw error for k = 0', () => {
+      expect(() => {
+        vectorPool.search([1, 0, 0], 0, LVS_Search_Mode.cosineSimilarity);
+      }).toThrowError('k must be a positive number');
+    });
+
+    it('| should throw error for negative k', () => {
+      expect(() => {
+        vectorPool.search([1, 0, 0], -1, LVS_Search_Mode.cosineSimilarity);
+      }).toThrowError('k must be a positive number');
+    });
+
+    it('| should throw error for unknown search mode', () => {
+      expect(() => {
+        vectorPool.search([1, 0, 0], 3, 'unknown-mode' as LVS_Search_Mode);
+      }).toThrowError('Unknown search mode: unknown-mode');
+    });
+
+    it('| should return correct scores for cosine similarity', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        4, 
+        LVS_Search_Mode.cosineSimilarity
+      );
+
+      // vec1 should have score = 1 (identical)
+      const vec1Result: LVS_SearchResult | undefined = 
+        results.find((r: LVS_SearchResult) => r.id === 'vec1');
+      expect(vec1Result).toBeDefined();
+      expect(vec1Result!.score).toBeCloseTo(1, 10);
+    });
+
+    it('| should return correct scores for L2 distance', () => {
+      const query: number[] = [1, 0, 0];
+      const results: LVS_SearchResult[] = vectorPool.search(
+        query, 
+        4, 
+        LVS_Search_Mode.l2Distance
+      );
+
+      // vec1 should have score = 0 (identical)
+      const vec1Result: LVS_SearchResult | undefined = 
+        results.find((r: LVS_SearchResult) => r.id === 'vec1');
+      expect(vec1Result).toBeDefined();
+      expect(vec1Result!.score).toBe(0);
+    });
+  });
+});
+

package/src/_services/base/data.service.ts

@@ -804,10 +804,8 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
     return data;
   }
 
-  async patchData(data?: T): Promise<T> {
+  async patchData(data?: Partial<T>): Promise<T> {
     try {
-      data = this.ensureData(data);
-
       if (!data._id) {
         throw new DyFM_Error({ 
           ...this._getDefaultErrorSettings(
@@ -828,6 +826,17 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         });
       }
 
+      for (const key in this.depSettings) {
+        if (data[key] && data[key] !== dataExists[key]) {
+          throw new DyFM_Error({ 
+            ...this._getDefaultErrorSettings(
+              'patchData',
+              new Error(`Cannot patch data: dependency data mismatch! (${this.dataParams.dataName})`)
+            ),
+          });
+        }
+      }
+
       DyFM_Object.cleanAssign(dataExists, data);
       
       await this.validateForSave(dataExists);
@@ -2335,7 +2344,8 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
 
   protected getDefaultErrorSettings(
     fnName: string, 
-    error: DyFM_AnyError
+    error: DyFM_AnyError,
+    useMessageAsUserMessage: boolean = true,
   ): DyFM_Error_Settings {
     return {
       status: (error as DyFM_Error)?.___status ?? 500,
@@ -2343,7 +2353,8 @@ export class DyNTS_DataService<T extends DyFM_Metadata> {
         (error as DyFM_Error)?._message ??
         `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
       addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? 
+        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
       issuer: this.issuer,
       issuerService: this.constructor?.name,
       systemVersion: DyNTS_global_settings.systemVersion,

package/src/_services/base/singleton.service.ts

@@ -16,6 +16,7 @@ export class DyNTS_SingletonService extends DyNTS_SingletonServiceBase {
     fnName: string, 
     error: DyFM_AnyError,
     issuer: string,
+    useMessageAsUserMessage: boolean = true,
     /* errorCode: string, */
   ): DyFM_Error_Settings {
     return {
@@ -24,7 +25,8 @@ export class DyNTS_SingletonService extends DyNTS_SingletonServiceBase {
         (error as DyFM_Error)?._message ??
         `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
       addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? 
+        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
       /* errorCode: errorCode, */
       issuer: issuer,
       issuerService: this.constructor?.name,

package/src/_services/core/email.service.ts

@@ -722,7 +722,8 @@ export class DyNTS_EmailService /* extends DyNTS_SingletonService */ {
   protected getDefaultErrorSettings(
     fnName: string, 
     error: DyFM_AnyError,
-    issuer: string
+    issuer: string,
+    useMessageAsUserMessage: boolean = true,
   ): DyFM_Error_Settings {
     return {
       status: (error as DyFM_Error)?.___status ?? 500,
@@ -730,7 +731,8 @@ export class DyNTS_EmailService /* extends DyNTS_SingletonService */ {
         (error as DyFM_Error)?._message ??
         `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
       addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? 
+        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
       issuer: issuer,
       issuerService: this.constructor?.name,
       error: error,

package/src/_services/core/global.service.ts

@@ -441,7 +441,8 @@ export class DyNTS_GlobalService extends DyNTS_SingletonService {
   protected static getDefaultErrorSettings(
     fnName: string, 
     error: DyFM_AnyError,
-    issuer: string
+    issuer: string,
+    useMessageAsUserMessage: boolean = true,
   ): DyFM_Error_Settings {
     return {
       status: (error as DyFM_Error)?.___status ?? 500,
@@ -449,7 +450,8 @@ export class DyNTS_GlobalService extends DyNTS_SingletonService {
         (error as DyFM_Error)?._message ??
         `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
       addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? 
+        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
       issuer: issuer,
       issuerService: this.constructor?.name,
       error: error,