@unchainedshop/utils 2.0.0-rc.4 → 2.0.0

package/jest.config.js

@@ -11,4 +11,7 @@ export default {
       },
     ],
   },
+  moduleNameMapper: {
+    '(.+)\\.js': '$1',
+  },
 };

package/lib/find-localized-text.js

@@ -19,19 +19,25 @@ const findLocalizedText = async (collection, selector, locale) => {
     const cachedText = textCache.get(cacheKey);
     if (cachedText)
         return cachedText;
-    const exactTranslation = await collection.findOne(extendSelectorWithLocale(selector, locale), {});
+    const exactTranslation = await collection.findOne(extendSelectorWithLocale(selector, locale), {
+        sort: { updated: -1 },
+    });
     if (exactTranslation) {
         textCache.set(cacheKey, exactTranslation);
         return exactTranslation;
     }
     if (systemLocale.normalized !== locale.normalized) {
-        const fallbackTranslation = await collection.findOne(extendSelectorWithLocale(selector, systemLocale), {});
+        const fallbackTranslation = await collection.findOne(extendSelectorWithLocale(selector, systemLocale), {
+            sort: { updated: -1 },
+        });
         if (fallbackTranslation) {
             textCache.set(cacheKey, fallbackTranslation);
             return fallbackTranslation;
         }
     }
-    const foundText = await collection.findOne(selector, {});
+    const foundText = await collection.findOne(selector, {
+        sort: { updated: -1 },
+    });
     textCache.set(cacheKey, foundText);
     return foundText;
 };

package/lib/find-localized-text.js.map

@@ -1 +1 @@
-{"version":3,"file":"find-localized-text.js","sourceRoot":"","sources":["../src/find-localized-text.ts"],"names":[],"mappings":"AAAA,OAAO,8BAA8B,CAAC;AACtC,OAAO,GAAG,MAAM,WAAW,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAEjC,MAAM,GAAG,GAAG,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B;AAEjF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;AAE/C,MAAM,wBAAwB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;IACpD,MAAM,cAAc,GAAG;QACrB,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;KACtD,CAAC;IACF,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,QAAQ,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAC7B,UAAyB,EACzB,QAAmB,EACnB,MAAc,EACF,EAAE;IACd,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9B,CAAC,EAAE,UAAU,CAAC,cAAc;QAC5B,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,MAAM;KACV,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,UAAU;QAAE,OAAO,UAAe,CAAC;IAEvC,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IAClG,IAAI,gBAAgB,EAAE;QACpB,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC1C,OAAO,gBAAqB,CAAC;KAC9B;IAED,IAAI,YAAY,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,EAAE;QACjD,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,OAAO,CAClD,wBAAwB,CAAC,QAAQ,EAAE,YAAY,CAAC,EAChD,EAAE,CACH,CAAC;QACF,IAAI,mBAAmB,EAAE;YACvB,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;YAC7C,OAAO,mBAAwB,CAAC;SACjC;KACF;IAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnC,OAAO,SAAc,CAAC;AACxB,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"find-localized-text.js","sourceRoot":"","sources":["../src/find-localized-text.ts"],"names":[],"mappings":"AAAA,OAAO,8BAA8B,CAAC;AACtC,OAAO,GAAG,MAAM,WAAW,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAEjC,MAAM,GAAG,GAAG,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,0BAA0B;AAEjF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;AAE/C,MAAM,wBAAwB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;IACpD,MAAM,cAAc,GAAG;QACrB,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;KACtD,CAAC;IACF,OAAO,EAAE,GAAG,cAAc,EAAE,GAAG,QAAQ,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAC7B,UAAyB,EACzB,QAAmB,EACnB,MAAc,EACF,EAAE;IACd,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9B,CAAC,EAAE,UAAU,CAAC,cAAc;QAC5B,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,MAAM;KACV,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE3C,IAAI,UAAU;QAAE,OAAO,UAAe,CAAC;IAEvC,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;QAC5F,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE;KACtB,CAAC,CAAC;IACH,IAAI,gBAAgB,EAAE;QACpB,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAC1C,OAAO,gBAAqB,CAAC;KAC9B;IAED,IAAI,YAAY,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,EAAE;QACjD,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,OAAO,CAClD,wBAAwB,CAAC,QAAQ,EAAE,YAAY,CAAC,EAChD;YACE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE;SACtB,CACF,CAAC;QACF,IAAI,mBAAmB,EAAE;YACvB,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;YAC7C,OAAO,mBAAwB,CAAC;SACjC;KACF;IAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE;QACnD,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE;KACtB,CAAC,CAAC;IACH,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnC,OAAO,SAAc,CAAC;AACxB,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/utils",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0",
   "main": "lib/utils-index.js",
   "exports": {
     ".": "./lib/utils-index.js",
@@ -30,18 +30,18 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^2.0.0-rc.4",
+    "@unchainedshop/logger": "^2.0.0",
     "abort-controller": "3.0.0",
-    "bson": "^4.7.0",
+    "bson": "^4.7.2",
     "hashids": "^2.2.10",
-    "jest": "^29.3.1",
+    "jest": "^29.4.1",
     "locale": "0.1.0",
     "lru-cache": "^7.14.1",
     "simpl-schema": "=3.2.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.18",
-    "@unchainedshop/types": "^2.0.0-rc.4",
+    "@unchainedshop/types": "^2.0.0",
     "typescript": "^4.9.4"
   }
 }

package/src/director/base-director.test.ts

@@ -0,0 +1,129 @@
+import { BaseDirector } from "./BaseDirector.js";
+
+const adapter1 = {
+  key: 'adapter1',
+  label: 'Adapter 1',
+  version: '1',
+  log: import.meta.jest.fn(),
+};
+
+const adapter2 = {
+  key: 'adapter2',
+  label: 'Adapter 2',
+  version: '2',
+  log: import.meta.jest.fn(),
+};
+
+const adapter3 = {
+  key: 'adapter3',
+  label: 'Adapter 3',
+  version: '3',
+  log: import.meta.jest.fn(),
+};
+
+describe('BaseDirector', () => {
+  let director;
+
+  beforeEach(() => {
+    director = BaseDirector('TestDirector');
+    director.registerAdapter(adapter1);
+    director.registerAdapter(adapter3);
+    director.registerAdapter(adapter2);
+  });
+
+  describe('registerAdapter',  ()=> {
+
+    it('should add the adapter to the director', () => {
+      director.registerAdapter(adapter1);
+      expect(director.getAdapter(adapter1.key)).toBe(adapter1);
+    });
+  
+    xit('should generate a log message when an adapter is registered', () => {
+      const spy = import.meta.jest.spyOn(console, 'log')
+       expect(spy).toHaveBeenCalledWith(
+        'TestDirector -> Registered  adapter1 1.0.0 (Adapter 1)',
+      ); 
+    });
+  
+    it('should allow multiple adapters to be registered', () => {
+      expect(director.getAdapter(adapter1.key)).toBe(adapter1);
+      expect(director.getAdapter(adapter2.key)).toBe(adapter2);
+    });
+  
+    it('should register an adapter and add it to the internal map', () => {
+      expect(director.getAdapter(adapter1.key)).toEqual(adapter1);
+    });
+  
+    it('should use the adapterKeyField specified in the options to store the adapter in the internal map', () => {
+  
+      director = BaseDirector('TestDirector', {
+        adapterKeyField: 'label',
+      });
+      director.registerAdapter(adapter1);
+      expect(director.getAdapter(adapter1.label)).toEqual(adapter1);
+    });
+  
+      it('should return the correct Adapter object', () => {
+        const directorName = 'TestDirector';
+        const adapterKeyField = 'key';
+        director = BaseDirector(directorName, { adapterKeyField });
+        director.registerAdapter(adapter1);
+        
+        expect(director.getAdapter(adapter1.key)).toEqual(adapter1);
+      });
+  
+      it('should return undefined if the Adapter does not exist', () => {
+        const directorName = 'TestDirector';
+        const adapterKeyField = 'key';
+        director = BaseDirector(directorName, { adapterKeyField });
+        expect(director.getAdapter(adapter1.key)).toBeUndefined();
+      });
+  
+  })
+
+
+describe('getAdapter', () => {
+  it('should return the correct Adapter object for a given key', () => {
+    // Expect that calling getAdapter with the key 'foo' returns the fooAdapter
+    expect(director.getAdapter(adapter1.key)).toBe(adapter1);
+  });
+
+  it('should return undefined if no Adapter is registered with the given key', () => {
+    // Expect that calling getAdapter with a key that has not been registered returns undefined
+    expect(director.getAdapter('invalid-key')).toBeUndefined();
+  });
+
+  it('should return the correct Adapter object when the keyField is set to a property other than "key"', () => {
+    // Create a director with the keyField option set to 'label'
+    director = BaseDirector('TestDirector', { adapterKeyField: 'label' });
+    director.registerAdapter(adapter1);
+    expect(director.getAdapter(adapter1.label)).toBe(adapter1);
+  });
+});
+
+describe('getAdapters', () => {
+  it('should return an array of registered Adapter objects', () => {
+    expect(director.getAdapters()).toEqual([adapter1, adapter3, adapter2]);
+  });
+
+  it('should return an empty array if no Adapter objects have been registered', () => {
+    const directorName = 'TestDirector';
+    const adapterKeyField = 'key';
+    const baseDirector = BaseDirector(directorName, { adapterKeyField });
+    expect(baseDirector.getAdapters()).toEqual([]);
+  });
+
+  it('should return an array of registered Adapter objects sorted by the adapterSortKey provided', () => {
+    director = BaseDirector('TestDirector', { adapterSortKey: 'version' });
+    director.registerAdapter(adapter1);
+    director.registerAdapter(adapter3);
+    director.registerAdapter(adapter2);
+    expect(director.getAdapters()).toEqual([adapter1, adapter2, adapter3]);
+  });
+
+})
+  
+
+})
+
+

package/src/director/base-discount-adapter.test.ts

@@ -0,0 +1,52 @@
+import { BaseDiscountAdapter } from "./BaseDiscountAdapter.js";
+
+describe("BaseDiscountAdapter instantiation", () => {
+  const adapter = BaseDiscountAdapter;
+  const context = null
+  it("should initialize with default values", () => {
+    expect(adapter.orderIndex).toEqual(0);
+    expect(adapter.log).toEqual(expect.any(Function));
+    expect(adapter.isManualAdditionAllowed('')).resolves.toEqual(false);
+    expect(adapter.isManualRemovalAllowed()).resolves.toEqual(false);
+    
+    expect(adapter.actions(context)).resolves.toEqual({
+      isValidForSystemTriggering: expect.any(Function),
+      reserve: expect.any(Function),
+      release: expect.any(Function),
+      isValidForCodeTriggering: expect.any(Function),
+      discountForPricingAdapterKey: expect.any(Function),
+    });
+  });
+
+  describe('actions',  ()=> {
+    const actions =  adapter.actions(context)
+    
+    it('isValidForSystemTriggering', async () => {
+      const result = await adapter.actions(context);
+      
+      expect(await result.isValidForSystemTriggering()).toEqual(false)
+    })
+
+    it('reserve', async () => {
+      const result = await adapter.actions(context);
+      expect(await result.reserve({code: ''})).toEqual({})
+    })
+
+    it('release', async () => {
+      const result = await adapter.actions(context);
+      expect(await result.release()).toEqual(null)
+    })
+
+    it('isValidForCodeTriggering', async () => {
+      const result = await adapter.actions(context);
+      expect(await result.isValidForCodeTriggering({code: ''})).toEqual(false)
+    })
+
+    it('discountForPricingAdapterKey', async () => {
+      const result = await adapter.actions(context);
+      const calculationSheet = {}
+      expect(await result.discountForPricingAdapterKey({calculationSheet, pricingAdapterKey: 'key'} as any)).toEqual(null)
+    })
+
+  })
+});

package/src/director/base-price-sheet.test.ts

@@ -0,0 +1,106 @@
+import { BasePricingSheet } from "./BasePricingSheet.js";
+
+describe('BasePricingSheet', () => {
+  let pricingSheet;
+  const TAX = { category: 'tax', amount: 100 };
+  const DISCOUNT = { category: 'discount', amount: 50 };
+  const ITEM1 = { category: 'item', amount: 200 };
+  const ITEM2 = { category: 'item', amount: 200 };
+  const calculations = [TAX, DISCOUNT, ITEM1, ITEM2];
+
+  beforeEach(() => {
+    pricingSheet =  BasePricingSheet({
+      calculation: calculations,
+    });
+  });
+
+  it('gross() calculates the sum of the amounts in the calculations', () => {
+    expect(pricingSheet.gross()).toEqual(550);
+  });
+
+  it('gross() returns 0 if the calculation is empty', () => {
+    expect(BasePricingSheet({ calculation: [] }).gross()).toEqual(0);
+  });
+  
+
+
+    it('total() calculates the sum of the amounts in the calculations by default', () => {
+      expect(pricingSheet.total()).toEqual({ amount: 550, currency: undefined });
+    });
+  
+    it('total() calculates the sum of the amounts in the calculations for a given category', () => {
+      expect(pricingSheet.total({ category: 'item' })).toEqual({ amount: 400, currency: undefined });
+    });
+
+    it('total() calculates the net sum of the amounts in the calculations if useNetPrice is true', () => {
+      expect(pricingSheet.total({ useNetPrice: true })).toEqual({ amount: 550, currency: undefined });
+    });
+
+    it('total() returns 0 if the calculation is empty', () => {
+      expect(BasePricingSheet({ calculation: [] }).total()).toEqual({ amount: 0, currency: undefined });
+    });
+    
+    it('calculates the correct net amount', () => {
+        expect(pricingSheet.net()).toEqual(550);
+    });
+
+    it('calculates the correct sum for a given category', () => {
+        expect(pricingSheet.sum({ category: 'item' })).toEqual(400);
+    });
+
+    it('calculates the correct tax amount', () => {
+        expect(pricingSheet.taxSum()).toEqual(0);
+    });
+
+  
+
+  describe('getRawPricingSheet', () => {
+    it('returns the correct list of calculations', () => {      
+      expect(pricingSheet.getRawPricingSheet()).toEqual(calculations);
+    });
+  
+    it('returns an empty list of calculations if none are provided', () => {
+      expect(BasePricingSheet({}).getRawPricingSheet()).toEqual([]);
+    });
+  });
+  
+
+describe('isValid', () => {
+  it('returns true if the sheet has calculations', () => {
+    expect(pricingSheet.isValid()).toEqual(true);
+  });
+
+  it('returns false if the sheet does not have calculations', () => {
+    expect(BasePricingSheet({}).isValid()).toEqual(false);
+  });
+});
+
+describe('filterBy', () => {
+    it('filters the list of calculations correctly', () => {
+      expect(pricingSheet.filterBy({ category: 'item' })).toEqual([ITEM1, ITEM2]);
+    });
+
+    it('returns the full list of calculations if no filter is provided', () => {
+        expect(pricingSheet.filterBy()).toEqual(calculations);
+    })
+});
+
+
+
+describe('resetCalculation', () => {
+  it('resets the list of calculations correctly', () => {
+    const expectedCalculations =  calculations.reduce((prev,{ amount, ...row}) => {
+        return [
+            ...prev,
+            {
+                ...row,
+                amount: -amount
+            }
+        ]
+    }, [...calculations]) 
+    expect(pricingSheet.resetCalculation(pricingSheet)).toEqual(expectedCalculations);
+  });
+
+})
+
+});

package/src/find-localized-text.ts

@@ -31,7 +31,9 @@ const findLocalizedText = async <T extends Document>(
 
   if (cachedText) return cachedText as T;
 
-  const exactTranslation = await collection.findOne(extendSelectorWithLocale(selector, locale), {});
+  const exactTranslation = await collection.findOne(extendSelectorWithLocale(selector, locale), {
+    sort: { updated: -1 },
+  });
   if (exactTranslation) {
     textCache.set(cacheKey, exactTranslation);
     return exactTranslation as T;
@@ -40,7 +42,9 @@ const findLocalizedText = async <T extends Document>(
   if (systemLocale.normalized !== locale.normalized) {
     const fallbackTranslation = await collection.findOne(
       extendSelectorWithLocale(selector, systemLocale),
-      {},
+      {
+        sort: { updated: -1 },
+      },
     );
     if (fallbackTranslation) {
       textCache.set(cacheKey, fallbackTranslation);
@@ -48,7 +52,9 @@ const findLocalizedText = async <T extends Document>(
     }
   }
 
-  const foundText = await collection.findOne(selector, {});
+  const foundText = await collection.findOne(selector, {
+    sort: { updated: -1 },
+  });
   textCache.set(cacheKey, foundText);
   return foundText as T;
 };

package/{tests → src}/utils-index.test.ts

@@ -15,11 +15,10 @@ import {
   resolveBestCountry,
   resolveBestSupported,
   resolveUserRemoteAddress,
-  
   slugify,
   systemLocale,
 } from '@unchainedshop/utils';
-import generateHashId from '../lib/generate-random-hash.js'
+import generateHashId from './generate-random-hash.js'
 
 describe('Utils', () => {
 

package/tsconfig.json

@@ -1,29 +1,11 @@
 {
+  "extends": "../shared/base.tsconfig.json",
   "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "lib": [
-      "esnext"
-    ],
-    "module": "Node16",
-    "moduleResolution": "Node16",
-    "noImplicitReturns": true,
-    "noUnusedLocals": false,
-    "outDir": "lib",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "target": "ES2022",
-    "types": [
-      "node",
-      "jest"
-    ]
+    "rootDir": "src",
+    "outDir": "lib"
   },
+  "exclude": ["**/*.test.ts", "**/*.test.js", "tests"],
   "include": [
-    "src"
+    "./src"
   ]
 }