erpnext-queue-client 2.4.5 → 2.5.1

package/dist/erpnext/doctypes/shipment.js

@@ -5,28 +5,11 @@ const doctypeSubmittableResourceRequest_1 = require("../doctypeSubmittableResour
 const methodRequest_1 = require("../methodRequest");
 const Shipment_1 = require("../model/Shipment");
 const zodContextOptionals_1 = require("../../utils/zodContextOptionals");
-class ERPNextShipment {
-    temporalClient;
-    baseRequest;
+class ERPNextShipment extends doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest {
     methodRequest;
-    getList;
-    getById;
-    updateById;
-    deleteById;
-    create;
-    cancel;
-    submit;
     constructor(temporalClient) {
-        this.temporalClient = temporalClient;
-        this.baseRequest = new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(temporalClient, "Shipment", Shipment_1.Shipment);
+        super(temporalClient, "Shipment", Shipment_1.Shipment);
         this.methodRequest = new methodRequest_1.ERPNextMethodRequest(temporalClient);
-        this.getList = this.baseRequest.getList;
-        this.getById = this.baseRequest.getById;
-        this.updateById = this.baseRequest.updateById;
-        this.deleteById = this.baseRequest.deleteById;
-        this.create = this.baseRequest.create;
-        this.cancel = this.baseRequest.cancel;
-        this.submit = this.baseRequest.submit;
     }
     async createShipmentDraft(deliveryNoteName) {
         const draft = await this.methodRequest.request({
@@ -47,7 +30,7 @@ class ERPNextShipment {
         return shipmentInfo;
     }
     async addShippingLabelAndSubmit(shipmentErpNextName, body) {
-        const shipment = await this.baseRequest.updateById({
+        const shipment = await this.updateById({
             resourceId: shipmentErpNextName,
             inputValidationModel: Shipment_1.ShipmentAddShippingLabelAndSubmitBody,
             body,

package/dist/erpnext/item.getList.alias-parsing.test.d.ts

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

package/dist/erpnext/item.getList.alias-parsing.test.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const item_1 = require("./doctypes/item");
+const zod_1 = require("zod");
+const zodUtils_1 = require("../utils/zodUtils");
+describe("Item.getList field alias parsing", () => {
+    test("does not treat field names containing 'as' as aliases", async () => {
+        const temporalClientStub = {
+            executeERPNextRequestWorkflow: async (_requestName, options) => {
+                const { responseValidationModel } = options;
+                if (!responseValidationModel) {
+                    throw new Error("Missing responseValidationModel in stub options");
+                }
+                // Intentionally omit the wrongly-selected key "undefined" that results from
+                // the buggy alias parsing logic in pickFromSchema.
+                const data = {
+                    data: [
+                        {
+                            name: "ITEM-0001",
+                            item_code: "ITEM-0001",
+                            item_name: "Test Item",
+                            ean: "EAN-1",
+                            disabled: 0,
+                            has_variants: 1,
+                            is_purchase_item: 1,
+                            is_stock_item: 1,
+                            custom_product_version: "v1",
+                            custom_supplier: "SUP-1",
+                        },
+                    ],
+                };
+                return (0, zodUtils_1.validateData)(data, responseValidationModel);
+            },
+        };
+        const itemApi = new item_1.ERPNextItem(temporalClientStub);
+        const fields = [
+            "name",
+            "item_code",
+            "item_name",
+            "ean",
+            "disabled",
+            "has_variants",
+            "is_purchase_item",
+            "is_stock_item",
+            "custom_product_version",
+            "custom_supplier",
+        ];
+        const result = await itemApi.getList({
+            fields: fields,
+            limit: 1,
+        });
+        expect(result).toHaveLength(1);
+        expect(result.at(0)?.name).toBeTypeOf("string");
+        expect(result.at(0)?.has_variants).toBeTypeOf("number");
+        expect(result.at(0)?.is_purchase_item).toBeTypeOf("number");
+        expect(result.at(0)?.custom_product_version).toBeTypeOf("string");
+    });
+    test("supports uppercase AS delimiter in alias expressions", () => {
+        const schema = zod_1.z.object({
+            "item_name AS item_title": zod_1.z.string(),
+        });
+        const picked = (0, zodUtils_1.pickFromSchema)(schema, ["item_name AS item_title"]);
+        const parsed = picked.parse({ item_title: "x" });
+        expect(parsed.item_title).toBe("x");
+    });
+});

package/dist/erpnext/methodRequest.js

@@ -10,8 +10,6 @@ class ERPNextMethodRequest {
         this.temporalClient = temporalClient;
     }
     async request({ methodName, requestMethod, body, inputValidationModel, responseValidationModel, isAutoWrapResponseValidationWithMessage = true, params, priority = 5, }) {
-        if (responseValidationModel && !responseValidationModel.description)
-            throw new Error("Resource model must have a description");
         const result = await this.temporalClient.executeERPNextRequestWorkflow(`${requestMethod}-${methodName}`, {
             methodName,
             requestMethod,

package/dist/erpnext/resourceRequest.js

@@ -34,8 +34,6 @@ class ERPNextResourceRequest {
         return allParams;
     };
     async getList({ resourceName, fields, filters, resourceModel, skip, limit, priority = 5, asDict, params, }) {
-        if (resourceModel && !resourceModel.description)
-            throw new Error("Resource model must have a description");
         const erpNextFields = fields?.length
             ? fields
             : ["name"]; // default field is name
@@ -57,7 +55,7 @@ class ERPNextResourceRequest {
                         data: zod_1.z.array((0, zodUtils_1.pickFromSchema)((0, DocTypeHelpers_1.DocModelListEntry)(resourceModel), erpNextFields.filter((f) => f !== "*") // filter out * when other fields are present
                         )),
                     })
-                        .describe(`${resourceModel.description} List with fields ${JSON.stringify(erpNextFields.filter((f) => f !== "*"))}`)
+                        .describe(`${resourceName} List with fields ${JSON.stringify(erpNextFields.filter((f) => f !== "*"))}`)
                 : zod_1.z.any().describe("Any response");
         const defaultPaginationSize = 500;
         let loopLimit = defaultPaginationSize;
@@ -92,8 +90,6 @@ class ERPNextResourceRequest {
         return results;
     }
     async getById({ resourceName, resourceId, resourceModel, priority = 5, }) {
-        if (resourceModel && !resourceModel.description)
-            throw new Error("Resource model must have a description");
         if (!resourceId)
             throw new Error("Resource id is required");
         const result = await this.temporalClient
@@ -134,8 +130,6 @@ class ERPNextResourceRequest {
         return result.data;
     }
     async create({ resourceName, inputValidationModel, resourceModel, body, params, priority = 5, }) {
-        if (resourceModel && !resourceModel.description)
-            throw new Error("Resource model must have a description");
         const result = await this.temporalClient.executeERPNextRequestWorkflow(`POST-${resourceName}`, {
             requestMethod: "POST",
             resourceName,
@@ -154,8 +148,6 @@ class ERPNextResourceRequest {
         return result.data;
     }
     async deleteById({ resourceName, resourceId, resourceModel, priority = 5, }) {
-        if (resourceModel && !resourceModel.description)
-            throw new Error("Resource model must have a description");
         return await this.temporalClient.executeERPNextRequestWorkflow(`DELETE-${resourceName}`, {
             requestMethod: "DELETE",
             resourceName,

package/dist/index.test.js

@@ -113,8 +113,9 @@ describe.skipIf(constants_1.constants.TEMPORAL_HOST === "test")("Type tests", as
     });
     test("Item List with invalid field list", async () => {
         // don't execute, this is just for type testing statically
-        () => erp.item.getList({
-            // @ts-expect-error
+        () => 
+        // @ts-expect-error barcode is not a valid Item list field
+        erp.item.getList({
             fields: ["name", "barcode"],
             limit: 10,
         });

package/dist/utils/zodUtils.d.ts

@@ -1,4 +1,4 @@
 import { z, ZodObject, ZodRawShape } from "zod";
-export declare function validateData<T extends z.ZodTypeAny>(data: unknown, ValidationModel: T): z.infer<T>;
+export declare function validateData<T extends z.ZodTypeAny>(data: unknown, ValidationModel: T, isDebug?: boolean): z.infer<T>;
 export declare function pickFromSchema<T extends ZodRawShape, K extends keyof T>(schema: ZodObject<T>, keys: readonly K[]): ZodObject<Pick<T, K>>;
 export type KeysOf<T> = T extends ZodObject<any> ? keyof z.infer<T> : string;

package/dist/utils/zodUtils.js

@@ -4,48 +4,59 @@ exports.validateData = validateData;
 exports.pickFromSchema = pickFromSchema;
 const zod_1 = require("zod");
 const constants_1 = require("../constants");
-const logger_1 = require("./logger");
-function validateData(data, ValidationModel) {
+function validateData(data, ValidationModel, isDebug) {
     if (!ValidationModel.description)
         throw new Error("ValidationModel.description is required");
     // writeFileSync("test.json", JSON.stringify(data, null, 2));
     if (!(ValidationModel instanceof zod_1.ZodObject) &&
         !(ValidationModel instanceof zod_1.ZodArray)) {
-        console.log(ValidationModel);
         throw new Error("Invalid Zod Model");
     }
     const validationResult = ValidationModel.safeParse(data);
     if (!validationResult.success) {
-        const errorObject = {
-            message: `Validation error in model ${ValidationModel.description}`,
-            error: validationResult.error,
-            input: constants_1.constants.DEBUG_MODE === "true"
-                ? data
-                : "set DEBUG_MODE to true to see the input",
-        };
-        logger_1.lg.error(errorObject);
-        if (data &&
-            typeof data === "object" &&
-            "message" in data &&
-            typeof data.message === "string") {
-            throw new Error(data.message);
-        }
-        throw new Error(errorObject.message, { cause: errorObject.error });
+        const isDebugSet = constants_1.constants.DEBUG_MODE === "true" || isDebug;
+        // ZodError.issues contains the most actionable information; render a readable list.
+        const issues = validationResult.error.issues;
+        const issueStrings = issues.map((issue) => {
+            const path = issue.path.length ? issue.path.join(".") : "(root)";
+            return `"${path}": ${issue.message}`;
+        });
+        const previewCount = 8;
+        const previewLines = "\n──────────────\n\n" +
+            issueStrings.slice(0, previewCount).join("\n") +
+            "\n\n──────────────\n";
+        const moreCount = Math.max(0, issueStrings.length - previewCount);
+        const moreSuffix = moreCount > 0 ? `\n- (+${moreCount} more)` : "";
+        const cleanMessage = `Validation failed for ${ValidationModel.description}\n${previewLines}${moreSuffix}`;
+        // Include the full error as a `cause` only when debugging; otherwise keep stack output clean.
+        if (isDebugSet)
+            console.dir(data, { depth: null });
+        const error = new Error(cleanMessage + "\n" + validationResult.error.toString());
+        delete error.stack;
+        throw error;
     }
     return validationResult.data;
 }
 function pickFromSchema(schema, keys) {
     const pickedShape = keys?.reduce((acc, key) => {
-        if (typeof key === "string" && key.includes("as")) {
-            const [field, alias] = key.split(" as ");
-            if (key in schema.shape) {
-                acc[alias] = schema.shape[key];
+        // ERPNext alias fields use: `<field> as <alias>` (case-insensitive).
+        // Don't treat substring matches like `has_variants` as aliases.
+        if (typeof key === "string") {
+            const match = key.match(/^(.*?)\s+as\s+(.*?)$/i);
+            if (match) {
+                const alias = match[2].trim();
+                if (key in schema.shape) {
+                    acc[alias] = schema.shape[key];
+                }
+                return acc;
             }
+            // Not an alias expression, treat it as a direct field key.
+            if (key in schema.shape)
+                acc[key] = schema.shape[key];
         }
         else {
-            if (key in schema.shape) {
+            if (key in schema.shape)
                 acc[key] = schema.shape[key];
-            }
         }
         return acc;
     }, {});

package/package.json

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