@softwear/latestcollectioncore 1.0.73 → 1.0.74

package/dist/findSkuByBarcode.d.ts

@@ -1,10 +1,9 @@
 import { MarkedSkuI } from './types';
 /**
- *
  * Find a sku by 12 or 13 digit barcode.
  * 12-digit US UPC barcodes can be shorthand for a 13-digit barcodes in the DB
  * According to the UPC/EAN standard, US barcodes can omit the first 0 when printed
  */
-export default function (barcodeToFind: string, skus: {
+export default function (skus: {
     [barcode: string]: MarkedSkuI;
-}): MarkedSkuI | null;
+}, barcodeToFind: string): MarkedSkuI | null;

package/dist/findSkuByBarcode.js

@@ -1,41 +1,61 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- *
- * Find a sku by 12 or 13 digit barcode.
- * 12-digit US UPC barcodes can be shorthand for a 13-digit barcodes in the DB
- * According to the UPC/EAN standard, US barcodes can omit the first 0 when printed
+ * Find a sku by barcode within an array.
+ */
+const lookupSkuInArray = function (skus, barcodeToFind) {
+    const foundSku = skus.find((sku) => sku.id === barcodeToFind);
+    return foundSku ? foundSku : null;
+};
+/**
+ * Find an alternative sku that have the same first 12 digits of the barcode within an array.
+ */
+const lookupAlternativeSkuInArray = function (skus, barcodeToFind) {
+    if (barcodeToFind.length !== 13)
+        return null;
+    const prefix = barcodeToFind.substring(0, 12);
+    const foundSku = skus.find((sku) => { var _a; return ((_a = sku.id) === null || _a === void 0 ? void 0 : _a.substring(0, 12)) === prefix; });
+    return foundSku ? foundSku : null;
+};
+/**
+ * Find a sku by barcode from an array.
+ */
+const findSkuByBarcodeFromArray = function (skus, barcodeToFind) {
+    let foundSku = lookupSkuInArray(skus, barcodeToFind);
+    if (foundSku)
+        return foundSku;
+    // This is an internally generated barcode.
+    // We have some weird errors from the past where incorrect barcodes were generated (wrong check digit.)
+    // When these barcodes were printed in our legacy software, noone noticed. Now, when LC prints these barcodes, the printer
+    // corrects the check digit. This results in a scan of a barcode that does not appear in the DB.
+    // However, we know which barcode we need because we can ignore the check digit.
+    foundSku = lookupAlternativeSkuInArray(skus, barcodeToFind);
+    if (foundSku)
+        return foundSku;
+    if (barcodeToFind.length != 12)
+        return null;
+    const barcode13 = '0' + barcodeToFind;
+    foundSku = lookupSkuInArray(skus, barcode13);
+    if (foundSku)
+        return foundSku;
+    return null;
+};
+/**
+ * Find a sku by barcode from an object.
  */
-function default_1(barcodeToFind, skus) {
+const findSkuByBarcodeFromObject = function (skus, barcodeToFind) {
     if (skus[barcodeToFind])
         return skus[barcodeToFind];
-    if (barcodeToFind.length == 13 && barcodeToFind.substring(0, 1) == '2') {
+    if (barcodeToFind.length == 13) {
         // This is an internally generated barcode.
         // We have some weird errors from the past where incorrect barcodes were generated (wrong check digit.)
         // When these barcodes were printed in our legacy software, noone noticed. Now, when LC prints these barcodes, the printer
         // corrects the check digit. This results in a scan of a barcode that does not appear in the DB.
         // However, we know which barcode we need because we can ignore the check digit.
         const prefix = barcodeToFind.substring(0, 12);
-        if (skus[prefix + '0'])
-            return skus[prefix + '0'];
-        if (skus[prefix + '1'])
-            return skus[prefix + '1'];
-        if (skus[prefix + '2'])
-            return skus[prefix + '2'];
-        if (skus[prefix + '3'])
-            return skus[prefix + '3'];
-        if (skus[prefix + '4'])
-            return skus[prefix + '4'];
-        if (skus[prefix + '5'])
-            return skus[prefix + '5'];
-        if (skus[prefix + '6'])
-            return skus[prefix + '6'];
-        if (skus[prefix + '7'])
-            return skus[prefix + '7'];
-        if (skus[prefix + '8'])
-            return skus[prefix + '8'];
-        if (skus[prefix + '9'])
-            return skus[prefix + '9'];
+        for (let i = 0; i <= 9; i++)
+            if (skus[prefix + `${i}`])
+                return skus[prefix + `${i}`];
     }
     if (barcodeToFind.length != 12)
         return null;
@@ -43,5 +63,23 @@ function default_1(barcodeToFind, skus) {
     if (skus[barcode13])
         return skus[barcode13];
     return null;
+};
+/**
+ * Check whether the passed parameter is an object
+ */
+function isObject(variable) {
+    return variable !== null && variable !== undefined && typeof variable === 'object' && !Array.isArray(variable);
+}
+/**
+ * Find a sku by 12 or 13 digit barcode.
+ * 12-digit US UPC barcodes can be shorthand for a 13-digit barcodes in the DB
+ * According to the UPC/EAN standard, US barcodes can omit the first 0 when printed
+ */
+function default_1(skus, barcodeToFind) {
+    if (Array.isArray(skus))
+        return findSkuByBarcodeFromArray(skus, barcodeToFind);
+    if (isObject(skus))
+        return findSkuByBarcodeFromObject(skus, barcodeToFind);
+    throw Error(`findSkuByBarcode doesn't support type of ${typeof skus}, must be an object or an array.`);
 }
 exports.default = default_1;

package/package.json

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

package/src/findSkuByBarcode.ts

@@ -1,30 +1,58 @@
 import { MarkedSkuI } from './types'
 
 /**
- *
- * Find a sku by 12 or 13 digit barcode.
- * 12-digit US UPC barcodes can be shorthand for a 13-digit barcodes in the DB
- * According to the UPC/EAN standard, US barcodes can omit the first 0 when printed
+ * Find a sku by barcode within an array.
+ */
+const lookupSkuInArray = function (skus: MarkedSkuI[], barcodeToFind: string): MarkedSkuI | null {
+  const foundSku = skus.find((sku: MarkedSkuI) => sku.id === barcodeToFind)
+  return foundSku ? foundSku : null 
+}
+
+/**
+ * Find an alternative sku that have the same first 12 digits of the barcode within an array.
+ */
+const lookupAlternativeSkuInArray = function (skus: MarkedSkuI[], barcodeToFind: string): MarkedSkuI | null {
+  if (barcodeToFind.length !== 13) return null
+  const prefix = barcodeToFind.substring(0, 12)
+  const foundSku = skus.find((sku: MarkedSkuI) => sku.id?.substring(0, 12) === prefix)
+  return foundSku ? foundSku : null 
+}
+
+/**
+ * Find a sku by barcode from an array.
  */
-export default function (barcodeToFind: string, skus: { [barcode: string]: MarkedSkuI }): MarkedSkuI | null {
+const findSkuByBarcodeFromArray = function (skus: MarkedSkuI[], barcodeToFind: string): MarkedSkuI | null {
+  let foundSku = lookupSkuInArray(skus, barcodeToFind)
+  if (foundSku) return foundSku
+
+  // This is an internally generated barcode.
+  // We have some weird errors from the past where incorrect barcodes were generated (wrong check digit.)
+  // When these barcodes were printed in our legacy software, noone noticed. Now, when LC prints these barcodes, the printer
+  // corrects the check digit. This results in a scan of a barcode that does not appear in the DB.
+  // However, we know which barcode we need because we can ignore the check digit.
+  foundSku = lookupAlternativeSkuInArray(skus, barcodeToFind)
+  if (foundSku) return foundSku
+
+  if (barcodeToFind.length != 12) return null
+  const barcode13 = '0' + barcodeToFind
+  foundSku = lookupSkuInArray(skus, barcode13)
+  if (foundSku) return foundSku
+  return null
+}
+
+/**
+ * Find a sku by barcode from an object.
+ */
+const findSkuByBarcodeFromObject = function (skus: { [barcode: string]: MarkedSkuI }, barcodeToFind: string): MarkedSkuI | null {
   if (skus[barcodeToFind]) return skus[barcodeToFind]
-  if (barcodeToFind.length == 13 && barcodeToFind.substring(0, 1) == '2') {
+  if (barcodeToFind.length == 13) {
     // This is an internally generated barcode.
     // We have some weird errors from the past where incorrect barcodes were generated (wrong check digit.)
     // When these barcodes were printed in our legacy software, noone noticed. Now, when LC prints these barcodes, the printer
     // corrects the check digit. This results in a scan of a barcode that does not appear in the DB.
     // However, we know which barcode we need because we can ignore the check digit.
     const prefix = barcodeToFind.substring(0, 12)
-    if (skus[prefix + '0']) return skus[prefix + '0']
-    if (skus[prefix + '1']) return skus[prefix + '1']
-    if (skus[prefix + '2']) return skus[prefix + '2']
-    if (skus[prefix + '3']) return skus[prefix + '3']
-    if (skus[prefix + '4']) return skus[prefix + '4']
-    if (skus[prefix + '5']) return skus[prefix + '5']
-    if (skus[prefix + '6']) return skus[prefix + '6']
-    if (skus[prefix + '7']) return skus[prefix + '7']
-    if (skus[prefix + '8']) return skus[prefix + '8']
-    if (skus[prefix + '9']) return skus[prefix + '9']
+    for (let i = 0; i <= 9; i++) if (skus[prefix + `${i}`]) return skus[prefix + `${i}`]
   }
 
   if (barcodeToFind.length != 12) return null
@@ -32,3 +60,21 @@ export default function (barcodeToFind: string, skus: { [barcode: string]: Marke
   if (skus[barcode13]) return skus[barcode13]
   return null
 }
+
+/**
+ * Check whether the passed parameter is an object
+ */
+function isObject(variable: any): boolean {
+  return variable !== null && variable !== undefined && typeof variable === 'object' && !Array.isArray(variable);
+}
+
+/**
+ * Find a sku by 12 or 13 digit barcode.
+ * 12-digit US UPC barcodes can be shorthand for a 13-digit barcodes in the DB
+ * According to the UPC/EAN standard, US barcodes can omit the first 0 when printed
+ */
+export default function (skus: { [barcode: string]: MarkedSkuI }, barcodeToFind: string): MarkedSkuI | null {
+  if (Array.isArray(skus)) return findSkuByBarcodeFromArray(skus, barcodeToFind)
+  if (isObject(skus)) return findSkuByBarcodeFromObject(skus, barcodeToFind)
+  throw Error(`findSkuByBarcode doesn't support type of ${typeof skus}, must be an object or an array.`)
+}

package/test/findSkuByBarcode.spec.js

@@ -2,22 +2,48 @@ const { findSkuByBarcode } = require('../dist/index')
 const { expect } = require('chai')
 
 describe('findSkuByBarcode function', function () {
-  it('should return null for any barcode shorter than 12 digits', function () {
-    expect(findSkuByBarcode('12345678901', {})).to.equal(null)
+  // Test findSkuByBarcode function by passing skus parameter as an Object
+  it('(Skus Object) should return null for any barcode shorter than 12 digits', function () {
+    expect(findSkuByBarcode({}, '12345678901')).to.equal(null)
   })
-  it('should return the sku at the first check if exist', function () {
-    expect(findSkuByBarcode('1234567890123', { 1234567890123: { id: '1234567890123' } })).to.deep.equal({ id: '1234567890123' })
+  it('(Skus Object) should return the sku at the first check if exist', function () {
+    expect(findSkuByBarcode({ '1234567890123': { id: '1234567890123' } }, '1234567890123')).to.deep.equal({ id: '1234567890123' })
   })
-  it('should return the sku at the second check if exist, 13 digits, begins with 2', function () {
-    expect(findSkuByBarcode('2234567890123', { 2234567890127: { id: '2234567890127' } })).to.deep.equal({ id: '2234567890127' })
+  it('(Skus Object) should return the sku at the second check if exist with another last number, 13 digits', function () {
+    expect(findSkuByBarcode({ '1234567890127': { id: '1234567890127' } }, '1234567890123')).to.deep.equal({ id: '1234567890127' })
   })
-  it('should return null because the sku doesn not exist', function () {
-    expect(findSkuByBarcode('2234567890123', {})).to.equal(null)
+  it('(Skus Object) should return null because the sku doesn not exist', function () {
+    expect(findSkuByBarcode({}, '2234567890123')).to.equal(null)
   })
-  it('should return the sku at the third check if exist, 12 digits', function () {
-    expect(findSkuByBarcode('123456789012', { '0123456789012': { id: '0123456789012' } })).to.deep.equal({ id: '0123456789012' })
+  it('(Skus Object) should return the sku at the third check if exist, 12 digits', function () {
+    expect(findSkuByBarcode({ '0123456789012': { id: '0123456789012' } }, '123456789012')).to.deep.equal({ id: '0123456789012' })
   })
-  it('should return the null because the sku does not exist, 12 digits', function () {
-    expect(findSkuByBarcode('123456789012', {})).to.deep.equal(null)
+  it('(Skus Object) should return the null because the sku does not exist, 12 digits', function () {
+    expect(findSkuByBarcode({}, '123456789012')).to.deep.equal(null)
+  })
+  // Test findSkuByBarcode function by passing skus parameter as an Array
+  it('(Skus Array) should return null for any barcode shorter than 12 digits', function () {
+    expect(findSkuByBarcode([], '12345678901')).to.equal(null)
+  })
+  it('(Skus Array) should return the sku at the first check if exist', function () {
+    expect(findSkuByBarcode([{ id: '1234567890123' }], '1234567890123')).to.deep.equal({ id: '1234567890123' })
+  })
+  it('(Skus Array) should return the sku at the second check if exist with another last number, 13 digits', function () {
+    expect(findSkuByBarcode([{ id: '1234567890127' }], '1234567890123')).to.deep.equal({ id: '1234567890127' })
+  })
+  it('(Skus Array) should return null because the sku doesn not exist', function () {
+    expect(findSkuByBarcode([], '2234567890123')).to.equal(null)
+  })
+  it('(Skus Array) should return the sku at the third check if exist, 12 digits', function () {
+    expect(findSkuByBarcode([{ id: '0123456789012' }], '123456789012')).to.deep.equal({ id: '0123456789012' })
+  })
+  it('(Skus Array) should return the null because the sku does not exist, 12 digits', function () {
+    expect(findSkuByBarcode([], '123456789012')).to.deep.equal(null)
+  })
+
+  it('should fail validation for unsupported skus type', function () {
+    expect(() => findSkuByBarcode(123, '123')).to.throw("findSkuByBarcode doesn't support type of number, must be an object or an array.")
+    expect(() => findSkuByBarcode('123', '123')).to.throw("findSkuByBarcode doesn't support type of string, must be an object or an array.")
+    expect(() => findSkuByBarcode(true, '123')).to.throw("findSkuByBarcode doesn't support type of boolean, must be an object or an array.")
   })
 })