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

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

@@ -180,6 +180,7 @@ interface ProductBlock {
  * stored here: compute them with `discountPercent()` from `@growupsell/commerce/rules`, so
  * every app uses the same rule.
  */
+
 /** One option of a variant group, e.g. "128 GB" in "Storage". */
 interface VariantOption {
     id: number;
@@ -225,8 +226,10 @@ interface ProductListItem {
     unit: string | null;
     variantGroups: VariantGroup[];
     selectedVariantIds: number[];
+    /** The product's description (HTML), for list views; null when empty. */
+    description: string | null;
     /** `none` for stocked goods; custom modes are made to order. */
-    fulfillmentMode: string;
+    fulfillmentMode: FulfillmentMode;
     hasDigitalDelivery: boolean;
     /** Advance payment required for made-to-order products. */
     advanceAmount: number | null;
@@ -300,7 +303,7 @@ interface ProductDetail {
     policies: ProductPolicies | null;
     availableForSubscription: boolean;
     hasDigitalDelivery: boolean;
-    fulfillmentMode: string;
+    fulfillmentMode: FulfillmentMode;
     advanceAmount: number | null;
 }
 /** A product as listed by `products.list()` (home sliders, product pickers). */
@@ -308,6 +311,13 @@ interface ProductOverview {
     id: number;
     name: string;
     slug: string;
+    /** HTML, written with the editor the product detail's `descriptionFormat` names; null when empty. */
+    description: string | null;
+    /**
+     * `none` for stocked goods; custom modes are made to order and never out of stock (pass it to
+     * `purchaseLimit()` with a SKU's `stockQty` for the stock badge).
+     */
+    fulfillmentMode: FulfillmentMode;
     categoryName: string | null;
     images: ProductImage[];
     variantGroups: VariantGroup[];
@@ -316,6 +326,20 @@ interface ProductOverview {
     priceFrom: number | null;
     unit: string | null;
 }
+/**
+ * Order of `products.list()`. The backend orders this list by id only (no creation date), so
+ * `newest` is the highest id first. Without `sort` the backend's default applies: `oldest`.
+ */
+type ProductListSort = 'newest' | 'oldest' | 'name-a-z' | 'name-z-a';
+interface ProductListOptions {
+    ids?: readonly number[];
+    /** Includes sub-categories. */
+    categoryIds?: readonly number[];
+    sort?: ProductListSort;
+    /** Default 20. */
+    limit?: number;
+    offset?: number;
+}
 interface ProductFilterConfig {
     /** Price range across the business's products. */
     price: {
@@ -557,4 +581,4 @@ interface AdvanceOrder {
     payment: PendingPayment;
 }
 
-export type { AdvanceOrder as A, Brand as B, Cart as C, DeliveryChargeType as D, ProductSku as E, FulfillmentMode as F, GiftCard as G, ProductSort as H, ProductSpecificationGroup as I, PromoCode as J, ReviewEligibility as K, ReviewListItem as L, ReviewReply as M, ReviewSummary as N, Offer as O, Page as P, RewardPointSettings as Q, Review as R, SearchSuggestion as S, SpecificationScope as T, TaxDetails as U, VariantGroup as V, VariantOption as W, 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, ProductOverview as u, ProductPolicies as v, ProductSearchOptions as w, ProductSection as x, ProductSectionItem as y, ProductSectionItemTarget as z };
+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 };

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

@@ -197,8 +197,6 @@ function toBusiness(wire) {
     name: wire.name ?? null,
     description: wire.description ?? null,
     legalName: wire.legal_name ?? null,
-    gstNumber: wire.gst_number ?? null,
-    panNumber: wire.pan_number ?? null,
     isTemplate: wire.is_template ?? false,
     category: wire.category ? { id: wire.category.id, name: wire.category.name, type: wire.category.type } : null,
     legalForm: wire.legal_forms ? { id: wire.legal_forms.id, name: wire.legal_forms.name } : null,
@@ -913,6 +911,12 @@ var SORT = {
   popularity: "popularity",
   category: "category"
 };
+var LIST_ORDERING = {
+  newest: "-id",
+  oldest: "id",
+  "name-a-z": "name",
+  "name-z-a": "-name"
+};
 var PUBLIC10 = { business: "required", anonymous: true };
 function createProductsApi(request) {
   return {
@@ -954,6 +958,7 @@ function createProductsApi(request) {
           status: "available",
           ids: options.ids,
           category_ids: options.categoryIds,
+          ordering: options.sort ? LIST_ORDERING[options.sort] : void 0,
           limit,
           offset
         }
@@ -1060,7 +1065,8 @@ function toProductListItem(wire) {
     unit: text(wire.unit),
     variantGroups: (wire.variant ?? []).map(toVariantGroup),
     selectedVariantIds: wire.selected_variants,
-    fulfillmentMode: wire.fulfillment_mode,
+    description: text(wire.description),
+    fulfillmentMode: text(wire.fulfillment_mode) ?? "none",
     hasDigitalDelivery: wire.has_digital_delivery,
     advanceAmount: amount(wire.advance_amount)
   };
@@ -1113,6 +1119,8 @@ function toProductOverview(wire) {
     id: wire.id,
     name: wire.name,
     slug: wire.url_slug,
+    description: text(wire.description),
+    fulfillmentMode: wire.fulfillment_mode ?? "none",
     categoryName: text(wire.category_name),
     images: liveImages(wire.images).map(toImage),
     variantGroups: (wire.variant ?? []).map(toVariantGroup),
@@ -2879,4 +2887,4 @@ export {
   GrowupsellApiError,
   createClient
 };
-//# sourceMappingURL=chunk-AI2CWQ22.js.map
+//# sourceMappingURL=chunk-BORVKACK.js.map