@softwear/latestcollectioncore 1.0.163 → 1.0.165

package/dist/articleStatus.d.ts

@@ -90,6 +90,7 @@ declare const _default: {
     QTY_B2B_RETURN: number;
     RETURN_PERCENTAGE: number;
     ROI: number;
+    ROI_PERCENTAGE: number;
     SELLOUT_PERCENTAGE: number;
     STOCKAMOUNT_TIME_PRODUCT: number;
     STOCK_TIME_PRODUCT: number;

package/dist/articleStatus.js

@@ -13,7 +13,7 @@ const { QTY_TRANSACTION, QTY_STOCK, AMOUNT_STOCK, QTY_SHELF_STOCK, AMOUNT_SHELF_
 // Derived fields
 AMOUNT_SOLD_MAX, AMOUNT_SOLD_DISCOUNT, MAX_RECIEVE_TIMESTAMP, STOCK_TIME_PRODUCT, STOCKAMOUNT_TIME_PRODUCT, QTY_RETURN, AMOUNT_RETURN, 
 // Post aggregation fields
-SELLOUT_PERCENTAGE, ROI, QTY_AVG_STOCK, VALUE_AVG_STOCK, QTY_TURNOVER_VELOCITY, AMOUNT_TURNOVER_VELOCITY, PROFITABILITY, MARGIN, PROFIT, QTY_END_SHELF_STOCK, AMOUNT_END_SHELF_STOCK, QTY_END_STOCK, AMOUNT_END_STOCK, RETURN_PERCENTAGE, QTY_SOLD_BEFORE_RETURNS, } = transaction_1.default.dbTransactionVector;
+SELLOUT_PERCENTAGE, ROI, QTY_AVG_STOCK, VALUE_AVG_STOCK, QTY_TURNOVER_VELOCITY, AMOUNT_TURNOVER_VELOCITY, PROFITABILITY, MARGIN, PROFIT, QTY_END_SHELF_STOCK, AMOUNT_END_SHELF_STOCK, QTY_END_STOCK, AMOUNT_END_STOCK, RETURN_PERCENTAGE, QTY_SOLD_BEFORE_RETURNS, ROI_PERCENTAGE, } = transaction_1.default.dbTransactionVector;
 // Vector length to allocate for aggregation
 const VECTOR_LENGTH = 50;
 const BEGIN_STOCK_VECTOR_START = QTY_STOCK;
@@ -290,6 +290,8 @@ function postAgg(v, timeFrame) {
     v[MARGIN] = (v[PROFIT] / totalAmountSold) * 100;
     v[RETURN_PERCENTAGE] = (v[QTY_RETURN] / v[QTY_RECIEVED]) * 100;
     v[QTY_SOLD_BEFORE_RETURNS] = totalQtySold + Math.abs(v[QTY_RETURN]);
+    const investmentBase = v[AMOUNT_RECIEVED] - v[AMOUNT_TRANSIT];
+    v[ROI_PERCENTAGE] = investmentBase <= 0 ? NaN : ((v[ROI] + investmentBase) / investmentBase) * 100;
     v[QTY_SOLD] = totalQtySold;
     v[AMOUNT_SOLD_EXCL] = totalAmountSold;
     v[COSTPRICE_SOLD] = totalCostSold;
@@ -522,6 +524,7 @@ exports.default = {
     QTY_B2B_RETURN,
     RETURN_PERCENTAGE,
     ROI,
+    ROI_PERCENTAGE,
     SELLOUT_PERCENTAGE,
     STOCKAMOUNT_TIME_PRODUCT,
     STOCK_TIME_PRODUCT,

package/dist/ensureImpliedProperties.d.ts

@@ -0,0 +1,7 @@
+import type { SkuI } from './types';
+/**
+ * Fills missing SKU fields from redundant sources (supplier mirrors, articleCode, id, etc.).
+ * Then sets UI-only `PRODUCT` to the clustering key (phase 1: same as `articleCodeSupplier` after normalization).
+ * Mutates the sku in place.
+ */
+export default function ensureImpliedProperties(sku: SkuI): void;

package/dist/ensureImpliedProperties.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Fills missing SKU fields from redundant sources (supplier mirrors, articleCode, id, etc.).
+ * Then sets UI-only `PRODUCT` to the clustering key (phase 1: same as `articleCodeSupplier` after normalization).
+ * Mutates the sku in place.
+ */
+function ensureImpliedProperties(sku) {
+    var _a;
+    if (!sku.articleGroupSupplier)
+        sku.articleGroupSupplier = sku.articleGroup;
+    if (!sku.collectionSupplier)
+        sku.collectionSupplier = sku.collection;
+    if (!sku.colorCodeSupplier)
+        sku.colorCodeSupplier = sku.colorCode;
+    if (!sku.sizeSupplier)
+        sku.sizeSupplier = sku.size;
+    if (!sku.brandSupplier)
+        sku.brandSupplier = sku.brand;
+    if (!sku.colorFamily && sku.colorSupplier)
+        sku.colorFamily = '' + sku.colorSupplier;
+    if (!sku.colorFamily && sku.colorDescription)
+        sku.colorFamily = '' + sku.colorDescription;
+    if (!sku.colorFamily && sku.mainColorDescription)
+        sku.colorFamily = '' + sku.mainColorDescription;
+    if (!sku.articleCodeSupplier)
+        sku.articleCodeSupplier = sku.articleCode;
+    if (!sku.size && sku.sizeSupplier)
+        sku.size = sku.sizeSupplier;
+    if (!sku.barcode)
+        sku.barcode = sku.id;
+    sku.PRODUCT = (_a = sku.articleCodeSupplier) !== null && _a !== void 0 ? _a : '';
+}
+exports.default = ensureImpliedProperties;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { default as deepCopy } from './deepCopy';
 export { default as ean13 } from './ean13';
 export { default as edifact } from './edifact';
 export { default as ensureArray } from './ensureArray';
+export { default as ensureImpliedProperties } from './ensureImpliedProperties';
 export { default as findSkuByBarcode } from './findSkuByBarcode';
 export { default as getBrandName } from './getBrandName';
 export { default as getPreferedPropertyMappings } from './getPreferedPropertyMappings';

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAxiosError = exports.exponentialDelay = exports.axiosRetry = exports.createAxiosInstance = exports.lcAxios = exports.transaction = exports.sizeToMap = exports.round2 = exports.pivotTable = exports.isean13 = exports.imageBinder = exports.hasOnlyDigits = exports.hashBrand = exports.getPreferedPropertyMappings = exports.getBrandName = exports.findSkuByBarcode = exports.ensureArray = exports.edifact = exports.ean13 = exports.deepCopy = exports.buildPropertyMappingFn = exports.articleStatus = void 0;
+exports.isAxiosError = exports.exponentialDelay = exports.axiosRetry = exports.createAxiosInstance = exports.lcAxios = exports.transaction = exports.sizeToMap = exports.round2 = exports.pivotTable = exports.isean13 = exports.imageBinder = exports.hasOnlyDigits = exports.hashBrand = exports.getPreferedPropertyMappings = exports.getBrandName = exports.findSkuByBarcode = exports.ensureImpliedProperties = exports.ensureArray = exports.edifact = exports.ean13 = exports.deepCopy = exports.buildPropertyMappingFn = exports.articleStatus = void 0;
 var articleStatus_1 = require("./articleStatus");
 Object.defineProperty(exports, "articleStatus", { enumerable: true, get: function () { return __importDefault(articleStatus_1).default; } });
 var buildPropertyMappingFn_1 = require("./buildPropertyMappingFn");
@@ -30,6 +30,8 @@ var edifact_1 = require("./edifact");
 Object.defineProperty(exports, "edifact", { enumerable: true, get: function () { return __importDefault(edifact_1).default; } });
 var ensureArray_1 = require("./ensureArray");
 Object.defineProperty(exports, "ensureArray", { enumerable: true, get: function () { return __importDefault(ensureArray_1).default; } });
+var ensureImpliedProperties_1 = require("./ensureImpliedProperties");
+Object.defineProperty(exports, "ensureImpliedProperties", { enumerable: true, get: function () { return __importDefault(ensureImpliedProperties_1).default; } });
 var findSkuByBarcode_1 = require("./findSkuByBarcode");
 Object.defineProperty(exports, "findSkuByBarcode", { enumerable: true, get: function () { return __importDefault(findSkuByBarcode_1).default; } });
 var getBrandName_1 = require("./getBrandName");

package/dist/transaction.d.ts

@@ -66,6 +66,7 @@ declare const _default: {
         AMOUNT_END_STOCK: number;
         RETURN_PERCENTAGE: number;
         QTY_SOLD_BEFORE_RETURNS: number;
+        ROI_PERCENTAGE: number;
     };
     buildTransaction: (transaction: TransactionI) => dbTransactionI | undefined;
     buildVector: (transaction: TransactionI) => Float64Array;

package/dist/transaction.js

@@ -71,6 +71,7 @@ const dbTransactionVector = {
     AMOUNT_END_STOCK: 62,
     RETURN_PERCENTAGE: 63,
     QTY_SOLD_BEFORE_RETURNS: 64,
+    ROI_PERCENTAGE: 65,
 };
 const tv = dbTransactionVector;
 const buildVector = function (transaction) {

package/dist/types.d.ts

@@ -131,6 +131,8 @@ interface SkuI {
     IMAGES?: Array<ImageI>;
     SIZES?: unknown;
     FOOTPRINT?: number;
+    /** UI-only clustering key for product tiles / matrices; not persisted. Phase 1 mirrors articleCodeSupplier after ensureImpliedProperties. */
+    PRODUCT?: string;
     quickPick?: number;
     gln?: string;
     set?: string;
@@ -225,9 +227,6 @@ interface BrandSettingI {
     gln?: string;
     ownerTenantId?: string;
     orderMethods?: string[];
-    whiteListTenants?: string[];
-    associates?: object[];
-    authGroups?: string[];
     propertyMapping?: PropertyMappingI[];
     fashionCloudId?: string;
     sizeSystemPrefix?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softwear/latestcollectioncore",
-  "version": "1.0.163",
+  "version": "1.0.165",
   "description": "Core functions for LatestCollections applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,8 +18,7 @@
     "build": "tsc -p tsconfig.json",
     "build:watch": "tsc -p tsconfig.json --watch",
     "test": "vitest run",
-    "test:watch": "vitest",
-    "dev": "concurrently \"npm:build:watch\" \"npm:test:watch\""
+    "test:watch": "vitest"
   },
   "repository": {
     "type": "git",
@@ -33,7 +32,6 @@
   "homepage": "https://gitlab.com/softwearconnect/latestcollectioncore#readme",
   "devDependencies": {
     "@types/node": "^18.11.17",
-    "concurrently": "^9.2.1",
     "typescript": "^4.9.4",
     "vitest": "^1.0.0"
   },

package/src/articleStatus.ts

@@ -75,6 +75,7 @@ const {
   AMOUNT_END_STOCK,
   RETURN_PERCENTAGE,
   QTY_SOLD_BEFORE_RETURNS,
+  ROI_PERCENTAGE,
 } = transactionFunctions.dbTransactionVector
 
 // Vector length to allocate for aggregation
@@ -375,6 +376,8 @@ function postAgg(v: any, timeFrame: number): void {
   v[MARGIN] = (v[PROFIT] / totalAmountSold) * 100
   v[RETURN_PERCENTAGE] = (v[QTY_RETURN] / v[QTY_RECIEVED]) * 100
   v[QTY_SOLD_BEFORE_RETURNS] = totalQtySold + Math.abs(v[QTY_RETURN])
+  const investmentBase = v[AMOUNT_RECIEVED] - v[AMOUNT_TRANSIT]
+  v[ROI_PERCENTAGE] = investmentBase <= 0 ? NaN : ((v[ROI] + investmentBase) / investmentBase) * 100
   v[QTY_SOLD] = totalQtySold
   v[AMOUNT_SOLD_EXCL] = totalAmountSold
   v[COSTPRICE_SOLD] = totalCostSold
@@ -616,6 +619,7 @@ export default {
   QTY_B2B_RETURN,
   RETURN_PERCENTAGE,
   ROI,
+  ROI_PERCENTAGE,
   SELLOUT_PERCENTAGE,
   STOCKAMOUNT_TIME_PRODUCT,
   STOCK_TIME_PRODUCT,

package/src/ensureImpliedProperties.ts

@@ -0,0 +1,23 @@
+import type { SkuI } from './types'
+
+/**
+ * Fills missing SKU fields from redundant sources (supplier mirrors, articleCode, id, etc.).
+ * Then sets UI-only `PRODUCT` to the clustering key (phase 1: same as `articleCodeSupplier` after normalization).
+ * Mutates the sku in place.
+ */
+export default function ensureImpliedProperties(sku: SkuI): void {
+  if (!sku.articleGroupSupplier) sku.articleGroupSupplier = sku.articleGroup
+  if (!sku.collectionSupplier) sku.collectionSupplier = sku.collection
+  if (!sku.colorCodeSupplier) sku.colorCodeSupplier = sku.colorCode
+  if (!sku.sizeSupplier) sku.sizeSupplier = sku.size
+  if (!sku.brandSupplier) sku.brandSupplier = sku.brand
+
+  if (!sku.colorFamily && sku.colorSupplier) sku.colorFamily = '' + sku.colorSupplier
+  if (!sku.colorFamily && sku.colorDescription) sku.colorFamily = '' + sku.colorDescription
+  if (!sku.colorFamily && sku.mainColorDescription) sku.colorFamily = '' + sku.mainColorDescription
+  if (!sku.articleCodeSupplier) sku.articleCodeSupplier = sku.articleCode
+  if (!sku.size && sku.sizeSupplier) sku.size = sku.sizeSupplier
+  if (!sku.barcode) sku.barcode = sku.id
+
+  sku.PRODUCT = sku.articleCodeSupplier ?? ''
+}

package/src/index.ts

@@ -4,6 +4,7 @@ export { default as deepCopy } from './deepCopy'
 export { default as ean13 } from './ean13'
 export { default as edifact } from './edifact'
 export { default as ensureArray } from './ensureArray'
+export { default as ensureImpliedProperties } from './ensureImpliedProperties'
 export { default as findSkuByBarcode } from './findSkuByBarcode'
 export { default as getBrandName } from './getBrandName'
 export { default as getPreferedPropertyMappings } from './getPreferedPropertyMappings'

package/src/transaction.ts

@@ -73,6 +73,7 @@ const dbTransactionVector = {
   AMOUNT_END_STOCK: 62,
   RETURN_PERCENTAGE: 63,
   QTY_SOLD_BEFORE_RETURNS: 64,
+  ROI_PERCENTAGE: 65,
 }
 const tv = dbTransactionVector
 

package/src/types.ts

@@ -140,6 +140,8 @@ interface SkuI {
   IMAGES?: Array<ImageI>
   SIZES?: unknown
   FOOTPRINT?: number
+  /** UI-only clustering key for product tiles / matrices; not persisted. Phase 1 mirrors articleCodeSupplier after ensureImpliedProperties. */
+  PRODUCT?: string
   quickPick?: number
   gln?: string
   set?: string
@@ -239,9 +241,6 @@ interface BrandSettingI {
   gln?: string
   ownerTenantId?: string
   orderMethods?: string[]
-  whiteListTenants?: string[]
-  associates?: object[]
-  authGroups?: string[]
   propertyMapping?: PropertyMappingI[]
   fashionCloudId?: string
   sizeSystemPrefix?: string

package/test/articleStatus.spec.js

@@ -123,6 +123,9 @@ describe('articleStatus', () => {
     it('QTY_SOLD_BEFORE_RETURNS should be 64', () => {
       expect(articleStatus.QTY_SOLD_BEFORE_RETURNS).toBe(64)
     })
+    it('ROI_PERCENTAGE should be 65', () => {
+      expect(articleStatus.ROI_PERCENTAGE).toBe(65)
+    })
     it('AMOUNT_RETURN should be 49', () => {
       expect(articleStatus.AMOUNT_RETURN).toBe(49)
     })
@@ -414,5 +417,27 @@ describe('articleStatus', () => {
       expect(dateRange.hrDay).toBe('2024-01-01')
       expect(dateRange.timeFrame).toBe(367 * 24 * 3600 * 1000)
     })
+
+    it('should calculate ROI percentage from post-aggregated values', () => {
+      const vector = new Array(articleStatus.ROI_PERCENTAGE + 1).fill(0)
+      vector[articleStatus.AMOUNT_RECIEVED] = 8700
+      vector[articleStatus.AMOUNT_SOLD_EXCL] = 5900
+
+      articleStatus.postAgg(vector, msYear)
+
+      expect(vector[articleStatus.ROI]).toBe(-2800)
+      expect(vector[articleStatus.ROI_PERCENTAGE]).toBeCloseTo(67.81609195402298, 10)
+    })
+
+    it('should set ROI percentage to NaN when investment base is zero or negative', () => {
+      const vector = new Array(articleStatus.ROI_PERCENTAGE + 1).fill(0)
+      vector[articleStatus.AMOUNT_RECIEVED] = 100
+      vector[articleStatus.AMOUNT_TRANSIT] = 100
+      vector[articleStatus.AMOUNT_SOLD_EXCL] = 150
+
+      articleStatus.postAgg(vector, msYear)
+
+      expect(Number.isNaN(vector[articleStatus.ROI_PERCENTAGE])).toBe(true)
+    })
   })
 })

package/test/ensureImpliedProperties.spec.ts

@@ -0,0 +1,95 @@
+import { describe, expect, it } from 'vitest'
+import ensureImpliedProperties from '../src/ensureImpliedProperties'
+import type { SkuI } from '../src/types'
+
+function baseSku(overrides: Partial<SkuI> = {}): SkuI {
+  return {
+    articleCode: 'AC-1',
+    articleDescription: 'Desc',
+    brand: 'BrandX',
+    colorFamily: 'Black',
+    size: 'M',
+    ...overrides,
+  } as SkuI
+}
+
+describe('ensureImpliedProperties', () => {
+  it('fills articleCodeSupplier from articleCode and sets PRODUCT to match', () => {
+    const sku = baseSku({ articleCode: 'SUP-99' })
+    delete (sku as { articleCodeSupplier?: string }).articleCodeSupplier
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.articleCodeSupplier).toBe('SUP-99')
+    expect(sku.PRODUCT).toBe('SUP-99')
+  })
+
+  it('sets PRODUCT from existing articleCodeSupplier without overwriting', () => {
+    const sku = baseSku({
+      articleCode: 'AC-1',
+      articleCodeSupplier: 'ALREADY-SET',
+    })
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.articleCodeSupplier).toBe('ALREADY-SET')
+    expect(sku.PRODUCT).toBe('ALREADY-SET')
+  })
+
+  it('sets barcode from id when barcode is missing', () => {
+    const sku = baseSku({
+      id: 'ID-12345',
+      barcode: undefined,
+    })
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.barcode).toBe('ID-12345')
+    expect(sku.PRODUCT).toBe('AC-1')
+  })
+
+  it('fills colorFamily from colorSupplier when colorFamily is missing', () => {
+    const sku = baseSku({
+      colorFamily: undefined as unknown as string,
+      colorSupplier: 'Navy',
+    })
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.colorFamily).toBe('Navy')
+    expect(sku.PRODUCT).toBe('AC-1')
+  })
+
+  it('fills supplier mirror fields from primary fields', () => {
+    const sku = baseSku({
+      articleGroup: 'G1',
+      collection: 'C1',
+      colorCode: 'CC',
+      brand: 'B1',
+    })
+    delete (sku as { articleGroupSupplier?: string }).articleGroupSupplier
+    delete (sku as { collectionSupplier?: string }).collectionSupplier
+    delete (sku as { colorCodeSupplier?: string }).colorCodeSupplier
+    delete (sku as { brandSupplier?: string }).brandSupplier
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.articleGroupSupplier).toBe('G1')
+    expect(sku.collectionSupplier).toBe('C1')
+    expect(sku.colorCodeSupplier).toBe('CC')
+    expect(sku.brandSupplier).toBe('B1')
+    expect(sku.PRODUCT).toBe('AC-1')
+  })
+
+  it('sets PRODUCT to empty string when articleCodeSupplier is still missing after fallbacks', () => {
+    const sku = baseSku({
+      articleCode: '',
+      articleCodeSupplier: undefined,
+    })
+
+    ensureImpliedProperties(sku)
+
+    expect(sku.articleCodeSupplier).toBe('')
+    expect(sku.PRODUCT).toBe('')
+  })
+})