@softwear/latestcollectioncore 1.0.130 → 1.0.132

package/.cursorrules

@@ -0,0 +1,353 @@
+# latestcollectioncore Library Rules
+
+**Context**: This is a shared TypeScript library used by both erp8 (frontend) and latest-collection-server (backend). See parent `.cursorrules` for overall architecture.
+
+## Core Principles
+
+1. **Pure and portable**: No side effects, runs in browser AND Node.js
+2. **Strictly typed**: All exports have TypeScript types
+3. **Tested**: Unit tests for all functions
+4. **Semver discipline**: Breaking changes = major version bump
+
+## What Belongs Here
+
+✅ **Include**:
+
+- Pure utility functions (data transformation, validation, formatting)
+- Shared TypeScript types/interfaces
+- Constants used by multiple repos
+- Business logic calculations (no I/O)
+- Format converters (barcode, dates, currency)
+
+❌ **Exclude**:
+
+- Node.js-specific code (`fs`, `path`, `http`)
+- Browser-specific code (`window`, `document`, `localStorage`)
+- Database operations
+- API calls
+- UI components
+- Environment-dependent config
+
+## Development Rules
+
+### Function Design
+
+**Pure functions only**:
+
+```typescript
+// ✅ Good - pure function
+export function calculateDiscount(price: number, percent: number): number {
+  return price * (1 - percent / 100)
+}
+
+// ❌ Bad - side effect
+export function saveDiscount(price: number, percent: number): number {
+  localStorage.setItem('lastDiscount', percent.toString()) // Browser-only!
+  return price * (1 - percent / 100)
+}
+```
+
+**Dependency injection for testing**:
+
+```typescript
+// ✅ Good - inject dependencies
+export function processData(data: Data[], deps?: { logger?: (msg: string) => void }): Result {
+  deps?.logger?.('Processing started')
+  // ... pure logic
+  return result
+}
+
+// ❌ Bad - hardcoded dependency
+import { logger } from './logger' // Might not work in browser
+export function processData(data: Data[]): Result {
+  logger.log('Processing started')
+  return result
+}
+```
+
+### Type Definitions
+
+**Export types from index.ts**:
+
+```typescript
+// src/types.ts
+export interface Sku {
+  id: string
+  barcode: string
+  description: string
+  price: number
+}
+
+// src/index.ts
+export { Sku } from './types'
+export { deepCopy } from './utils/deepCopy'
+```
+
+**Use discriminated unions for complex types**:
+
+```typescript
+export type Result<T> = { success: true; data: T } | { success: false; error: string }
+```
+
+### Testing
+
+**Every exported function needs a test**:
+
+```typescript
+// test/deepCopy.test.js
+import { deepCopy } from '../src/utils/deepCopy'
+
+describe('deepCopy', () => {
+  it('creates independent copy', () => {
+    const original = { a: { b: 1 } }
+    const copy = deepCopy(original)
+    copy.a.b = 2
+    expect(original.a.b).toBe(1)
+  })
+})
+```
+
+**Test in both Node and browser environments** (if applicable):
+
+- Use framework-agnostic test runner (e.g., Mocha, Jest)
+- Avoid Node-specific assertions
+
+## File Structure
+
+✅ Keep folder structure flat
+❌ Clutter `/src` folder with unneccesary subfolders
+
+```
+latestcollectioncore/
+├── src/
+│   ├── index.ts              # Main export file
+│   ├── types.ts              # Shared TypeScript types
+│   ├── deepCopy.ts
+│   ├── articleStatus.ts
+│   ├── formatCurrency.ts
+│   ├── inventory.ts
+│   └── validateBarcode.ts
+├── test/
+│   ├── deepCopy.test.js
+│   └── validateBarcode.test.js
+├── dist/                     # Compiled output
+├── package.json
+└── tsconfig.json
+```
+
+## Versioning & Publishing
+
+### Semver Rules
+
+- **Patch** (1.0.x): Bug fixes, no API changes
+- **Minor** (1.x.0): New functions, backward compatible
+- **Major** (x.0.0): Breaking changes to existing exports
+
+### Before Publishing Checklist
+
+1. ✅ All tests pass: `npm test`
+2. ✅ TypeScript compiles: `npm run build`
+3. ✅ No Node/browser-specific code
+4. ✅ Exports added to `index.ts`
+5. ✅ Version bumped in `package.json`
+6. ✅ Changelog updated
+
+### Breaking Change Examples
+
+- Removing or renaming exported function
+- Changing function signature (parameters, return type)
+- Changing behavior of existing function
+- Removing or renaming exported type
+
+### Non-Breaking Change Examples
+
+- Adding new exported function
+- Adding optional parameters with defaults
+- Adding new exported type
+- Internal refactoring (no export changes)
+
+## Common Utilities
+
+### deepCopy
+
+**Critical for erp8's database pattern** - always deep copy before modifying objects from globalStore:
+
+```typescript
+import { deepCopy } from '@softwear/latestcollectioncore'
+
+const original = globalStore.getLatestCollectionObject('sku')[id]
+const modified = deepCopy(original)
+modified.price = 100
+// Now updateObjects will detect the diff
+```
+
+### Validation
+
+```typescript
+// validateBarcode.ts
+export function isValidEAN13(barcode: string): boolean {
+  if (!/^\d{13}$/.test(barcode)) return false
+  // ... checksum validation
+  return true
+}
+```
+
+### Formatting
+
+```typescript
+// formatCurrency.ts
+export function formatCurrency(amount: number, currency: string = 'EUR'): string {
+  return new Intl.NumberFormat('nl-NL', {
+    style: 'currency',
+    currency,
+  }).format(amount)
+}
+```
+
+## Import Restrictions
+
+### Allowed Standard Imports
+
+- ✅ Pure JavaScript standard library (Array, Object, Math, Date, etc.)
+- ✅ TypeScript types (no runtime)
+- ✅ Other functions within latestcollectioncore
+
+### Forbidden Imports
+
+- ❌ `fs`, `path`, `http`, `process` (Node.js only)
+- ❌ `window`, `document`, `localStorage` (Browser only)
+- ❌ `axios`, `express`, `vue` (app-specific)
+- ❌ External dependencies (minimize; justify each)
+
+### External Dependencies
+
+- Keep `package.json` dependencies minimal
+- Prefer zero-dependency implementations for simple utilities
+- If needed, choose universal libraries (work in Node + browser)
+- Document why each dependency is required
+
+## Documentation
+
+### JSDoc for Complex Functions
+
+````typescript
+/**
+ * Calculates inventory from transaction history
+ *
+ * @param transactions - Array of stock transactions
+ * @param warehouseId - Optional warehouse filter
+ * @returns Map of SKU ID to current quantity
+ *
+ * @example
+ * ```typescript
+ * const inventory = calculateInventory(transactions, 'WH001')
+ * console.log(inventory['12345']) // 42
+ * ```
+ */
+export function calculateInventory(transactions: Transaction[], warehouseId?: string): Map<string, number> {
+  // ...
+}
+````
+
+### README.md
+
+- List all major exported functions
+- Provide usage examples
+- Explain design principles
+- Document breaking changes in each version
+
+## Error Handling
+
+**Return errors, don't throw**:
+
+```typescript
+// ✅ Good - explicit error handling
+export function parseBarcode(input: string): Result<Barcode> {
+  if (!isValidEAN13(input)) {
+    return { success: false, error: 'Invalid EAN-13 format' }
+  }
+  return { success: true, data: { ... } }
+}
+
+// ❌ Bad - throws exception
+export function parseBarcode(input: string): Barcode {
+  if (!isValidEAN13(input)) {
+    throw new Error('Invalid EAN-13 format')
+  }
+  return { ... }
+}
+```
+
+**Why**: Throwing errors crosses module boundaries unpredictably; explicit returns are clearer.
+
+## Performance
+
+- **Avoid premature optimization** - clarity first
+- **Benchmark hot paths** - use `console.time()` in tests
+- **Document O(n) complexity** for non-trivial algorithms
+- **Lazy evaluation** for expensive computations:
+  ```typescript
+  export function expensiveCalc(data: Data): () => Result {
+    return () => {
+      /* compute only when called */
+    }
+  }
+  ```
+
+## Common Pitfalls
+
+- ❌ Importing Node.js `fs` to read config files
+- ❌ Using `process.env` for environment variables
+- ❌ Mutating input parameters (always return new objects)
+- ❌ Using `console.log` (pass logger via deps if needed)
+- ❌ Publishing without testing in both erp8 and server
+- ✅ Keep functions small and focused
+- ✅ Write tests first (TDD when possible)
+- ✅ Document breaking changes in CHANGELOG
+- ✅ Use TypeScript strict mode
+
+## Publishing Workflow
+
+```bash
+# 1. Make changes
+# 2. Update version in package.json
+npm version patch  # or minor, or major
+
+# 3. Build
+npm run build
+
+# 4. Test
+npm test
+
+# 5. Publish
+npm publish
+
+# 6. Update dependent repos
+cd ../erp8 && npm update @softwear/latestcollectioncore
+cd ../latest-collection-server && npm update @softwear/latestcollectioncore
+```
+
+## Integration with Other Repos
+
+### erp8 Usage
+
+```typescript
+import { deepCopy, formatCurrency } from '@softwear/latestcollectioncore'
+
+const sku = deepCopy(globalStore.getLatestCollectionObject('sku')[id])
+const priceFormatted = formatCurrency(sku.price)
+```
+
+### latest-collection-server Usage
+
+```typescript
+import { isValidEAN13 } from '@softwear/latestcollectioncore'
+
+if (!isValidEAN13(sku.barcode)) {
+  throw { status: 400, message: 'Invalid barcode' }
+}
+```
+
+Both repos should always use the same version of latestcollectioncore to avoid compatibility issues.
+
+

package/dist/getBrandName.d.ts

@@ -0,0 +1,3 @@
+export default function (brand: string, metaBrandSetting: {
+    [key: string]: any;
+}): string;

package/dist/getBrandName.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hashBrand_1 = __importDefault(require("./hashBrand"));
+function default_1(brand, metaBrandSetting) {
+    var _a;
+    const hashedBrand = (0, hashBrand_1.default)(brand);
+    return ((_a = metaBrandSetting[hashedBrand]) === null || _a === void 0 ? void 0 : _a.name) || brand;
+}
+exports.default = default_1;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { default as ean13 } from './ean13';
 export { default as edifact } from './edifact';
 export { default as ensureArray } from './ensureArray';
 export { default as findSkuByBarcode } from './findSkuByBarcode';
+export { default as getBrandName } from './getBrandName';
 export { default as getPreferedPropertyMappings } from './getPreferedPropertyMappings';
 export { default as hashBrand } from './hashBrand';
 export { default as hasOnlyDigits } from './hasOnlyDigits';

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.transaction = exports.sizeToMap = exports.round2 = exports.pivotTable = exports.isean13 = exports.imageBinder = exports.hasOnlyDigits = exports.hashBrand = exports.getPreferedPropertyMappings = exports.findSkuByBarcode = exports.ensureArray = exports.edifact = exports.ean13 = exports.deepCopy = exports.buildPropertyMappingFn = exports.articleStatus = void 0;
+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;
 var articleStatus_1 = require("./articleStatus");
 Object.defineProperty(exports, "articleStatus", { enumerable: true, get: function () { return __importDefault(articleStatus_1).default; } });
 var buildPropertyMappingFn_1 = require("./buildPropertyMappingFn");
@@ -32,6 +32,8 @@ var ensureArray_1 = require("./ensureArray");
 Object.defineProperty(exports, "ensureArray", { enumerable: true, get: function () { return __importDefault(ensureArray_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");
+Object.defineProperty(exports, "getBrandName", { enumerable: true, get: function () { return __importDefault(getBrandName_1).default; } });
 var getPreferedPropertyMappings_1 = require("./getPreferedPropertyMappings");
 Object.defineProperty(exports, "getPreferedPropertyMappings", { enumerable: true, get: function () { return __importDefault(getPreferedPropertyMappings_1).default; } });
 var hashBrand_1 = require("./hashBrand");

package/dist/isean13.js

@@ -12,6 +12,12 @@ function default_1(value) {
     if (stringILN.length != 13)
         return false;
     const baseNumber = stringILN.substring(0, 12);
-    return (0, ean13_1.default)(baseNumber) + '' == stringILN;
+    try {
+        const isean13 = (0, ean13_1.default)(baseNumber) + '' == stringILN;
+        return isean13;
+    }
+    catch (error) {
+        return false;
+    }
 }
 exports.default = default_1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softwear/latestcollectioncore",
-  "version": "1.0.130",
+  "version": "1.0.132",
   "description": "Core functions for LatestCollections applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/getBrandName.ts

@@ -0,0 +1,6 @@
+import hashBrand from './hashBrand'
+
+export default function (brand: string, metaBrandSetting: { [key: string]: any }): string {
+  const hashedBrand = hashBrand(brand)
+  return metaBrandSetting[hashedBrand]?.name || brand
+}

package/src/index.ts

@@ -5,6 +5,7 @@ export { default as ean13 } from './ean13'
 export { default as edifact } from './edifact'
 export { default as ensureArray } from './ensureArray'
 export { default as findSkuByBarcode } from './findSkuByBarcode'
+export { default as getBrandName } from './getBrandName'
 export { default as getPreferedPropertyMappings } from './getPreferedPropertyMappings'
 export { default as hashBrand } from './hashBrand'
 export { default as hasOnlyDigits } from './hasOnlyDigits'

package/src/isean13.ts

@@ -8,5 +8,10 @@ export default function (value: string | number): boolean {
   if (stringILN.length != 13) return false
 
   const baseNumber = stringILN.substring(0, 12)
-  return ean13(baseNumber) + '' == stringILN
+  try {
+    const isean13 = ean13(baseNumber) + '' == stringILN
+    return isean13
+  } catch (error) {
+    return false
+  }
 }

package/test/getBrandName.spec.js

@@ -0,0 +1,16 @@
+const { getBrandName } = require('../dist/index')
+const { expect } = require('chai')
+
+const should = require('chai').should()
+
+describe('getBrandName function', function () {
+  it('should return the brand name if it is in the meta brand setting', function () {
+    expect(getBrandName('Marie Jo', { mariejo: { name: 'Marie Jo' } })).to.equal('Marie Jo')
+    expect(getBrandName('mariejo', { mariejo: { name: 'Marie Jo' } })).to.equal('Marie Jo')
+    expect(getBrandName('MARIEJO', { mariejo: { name: 'Marie Jo' } })).to.equal('Marie Jo')
+    expect(getBrandName('Cl ~<>!@#$%.^&*():\'"? ean', { clean: { name: 'Clean' } })).to.equal('Clean')
+  })
+  it('should return the brand name if it is not in the meta brand setting', function () {
+    expect(getBrandName('Not in the meta brand setting', {})).to.equal('Not in the meta brand setting')
+  })
+})