washday-sdk 1.6.79 → 1.6.80

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "washday-sdk",
-  "version": "1.6.79",
+  "version": "1.6.80",
   "description": "Washday utilities functions and API",
   "main": "dist/index.js",
   "type": "module",

package/src/api/index.ts

@@ -126,6 +126,8 @@ const WashdayClient: WashdayClientConstructor = function WashdayClient(this: Was
         updateRouteById: routesEndpoints.putModule.updateRouteById,
         getRoutesByDriver: routesEndpoints.getModule.getRoutesByDriver,
         getRoutes: routesEndpoints.getModule.getRoutes,
+        getRoutesPage: routesEndpoints.getModule.getRoutesPage,
+        getRoutesByStorePage: routesEndpoints.getModule.getRoutesByStorePage,
         startRoute: routesEndpoints.postModule.startRoute,
         reorderRouteOrders: routesEndpoints.patchModule.reorderRouteOrders,
     });

package/src/api/routes/get.ts

@@ -18,6 +18,25 @@ export type RouteListQuery = {
     createdTo?: string,
 };
 
+export type RoutePageQuery = RouteListQuery & {
+    pageNum?: number | string,
+    limit?: number | string,
+};
+
+export type RouteStorePageQuery = {
+    pageNum?: number | string,
+    limit?: number | string,
+};
+
+export type RouteListPageResponse = {
+    routes: IRoute[],
+    totalRowsCount: number,
+    totalPages: number,
+    pageNum: number,
+    limit: number,
+    hasNextPage: boolean,
+};
+
 //@deprecated
 export const getOrdersForRoute = async function (this: WashdayClientInstance, params: {
     store: string | undefined,
@@ -65,6 +84,26 @@ export const getRoutesByStore = async function (this: WashdayClientInstance, sto
     }
 };
 
+export const getRoutesByStorePage = async function (
+    this: WashdayClientInstance,
+    storeId: string,
+    query: RouteStorePageQuery = {}
+): Promise<{ data: { data: RouteListPageResponse } }> {
+    try {
+        const config = {
+            headers: { Authorization: `Bearer ${this.apiToken}` }
+        };
+        const queryParams = generateQueryParamsStr([
+            'pageNum',
+            'limit',
+        ], query);
+        return await this.axiosInstance.get(`${GET_STORE_ROUTES_BY_ID.replace(':id', storeId)}?${queryParams}`, config);
+    } catch (error) {
+        console.error('Error fetching getRoutesByStorePage:', error);
+        throw error;
+    }
+};
+
 export const getRouteByIdV2 = async function (this: WashdayClientInstance, routeId: string): Promise<{ data: { data: IRoute } }> {
     try {
         const config = {
@@ -129,3 +168,25 @@ export const getRoutes = async function (this: WashdayClientInstance, query: Rou
         throw error;
     }
 };
+
+export const getRoutesPage = async function (this: WashdayClientInstance, query: RoutePageQuery = {}): Promise<{ data: { data: RouteListPageResponse } }> {
+    try {
+        const config = {
+            headers: { Authorization: `Bearer ${this.apiToken}` }
+        };
+        const queryParams = generateQueryParamsStr([
+            'scope',
+            'storeIds',
+            'status',
+            'driver',
+            'createdFrom',
+            'createdTo',
+            'pageNum',
+            'limit',
+        ], query);
+        return await this.axiosInstance.get(`${GET_ROUTE}?${queryParams}`, config);
+    } catch (error) {
+        console.error('Error fetching getRoutesPage:', error);
+        throw error;
+    }
+};

package/src/interfaces/Api.ts

@@ -128,6 +128,8 @@ export interface WashdayClientInstance {
         updateRouteById: typeof routesEndpoints.putModule.updateRouteById,
         getRoutesByDriver: typeof routesEndpoints.getModule.getRoutesByDriver,
         getRoutes: typeof routesEndpoints.getModule.getRoutes,
+        getRoutesPage: typeof routesEndpoints.getModule.getRoutesPage,
+        getRoutesByStorePage: typeof routesEndpoints.getModule.getRoutesByStorePage,
         startRoute: typeof routesEndpoints.postModule.startRoute,
         reorderRouteOrders: typeof routesEndpoints.patchModule.reorderRouteOrders,
     },

package/src/interfaces/Company.ts

@@ -174,6 +174,13 @@ export interface ApplySubscriptionPlanChangeResponse {
 
 export interface IStripeSettings {
     planPriceId?: string | null;
+    /**
+     * Legacy/subscription billing CFDI fields.
+     * Operational Invoice Module usage billing should prefer
+     * InvoiceModuleProviderSettings.billingConfig.stripeSubscriptionItemId,
+     * then fall back to company.stripeSettings.stripeCFDISubItemID.
+     * Do not mix operational module country with subscription billing fiscal country.
+     */
     stripeCFDISubID: string | null;
     stripeCFDISubItemID: string | null;
     cfdiBillingMode?: CFDIBillingMode;
@@ -187,12 +194,27 @@ export interface IStripeSettings {
 
 export interface ICompanyTaxInfo {
     name?: string;
+    /**
+     * Legacy CFDI issuer legal name.
+     * Forward replacement: InvoiceModuleIssuerProfile.cfdi.legalName.
+     * Still used as fallback for CFDI issuer/profile compatibility.
+     */
     legal_name?: string;
+    /**
+     * Legacy CFDI issuer tax system.
+     * Forward replacement: InvoiceModuleIssuerProfile.cfdi.taxSystem.
+     * Still used as fallback for CFDI issuer/profile compatibility.
+     */
     tax_system?: string;
     website?: string;
     support_email?: string;
     phone?: string;
     address?: {
+        /**
+         * Legacy CFDI issuer postal code.
+         * Forward replacement: InvoiceModuleIssuerProfile.cfdi.zip.
+         * Still used as fallback for CFDI issuer/profile compatibility.
+         */
         zip?: string;
         street?: string;
         exterior?: string;
@@ -201,5 +223,10 @@ export interface ICompanyTaxInfo {
         enabled: boolean;
         email: string;
     };
+    /**
+     * Legacy global-payment-method CFDI product defaults.
+     * Future target: provider/standard-specific Invoice Module settings.
+     * Keep until global CFDI settings are migrated.
+     */
     globalPaymentMethodCfdiSettings?: GlobalPaymentMethodCfdiSettings;
 }

package/src/interfaces/Product.ts

@@ -30,6 +30,10 @@ export interface IPriceOption {
 }
 
 export interface IProductCfdiInvoiceModuleSettings {
+    /**
+     * Forward per-standard fiscal metadata for Mexico CFDI.
+     * Current Mexico runtime should prefer these fields over legacy product invoice_* fields.
+     */
     description?: string,
     productKey?: string,
     unitKey?: string,
@@ -37,6 +41,9 @@ export interface IProductCfdiInvoiceModuleSettings {
 }
 
 export interface IProductSunatInvoiceModuleSettings {
+    /**
+     * Forward per-standard fiscal metadata reserved/prepared for Peru SUNAT provider runtime.
+     */
     enabled?: boolean,
 }
 
@@ -67,6 +74,15 @@ export interface IProduct {
     store: IStore | string,
     order: number,
     productSupplies?: [IProductSupplies],
+    /**
+     * Legacy CFDI product fiscal metadata.
+     * Forward replacements:
+     * - invoiceModuleSettings.cfdi.description
+     * - invoiceModuleSettings.cfdi.productKey
+     * - invoiceModuleSettings.cfdi.unitKey
+     * - invoiceModuleSettings.cfdi.unitName
+     * Still used as fallback by CFDI builders/resolvers.
+     */
     invoice_description?: string,
     invoice_product_key?: string,
     invoice_product_unit_key?: string,

package/test/routes.multistore.test.ts

@@ -1,4 +1,4 @@
-import { getRoutes, getRoutesByDriver } from "../src/api/routes/get";
+import { getRoutes, getRoutesByDriver, getRoutesByStorePage, getRoutesPage } from "../src/api/routes/get";
 import { createRouteV2 } from "../src/api/routes/post";
 import { WashdayClient } from "../src";
 
@@ -95,6 +95,47 @@ describe("routes multi-store api", () => {
     );
   });
 
+  it("lists paginated company routes through the root routes endpoint", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: { routes: [] } } });
+    const client = {
+      apiToken: "token-123",
+      axiosInstance: { get },
+    } as any;
+
+    await getRoutesPage.call(client, {
+      scope: "company",
+      pageNum: 1,
+      limit: 9,
+    });
+
+    expect(get).toHaveBeenCalledWith(
+      "api/routes?scope=company&pageNum=1&limit=9",
+      {
+        headers: { Authorization: "Bearer token-123" },
+      }
+    );
+  });
+
+  it("lists paginated store routes through the store routes endpoint", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: { routes: [] } } });
+    const client = {
+      apiToken: "token-123",
+      axiosInstance: { get },
+    } as any;
+
+    await getRoutesByStorePage.call(client, "store-a", {
+      pageNum: 2,
+      limit: 9,
+    });
+
+    expect(get).toHaveBeenCalledWith(
+      "api/stores/store-a/routes?pageNum=2&limit=9",
+      {
+        headers: { Authorization: "Bearer token-123" },
+      }
+    );
+  });
+
   it("exposes getRoutes through the WashdayClient routes module", async () => {
     const get = jest.fn().mockResolvedValue({ data: { data: [] } });
     const client = new WashdayClient("token-123", "DEV") as any;
@@ -108,4 +149,23 @@ describe("routes multi-store api", () => {
       headers: { Authorization: "Bearer token-123" },
     });
   });
+
+  it("exposes paginated route list helpers through the WashdayClient routes module", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: { routes: [] } } });
+    const client = new WashdayClient("token-123", "DEV") as any;
+    client.axiosInstance = { get };
+
+    expect(typeof client.routes.getRoutesPage).toBe("function");
+    expect(typeof client.routes.getRoutesByStorePage).toBe("function");
+
+    await client.routes.getRoutesPage({ scope: "company", pageNum: 0, limit: 9 });
+    await client.routes.getRoutesByStorePage("store-a", { pageNum: 0, limit: 9 });
+
+    expect(get).toHaveBeenNthCalledWith(1, "api/routes?scope=company&pageNum=0&limit=9", {
+      headers: { Authorization: "Bearer token-123" },
+    });
+    expect(get).toHaveBeenNthCalledWith(2, "api/stores/store-a/routes?pageNum=0&limit=9", {
+      headers: { Authorization: "Bearer token-123" },
+    });
+  });
 });