erpnext-queue-client 2.0.0-beta.0 → 2.0.0-beta.2

package/dist/index.js

@@ -8,6 +8,7 @@ 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");
@@ -20,12 +21,13 @@ const doctypeSubmittableResourceRequest_1 = require("./erpnext/doctypeSubmittabl
 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");
@@ -36,6 +38,7 @@ 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");
@@ -69,7 +72,7 @@ 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);
@@ -83,6 +86,10 @@ class ERPNextQueueClient {
         this.servicecaseSolution = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Servicecase Solution", ServicecaseSolution_1.ServiceCaseSolution);
         this.internalReason = new doctypeResourceRequest_1.ERPNextDoctypeResourceRequest(this.temporalClient, "Internal Reason", InternalReasons_1.InternalReason);
         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);
     }
 }

package/dist/index.test.js

@@ -1,6 +1,4 @@
 "use strict";
-// Type testing only - should not be in compiled code
-// Use this to statically test types before build
 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) {
@@ -14,84 +12,118 @@ 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 zod_1 = __importDefault(require("zod"));
-const zodContextOptionals_1 = require("./utils/zodContextOptionals");
 const Address_1 = require("./erpnext/model/Address");
-describe("Type tests", () => __awaiter(void 0, void 0, void 0, function* () {
-    beforeAll(() => {
-        console.log("THIS TEST IS RUN ON erp-test - Make sure the test instance ");
-    });
+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_ERPNEXT_QUEUE_HOST,
-            temporalNamespace: constants_1.constants.TEMPORAL_ERPNEXT_QUEUE_NAMESPACE,
+            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* () {
-        var _a;
         // We use expect-error to statically test negative cases in typescript
-        const items = yield erp.item.getList({ limit: 1 });
-        const item = yield erp.item.getById({ resourceId: items[0].name });
-        expect(item.name).toBeTypeOf("string");
-        expect(item.doctype).toBeTypeOf("string");
-        expect(item.description).toBeTypeOf("string");
-        expect((_a = item.barcodes.at(0)) === null || _a === void 0 ? void 0 : _a.idx).toBeTypeOf("number");
+        () => __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* () {
-        var _a, _b, _c, _d, _e, _f;
-        // get list with field defined
-        const itemsOnlyFieldDescription = yield erp.item.getList({
-            fields: ["description"],
-            limit: 10,
+        () => __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}
         });
-        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* () {
-        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
+        () => __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* () {
-        // get list without fields defined
-        var _a, _b, _c, _d;
-        const itemsWithAllFields = yield erp.item.getList({
-            fields: ["*"],
-            limit: 10,
+        () => __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();
         });
-        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* () {
-        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,
+        () => __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}
         });
-        dn.amended_from; // for static type analysis
     }));
     test("Get Address by Supplier", () => __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");
+        () => __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
@@ -102,7 +134,7 @@ describe("Type tests", () => __awaiter(void 0, void 0, void 0, function* () {
         });
     }));
     test("Create with DocModel Metafields should fail", () => __awaiter(void 0, void 0, void 0, function* () {
-        // DO NOT EXECUTE, ONLY FOR STATIC TYPE TESTING
+        // SHOULD NOT BE EXECUTED, ONLY FOR STATIC TYPE TESTING
         // We use expect-error to statically test negative cases in typescript
         () => erp.item.create({
             body: {
@@ -209,19 +241,21 @@ describe("Type tests", () => __awaiter(void 0, void 0, void 0, function* () {
         };
     }));
     test("Input for updateById 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,
+        () => __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/zodContextOptionals.js

@@ -15,9 +15,10 @@ function isMarkedOptionalForInput(schema) {
 }
 // schema transformation
 function ResourceInput(schema) {
+    var _a;
     const shape = schema.shape;
     function makeMarkedKeysOptional(shape) {
-        const newShape = {};
+        const newShape = zod_1.z.object({}).shape;
         for (const [key, value] of Object.entries(shape)) {
             if (isMarkedOptionalForInput(value)) {
                 newShape[key] = value.optional();
@@ -28,15 +29,17 @@ function ResourceInput(schema) {
             // Recurse one level into nested objects to apply the same optionalization
             if (value instanceof zod_1.z.ZodObject) {
                 const innerShape = value.shape;
-                newShape[key] = makeMarkedKeysOptional(innerShape);
+                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(makeMarkedKeysOptional(arrayElementShape));
+                newShape[key] = zod_1.z.array(zod_1.z.object(makeMarkedKeysOptional(arrayElementShape)));
             }
         }
         return newShape;
     }
-    return zod_1.z.object(makeMarkedKeysOptional(shape));
+    return zod_1.z
+        .object(makeMarkedKeysOptional(shape))
+        .describe(((_a = schema.description) !== null && _a !== void 0 ? _a : "Unnamed Model") + " Input");
 }

package/dist/utils/zodUtils.js

@@ -9,6 +9,10 @@ function validateData(data, ValidationModel) {
     if (!ValidationModel.description)
         throw new Error("ValidationModel.description is required");
     // writeFileSync("test.json", JSON.stringify(data, null, 2));
+    if (!(ValidationModel instanceof zod_1.ZodObject)) {
+        console.log(ValidationModel);
+        throw new Error("Invalid Zod Model");
+    }
     const validationResult = ValidationModel.safeParse(data);
     if (!validationResult.success) {
         const errorObject = {
@@ -31,8 +35,16 @@ function validateData(data, ValidationModel) {
 }
 function pickFromSchema(schema, keys) {
     const pickedShape = keys === null || keys === void 0 ? void 0 : keys.reduce((acc, key) => {
-        if (key in schema.shape) {
-            acc[key] = schema.shape[key];
+        if (typeof key === "string" && key.includes("as")) {
+            const [field, alias] = key.split(" as ");
+            if (key in schema.shape) {
+                acc[alias] = schema.shape[key];
+            }
+        }
+        else {
+            if (key in schema.shape) {
+                acc[key] = schema.shape[key];
+            }
         }
         return acc;
     }, {});

package/package.json

@@ -7,7 +7,12 @@
   "main": "dist/index.js",
   "scripts": {
     "dev": "tsc -w",
+    "op:env": "op item get --fields notesPlain 'ERPNext Queue client .env' | sed -e 's/^\"//' -e 's/\"$//' | tee .env  > /dev/null",
+    "op:env-development": "op item get --fields notesPlain 'ERPNext Queue client .env.development' | sed -e 's/^\"//' -e 's/\"$//' | tee .env.development  > /dev/null",
+    "op": "op signin --account ehrenkind.1password.com && run-p op:*",
+    "ci": "yarn test && yarn lint && yarn typecheck",
     "test": "dotenv -c test vitest",
+    "test-on-staging": "dotenv -c development vitest",
     "build": "tsc",
     "release": "npm run build && npm publish"
   },
@@ -25,7 +30,7 @@
     "winston": "^3.15.0",
     "zod": "3.25.76"
   },
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.2",
   "devDependencies": {
     "@types/crypto-js": "^4.2.2",
     "@types/lodash": "^4.17.13",
@@ -34,4 +39,4 @@
     "typescript": "^5.6.3",
     "vitest": "^2.1.8"
   }
-}
+}