erpnext-queue-client 2.7.8 → 2.8.0

package/dist/erpnext/doctypeResourceRequest.d.ts

@@ -10,7 +10,7 @@ export declare class ERPNextDoctypeResourceRequest<TModel extends AnyZodObject>
     protected resourceModel: TModel;
     protected baseRequest: ERPNextResourceRequest;
     constructor(temporalClient: TemporalClient, resourceName: string, resourceModel: TModel);
-    getList<TFieldOptions extends KeysOfModel<TModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined>(args: {
+    getList<TFieldOptions extends KeysOfModel<TModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined, TReturnPaginationMeta extends boolean | undefined = undefined>(args: {
         fields?: TSelectedFields;
         filters?: (string | string[])[][];
         skip?: number;
@@ -18,9 +18,10 @@ export declare class ERPNextDoctypeResourceRequest<TModel extends AnyZodObject>
         priority?: number;
         asDict?: TAsDict;
         params?: Record<string, string>;
+        returnPaginationMeta?: TReturnPaginationMeta;
         resourceModel?: undefined;
-    }): Promise<GetListReturnValue<TModel, TFieldOptions, TSelectedFields, TAsDict>>;
-    getList<TOverrideModel extends AnyZodObject, TFieldOptions extends KeysOfModel<TOverrideModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined>(args: {
+    }): Promise<GetListReturnValue<TModel, TFieldOptions, TSelectedFields, TAsDict, TReturnPaginationMeta>>;
+    getList<TOverrideModel extends AnyZodObject, TFieldOptions extends KeysOfModel<TOverrideModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined, TReturnPaginationMeta extends boolean | undefined = undefined>(args: {
         fields?: TSelectedFields;
         filters?: (string | string[])[][];
         skip?: number;
@@ -29,7 +30,8 @@ export declare class ERPNextDoctypeResourceRequest<TModel extends AnyZodObject>
         priority?: number;
         asDict?: TAsDict;
         params?: Record<string, string>;
-    }): Promise<GetListReturnValue<TOverrideModel, TFieldOptions, TSelectedFields, TAsDict>>;
+        returnPaginationMeta?: TReturnPaginationMeta;
+    }): Promise<GetListReturnValue<TOverrideModel, TFieldOptions, TSelectedFields, TAsDict, TReturnPaginationMeta>>;
     getById({ resourceId, priority, }: {
         resourceId: string;
         priority?: number;

package/dist/erpnext/doctypeResourceRequest.js

@@ -13,7 +13,7 @@ class ERPNextDoctypeResourceRequest {
         this.resourceModel = resourceModel.describe(resourceName);
         this.baseRequest = new resourceRequest_1.ERPNextResourceRequest(this.temporalClient);
     }
-    async getList({ fields, filters, skip, limit, resourceModel, priority = 5, asDict, params, } = {}) {
+    async getList({ fields, filters, skip, limit, resourceModel, priority = 5, asDict, params, returnPaginationMeta, } = {}) {
         return await this.baseRequest.getList({
             resourceName: this.resourceName,
             resourceModel: resourceModel ?? this.resourceModel,
@@ -24,6 +24,7 @@ class ERPNextDoctypeResourceRequest {
             ...(skip !== undefined ? { skip } : {}),
             ...(params !== undefined ? { params } : {}),
             ...(asDict !== undefined ? { asDict } : {}),
+            ...(returnPaginationMeta !== undefined ? { returnPaginationMeta } : {}),
         });
     }
     async getById({ resourceId, priority = 5, }) {

package/dist/erpnext/model/DocTypeHelpers.d.ts

@@ -2,6 +2,12 @@ import { AnyZodObject, z, ZodArray, ZodNullable, ZodObject, ZodOptional, ZodRawS
 import { Prettify } from "../../utils/utils";
 import { KeysOf } from "../../utils/zodUtils";
 import { DocTypeChildTableEntryMeta, DocTypeMeta, SubmittableMeta } from "./ERPNextDocTypeMeta";
+type ListFilterValue = string | string[];
+export type ListFilter<TValue extends ListFilterValue = ListFilterValue> = [
+    field: string,
+    operator: string,
+    value: TValue
+];
 export type KeysOfModel<T> = Extract<KeysOf<T extends AnyZodObject ? DocModelListEntryType<T> : never>, string>;
 /**
  * Extracts the alias from a field name if it contains " as ".
@@ -16,9 +22,19 @@ type ExtractAlias<T extends string> = T extends `${infer _Before} as ${infer Ali
 type PickWithAliases<TModel extends AnyZodObject, TFields extends readonly string[]> = {
     [K in TFields[number] as ExtractAlias<K>]: ExtractAlias<K> extends keyof z.infer<DocModelListEntryType<TModel>> ? z.infer<DocModelListEntryType<TModel>>[ExtractAlias<K>] : never;
 };
-export type GetListReturnValue<TModel, TFieldOptions extends string, TSelectedFields, TAsDict> = Prettify<TAsDict extends false ? Array<Array<string>> : TModel extends AnyZodObject ? TSelectedFields extends undefined ? Array<{
+export type ListPaginationMeta = {
+    totalCount: number;
+    page?: number;
+    pageSize?: number;
+};
+export type GetListPaginatedReturnValue<TListData> = Prettify<{
+    page: TListData;
+    pagination: ListPaginationMeta;
+}>;
+type GetListData<TModel, TFieldOptions extends string, TSelectedFields, TAsDict> = Prettify<TAsDict extends false ? Array<Array<string>> : TModel extends AnyZodObject ? TSelectedFields extends undefined ? Array<{
     name: string;
 }> : TSelectedFields extends readonly ["*"] ? Array<z.infer<DocModelListEntryType<TModel>>> : TSelectedFields extends readonly TFieldOptions[] ? Array<PickWithAliases<TModel, TSelectedFields>> : any : any>;
+export type GetListReturnValue<TModel, TFieldOptions extends string, TSelectedFields, TAsDict, TReturnPaginationMeta extends boolean | undefined = undefined> = TReturnPaginationMeta extends true ? GetListPaginatedReturnValue<GetListData<TModel, TFieldOptions, TSelectedFields, TAsDict>> : GetListData<TModel, TFieldOptions, TSelectedFields, TAsDict>;
 export declare const LoadDocumentWrapper: <T extends AnyZodObject>(BaseModel: T) => z.ZodObject<{
     [x: string]: any;
 } & {

package/dist/erpnext/resourceRequest.d.ts

@@ -10,7 +10,9 @@ export declare class ERPNextResourceRequest {
     protected temporalClient: TemporalClient;
     constructor(temporalClient: TemporalClient);
     private getParams;
-    getList<TModel extends AnyZodObject | undefined = undefined, TFieldOptions extends GetListFieldOptions<TModel> = GetListFieldOptions<TModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined>({ resourceName, fields, filters, resourceModel, skip, limit, priority, asDict, params, }: {
+    private buildListPaginationMeta;
+    private getListTotalCount;
+    getList<TModel extends AnyZodObject | undefined = undefined, TFieldOptions extends GetListFieldOptions<TModel> = GetListFieldOptions<TModel>, TSelectedFields extends readonly TFieldOptions[] | readonly ["*"] | undefined = undefined, TAsDict extends boolean | undefined = undefined, TReturnPaginationMeta extends boolean | undefined = undefined>({ resourceName, fields, filters, resourceModel, skip, limit, priority, asDict, params, returnPaginationMeta, }: {
         resourceName: string;
         fields?: TSelectedFields;
         filters?: (string | string[])[][];
@@ -20,7 +22,8 @@ export declare class ERPNextResourceRequest {
         priority?: number;
         asDict?: TAsDict;
         params?: Record<string, string>;
-    }): Promise<GetListReturnValue<TModel, TFieldOptions, TSelectedFields, TAsDict>>;
+        returnPaginationMeta?: TReturnPaginationMeta;
+    }): Promise<GetListReturnValue<TModel, TFieldOptions, TSelectedFields, TAsDict, TReturnPaginationMeta>>;
     getById<TModel extends AnyZodObject | undefined = undefined>({ resourceName, resourceId, resourceModel, priority, }: {
         resourceName: string;
         resourceId: string;

package/dist/erpnext/resourceRequest.js

@@ -45,7 +45,32 @@ class ERPNextResourceRequest {
         };
         return allParams;
     };
-    async getList({ resourceName, fields, filters, resourceModel, skip, limit, priority = 5, asDict, params, }) {
+    buildListPaginationMeta({ totalCount, skip, limit, }) {
+        const pagination = { totalCount };
+        if (limit !== undefined && Number.isInteger(limit) && limit > 0) {
+            pagination.pageSize = limit;
+            pagination.page = Math.floor((skip ?? 0) / limit) + 1;
+        }
+        return pagination;
+    }
+    async getListTotalCount({ resourceName, filters, priority, params, }) {
+        const countSchema = zod_1.z
+            .object({
+            data: zod_1.z.array(zod_1.z.object({ "count(name)": zod_1.z.number() })),
+        })
+            .describe("Count Response");
+        const paramsString = (0, utils_1.paramsToString)({
+            ...this.getParams(["count(name)"], filters, true, params),
+        });
+        const result = await this.temporalClient.executeERPNextRequestWorkflow(`GET-${resourceName}-List-count`, {
+            requestMethod: "GET",
+            resourceName,
+            responseValidationModel: countSchema,
+            params: paramsString,
+        }, "erpnext", priority);
+        return result.data[0]?.["count(name)"] ?? 0;
+    }
+    async getList({ resourceName, fields, filters, resourceModel, skip, limit, priority = 5, asDict, params, returnPaginationMeta, }) {
         const erpNextFields = fields?.length
             ? fields
             : ["name"]; // default field is name
@@ -89,7 +114,7 @@ class ERPNextResourceRequest {
                     ? {}
                     : { limit_start: String(skip ?? loopSkip) }),
             });
-            const result = await this.temporalClient.executeERPNextRequestWorkflow(`GET-${resourceName.toLowerCase()}-List`, {
+            const result = await this.temporalClient.executeERPNextRequestWorkflow(`GET-${resourceName}-List`, {
                 requestMethod: "GET",
                 resourceName,
                 responseValidationModel: schema,
@@ -99,7 +124,23 @@ class ERPNextResourceRequest {
             results = [...results, ...currentResult];
             loopSkip = loopSkip + loopLimit;
         } while (autoPaginate && currentResult.length);
-        return results;
+        if (!returnPaginationMeta) {
+            return results;
+        }
+        const totalCount = await this.getListTotalCount({
+            resourceName,
+            priority,
+            ...(filters !== undefined ? { filters } : {}),
+            ...(params !== undefined ? { params } : {}),
+        });
+        return {
+            page: results,
+            pagination: this.buildListPaginationMeta({
+                totalCount,
+                ...(skip !== undefined ? { skip } : {}),
+                ...(limit !== undefined ? { limit } : {}),
+            }),
+        };
     }
     async getById({ resourceName, resourceId, resourceModel, priority = 5, }) {
         if (!resourceId)

package/dist/erpnext/resourceRequest.test.js

@@ -29,9 +29,8 @@ describe("stringifyFiltersForParams", () => {
     test("adds context when filter serialization fails", () => {
         const cyclicFilterValue = {};
         cyclicFilterValue.self = cyclicFilterValue;
-        const filters = [
-            ["custom", "=", cyclicFilterValue],
-        ];
+        const filters = [["custom", "=", cyclicFilterValue]];
+        // @ts-expect-error - we want to test the error case, filters has wrong format here
         expect(() => (0, resourceRequest_1.stringifyFiltersForParams)(filters)).toThrow("Failed to serialize ERPNext filters for query params");
     });
     test("passes typed getList filters as encoded JSON query params", async () => {
@@ -61,3 +60,91 @@ describe("stringifyFiltersForParams", () => {
         expect((0, resourceRequest_1.stringifyFiltersForParams)(undefined)).toBeUndefined();
     });
 });
+describe("ERPNextResourceRequest.getList returnPaginationMeta", () => {
+    const createResourceRequest = (listData, totalCount, mockOptions) => {
+        let listRequestCount = 0;
+        const executeERPNextRequestWorkflow = vi
+            .fn()
+            .mockImplementation((_workflowId, requestOptions) => {
+            const params = new URLSearchParams(requestOptions.params.slice(1));
+            const fields = params.get("fields");
+            if (fields?.includes("count(name)")) {
+                return Promise.resolve({ data: [{ "count(name)": totalCount }] });
+            }
+            if (mockOptions?.paginateOnce) {
+                listRequestCount += 1;
+                return Promise.resolve({
+                    data: listRequestCount === 1 ? listData : [],
+                });
+            }
+            return Promise.resolve({ data: listData });
+        });
+        return new resourceRequest_1.ERPNextResourceRequest({
+            executeERPNextRequestWorkflow,
+        });
+    };
+    test("returns a plain array by default", async () => {
+        const resourceRequest = createResourceRequest([{ name: "ITEM-0001" }], 42);
+        const result = await resourceRequest.getList({
+            resourceName: "Item",
+            fields: ["name"],
+            limit: 10,
+            skip: 0,
+        });
+        expect(result).toEqual([{ name: "ITEM-0001" }]);
+    });
+    test("wraps results with page and pagination when returnPaginationMeta is true", async () => {
+        const resourceRequest = createResourceRequest([{ name: "ITEM-0001" }, { name: "ITEM-0002" }], 42);
+        const filters = [["disabled", "=", "0"]];
+        const result = await resourceRequest.getList({
+            resourceName: "Item",
+            fields: ["name"],
+            filters,
+            limit: 10,
+            skip: 10,
+            returnPaginationMeta: true,
+        });
+        expect(result).toEqual({
+            page: [{ name: "ITEM-0001" }, { name: "ITEM-0002" }],
+            pagination: {
+                totalCount: 42,
+                pageSize: 10,
+                page: 2,
+            },
+        });
+    });
+    test("requests count(name) with the same filters as the list query", async () => {
+        const resourceRequest = createResourceRequest([], 7);
+        const filters = [["item_group", "=", "Products"]];
+        const executeERPNextRequestWorkflow = resourceRequest
+            .temporalClient.executeERPNextRequestWorkflow;
+        await resourceRequest.getList({
+            resourceName: "Item",
+            fields: ["name"],
+            filters,
+            limit: 5,
+            returnPaginationMeta: true,
+        });
+        const countCall = executeERPNextRequestWorkflow.mock.calls.find((call) => call[1].params.includes("count(name)"));
+        const listCall = executeERPNextRequestWorkflow.mock.calls.find((call) => !call[1].params.includes("count(name)"));
+        const countParams = new URLSearchParams((countCall?.[1]).params.slice(1));
+        const listParams = new URLSearchParams((listCall?.[1]).params.slice(1));
+        expect(countParams.get("fields")).toBe('["count(name)"]');
+        expect(countParams.get("filters")).toBe(listParams.get("filters"));
+        expect(JSON.parse(countParams.get("filters") ?? "")).toEqual(filters);
+    });
+    test("includes only totalCount when limit is not set", async () => {
+        const resourceRequest = createResourceRequest([{ name: "ITEM-0001" }], 3, {
+            paginateOnce: true,
+        });
+        const result = await resourceRequest.getList({
+            resourceName: "Item",
+            fields: ["name"],
+            returnPaginationMeta: true,
+        });
+        expect(result).toEqual({
+            page: [{ name: "ITEM-0001" }],
+            pagination: { totalCount: 3 },
+        });
+    });
+});

package/package.json

@@ -29,7 +29,7 @@
     "winston": "^3.15.0",
     "zod": "3.25.76"
   },
-  "version": "2.7.8",
+  "version": "2.8.0",
   "engines": {
     "node": ">=22"
   },