@growupsell/commerce 1.0.0-alpha.4 → 1.0.0-alpha.5

package/dist/{checkout-DDNMdKbR.d.ts → checkout-CAW8nLoz.d.ts}

@@ -1,4 +1,42 @@
+type FormFieldType = 'text' | 'boolean' | 'date' | 'number' | 'email' | 'phone' | 'select' | 'radio' | 'image' | 'file';
+interface FormFieldOption {
+    label: string;
+    value: string;
+}
+interface FormField {
+    /** The key to submit the value under. */
+    name: string;
+    type: FormFieldType;
+    required: boolean;
+    /** The merchant's label, or the name with `_` turned into spaces. */
+    label: string;
+    /** Only for `select` and `radio`; otherwise empty. */
+    options: FormFieldOption[];
+}
+/** A merchant-built form, as a shopper fills it in. */
+interface PublicForm {
+    id: number;
+    slug: string;
+    name: string;
+    description: string | null;
+    /** What to show after a successful submit; null means the app's default. */
+    successMessage: string | null;
+    fields: FormField[];
+}
+/** A form for the merchant to pick (e.g. for a banner button). */
+interface FormSummary {
+    id: number;
+    name: string;
+    slug: string;
+}
+/**
+ * A submitted value. `image` / `file` fields take a URL string: upload the file first. Guests
+ * cannot fill them today, because the only upload endpoint needs a customer login (ADR-023).
+ */
+type FormValue = string | number | boolean | null;
+
 /** Cart domain types. The backend calculates every total; the library only converts them. */
+
 /** `delivery` (paid online) or `cod` (cash on delivery). */
 type OrderType = 'delivery' | 'cod';
 /** How the business charges delivery: fixed thresholds, or a delivery partner's quote. */
@@ -26,7 +64,13 @@ interface CartLine {
     maxQuantity: number | null;
     isDigital: boolean;
     fulfillmentMode: FulfillmentMode;
+    /** The shopper's values for the product's custom fields, keyed by field `name`. */
     customData: Record<string, unknown> | null;
+    /**
+     * The product's custom fields as the merchant configured them: the label of each
+     * `customData` key. Empty for products without custom fields and lines without a SKU.
+     */
+    customFields: FormField[];
     variantIds: number[];
 }
 interface AppliedOffer {
@@ -305,6 +349,12 @@ interface ProductDetail {
     hasDigitalDelivery: boolean;
     fulfillmentMode: FulfillmentMode;
     advanceAmount: number | null;
+    /**
+     * The custom fields the shopper fills in for a made-to-order or custom fixed-price product
+     * (`cart.addItem` `customData`, `checkout.createAdvanceOrder`), as the merchant configured
+     * them. Empty for other products.
+     */
+    customFields: FormField[];
 }
 /** A product as listed by `products.list()` (home sliders, product pickers). */
 interface ProductOverview {
@@ -581,4 +631,4 @@ interface AdvanceOrder {
     payment: PendingPayment;
 }
 
-export type { AdvanceOrder as A, Brand as B, Cart as C, DeliveryChargeType as D, ProductSectionItem as E, FulfillmentMode as F, GiftCard as G, ProductSectionItemTarget as H, ProductSku as I, ProductSort as J, ProductSpecificationGroup as K, PromoCode as L, ReviewEligibility as M, ReviewListItem as N, Offer as O, Page as P, ReviewReply as Q, Review as R, ReviewSummary as S, RewardPointSettings as T, SearchSuggestion as U, SpecificationScope as V, TaxDetails as W, VariantGroup as X, VariantOption as Y, AppliedOffer as a, AppliedPromoCode as b, CartLine as c, CartTotals as d, CatalogSettings as e, Category as f, CategoryTree as g, CheckoutSettings as h, CustomerProfile as i, DeliveryEstimate as j, OfferScope as k, OrderType as l, PaymentMethodType as m, PendingPayment as n, PlaceOrderResult as o, ProductBlock as p, ProductDetail as q, ProductFilterConfig as r, ProductImage as s, ProductListItem as t, ProductListOptions as u, ProductListSort as v, ProductOverview as w, ProductPolicies as x, ProductSearchOptions as y, ProductSection as z };
+export type { SpecificationScope as $, AdvanceOrder as A, Brand as B, Cart as C, DeliveryChargeType as D, ProductListSort as E, FormField as F, GiftCard as G, ProductOverview as H, ProductPolicies as I, ProductSearchOptions as J, ProductSection as K, ProductSectionItem as L, ProductSectionItemTarget as M, ProductSku as N, Offer as O, Page as P, ProductSort as Q, ProductSpecificationGroup as R, PromoCode as S, PublicForm as T, Review as U, ReviewEligibility as V, ReviewListItem as W, ReviewReply as X, ReviewSummary as Y, RewardPointSettings as Z, SearchSuggestion as _, AppliedOffer as a, TaxDetails as a0, VariantGroup as a1, VariantOption as a2, AppliedPromoCode as b, CartLine as c, CartTotals as d, CatalogSettings as e, Category as f, CategoryTree as g, CheckoutSettings as h, CustomerProfile as i, DeliveryEstimate as j, FormFieldOption as k, FormFieldType as l, FormSummary as m, FormValue as n, FulfillmentMode as o, OfferScope as p, OrderType as q, PaymentMethodType as r, PendingPayment as s, PlaceOrderResult as t, ProductBlock as u, ProductDetail as v, ProductFilterConfig as w, ProductImage as x, ProductListItem as y, ProductListOptions as z };

package/dist/{chunk-BORVKACK.js → chunk-VB5IJELC.js}

@@ -256,6 +256,61 @@ function toBankTransferOption(wire) {
   };
 }
 
+// src/http/forms.ts
+var PUBLIC3 = { anonymous: true, business: "required" };
+var SUBMIT = { business: "required" };
+var MERCHANT3 = { merchant: true, anonymous: true, business: "required" };
+function createFormsApi(request) {
+  return {
+    async get(slug) {
+      return toPublicForm(
+        await request("GET", `/forms/public/${path2(slug)}`, PUBLIC3)
+      );
+    },
+    async submit(slug, values) {
+      const json = { data: values };
+      await request("POST", `/forms/submit/${path2(slug)}`, { ...SUBMIT, json });
+    },
+    async listForMerchant() {
+      const rows = await request("GET", "/forms/list", {
+        ...MERCHANT3,
+        query: { is_active: true }
+      });
+      return rows.map(toFormSummary);
+    }
+  };
+}
+function path2(slug) {
+  if (!slug.trim()) throw new Error("forms: slug is required.");
+  return encodeURIComponent(slug.trim());
+}
+function toPublicForm(wire) {
+  return {
+    id: wire.id,
+    slug: wire.slug,
+    name: wire.name,
+    description: text(wire.description),
+    successMessage: text(wire.success_message),
+    fields: toFormFields(wire.field_configuration)
+  };
+}
+function toFormFields(wire) {
+  return Array.isArray(wire) ? wire.map(toFormField) : [];
+}
+function toFormSummary(wire) {
+  return { id: wire.id, name: wire.name, slug: wire.slug };
+}
+function toFormField(wire) {
+  return {
+    name: wire.name,
+    // The backend only saves the ten known types (`validation.py:4-7`).
+    type: wire.type,
+    required: wire.required,
+    label: text(wire.label) ?? wire.name.replace(/_/g, " "),
+    options: wire.options?.map((o) => ({ label: o.label, value: o.value })) ?? []
+  };
+}
+
 // src/http/cart.ts
 var SHOPPER = { business: "required", customerOrSession: "required" };
 function createCartApi(request) {
@@ -392,6 +447,7 @@ function toCartLine(wire) {
     isDigital: wire.is_digital_product,
     fulfillmentMode: text(wire.fulfillment_mode) ?? "none",
     customData: wire.custom_data ?? null,
+    customFields: toFormFields(wire.custom_field_configuration),
     // The cart serialises the SKU at depth 2, so `selected_variants` are variant rows, not ids
     // (local backend, 2026-11-01): take each row's id.
     variantIds: (sku?.selected_variants ?? []).map((variant) => variant.id)
@@ -414,13 +470,13 @@ function sum(values) {
 }
 
 // src/http/catalog.ts
-var PUBLIC3 = { business: "required", anonymous: true };
+var PUBLIC4 = { business: "required", anonymous: true };
 function createCatalogApi(request) {
   return {
     async categories(options = {}) {
       const search = options.search?.trim();
       const wire = await request("GET", "/product/category/list", {
-        ...PUBLIC3,
+        ...PUBLIC4,
         query: { search }
       });
       return wire.map(toCategoryTree);
@@ -435,21 +491,21 @@ function createCatalogApi(request) {
     async categoriesByIds(ids) {
       if (ids.length === 0) return [];
       const wire = await request("GET", "/product/category/list/filter", {
-        ...PUBLIC3,
+        ...PUBLIC4,
         query: { ids }
       });
       return wire.map(toCategory2);
     },
     async brands(options = {}) {
       const wire = await request("GET", "/product/brand/list", {
-        ...PUBLIC3,
+        ...PUBLIC4,
         query: { category_ids: options.categoryIds }
       });
       return wire.map(toBrand);
     },
     async settings() {
       return toCatalogSettings(
-        await request("GET", "/product/business/setting/get", PUBLIC3)
+        await request("GET", "/product/business/setting/get", PUBLIC4)
       );
     }
   };
@@ -491,31 +547,31 @@ function toCatalogSettings(wire) {
 }
 
 // src/http/faq.ts
-var PUBLIC4 = { business: "required", anonymous: true };
-var MERCHANT3 = { business: "required", merchant: true, anonymous: true };
+var PUBLIC5 = { business: "required", anonymous: true };
+var MERCHANT4 = { business: "required", merchant: true, anonymous: true };
 function createFaqApi(request) {
   return {
     async list() {
-      return (await request("GET", "/content/faq/list", PUBLIC4)).map(toFaq);
+      return (await request("GET", "/content/faq/list", PUBLIC5)).map(toFaq);
     },
     async create(input) {
       const json = { question: input.question, answer: input.answer };
-      return toFaq(await request("POST", "/content/faq/create", { ...MERCHANT3, json }));
+      return toFaq(await request("POST", "/content/faq/create", { ...MERCHANT4, json }));
     },
     async update(id, changes) {
       const json = {};
       if (changes.question !== void 0) json.question = changes.question;
       if (changes.answer !== void 0) json.answer = changes.answer;
       return toFaq(
-        await request("PATCH", `/content/faq/update/${id}`, { ...MERCHANT3, json })
+        await request("PATCH", `/content/faq/update/${id}`, { ...MERCHANT4, json })
       );
     },
     async move(id, direction) {
       const json = { direction };
-      await request("PATCH", `/content/faq/update/${id}`, { ...MERCHANT3, json });
+      await request("PATCH", `/content/faq/update/${id}`, { ...MERCHANT4, json });
     },
     async remove(id) {
-      await request("DELETE", `/content/faq/delete/${id}`, MERCHANT3);
+      await request("DELETE", `/content/faq/delete/${id}`, MERCHANT4);
     }
   };
 }
@@ -528,59 +584,6 @@ function toFaq(wire) {
   };
 }
 
-// src/http/forms.ts
-var PUBLIC5 = { anonymous: true, business: "required" };
-var SUBMIT = { business: "required" };
-var MERCHANT4 = { merchant: true, anonymous: true, business: "required" };
-function createFormsApi(request) {
-  return {
-    async get(slug) {
-      return toPublicForm(
-        await request("GET", `/forms/public/${path2(slug)}`, PUBLIC5)
-      );
-    },
-    async submit(slug, values) {
-      const json = { data: values };
-      await request("POST", `/forms/submit/${path2(slug)}`, { ...SUBMIT, json });
-    },
-    async listForMerchant() {
-      const rows = await request("GET", "/forms/list", {
-        ...MERCHANT4,
-        query: { is_active: true }
-      });
-      return rows.map(toFormSummary);
-    }
-  };
-}
-function path2(slug) {
-  if (!slug.trim()) throw new Error("forms: slug is required.");
-  return encodeURIComponent(slug.trim());
-}
-function toPublicForm(wire) {
-  const fields = Array.isArray(wire.field_configuration) ? wire.field_configuration : [];
-  return {
-    id: wire.id,
-    slug: wire.slug,
-    name: wire.name,
-    description: text(wire.description),
-    successMessage: text(wire.success_message),
-    fields: fields.map(toFormField)
-  };
-}
-function toFormSummary(wire) {
-  return { id: wire.id, name: wire.name, slug: wire.slug };
-}
-function toFormField(wire) {
-  return {
-    name: wire.name,
-    // The backend only saves the ten known types (`validation.py:4-7`).
-    type: wire.type,
-    required: wire.required,
-    label: text(wire.label) ?? wire.name.replace(/_/g, " "),
-    options: wire.options?.map((o) => ({ label: o.label, value: o.value })) ?? []
-  };
-}
-
 // src/http/helpdesk.ts
 var CREATE = { business: "required" };
 function createHelpdeskApi(request) {
@@ -1111,7 +1114,8 @@ function toProductDetail(wire) {
     availableForSubscription: wire.available_for_subscription ?? false,
     hasDigitalDelivery: wire.has_digital_delivery ?? false,
     fulfillmentMode: wire.fulfillment_mode ?? "none",
-    advanceAmount: amount(wire.advance_amount)
+    advanceAmount: amount(wire.advance_amount),
+    customFields: toFormFields(wire.custom_field_configuration)
   };
 }
 function toProductOverview(wire) {
@@ -2394,6 +2398,9 @@ function toOrderLine(wire) {
     taxPercent: amount(wire.tax),
     isDigital: wire.is_digital_product,
     customData: wire.custom_data,
+    customFields: toFormFields(wire.custom_field_configuration),
+    // At depth 2 the variants are rows, as in the cart: take each row's id.
+    variantIds: (wire.sku?.selected_variants ?? []).map((variant) => variant.id),
     canReplace: wire.can_replace,
     canExchange: wire.can_exchange,
     maxReplaceOrExchangeQuantity: wire.max_qty_for_replace_or_exchange
@@ -2409,7 +2416,8 @@ function toOrderAddress(wire) {
     state: text(wire.state_name),
     postalCode: text(wire.postal_code),
     country: text(wire.country),
-    type: text(wire.type)
+    type: text(wire.type),
+    contactNo: text(wire.contact_no)
   };
 }
 function toOrderPaymentEntry(wire) {
@@ -2419,7 +2427,10 @@ function toOrderPaymentEntry(wire) {
     amount: amount(wire.amount) ?? 0,
     status: wire.status,
     method: wire.payment_method?.type ?? null,
-    label: wire.payment_method_label
+    label: wire.payment_method_label,
+    // Only an unpaid online entry can be resumed: COD is collected on delivery, cash and
+    // transfers by the merchant, gift cards and reward points are spent when the order is placed.
+    pendingPayment: wire.type === "pg" && wire.status === "unpaid" ? toPendingPayment(wire) : null
   };
 }
 function toOrderDetail(wire) {
@@ -2443,6 +2454,8 @@ function toOrderDetail(wire) {
     shippingAddress: wire.shipping_address ? toOrderAddress(wire.shipping_address) : null,
     billingAddress: wire.billing_address ? toOrderAddress(wire.billing_address) : null,
     payments: (wire.payment_history ?? []).map(toOrderPaymentEntry),
+    paymentStatus: wire.payment?.status ?? null,
+    promoCode: text(wire.promo?.code),
     hasExchangeOrReplacement: wire.has_exchange_or_replacement
   };
 }
@@ -2479,6 +2492,10 @@ function toShipment(wire) {
     trackingNumber: text(info.tracking_number),
     status: info.status,
     createdAt: info.created_at,
+    trackingUrl: text(info.tracking_url),
+    method: text(info.method),
+    charge: amount(info.charge) ?? 0,
+    courierPartner: text(info.courier_partner),
     items: wire.products.map((item) => ({
       orderLineId: item.order_product,
       name: item.product_name ?? "",
@@ -2537,7 +2554,22 @@ function toReturnableItem(wire) {
     photo: text(wire.product_photo),
     unitPrice: amount(wire.price) ?? 0,
     maxQuantity: wire.max_returnable_qty,
-    unitTrackingIds: wire.unit_tracking_infos.map((unit) => unit.id)
+    unitTrackingIds: wire.unit_tracking_infos.map((unit) => unit.id),
+    trackedUnits: wire.unit_tracking_infos.map(toTrackedUnit)
+  };
+}
+function toTrackedUnit(wire) {
+  const { data } = wire;
+  const isRecord = typeof data === "object" && data !== null && !Array.isArray(data);
+  return { id: wire.id, data: isRecord ? data : null };
+}
+function toRefund(wire) {
+  return {
+    id: wire.id,
+    amount: amount(wire.amount) ?? 0,
+    type: text(wire.type),
+    status: wire.status,
+    createdAt: wire.created_at
   };
 }
 function toReturnRequest(wire) {
@@ -2546,11 +2578,21 @@ function toReturnRequest(wire) {
     status: wire.status,
     createdAt: wire.created_at,
     amount: amount(wire.final_amount) ?? 0,
+    amountInWords: text(wire.total_in_words),
+    reason: text(wire.requested_message),
+    declineMessage: text(wire.declined_message),
+    creditNoteNumber: text(wire.cn_number),
+    refunds: (wire.payment_refund_histories ?? []).map(toRefund),
     items: (wire.products ?? []).map((item) => ({
       id: item.id,
       name: item.product_name ?? "",
+      photo: text(item.product_photo),
+      unitPrice: amount(item.price) ?? 0,
       quantity: item.qty,
-      status: item.status
+      status: item.status,
+      reason: text(item.requested_message),
+      declineMessage: text(item.declined_message),
+      mediaUrl: text(item.request_media)
     }))
   };
 }
@@ -2648,19 +2690,30 @@ function toExchangeListItem(wire) {
     status: wire.status,
     createdAt: wire.created_at,
     paymentId: wire.payment_id,
-    itemCount: wire.products_count
+    itemCount: wire.products_count,
+    reason: text(wire.requested_message),
+    declineMessage: text(wire.declined_message)
   };
 }
 function toExchangeDetail(wire) {
   return {
     ...toExchangeListItem({ ...wire, products_count: wire.products.length }),
+    payments: (wire.payment_history ?? []).map(toOrderPaymentEntry),
+    refunds: (wire.payment_refund_histories ?? []).map(toRefund),
     items: wire.products.map((row) => ({
       orderLineId: row.order_product,
       name: text(row.original_sku?.product_name),
       targetSkuId: row.target_sku,
+      targetSkuName: text(row.target_sku_data?.product_name),
+      targetSkuCode: text(row.target_sku_data?.sku),
       quantity: row.qty,
+      unitPrice: amount(row.price) ?? 0,
+      originalUnitPrice: amount(row.original_price) ?? 0,
       priceDifference: amount(row.price_difference) ?? 0,
-      status: row.status
+      status: row.status,
+      reason: text(row.requested_message),
+      declineMessage: text(row.declined_message),
+      mediaUrl: text(row.request_media)
     }))
   };
 }
@@ -2887,4 +2940,4 @@ export {
   GrowupsellApiError,
   createClient
 };
-//# sourceMappingURL=chunk-BORVKACK.js.map
+//# sourceMappingURL=chunk-VB5IJELC.js.map