@dotdev/harmony-sdk 1.0.6

package/dist/modules/stock-lookup/types/stock-lookup.interface.js

@@ -0,0 +1,82 @@
+// TODO: Refactor interfaces to combine multiple numeric props of the same type into 1 prop (e.g., StockClass: {From: string, To: string}[])
+import { OptionalStockRequestBody, StockActive, } from "../../shared/types";
+// =========================== COMMON INTERFACES ============================
+export class StockLookupRequestBody extends OptionalStockRequestBody {
+    SearchType;
+    SearchValue;
+    Warehouse;
+    Debtor;
+    DateTime;
+    constructor(obj) {
+        if (!obj?.SearchType) {
+            throw new Error("SearchType is required when constructing StockLookup request body");
+        }
+        super(obj);
+        Object.assign(this, obj);
+    }
+    toString() {
+        let str = "";
+        for (const k in this) {
+            if (this[k]) {
+                str += `<${k}>${this[k]}</${k}>\n`;
+            }
+        }
+        return str;
+    }
+}
+export var StockSearchType;
+(function (StockSearchType) {
+    StockSearchType["BARCODE"] = "Barcode";
+    StockSearchType["STOCK"] = "Stock";
+    StockSearchType["STOCK_KEYWORD"] = "StockKeyword";
+})(StockSearchType || (StockSearchType = {}));
+export const STOCK_LOOKUP_REQUEST_PARAMS_LIMIT = {
+    searchType: (val) => Object.values({
+        ...StockSearchType,
+        ...StockClassificationType,
+    }).includes(val),
+    searchValue: 255,
+    stockCategoryFr: 5,
+    stockCategoryTo: 5,
+    stockClassFr1: 5,
+    stockClassTo1: 5,
+    stockClassFr2: 5,
+    stockClassTo2: 5,
+    stockClassFr3: 5,
+    stockClassTo3: 5,
+    stockExtraClassFr1: 5,
+    stockExtraClassTo1: 5,
+    stockExtraClassFr2: 5,
+    stockExtraClassTo2: 5,
+    stockExtraClassFr3: 5,
+    stockExtraClassTo3: 5,
+    stockExtraClassFr4: 5,
+    stockExtraClassTo4: 5,
+    stockExtraClassFr5: 5,
+    stockExtraClassTo5: 5,
+    sysModTimeFr: 19,
+    sysModTimeTo: 19,
+    alternateNamekeyFr: 20,
+    alternateNamekeyTo: 20,
+    stockActive: (val) => {
+        for (const v of val) {
+            if (!Object.values(StockActive).includes(v))
+                return false;
+        }
+        return true;
+    },
+    warehouse: 3,
+    debtor: 10,
+    datetime: 19,
+};
+export var StockClassificationType;
+(function (StockClassificationType) {
+    StockClassificationType["STK1"] = "STK1";
+    StockClassificationType["STK2"] = "STK2";
+    StockClassificationType["STK3"] = "STK3";
+    StockClassificationType["EXT1"] = "EXT1";
+    StockClassificationType["EXT2"] = "EXT2";
+    StockClassificationType["EXT3"] = "EXT3";
+    StockClassificationType["EXT4"] = "EXT4";
+    StockClassificationType["EXT5"] = "EXT5";
+})(StockClassificationType || (StockClassificationType = {}));

package/dist/modules/stock-lookup/types/stock-lookup.interface.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/modules/stock-lookup/types/stock-lookup.interface.spec.js

@@ -0,0 +1,76 @@
+import { promisify } from "util";
+import { parseString } from "xml2js";
+import { Utils } from "../../../helpers";
+import { StockClassificationType, StockLookupRequestBody, } from "./stock-lookup.interface";
+const parseXml = promisify(parseString);
+describe("stock-lookup.interface", () => {
+    test("convert StockLookupRequestBody object to XML string", async () => {
+        const body = new StockLookupRequestBody({
+            SearchType: StockClassificationType.EXT1,
+            SearchValue: "123",
+            StockCategoryFr: "1",
+            StockCategoryTo: "2",
+            StockClassFr1: "3",
+            StockClassTo1: "4",
+            StockClassFr2: "5",
+            StockClassTo2: "6",
+            StockClassFr3: "7",
+            StockClassTo3: "8",
+            StockExtraClassFr1: "9",
+            StockExtraClassTo1: "10",
+            StockExtraClassFr2: "11",
+            StockExtraClassTo2: "12",
+            StockExtraClassFr3: "13",
+            StockExtraClassTo3: "14",
+            StockExtraClassFr4: "15",
+            StockExtraClassTo4: "16",
+            StockExtraClassFr5: "17",
+            StockExtraClassTo5: "18",
+            SysModTimeFr: "2022-01-01",
+            SysModTimeTo: "2022-01-05",
+            AlternateNamekeyFr: "2022-01-02",
+            AlternateNamekeyTo: "2022-01-03",
+            StockActive: "Y",
+            Warehouse: "W1",
+            Debtor: "D1",
+            DateTime: "2022-01-04",
+        });
+        const expectedStr = `
+			<SearchType>EXT1</SearchType>
+			<SearchValue>123</SearchValue>
+			<StockCategoryFr>1</StockCategoryFr>
+			<StockCategoryTo>2</StockCategoryTo>
+			<StockClassFr1>3</StockClassFr1>
+			<StockClassTo1>4</StockClassTo1>
+			<StockClassFr2>5</StockClassFr2>
+			<StockClassTo2>6</StockClassTo2>
+			<StockClassFr3>7</StockClassFr3>
+			<StockClassTo3>8</StockClassTo3>
+			<StockExtraClassFr1>9</StockExtraClassFr1>
+			<StockExtraClassTo1>10</StockExtraClassTo1>
+			<StockExtraClassFr2>11</StockExtraClassFr2>
+			<StockExtraClassTo2>12</StockExtraClassTo2>
+			<StockExtraClassFr3>13</StockExtraClassFr3>
+			<StockExtraClassTo3>14</StockExtraClassTo3>
+			<StockExtraClassFr4>15</StockExtraClassFr4>
+			<StockExtraClassTo4>16</StockExtraClassTo4>
+			<StockExtraClassFr5>17</StockExtraClassFr5>
+			<StockExtraClassTo5>18</StockExtraClassTo5>
+			<SysModTimeFr>2022-01-01</SysModTimeFr>
+			<SysModTimeTo>2022-01-05</SysModTimeTo>
+			<AlternateNamekeyFr>2022-01-02</AlternateNamekeyFr>
+			<AlternateNamekeyTo>2022-01-03</AlternateNamekeyTo>
+			<StockActive>Y</StockActive>
+			<Warehouse>W1</Warehouse>
+			<Debtor>D1</Debtor>
+			<DateTime>2022-01-04</DateTime>
+		`;
+        const result = (await parseXml(`<result>${expectedStr}</result>`))["result"];
+        // Test that each key value pair matches the expected
+        for (const k in result) {
+            const val = result[k][0];
+            expect(body[k]).toEqual(val);
+        }
+        expect(await Utils.isXmlEqualJson(expectedStr, body)).toEqual(true);
+    });
+});

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "../modules/auth/types";
+export * from "../modules/carrier/types";
+export * from "../modules/point-of-sale/types";
+export * from "../modules/stock-level-lookup/types";
+export * from "../modules/stock-lookup/types";

package/dist/types/index.js

@@ -0,0 +1,6 @@
+export * from "../modules/auth/types";
+export * from "../modules/carrier/types";
+export * from "../modules/point-of-sale/types";
+export * from "../modules/stock-level-lookup/types";
+export * from "../modules/stock-lookup/types";
+// other types could be added here

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@dotdev/harmony-sdk",
+  "version": "1.0.6",
+  "description": "Harmony API SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.7.2",
+    "xml2js": "0.6.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^16.3.1",
+    "@types/xml2js": "^0.4.14",
+    "jest": "^29.7.0",
+    "standard-version": "^9.5.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.8.2"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "packageManager": "pnpm@8.15.4",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "jest",
+    "release": "./release.sh"
+  }
+}