erpnext-queue-client 2.4.3 → 2.4.4

package/dist/index.js

@@ -44,13 +44,50 @@ const Waitlist_1 = require("./erpnext/model/Waitlist");
 const reports_1 = require("./erpnext/reports");
 const resourceRequest_1 = require("./erpnext/resourceRequest");
 class ERPNextQueueClient {
+    temporalClient;
+    credentials;
+    resourceRequest;
+    methodRequest;
+    account;
+    country;
+    address;
+    contact;
+    customer;
+    deliveryNote;
+    fileRequests;
+    shipment;
+    productBundle;
+    shippingProvider;
+    item;
+    purchaseOrder;
+    purchaseReceipt;
+    purchaseInvoice;
+    waitlist;
+    stockEntry;
+    supplier;
+    paymentEntry;
+    stockReconciliation;
+    stock;
+    reports;
+    compliance;
+    partList;
+    salesOrder;
+    salesInvoice;
+    servicecase;
+    serviceportalProductConfiguration;
+    servicecaseReason;
+    servicecaseSolution;
+    internalReason;
+    shippingLabel;
+    file;
+    itemTaxTemplate;
+    taxCategory;
+    tags;
+    consolidatedCustomsInvoice;
     /**
      * @description Provide either a temporal client or connection details to create a new client
      */
     constructor(options) {
-        this.utils = {
-            decryptFromErpNext: (encryptedString) => (0, decryptFromErpNext_server_1.decryptFromErpNext)(this.credentials, encryptedString),
-        };
         if (options.erpnextCredentials)
             this.credentials = options.erpnextCredentials;
         this.temporalClient = new client_1.TemporalClient(options.temporalCredentials);
@@ -94,6 +131,9 @@ class ERPNextQueueClient {
         this.tags = new tags_1.ERPNextTags(this.temporalClient);
         this.consolidatedCustomsInvoice = new consolidatedCustomsInvoice_1.ERPNextConsolidatedCustomsInvoice(this.temporalClient);
     }
+    utils = {
+        decryptFromErpNext: (encryptedString) => (0, decryptFromErpNext_server_1.decryptFromErpNext)(this.credentials, encryptedString),
+    };
 }
 exports.ERPNextQueueClient = ERPNextQueueClient;
 var ERPNextResponse_1 = require("./erpnext/model/ERPNextResponse");

package/dist/index.test.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -20,7 +11,7 @@ const zodContextOptionals_1 = require("./utils/zodContextOptionals");
 const Item_1 = require("./erpnext/model/Item");
 // Most tests are wrapped in async function blocks so they are declared statically but not run as tests.
 // If we wanted to run the tests, a mocking system would need to be implemented.
-describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", () => __awaiter(void 0, void 0, void 0, function* () {
+describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", async () => {
     const erp = new _1.ERPNextQueueClient({
         temporalCredentials: {
             temporalHost: constants_1.constants.TEMPORAL_HOST,
@@ -29,21 +20,19 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
             temporalKey: constants_1.constants.TEMPORAL_KEY,
         },
     });
-    test("Single item fetch", () => __awaiter(void 0, void 0, void 0, function* () {
+    test("Single item fetch", async () => {
         // We use expect-error to statically test negative cases in typescript
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            var _a;
-            const items = yield erp.item.getList({ limit: 1 });
-            const item = yield erp.item.getById({ resourceId: items[0].name });
-            expect(item === null || item === void 0 ? void 0 : item.name).toBeTypeOf("string");
-            expect(item === null || item === void 0 ? void 0 : item.doctype).toBeTypeOf("string");
-            expect(item === null || item === void 0 ? void 0 : item.description).toBeTypeOf("string");
-            expect((_a = item === null || item === void 0 ? void 0 : item.barcodes.at(0)) === null || _a === void 0 ? void 0 : _a.idx).toBeTypeOf("number");
-        });
-    }));
-    test("List with aliases", () => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b, _c;
-        const items = yield erp.resourceRequest.getList({
+        async () => {
+            const items = await erp.item.getList({ limit: 1 });
+            const item = await erp.item.getById({ resourceId: items[0].name });
+            expect(item?.name).toBeTypeOf("string");
+            expect(item?.doctype).toBeTypeOf("string");
+            expect(item?.description).toBeTypeOf("string");
+            expect(item?.barcodes.at(0)?.idx).toBeTypeOf("number");
+        };
+    });
+    test("List with aliases", async () => {
+        const items = await erp.resourceRequest.getList({
             resourceName: "Item",
             resourceModel: Item_1.Item.merge(zod_1.default.object({
                 "`tabItem Supplier`.supplier as supplier": zod_1.default
@@ -59,81 +48,78 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
                 "item_name as item_title",
             ],
         });
-        expect((_a = items.at(0)) === null || _a === void 0 ? void 0 : _a.name).toBeTypeOf("string");
-        expect((_b = items.at(0)) === null || _b === void 0 ? void 0 : _b.supplier).toBeTypeOf("string");
-        expect((_c = items.at(0)) === null || _c === void 0 ? void 0 : _c.item_title).toBeTypeOf("string");
-    }));
-    test("Item List with field description", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f;
+        expect(items.at(0)?.name).toBeTypeOf("string");
+        expect(items.at(0)?.supplier).toBeTypeOf("string");
+        expect(items.at(0)?.item_title).toBeTypeOf("string");
+    });
+    test("Item List with field description", async () => {
+        async () => {
             // get list with field defined
-            const itemsOnlyFieldDescription = yield erp.item.getList({
+            const itemsOnlyFieldDescription = await erp.item.getList({
                 fields: ["description"],
                 limit: 10,
             });
             expect(
             // @ts-expect-error
-            (_c = (_b = (_a = itemsOnlyFieldDescription.at(0)) === null || _a === void 0 ? void 0 : _a.barcodes) === null || _b === void 0 ? void 0 : _b.at(0)) === null || _c === void 0 ? void 0 : _c.idx).toBeUndefined();
-            expect((_d = itemsOnlyFieldDescription.at(0)) === null || _d === void 0 ? void 0 : _d.description).toBeTypeOf("string");
+            itemsOnlyFieldDescription.at(0)?.barcodes?.at(0)?.idx).toBeUndefined();
+            expect(itemsOnlyFieldDescription.at(0)?.description).toBeTypeOf("string");
             // @ts-expect-error
-            expect((_e = itemsOnlyFieldDescription.at(0)) === null || _e === void 0 ? void 0 : _e.name).toBeUndefined(); // name not valid here
+            expect(itemsOnlyFieldDescription.at(0)?.name).toBeUndefined(); // name not valid here
             // @ts-expect-error
-            expect((_f = itemsOnlyFieldDescription.at(0)) === null || _f === void 0 ? void 0 : _f.barcodes).toBeUndefined(); // barcodes not valid here}
-        });
-    }));
-    test("Item List with default field 'name'", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            var _a, _b;
+            expect(itemsOnlyFieldDescription.at(0)?.barcodes).toBeUndefined(); // barcodes not valid here}
+        };
+    });
+    test("Item List with default field 'name'", async () => {
+        async () => {
             // get list without fields defined
-            const items2 = yield erp.item.getList({ limit: 10 });
-            expect((_a = items2.at(0)) === null || _a === void 0 ? void 0 : _a.name).toBeTypeOf("string");
+            const items2 = await erp.item.getList({ limit: 10 });
+            expect(items2.at(0)?.name).toBeTypeOf("string");
             // @ts-expect-error
-            expect((_b = items2.at(0)) === null || _b === void 0 ? void 0 : _b.item_code).toBeUndefined(); // item_code not valid here
-        });
-    }));
-    test("Item List with all fields", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
+            expect(items2.at(0)?.item_code).toBeUndefined(); // item_code not valid here
+        };
+    });
+    test("Item List with all fields", async () => {
+        async () => {
             // get list without fields defined
-            const itemsWithAllFields = yield erp.item.getList({
+            const itemsWithAllFields = await erp.item.getList({
                 fields: ["*"],
                 limit: 10,
             });
-            expect((_a = itemsWithAllFields.at(0)) === null || _a === void 0 ? void 0 : _a.name).toBeTypeOf("string");
+            expect(itemsWithAllFields.at(0)?.name).toBeTypeOf("string");
             // @ts-expect-error
-            expect((_b = itemsWithAllFields.at(0)) === null || _b === void 0 ? void 0 : _b.doctype).toBeUndefined(); // doctype omitted in list entries
-            expect((_c = itemsWithAllFields.at(0)) === null || _c === void 0 ? void 0 : _c.item_code).toBeTypeOf("string");
+            expect(itemsWithAllFields.at(0)?.doctype).toBeUndefined(); // doctype omitted in list entries
+            expect(itemsWithAllFields.at(0)?.item_code).toBeTypeOf("string");
             // @ts-expect-error
-            expect((_d = itemsWithAllFields.at(0)) === null || _d === void 0 ? void 0 : _d.barcodes).toBeUndefined();
-        });
-    }));
-    test("Submittable DocType", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            const dns = yield erp.deliveryNote.getList({ limit: 1 });
+            expect(itemsWithAllFields.at(0)?.barcodes).toBeUndefined();
+        };
+    });
+    test("Submittable DocType", async () => {
+        async () => {
+            const dns = await erp.deliveryNote.getList({ limit: 1 });
             if (!dns[0])
                 throw new Error("No Delivery Notes found in test instance");
-            const dn = yield erp.deliveryNote.getById({
+            const dn = await erp.deliveryNote.getById({
                 resourceId: dns[0].name,
             });
-            dn === null || dn === void 0 ? void 0 : dn.amended_from; // for static type analysis}
-        });
-    }));
-    test("Get Address by Supplier", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
-            const sup = yield erp.supplier.getList({ limit: 1 });
-            const address = yield erp.address.getAddressesBySupplier(sup[0].name);
+            dn?.amended_from; // for static type analysis}
+        };
+    });
+    test("Get Address by Supplier", async () => {
+        async () => {
+            const sup = await erp.supplier.getList({ limit: 1 });
+            const address = await erp.address.getAddressesBySupplier(sup[0].name);
             expect(address[0].city).toBeTypeOf("string");
-        });
-    }));
-    test("Item List with invalid field list", () => __awaiter(void 0, void 0, void 0, function* () {
+        };
+    });
+    test("Item List with invalid field list", async () => {
         // don't execute, this is just for type testing statically
         () => erp.item.getList({
             // @ts-expect-error
             fields: ["name", "barcode"],
             limit: 10,
         });
-    }));
-    test("Create with DocModel Metafields should fail", () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    test("Create with DocModel Metafields should fail", async () => {
         // SHOULD NOT BE EXECUTED, ONLY FOR STATIC TYPE TESTING
         // We use expect-error to statically test negative cases in typescript
         () => erp.item.create({
@@ -179,8 +165,8 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
             // @ts-expect-error should not be empty
             body: {},
         });
-    }));
-    test("Static Types with Input Optional", () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    test("Static Types with Input Optional", async () => {
         // DO NOT EXECUTE, ONLY FOR STATIC TYPE TESTING
         // We use expect-error to statically test negative cases in typescript
         const testModel = zod_1.default.object({
@@ -200,8 +186,8 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
         const testOutput = {
             mandatory: "TEST",
         };
-    }));
-    test("Static Types with Nested Array Input Optional", () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    test("Static Types with Nested Array Input Optional", async () => {
         // DO NOT EXECUTE, ONLY FOR STATIC TYPE TESTING
         // We use expect-error to statically test negative cases in typescript
         const testModel = zod_1.default.object({
@@ -239,9 +225,9 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
                 },
             ],
         };
-    }));
-    test("Input for updateById function", () => __awaiter(void 0, void 0, void 0, function* () {
-        () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    test("Input for updateById function", async () => {
+        async () => {
             // This static type test ensures, that Input as inferred here
             // conformes to the expected input type defined in doctypeResourceRequest -> updateById()
             const AddressInput = (0, zodContextOptionals_1.ResourceInput)(Address_1.Address);
@@ -252,10 +238,10 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", ()
                 country: "Country",
                 pincode: "1234",
             };
-            yield erp.address.updateById({
+            await erp.address.updateById({
                 resourceId: "TEST",
                 body: typedInputBody,
             });
-        });
-    }));
-}));
+        };
+    });
+});

package/dist/utils/fernet.server.js

@@ -217,6 +217,10 @@ function createHmac(signingKey, time, iv, cipherText) {
  * Instance of a Secret to be used for the token encryption
  */
 class Secret {
+    signingKeyHex;
+    signingKey;
+    encryptionKeyHex;
+    encryptionKey;
     /**
      * Creates a Secret to be used for the token encryption
      * @param {String} secret64 - base64 encoded secret string
@@ -248,21 +252,37 @@ exports.Secret = Secret;
  * Token object to perform encryption/decryption
  */
 class Token {
+    secret;
+    ttl;
+    message;
+    /** cipher text to decrypt */
+    cipherText;
+    cipherTextHex;
+    /** token string */
+    token;
+    /** version of token */
+    version;
+    /** the IV array */
+    optsIV;
+    maxClockSkew = 60;
+    time;
+    encoded;
+    iv;
+    ivHex;
+    hmacHex;
     /**
      * Token object to perform encryption/decryption
      * @param {TokenOptions} opts - options for token initialization
      */
     constructor(opts) {
-        var _a, _b;
-        this.maxClockSkew = 60;
         opts = opts || {};
         this.secret = opts.secret || defaults.secret;
         this.ttl = opts.ttl || defaults.ttl;
         if (opts.ttl === 0)
             this.ttl = 0;
-        this.message = (_a = opts.message) !== null && _a !== void 0 ? _a : "";
+        this.message = opts.message ?? "";
         this.cipherText = opts.cipherText;
-        this.token = (_b = opts.token) !== null && _b !== void 0 ? _b : "";
+        this.token = opts.token ?? "";
         this.version = opts.version || parseHex(defaults.versionHex);
         this.optsIV = opts.iv;
         // @ts-ignore

package/dist/utils/request.js

@@ -1,30 +1,15 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestError = void 0;
 exports.request = request;
 const zodUtils_1 = require("./zodUtils");
 const logger_1 = require("./logger");
 class RequestError extends Error {
+    status;
+    requestUrl;
+    statusText;
+    responseHeaders;
+    response;
     constructor({ status, requestUrl, statusText, responseHeaders, response, }) {
         super(`Request failed with status ${status}: ${statusText} for URL ${requestUrl}`); // Call the parent `Error` constructor with the message
         // Manually set the prototype to ensure `instanceof` works
@@ -52,56 +37,58 @@ class RequestError extends Error {
     }
 }
 exports.RequestError = RequestError;
-function request(options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b;
-        const _c = options || {}, { body, url, inputValidationModel, responseValidationModel, credentials, headers } = _c, requestOptions = __rest(_c, ["body", "url", "inputValidationModel", "responseValidationModel", "credentials", "headers"]);
-        // Validate the request body
-        const validatedBody = inputValidationModel
-            ? (0, zodUtils_1.validateData)(body, inputValidationModel)
-            : body;
-        const contentType = options.headers &&
-            "Content-Type" in options.headers &&
-            ((_a = options.headers) === null || _a === void 0 ? void 0 : _a["Content-Type"])
-            ? (_b = options.headers) === null || _b === void 0 ? void 0 : _b["Content-Type"]
-            : undefined;
-        const stringifiedBody = options.method !== "GET" &&
-            contentType !== "text/xml" &&
-            contentType !== "application/xml" &&
-            contentType !== "application/x-www-form-urlencoded"
-            ? JSON.stringify(validatedBody)
-            : undefined;
-        const convertedOptions = Object.assign(Object.assign(Object.assign(Object.assign({}, requestOptions), (headers ? { headers } : {})), (credentials ? { credentials } : {})), (options.method !== "GET"
-            ? { body: stringifiedBody !== null && stringifiedBody !== void 0 ? stringifiedBody : validatedBody }
-            : {}));
-        // Log requests
-        logger_1.lg.info(`${options.method}: ${url}`);
-        // Wrap fetch
-        const response = yield fetch(url, convertedOptions);
-        const { status, url: requestUrl, statusText, ok } = response;
-        const textResult = yield response.text();
-        let finalResult;
-        try {
-            finalResult = JSON.parse(textResult);
-        }
-        catch (err) {
-            finalResult = textResult;
-        }
-        // Reject promise when status is expected or unexpected error. Allows use of try/catch to catch http errors
-        if (!ok) {
-            logger_1.lg.error(`Error in request to ${requestUrl} with status text ${statusText}`, JSON.stringify(finalResult, null, 2));
-            throw new RequestError({
-                status,
-                requestUrl,
-                statusText,
-                responseHeaders: response === null || response === void 0 ? void 0 : response.headers,
-                response: finalResult,
-            });
-        }
-        // Validate the response body
-        const validatedResult = responseValidationModel
-            ? (0, zodUtils_1.validateData)(finalResult, responseValidationModel)
-            : finalResult;
-        return validatedResult;
-    });
+async function request(options) {
+    const { body, url, inputValidationModel, responseValidationModel, credentials, headers, ...requestOptions } = options || {};
+    // Validate the request body
+    const validatedBody = inputValidationModel
+        ? (0, zodUtils_1.validateData)(body, inputValidationModel)
+        : body;
+    const contentType = options.headers &&
+        "Content-Type" in options.headers &&
+        options.headers?.["Content-Type"]
+        ? options.headers?.["Content-Type"]
+        : undefined;
+    const stringifiedBody = options.method !== "GET" &&
+        contentType !== "text/xml" &&
+        contentType !== "application/xml" &&
+        contentType !== "application/x-www-form-urlencoded"
+        ? JSON.stringify(validatedBody)
+        : undefined;
+    const convertedOptions = {
+        ...requestOptions,
+        ...(headers ? { headers } : {}),
+        ...(credentials ? { credentials } : {}),
+        ...(options.method !== "GET"
+            ? { body: stringifiedBody ?? validatedBody }
+            : {}),
+    };
+    // Log requests
+    logger_1.lg.info(`${options.method}: ${url}`);
+    // Wrap fetch
+    const response = await fetch(url, convertedOptions);
+    const { status, url: requestUrl, statusText, ok } = response;
+    const textResult = await response.text();
+    let finalResult;
+    try {
+        finalResult = JSON.parse(textResult);
+    }
+    catch (err) {
+        finalResult = textResult;
+    }
+    // Reject promise when status is expected or unexpected error. Allows use of try/catch to catch http errors
+    if (!ok) {
+        logger_1.lg.error(`Error in request to ${requestUrl} with status text ${statusText}`, JSON.stringify(finalResult, null, 2));
+        throw new RequestError({
+            status,
+            requestUrl,
+            statusText,
+            responseHeaders: response?.headers,
+            response: finalResult,
+        });
+    }
+    // Validate the response body
+    const validatedResult = responseValidationModel
+        ? (0, zodUtils_1.validateData)(finalResult, responseValidationModel)
+        : finalResult;
+    return validatedResult;
 }

package/dist/utils/zodContextOptionals.js

@@ -15,8 +15,10 @@ function isMarkedOptionalForInput(schema) {
 }
 // schema transformation
 function ResourceInput(schema) {
-    var _a;
-    const shape = Object.assign(Object.assign({}, schema.shape), { docstatus: zod_1.z.number().optional().default(0) });
+    const shape = {
+        ...schema.shape,
+        docstatus: zod_1.z.number().optional().default(0),
+    };
     function makeMarkedKeysOptional(shape) {
         const newShape = zod_1.z.object({}).shape;
         for (const [key, value] of Object.entries(shape)) {
@@ -52,5 +54,5 @@ function ResourceInput(schema) {
     }
     return zod_1.z
         .object(makeMarkedKeysOptional(shape))
-        .describe(((_a = schema.description) !== null && _a !== void 0 ? _a : "Unnamed Model") + " Input");
+        .describe((schema.description ?? "Unnamed Model") + " Input");
 }

package/dist/utils/zodUtils.js

@@ -30,12 +30,12 @@ function validateData(data, ValidationModel) {
             typeof data.message === "string") {
             throw new Error(data.message);
         }
-        throw errorObject;
+        throw new Error(errorObject.message, { cause: errorObject.error });
     }
     return validationResult.data;
 }
 function pickFromSchema(schema, keys) {
-    const pickedShape = keys === null || keys === void 0 ? void 0 : keys.reduce((acc, key) => {
+    const pickedShape = keys?.reduce((acc, key) => {
         if (typeof key === "string" && key.includes("as")) {
             const [field, alias] = key.split(" as ");
             if (key in schema.shape) {

package/package.json

@@ -30,7 +30,7 @@
     "winston": "^3.15.0",
     "zod": "3.25.76"
   },
-  "version": "2.4.3",
+  "version": "2.4.4",
   "devDependencies": {
     "@types/crypto-js": "^4.2.2",
     "@types/lodash": "^4.17.13",