washday-sdk 1.6.78 → 1.6.80

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/InvoiceModule.ts

@@ -0,0 +1,135 @@
+export type InvoiceModuleCountryCode = "MX" | "PE" | string;
+export type InvoiceModuleStandard = "cfdi" | "sunat" | string;
+export type InvoiceModuleProvider = "facturapi" | string;
+export type InvoiceModuleProviderStatus =
+    | "not_configured"
+    | "test"
+    | "active"
+    | "suspended"
+    | string;
+export type InvoiceModuleIssuerProfileStatus =
+    | "missing"
+    | "incomplete"
+    | "ready"
+    | "invalid"
+    | string;
+export type InvoiceModulePlanStatus = "active" | "grace" | "suspended" | string;
+
+export type InvoiceModuleDocumentType =
+    | "income_invoice"
+    | "global_invoice"
+    | "payment_complement"
+    | "global_payment_method_invoice"
+    | "cancellation"
+    | string;
+
+export interface InvoiceModuleCapabilitiesResponse {
+    enabled?: boolean;
+    country?: {
+        code?: InvoiceModuleCountryCode | null;
+        supported?: boolean;
+        standard?: InvoiceModuleStandard | null;
+        [key: string]: unknown;
+    };
+    provider?: {
+        provider?: InvoiceModuleProvider | null;
+        status?: InvoiceModuleProviderStatus;
+        [key: string]: unknown;
+    };
+    issuerProfile?: {
+        status?: InvoiceModuleIssuerProfileStatus;
+        [key: string]: unknown;
+    };
+    permissions?: {
+        canView?: boolean;
+        canMutate?: boolean;
+        [key: string]: unknown;
+    };
+    plan?: {
+        status?: InvoiceModulePlanStatus;
+        allowed?: boolean;
+        [key: string]: unknown;
+    };
+    legacy?: {
+        canUseCFDIInvoicing?: boolean;
+        canUseInvoiceModule?: boolean;
+        [key: string]: unknown;
+    };
+    reasons?: string[];
+    [key: string]: unknown;
+}
+
+export interface InvoiceModuleCFDIListParams {
+    query?: string;
+    storeId?: string;
+    fromDate?: string;
+    toDate?: string;
+    limit?: string | number;
+    pageNum?: string | number;
+}
+
+export interface InvoiceModuleCFDIPreviewParams {
+    ordersID?: string[];
+    customer?: string;
+}
+
+export interface InvoiceModuleCFDIProductCatalogsParams {
+    search?: string;
+    q?: string;
+}
+
+export interface InvoiceModuleCreateCFDIRequest {
+    provider?: InvoiceModuleProvider;
+    documentType?: InvoiceModuleDocumentType;
+    providerPayload?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+export type InvoiceModuleGlobalPaymentMethod =
+    | "cash"
+    | "card"
+    | "transfer"
+    | "mercadopago"
+    | string;
+
+export interface InvoiceModuleGlobalPaymentMethodStoreFilters {
+    storeIds?: string[];
+    includeAllStores?: boolean;
+}
+
+export interface InvoiceModuleSearchGlobalByPaymentMethodCandidatesRequest
+    extends InvoiceModuleGlobalPaymentMethodStoreFilters {
+    paymentMethod?: InvoiceModuleGlobalPaymentMethod;
+    dateFrom?: string;
+    dateTo?: string;
+    providerPayload?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+export interface InvoiceModuleGlobalByPaymentMethodSelectedLine {
+    paymentLineId: string;
+    description?: string;
+    [key: string]: unknown;
+}
+
+export interface InvoiceModuleGlobalByPaymentMethodCFDIRequest
+    extends InvoiceModuleSearchGlobalByPaymentMethodCandidatesRequest {
+    provider?: InvoiceModuleProvider;
+    documentType?: InvoiceModuleDocumentType;
+    date?: string;
+    sendEmailInvoice?: boolean;
+    global?: {
+        periodicity: string;
+        months: string;
+        year: string;
+        [key: string]: unknown;
+    };
+    paymentLines?: InvoiceModuleGlobalByPaymentMethodSelectedLine[];
+}
+
+export interface InvoiceModuleCancelCFDIRequest {
+    motive: string;
+    substitution?: string;
+}

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/api/invoiceModule.test.ts

@@ -0,0 +1,206 @@
+import WashdayClient from "../../src/api";
+
+const TOKEN = "token-123";
+const authConfig = {
+  headers: { Authorization: `Bearer ${TOKEN}` },
+};
+
+describe("WashdayClient invoiceModule namespace", () => {
+  it("binds invoiceModule without removing the legacy cfdi namespace", () => {
+    const client = new (WashdayClient as any)(TOKEN, "DEV");
+
+    expect(client.invoiceModule).toBeDefined();
+    expect(typeof client.invoiceModule.getCapabilities).toBe("function");
+    expect(typeof client.cfdi.createCFDI).toBe("function");
+    expect(typeof client.cfdi.getList).toBe("function");
+    expect(typeof client.cfdi.cancelCFDI).toBe("function");
+  });
+
+  it("calls invoice-module routes with authorization headers", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const post = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const deleteRequest = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const client = new (WashdayClient as any)(TOKEN, "DEV");
+    client.axiosInstance = { get, post, delete: deleteRequest };
+
+    await client.invoiceModule.getCapabilities();
+    await client.invoiceModule.getCFDIList({
+      query: "folio-1",
+      storeId: "store-1",
+      fromDate: "2026-01-01",
+      toDate: "2026-01-31",
+      limit: 25,
+      pageNum: 2,
+    });
+    await client.invoiceModule.getCFDIPreview({
+      ordersID: ["order-1", "order-2"],
+      customer: "customer-1",
+    });
+    await client.invoiceModule.sendCFDIByEmail("invoice-1");
+    await client.invoiceModule.downloadCFDIPDF("invoice-1");
+    await client.invoiceModule.downloadCFDIZIP("invoice-1");
+    await client.invoiceModule.getCFDIProductCatalogs({ search: "detergente" });
+
+    await client.invoiceModule.createCFDI({
+      provider: "facturapi",
+      documentType: "income_invoice",
+      providerPayload: { ordersID: ["order-1"] },
+    });
+    await client.invoiceModule.searchGlobalByPaymentMethodCandidates({
+      paymentMethod: "cash",
+      dateFrom: "2026-01-01",
+      dateTo: "2026-01-31",
+    });
+    await client.invoiceModule.previewGlobalByPaymentMethodCFDI({
+      paymentMethod: "cash",
+      dateFrom: "2026-01-01",
+      dateTo: "2026-01-31",
+      global: {
+        periodicity: "01",
+        months: "01",
+        year: "2026",
+      },
+      paymentLines: [{ paymentLineId: "payment-line-1" }],
+    });
+    await client.invoiceModule.createGlobalByPaymentMethodCFDI({
+      paymentMethod: "cash",
+      dateFrom: "2026-01-01",
+      dateTo: "2026-01-31",
+      global: {
+        periodicity: "01",
+        months: "01",
+        year: "2026",
+      },
+      paymentLines: [{ paymentLineId: "payment-line-1" }],
+    });
+    await client.invoiceModule.cancelCFDI("invoice-1", {
+      motive: "02",
+      substitution: "replacement-uuid",
+    });
+
+    expect(get).toHaveBeenNthCalledWith(1, "api/invoice-module/capabilities", authConfig);
+    expect(get).toHaveBeenNthCalledWith(
+      2,
+      "api/invoice-module/cfdi?query=folio-1&storeId=store-1&fromDate=2026-01-01&toDate=2026-01-31&limit=25&pageNum=2",
+      authConfig,
+    );
+    expect(get).toHaveBeenNthCalledWith(
+      3,
+      "api/invoice-module/cfdi/preview?ordersID=order-1,order-2&customer=customer-1",
+      authConfig,
+    );
+    expect(get).toHaveBeenNthCalledWith(4, "api/invoice-module/cfdi/invoice-1/email", authConfig);
+    expect(get).toHaveBeenNthCalledWith(5, "api/invoice-module/cfdi/invoice-1/download/pdf", {
+      headers: { Authorization: `Bearer ${TOKEN}` },
+      responseType: "arraybuffer",
+    });
+    expect(get).toHaveBeenNthCalledWith(6, "api/invoice-module/cfdi/invoice-1/download/zip", {
+      headers: { Authorization: `Bearer ${TOKEN}` },
+      responseType: "arraybuffer",
+    });
+    expect(get).toHaveBeenNthCalledWith(
+      7,
+      "api/invoice-module/cfdi/catalogs/products?search=detergente",
+      authConfig,
+    );
+
+    expect(post).toHaveBeenNthCalledWith(
+      1,
+      "api/invoice-module/cfdi",
+      {
+        provider: "facturapi",
+        documentType: "income_invoice",
+        providerPayload: { ordersID: ["order-1"] },
+      },
+      authConfig,
+    );
+    expect(post).toHaveBeenNthCalledWith(
+      2,
+      "api/invoice-module/cfdi/global-by-payment-method/search",
+      {
+        paymentMethod: "cash",
+        dateFrom: "2026-01-01",
+        dateTo: "2026-01-31",
+      },
+      authConfig,
+    );
+    expect(post).toHaveBeenNthCalledWith(
+      3,
+      "api/invoice-module/cfdi/global-by-payment-method/preview",
+      {
+        paymentMethod: "cash",
+        dateFrom: "2026-01-01",
+        dateTo: "2026-01-31",
+        global: {
+          periodicity: "01",
+          months: "01",
+          year: "2026",
+        },
+        paymentLines: [{ paymentLineId: "payment-line-1" }],
+      },
+      authConfig,
+    );
+    expect(post).toHaveBeenNthCalledWith(
+      4,
+      "api/invoice-module/cfdi/global-by-payment-method",
+      {
+        paymentMethod: "cash",
+        dateFrom: "2026-01-01",
+        dateTo: "2026-01-31",
+        global: {
+          periodicity: "01",
+          months: "01",
+          year: "2026",
+        },
+        paymentLines: [{ paymentLineId: "payment-line-1" }],
+      },
+      authConfig,
+    );
+    expect(deleteRequest).toHaveBeenCalledWith("api/invoice-module/cfdi/invoice-1", {
+      ...authConfig,
+      data: {
+        motive: "02",
+        substitution: "replacement-uuid",
+      },
+    });
+  });
+
+  it("keeps legacy cfdi endpoint mappings intact", async () => {
+    const get = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const post = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const deleteRequest = jest.fn().mockResolvedValue({ data: { data: {} } });
+    const client = new (WashdayClient as any)(TOKEN, "DEV");
+    client.axiosInstance = { get, post, delete: deleteRequest };
+
+    await client.cfdi.getList({ query: "folio-1" });
+    await client.cfdi.createCFDI({
+      ordersID: ["order-1"],
+      CFDIInfo: {
+        use: "G03",
+        payment_method: "PUE",
+        payment_form: "01",
+        date: "2026-01-01",
+      },
+    });
+    await client.cfdi.cancelCFDI("invoice-1", { motive: "02" });
+
+    expect(get).toHaveBeenCalledWith("api/cfdi?query=folio-1", authConfig);
+    expect(post).toHaveBeenCalledWith(
+      "api/cfdi",
+      {
+        ordersID: ["order-1"],
+        CFDIInfo: {
+          use: "G03",
+          payment_method: "PUE",
+          payment_form: "01",
+          date: "2026-01-01",
+        },
+      },
+      authConfig,
+    );
+    expect(deleteRequest).toHaveBeenCalledWith("api/cfdi/invoice-1", {
+      ...authConfig,
+      data: { motive: "02" },
+    });
+  });
+});

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" },
+    });
+  });
 });

package/tsconfig.json

@@ -10,5 +10,5 @@
     "lib": ["esnext"]
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "src/**/*.test.ts"]
 }

package/dist/interfaces/Company.garmentAttributeCatalogs.test.js

@@ -1,21 +0,0 @@
-const type = "brand";
-const catalog = {
-    type,
-    values: ["Nike"],
-};
-const getResponse = {
-    garmentAttributeCatalogs: [catalog],
-};
-const updateRequest = {
-    garmentAttributeCatalogs: [catalog],
-};
-const updateResponse = {
-    garmentAttributeCatalogs: updateRequest.garmentAttributeCatalogs,
-};
-if (getResponse.garmentAttributeCatalogs[0].type !== "brand") {
-    throw new Error("Garment attribute catalog type export was not preserved");
-}
-if (updateResponse.garmentAttributeCatalogs[0].values[0] !== "Nike") {
-    throw new Error("Garment attribute catalog response export was not preserved");
-}
-export {};

package/dist/interfaces/Product.description.test.js

@@ -1,37 +0,0 @@
-var _a;
-const variant = {
-    _id: "option-1",
-    label: "XL",
-    description: "Incluye tratamiento premium",
-    price: 130,
-    expressPrice: 190,
-    isDefault: true,
-    isActive: true,
-};
-const product = {
-    _id: "product-1",
-    name: "Camisa",
-    description: "Lavado y planchado",
-    price: 120,
-    expressPrice: 180,
-    overlayText: "",
-    sku: "",
-    pieces: "1",
-    taxExemptOne: false,
-    taxExemptTwo: false,
-    taxExemptThree: false,
-    type: "normal",
-    isActive: true,
-    showInApp: true,
-    owner: "user-1",
-    store: "store-1",
-    order: 1,
-    priceOptions: [variant],
-};
-if (product.description !== "Lavado y planchado") {
-    throw new Error("Product description was not preserved");
-}
-if (((_a = product.priceOptions) === null || _a === void 0 ? void 0 : _a[0].description) !== "Incluye tratamiento premium") {
-    throw new Error("Variant description was not preserved");
-}
-export {};

package/dist/interfaces/Store.ticketStructurePresets.test.js

@@ -1,73 +0,0 @@
-const folioPreset = "large";
-const spacingPreset = "medium";
-const ticketStructure = {
-    showTotalPieces: false,
-    showEmisionDate: true,
-    showEmisionTime: true,
-    showLegend: true,
-    showPaymentMethod: true,
-    showStorePhone: true,
-    showCustomerPoints: false,
-    showDeliveryDate: true,
-    showDeliveryTime: true,
-    ticketLegendText: "Gracias",
-    showStoreName: true,
-    showCustomerName: true,
-    showCreatedByName: true,
-    showOrderNotes: false,
-    showTaxes: false,
-    showDiscounts: true,
-    showCredit: true,
-    customerNameFontSize: "small",
-    orderFolioFontSizePreset: folioPreset,
-    ticketLineSpacingPreset: spacingPreset,
-    ticketPrintFormat: "escpos",
-    tax_id: "J-507138330",
-    tax_id_label: "RIF",
-};
-const labelTicketStructure = Object.assign({}, ticketStructure);
-const ticketForLaundryStructure = {
-    showTotalPieces: false,
-    showEmisionDate: true,
-    showEmisionTime: true,
-    showLegend: true,
-    showPaymentMethod: true,
-    showStorePhone: true,
-    showCustomerPoints: false,
-    showDeliveryDate: true,
-    showDeliveryTime: true,
-    ticketLegendText: "Gracias",
-    printLogoOnTicket: false,
-    showStoreName: true,
-    showCustomerName: true,
-    showCreatedByName: true,
-    showOrderNotes: false,
-    showTaxes: false,
-    showDiscounts: true,
-    showCredit: true,
-    customerNameFontSize: "medium",
-    orderFolioFontSizePreset: "large",
-    ticketLineSpacingPreset: "small",
-    ticketPrintFormat: "html",
-    tax_id: "ABC123",
-    tax_id_label: "RFC",
-};
-if (ticketStructure.orderFolioFontSizePreset !== "large") {
-    throw new Error("Ticket structure folio preset was not preserved");
-}
-if (labelTicketStructure.ticketLineSpacingPreset !== "medium") {
-    throw new Error("Label ticket structure spacing preset was not preserved");
-}
-if (ticketForLaundryStructure.customerNameFontSize !== "medium") {
-    throw new Error("Laundry ticket structure customer font size was not preserved");
-}
-if (ticketStructure.tax_id_label !== "RIF") {
-    throw new Error("Ticket structure tax ID label was not preserved");
-}
-if (labelTicketStructure.tax_id !== "J-507138330") {
-    throw new Error("Label ticket structure tax ID value was not preserved");
-}
-if (ticketForLaundryStructure.tax_id_label !== "RFC") {
-    throw new Error("Laundry ticket structure tax ID label was not preserved");
-}
-export {};