erpnext-queue-client 1.39.2 → 2.0.0-beta.1

package/dist/erpnext/resourceRequest.js

@@ -11,14 +11,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERPNextResourceRequest = void 0;
 const zod_1 = require("zod");
+const logger_1 = require("../utils/logger");
+const utils_1 = require("../utils/utils");
 const zodUtils_1 = require("../utils/zodUtils");
+const DocTypeHelpers_1 = require("./model/DocTypeHelpers");
 const ERPNextResponse_1 = require("./model/ERPNextResponse");
-const utils_1 = require("../utils/utils");
-const logger_1 = require("../utils/logger");
+const zodContextOptionals_1 = require("../utils/zodContextOptionals");
 class ERPNextResourceRequest {
     constructor(temporalClient) {
         this.getParams = (fields, filters, asDict, params) => {
-            const fieldsParams = fields ? { fields: JSON.stringify(fields) } : {};
+            const fieldsParams = fields
+                ? { fields: `[${fields.map((fi) => `"${fi}"`).join(",")}]` }
+                : {};
             const filtersParams = filters
                 ? {
                     filters: `[${filters
@@ -36,7 +40,9 @@ class ERPNextResourceRequest {
         return __awaiter(this, arguments, void 0, function* ({ 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 === null || fields === void 0 ? void 0 : fields.length) ? fields : ["name"];
+            const erpNextFields = (fields === null || fields === void 0 ? void 0 : fields.length)
+                ? fields
+                : ["name"]; // default field is name
             const schema = asDict === false
                 ? zod_1.z
                     .object({
@@ -48,13 +54,14 @@ class ERPNextResourceRequest {
                 : resourceModel
                     ? (fields === null || fields === void 0 ? void 0 : fields[0]) === "*"
                         ? zod_1.z
-                            .object({ data: zod_1.z.array(resourceModel.omit({ doctype: true })) })
-                            .describe(`${resourceModel.description} List`)
+                            .object({ data: zod_1.z.array((0, DocTypeHelpers_1.DocModelListEntry)(resourceModel)) })
+                            .describe(`${resourceName} List with all fields`)
                         : zod_1.z
                             .object({
-                            data: zod_1.z.array((0, zodUtils_1.pickFromSchema)(resourceModel, erpNextFields)),
+                            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)}`)
+                            .describe(`${resourceModel.description} List with fields ${JSON.stringify(erpNextFields.filter((f) => f !== "*"))}`)
                     : zod_1.z.any().describe("Any response");
             const defaultPaginationSize = 500;
             let loopLimit = defaultPaginationSize;
@@ -67,7 +74,7 @@ class ERPNextResourceRequest {
                 logger_1.lg.info("AUTO PAGINATE");
             do {
                 // use limit & skip whenever it is directly provided. In other cases use loopLimit & loopSkip to remove pagination
-                const paramsString = (0, utils_1.paramsToString)(Object.assign(Object.assign(Object.assign({}, this.getParams(fields, filters, asDict, params)), (limit === undefined && !autoPaginate
+                const paramsString = (0, utils_1.paramsToString)(Object.assign(Object.assign(Object.assign({}, this.getParams(erpNextFields, filters, asDict, params)), (limit === undefined && !autoPaginate
                     ? {}
                     : { limit: String(limit !== null && limit !== void 0 ? limit : loopLimit) })), (skip === undefined && !autoPaginate
                     ? {}
@@ -91,25 +98,29 @@ class ERPNextResourceRequest {
                 throw new Error("Resource model must have a description");
             if (!resourceId)
                 throw new Error("Resource id is required");
-            const result = yield this.temporalClient.executeERPNextRequestWorkflow(`GET-${resourceName}-${resourceId}`, {
+            const result = yield this.temporalClient
+                .executeERPNextRequestWorkflow(`GET-${resourceName}-${resourceId}`, {
                 requestMethod: "GET",
                 resourceName,
                 resourceId,
                 responseValidationModel: resourceModel
                     ? zod_1.z
-                        .object({ data: resourceModel })
-                        .describe(resourceModel.description)
+                        .object({ data: (0, DocTypeHelpers_1.DocModel)(resourceModel) })
+                        .describe(resourceName + " Response")
                     : undefined,
-            }, "erpnext", priority);
-            if (!result.data)
-                throw new Error(`Resource ${resourceName} with id ${resourceId} not found`);
-            return result.data;
+            }, "erpnext", priority)
+                .catch((err) => {
+                if (err.message.includes("Error 404")) {
+                    logger_1.lg.error(`Resource ${resourceName} with id ${resourceId} not found`);
+                    return;
+                }
+                throw err;
+            });
+            return result === null || result === void 0 ? void 0 : result.data;
         });
     }
     updateById(_a) {
         return __awaiter(this, arguments, void 0, function* ({ resourceName, resourceId, inputValidationModel, resourceModel, body, priority = 5, }) {
-            if (resourceModel && !resourceModel.description)
-                throw new Error("Resource model must have a description");
             // accept partial input while enforcing allowed keys
             const partialInputValidationModel = inputValidationModel && inputValidationModel instanceof zod_1.ZodObject
                 ? inputValidationModel.partial().strict()
@@ -120,9 +131,7 @@ class ERPNextResourceRequest {
                 resourceName,
                 inputValidationModel: partialInputValidationModel,
                 responseValidationModel: resourceModel
-                    ? zod_1.z
-                        .object({ data: resourceModel })
-                        .describe(resourceModel.description)
+                    ? zod_1.z.object({ data: (0, DocTypeHelpers_1.DocModel)(resourceModel) }).describe(resourceName)
                     : undefined,
                 body,
             }, "erpnext", priority);
@@ -136,10 +145,12 @@ class ERPNextResourceRequest {
             const result = yield this.temporalClient.executeERPNextRequestWorkflow(`POST-${resourceName}`, {
                 requestMethod: "POST",
                 resourceName,
-                inputValidationModel,
+                inputValidationModel: inputValidationModel !== null && inputValidationModel !== void 0 ? inputValidationModel : (resourceModel ? (0, zodContextOptionals_1.ResourceInput)(resourceModel) : undefined),
                 responseValidationModel: resourceModel
                     ? zod_1.z
-                        .object({ data: resourceModel })
+                        .object({
+                        data: (0, DocTypeHelpers_1.DocModel)(resourceModel),
+                    })
                         .describe(resourceModel.description)
                     : undefined,
                 params: (0, utils_1.paramsToString)(params),

package/dist/index.d.ts

@@ -4,36 +4,41 @@ import { ERPNextAddress } from "./erpnext/doctypes/address";
 import { ERPNextContact } from "./erpnext/doctypes/contact";
 import { ERPNextDeliveryNote } from "./erpnext/doctypes/deliveryNote";
 import { ERPNextItem } from "./erpnext/doctypes/item";
+import { ERPNextPaymentEntry } from "./erpnext/doctypes/paymentEntry";
+import { ERPNextProductBundle } from "./erpnext/doctypes/productBundle";
 import { ERPNextPurchaseInvoice } from "./erpnext/doctypes/purchaseInvoice";
 import { ERPNextPurchaseReceipt } from "./erpnext/doctypes/purchaseReceipt";
+import { ERPNextSalesInvoice } from "./erpnext/doctypes/salesInvoice";
+import { ERPNextServicecase } from "./erpnext/doctypes/servicecase";
 import { ERPNextShipment } from "./erpnext/doctypes/shipment";
-import { ERPNextProductBundle } from "./erpnext/doctypes/productBundle";
 import { ERPNextStock } from "./erpnext/doctypes/stock";
+import { ERPNextTags } from "./erpnext/doctypes/tags";
 import { ERPNextDoctypeSubmittableResourceRequest } from "./erpnext/doctypeSubmittableResourceRequest";
 import { ERPNextFileRequests } from "./erpnext/fileRequests";
 import { ERPNextMethodRequest } from "./erpnext/methodRequest";
 import { Compliance } from "./erpnext/model/Compliance";
+import { ConsolidatedCustomsInvoice } from "./erpnext/model/ConsolidatedCustomsInvoice";
 import { Country } from "./erpnext/model/Country";
 import { Customer } from "./erpnext/model/Customer";
 import { ERPNextQueueClientContructorOptions } from "./erpnext/model/ERPNextQueue";
+import { ERPNextFile } from "./erpnext/model/File";
+import { InternalReason } from "./erpnext/model/InternalReasons";
+import { ItemTaxTemplate } from "./erpnext/model/ItemTaxTemplate";
 import { PartList } from "./erpnext/model/PartList";
-import { PaymentEntry } from "./erpnext/model/PaymentEntry";
 import { PurchaseOrder } from "./erpnext/model/PurchaseOrder";
+import { SalesOrder } from "./erpnext/model/SalesOrder";
+import { ServicecaseReason } from "./erpnext/model/ServicecaseReason";
+import { ServiceCaseSolution } from "./erpnext/model/ServicecaseSolution";
+import { ServiceportalProductConfiguration } from "./erpnext/model/ServiceportalProductConfiguration";
+import { ShippingLabel } from "./erpnext/model/ShippingLabel";
 import { ShippingProvider } from "./erpnext/model/ShippingProvider";
 import { StockEntry } from "./erpnext/model/StockEntry";
 import { StockReconciliation } from "./erpnext/model/StockReconciliation";
 import { Supplier } from "./erpnext/model/Supplier";
+import { TaxCategory } from "./erpnext/model/TaxCategory";
 import { Waitlist } from "./erpnext/model/Waitlist";
 import { ERPNextReports } from "./erpnext/reports";
 import { ERPNextResourceRequest } from "./erpnext/resourceRequest";
-import { ERPNextServicecase } from "./erpnext/doctypes/servicecase";
-import { ServiceportalProductConfiguration } from "./erpnext/model/ServiceportalProductConfiguration";
-import { ShippingLabel } from "./erpnext/model/ShippingLabel";
-import { ServicecaseReason } from "./erpnext/model/ServicecaseReason";
-import { ServiceCaseSolution } from "./erpnext/model/ServicecaseSolution";
-import { InternalReason } from "./erpnext/model/InternalReasons";
-import { ERPNextFile } from "./erpnext/model/File";
-import { ConsolidatedCustomsInvoice } from "./erpnext/model/ConsolidatedCustomsInvoice";
 export declare class ERPNextQueueClient {
     temporalClient: TemporalClient;
     private credentials?;
@@ -55,12 +60,14 @@ export declare class ERPNextQueueClient {
     waitlist: ERPNextDoctypeResourceRequest<typeof Waitlist>;
     stockEntry: ERPNextDoctypeSubmittableResourceRequest<typeof StockEntry>;
     supplier: ERPNextDoctypeResourceRequest<typeof Supplier>;
-    paymentEntry: ERPNextDoctypeSubmittableResourceRequest<typeof PaymentEntry>;
+    paymentEntry: ERPNextPaymentEntry;
     stockReconciliation: ERPNextDoctypeSubmittableResourceRequest<typeof StockReconciliation>;
     stock: ERPNextStock;
     reports: ERPNextReports;
     compliance: ERPNextDoctypeResourceRequest<typeof Compliance>;
     partList: ERPNextDoctypeResourceRequest<typeof PartList>;
+    salesOrder: ERPNextDoctypeSubmittableResourceRequest<typeof SalesOrder>;
+    salesInvoice: ERPNextSalesInvoice;
     servicecase: ERPNextServicecase;
     serviceportalProductConfiguration: ERPNextDoctypeResourceRequest<typeof ServiceportalProductConfiguration>;
     servicecaseReason: ERPNextDoctypeResourceRequest<typeof ServicecaseReason>;
@@ -69,6 +76,9 @@ export declare class ERPNextQueueClient {
     shippingLabel: ERPNextDoctypeResourceRequest<typeof ShippingLabel>;
     file: ERPNextDoctypeResourceRequest<typeof ERPNextFile>;
     consolidatedCustomsInvoice: ERPNextDoctypeSubmittableResourceRequest<typeof ConsolidatedCustomsInvoice>;
+    itemTaxTemplate: ERPNextDoctypeResourceRequest<typeof ItemTaxTemplate>;
+    taxCategory: ERPNextDoctypeResourceRequest<typeof TaxCategory>;
+    tags: ERPNextTags;
     /**
      * @description Provide either a temporal client or connection details to create a new client
      */
@@ -79,3 +89,5 @@ export declare class ERPNextQueueClient {
 }
 export { ERPNextMethodResponse, ERPNextMethodResponseType, ERPNextResourceResponse, ERPNextResourceResponseType, } from "./erpnext/model/ERPNextResponse";
 export { pickFromSchema } from "./utils/zodUtils";
+export { AugmentChildTableArrays, CreateChildTableEntrySchema, DocTypeList, LoadDocumentWrapper, } from "./erpnext/model/DocTypeHelpers";
+export { DocTypeChildTableEntryMeta, DocTypeMeta, DocTypeNested, } from "./erpnext/model/ERPNextDocTypeMeta";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pickFromSchema = exports.ERPNextResourceResponse = exports.ERPNextMethodResponse = exports.ERPNextQueueClient = void 0;
+exports.DocTypeNested = exports.DocTypeMeta = exports.DocTypeChildTableEntryMeta = exports.LoadDocumentWrapper = exports.DocTypeList = exports.CreateChildTableEntrySchema = exports.AugmentChildTableArrays = exports.pickFromSchema = exports.ERPNextResourceResponse = exports.ERPNextMethodResponse = exports.ERPNextQueueClient = void 0;
 const client_1 = require("./client");
 const decryptFromErpNext_server_1 = require("./erpnext/decryptFromErpNext.server");
 const doctypeResourceRequest_1 = require("./erpnext/doctypeResourceRequest");
@@ -8,35 +8,40 @@ const address_1 = require("./erpnext/doctypes/address");
 const contact_1 = require("./erpnext/doctypes/contact");
 const deliveryNote_1 = require("./erpnext/doctypes/deliveryNote");
 const item_1 = require("./erpnext/doctypes/item");
+const paymentEntry_1 = require("./erpnext/doctypes/paymentEntry");
+const productBundle_1 = require("./erpnext/doctypes/productBundle");
 const purchaseInvoice_1 = require("./erpnext/doctypes/purchaseInvoice");
 const purchaseReceipt_1 = require("./erpnext/doctypes/purchaseReceipt");
+const salesInvoice_1 = require("./erpnext/doctypes/salesInvoice");
+const servicecase_1 = require("./erpnext/doctypes/servicecase");
 const shipment_1 = require("./erpnext/doctypes/shipment");
-const productBundle_1 = require("./erpnext/doctypes/productBundle");
 const stock_1 = require("./erpnext/doctypes/stock");
+const tags_1 = require("./erpnext/doctypes/tags");
 const doctypeSubmittableResourceRequest_1 = require("./erpnext/doctypeSubmittableResourceRequest");
 const fileRequests_1 = require("./erpnext/fileRequests");
 const methodRequest_1 = require("./erpnext/methodRequest");
 const Compliance_1 = require("./erpnext/model/Compliance");
+const ConsolidatedCustomsInvoice_1 = require("./erpnext/model/ConsolidatedCustomsInvoice");
 const Country_1 = require("./erpnext/model/Country");
 const Customer_1 = require("./erpnext/model/Customer");
+const File_1 = require("./erpnext/model/File");
+const InternalReasons_1 = require("./erpnext/model/InternalReasons");
+const ItemTaxTemplate_1 = require("./erpnext/model/ItemTaxTemplate");
 const PartList_1 = require("./erpnext/model/PartList");
-const PaymentEntry_1 = require("./erpnext/model/PaymentEntry");
 const PurchaseOrder_1 = require("./erpnext/model/PurchaseOrder");
+const SalesOrder_1 = require("./erpnext/model/SalesOrder");
+const ServicecaseReason_1 = require("./erpnext/model/ServicecaseReason");
+const ServicecaseSolution_1 = require("./erpnext/model/ServicecaseSolution");
+const ServiceportalProductConfiguration_1 = require("./erpnext/model/ServiceportalProductConfiguration");
+const ShippingLabel_1 = require("./erpnext/model/ShippingLabel");
 const ShippingProvider_1 = require("./erpnext/model/ShippingProvider");
 const StockEntry_1 = require("./erpnext/model/StockEntry");
 const StockReconciliation_1 = require("./erpnext/model/StockReconciliation");
 const Supplier_1 = require("./erpnext/model/Supplier");
+const TaxCategory_1 = require("./erpnext/model/TaxCategory");
 const Waitlist_1 = require("./erpnext/model/Waitlist");
 const reports_1 = require("./erpnext/reports");
 const resourceRequest_1 = require("./erpnext/resourceRequest");
-const servicecase_1 = require("./erpnext/doctypes/servicecase");
-const ServiceportalProductConfiguration_1 = require("./erpnext/model/ServiceportalProductConfiguration");
-const ShippingLabel_1 = require("./erpnext/model/ShippingLabel");
-const ServicecaseReason_1 = require("./erpnext/model/ServicecaseReason");
-const ServicecaseSolution_1 = require("./erpnext/model/ServicecaseSolution");
-const InternalReasons_1 = require("./erpnext/model/InternalReasons");
-const File_1 = require("./erpnext/model/File");
-const ConsolidatedCustomsInvoice_1 = require("./erpnext/model/ConsolidatedCustomsInvoice");
 class ERPNextQueueClient {
     /**
      * @description Provide either a temporal client or connection details to create a new client
@@ -67,8 +72,10 @@ class ERPNextQueueClient {
         this.waitlist = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Waitlist", Waitlist_1.Waitlist);
         this.stockEntry = new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(this.temporalClient, "Stock Entry", StockEntry_1.StockEntry);
         this.supplier = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Supplier", Supplier_1.Supplier);
-        this.paymentEntry = new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(this.temporalClient, "Payment Entry", PaymentEntry_1.PaymentEntry);
+        this.paymentEntry = new paymentEntry_1.ERPNextPaymentEntry(this.temporalClient);
         this.stockReconciliation = new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(this.temporalClient, "Stock Reconciliation", StockReconciliation_1.StockReconciliation);
+        this.salesOrder = new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(this.temporalClient, "Sales Order", SalesOrder_1.SalesOrder);
+        this.salesInvoice = new salesInvoice_1.ERPNextSalesInvoice(this.temporalClient);
         this.reports = new reports_1.ERPNextReports(this.temporalClient);
         this.stock = new stock_1.ERPNextStock(this.temporalClient);
         this.compliance = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Compliance", Compliance_1.Compliance);
@@ -81,6 +88,9 @@ class ERPNextQueueClient {
         this.shippingLabel = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Shipping Label", ShippingLabel_1.ShippingLabel);
         this.consolidatedCustomsInvoice =
             new doctypeSubmittableResourceRequest_1.ERPNextDoctypeSubmittableResourceRequest(this.temporalClient, "Consolidated Customs Invoice", ConsolidatedCustomsInvoice_1.ConsolidatedCustomsInvoice);
+        this.itemTaxTemplate = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Item Tax Template", ItemTaxTemplate_1.ItemTaxTemplate);
+        this.taxCategory = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Tax Category", TaxCategory_1.TaxCategory);
+        this.tags = new tags_1.ERPNextTags(this.temporalClient);
     }
 }
 exports.ERPNextQueueClient = ERPNextQueueClient;
@@ -89,3 +99,12 @@ Object.defineProperty(exports, "ERPNextMethodResponse", { enumerable: true, get:
 Object.defineProperty(exports, "ERPNextResourceResponse", { enumerable: true, get: function () { return ERPNextResponse_1.ERPNextResourceResponse; } });
 var zodUtils_1 = require("./utils/zodUtils");
 Object.defineProperty(exports, "pickFromSchema", { enumerable: true, get: function () { return zodUtils_1.pickFromSchema; } });
+var DocTypeHelpers_1 = require("./erpnext/model/DocTypeHelpers");
+Object.defineProperty(exports, "AugmentChildTableArrays", { enumerable: true, get: function () { return DocTypeHelpers_1.AugmentChildTableArrays; } });
+Object.defineProperty(exports, "CreateChildTableEntrySchema", { enumerable: true, get: function () { return DocTypeHelpers_1.CreateChildTableEntrySchema; } });
+Object.defineProperty(exports, "DocTypeList", { enumerable: true, get: function () { return DocTypeHelpers_1.DocTypeList; } });
+Object.defineProperty(exports, "LoadDocumentWrapper", { enumerable: true, get: function () { return DocTypeHelpers_1.LoadDocumentWrapper; } });
+var ERPNextDocTypeMeta_1 = require("./erpnext/model/ERPNextDocTypeMeta");
+Object.defineProperty(exports, "DocTypeChildTableEntryMeta", { enumerable: true, get: function () { return ERPNextDocTypeMeta_1.DocTypeChildTableEntryMeta; } });
+Object.defineProperty(exports, "DocTypeMeta", { enumerable: true, get: function () { return ERPNextDocTypeMeta_1.DocTypeMeta; } });
+Object.defineProperty(exports, "DocTypeNested", { enumerable: true, get: function () { return ERPNextDocTypeMeta_1.DocTypeNested; } });

package/dist/index.test.d.ts

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

package/dist/index.test.js

@@ -0,0 +1,261 @@
+"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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = __importDefault(require("zod"));
+const _1 = require(".");
+const constants_1 = require("./constants");
+const Address_1 = require("./erpnext/model/Address");
+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* () {
+    const erp = new _1.ERPNextQueueClient({
+        temporalCredentials: {
+            temporalHost: constants_1.constants.TEMPORAL_HOST,
+            temporalNamespace: constants_1.constants.TEMPORAL_NAMESPACE,
+            temporalCert: constants_1.constants.TEMPORAL_CRT,
+            temporalKey: constants_1.constants.TEMPORAL_KEY,
+        },
+    });
+    test("Single item fetch", () => __awaiter(void 0, void 0, void 0, function* () {
+        // 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({
+            resourceName: "Item",
+            resourceModel: Item_1.Item.merge(zod_1.default.object({
+                "`tabItem Supplier`.supplier as supplier": zod_1.default
+                    .string()
+                    .optional()
+                    .nullable(),
+                "item_name as item_title": zod_1.default.string().optional().nullable(),
+            })).describe("Item with supplier and title"),
+            filters: [["name", "=", "8721225924026FBP"]],
+            fields: [
+                "name",
+                "`tabItem Supplier`.supplier as supplier",
+                "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;
+            // get list with field defined
+            const itemsOnlyFieldDescription = yield 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");
+            // @ts-expect-error
+            expect((_e = itemsOnlyFieldDescription.at(0)) === null || _e === void 0 ? void 0 : _e.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;
+            // 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");
+            // @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;
+            // get list without fields defined
+            const itemsWithAllFields = yield erp.item.getList({
+                fields: ["*"],
+                limit: 10,
+            });
+            expect((_a = itemsWithAllFields.at(0)) === null || _a === void 0 ? void 0 : _a.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");
+            // @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 });
+            if (!dns[0])
+                throw new Error("No Delivery Notes found in test instance");
+            const dn = yield 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);
+            expect(address[0].city).toBeTypeOf("string");
+        });
+    }));
+    test("Item List with invalid field list", () => __awaiter(void 0, void 0, void 0, function* () {
+        // 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* () {
+        // SHOULD NOT BE EXECUTED, ONLY FOR STATIC TYPE TESTING
+        // We use expect-error to statically test negative cases in typescript
+        () => erp.item.create({
+            body: {
+                // @ts-expect-error
+                name: "TEST", // name and other metafields should not be set on create
+            },
+        });
+        () => erp.resourceRequest.create({
+            // @ts-expect-error - mandatory is missing, we expect an error here
+            body: {
+                optional: "string",
+            },
+            resourceName: "TEST",
+            resourceModel: zod_1.default.object({
+                mandatory: zod_1.default.string(),
+                optional: (0, zodContextOptionals_1.optionalForInput)(zod_1.default.string()),
+            }),
+        });
+        // should have no errors since the optional key is input-optional
+        () => erp.resourceRequest.create({
+            body: {
+                mandatory: "string",
+            },
+            resourceName: "TEST",
+            resourceModel: zod_1.default.object({
+                mandatory: zod_1.default.string(),
+                optional: (0, zodContextOptionals_1.optionalForInput)(zod_1.default.string()),
+            }),
+        });
+        () => erp.paymentEntry.create({
+            body: {
+                naming_series: "PAY-.#",
+                paid_amount: 12,
+                party: "test",
+                party_type: "Customer",
+                payment_type: "Receive",
+                reference_no: "REF",
+                reference_date: "2025-01-01",
+            },
+        });
+        () => erp.salesOrder.create({
+            // @ts-expect-error should not be empty
+            body: {},
+        });
+    }));
+    test("Static Types with Input Optional", () => __awaiter(void 0, void 0, void 0, function* () {
+        // 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({
+            mandatory: zod_1.default.string(),
+            optionalInInput: (0, zodContextOptionals_1.optionalForInput)(zod_1.default.string()),
+        });
+        const inputModel = (0, zodContextOptionals_1.ResourceInput)(testModel);
+        const testInputWrongType = {
+            mandatory: "TEST",
+            // @ts-expect-error because type is set incorrectly
+            optionalInInput: 1,
+        };
+        const testInputCorrect = {
+            mandatory: "TEST",
+        };
+        // @ts-expect-error because output should contain optionalInInput
+        const testOutput = {
+            mandatory: "TEST",
+        };
+    }));
+    test("Static Types with Nested Array Input Optional", () => __awaiter(void 0, void 0, void 0, function* () {
+        // 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({
+            mandatory: zod_1.default.string(),
+            subarray: zod_1.default.array(zod_1.default.object({
+                mandatoryElement: zod_1.default.string(),
+                inputOptionalSubarrayElement: (0, zodContextOptionals_1.optionalForInput)(zod_1.default.string()),
+            })),
+        });
+        const inputModel = (0, zodContextOptionals_1.ResourceInput)(testModel);
+        const testInputWrongType = {
+            mandatory: "TEST",
+            subarray: [
+                {
+                    mandatoryElement: "test",
+                    // @ts-expect-error because type is set incorrectly
+                    inputOptionalSubarrayElement: 1,
+                },
+            ],
+        };
+        const testInputCorrect = {
+            mandatory: "TEST",
+            subarray: [
+                {
+                    mandatoryElement: "test",
+                },
+            ],
+        };
+        const testOutput = {
+            mandatory: "TEST",
+            subarray: [
+                // @ts-expect-error because output should contain inputOptionalSubarrayElement
+                {
+                    mandatoryElement: "test",
+                },
+            ],
+        };
+    }));
+    test("Input for updateById function", () => __awaiter(void 0, void 0, void 0, function* () {
+        () => __awaiter(void 0, void 0, void 0, function* () {
+            // 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);
+            const typedInputBody = {
+                address_line1: "test",
+                address_type: "TEST",
+                city: "CITY",
+                country: "Country",
+                pincode: "1234",
+            };
+            yield erp.address.updateById({
+                resourceId: "TEST",
+                body: typedInputBody,
+            });
+        });
+    }));
+}));

package/dist/utils/utils.d.ts

@@ -1,3 +1,6 @@
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 export declare function addDays(date: string | number | Date, days: number): Date;
 export declare function addMinutes(date: Date, minutes: number): Date;
 export declare function timeout(ms: number): Promise<void>;

package/dist/utils/zodContextOptionals.d.ts

@@ -0,0 +1,14 @@
+import { AnyZodObject, z, ZodArray, ZodObject, ZodRawShape } from "zod";
+type MarkedInputOptional<T extends z.ZodTypeAny> = T & {
+    __optionalForInput: true;
+};
+export declare function optionalForInput<T extends z.ZodTypeAny>(schema: T): MarkedInputOptional<T>;
+type TransformInnerShape<S extends ZodRawShape> = {
+    [P in keyof S]: S[P] extends MarkedInputOptional<infer U> ? z.ZodOptional<U> : S[P];
+};
+type TransformOneLevel<V> = V extends MarkedInputOptional<infer U> ? z.ZodOptional<U> : V extends ZodObject<infer S extends ZodRawShape> ? ZodObject<TransformInnerShape<S>> : V extends ZodArray<infer Elem> ? Elem extends ZodObject<infer S2 extends ZodRawShape> ? ZodArray<ZodObject<TransformInnerShape<S2>>> : V : V;
+export type ResourceInputType<T extends AnyZodObject> = ZodObject<{
+    [K in keyof T["shape"]]: TransformOneLevel<T["shape"][K]>;
+}>;
+export declare function ResourceInput<T extends ZodRawShape>(schema: z.ZodObject<T>): ResourceInputType<z.ZodObject<T>>;
+export {};

package/dist/utils/zodContextOptionals.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optionalForInput = optionalForInput;
+exports.ResourceInput = ResourceInput;
+const zod_1 = require("zod");
+// Helper to mark a field as optional for input
+function optionalForInput(schema) {
+    return Object.assign(schema, {
+        __optionalForInput: true,
+    });
+}
+// Helper to check if field is marked
+function isMarkedOptionalForInput(schema) {
+    return "__optionalForInput" in schema && schema.__optionalForInput === true;
+}
+// schema transformation
+function ResourceInput(schema) {
+    var _a;
+    const shape = schema.shape;
+    function makeMarkedKeysOptional(shape) {
+        const newShape = zod_1.z.object({}).shape;
+        for (const [key, value] of Object.entries(shape)) {
+            if (isMarkedOptionalForInput(value)) {
+                newShape[key] = value.optional();
+            }
+            else {
+                newShape[key] = value;
+            }
+            // Recurse one level into nested objects to apply the same optionalization
+            if (value instanceof zod_1.z.ZodObject) {
+                const innerShape = value.shape;
+                newShape[key] = zod_1.z.object(makeMarkedKeysOptional(innerShape));
+            }
+            else if (value instanceof zod_1.ZodArray) {
+                const arrayElementShape = value.element
+                    .shape;
+                newShape[key] = zod_1.z.array(zod_1.z.object(makeMarkedKeysOptional(arrayElementShape)));
+            }
+        }
+        return newShape;
+    }
+    return zod_1.z
+        .object(makeMarkedKeysOptional(shape))
+        .describe(((_a = schema.description) !== null && _a !== void 0 ? _a : "Unnamed Model") + " Input");
+}