@numueg/theme-sdk 0.10.1 → 0.13.0

package/dist/{entities-B8378GKp.d.mts → entities-DRKn04q0.d.mts}

@@ -1,3 +1,43 @@
+/**
+ * A merchant-defined typed field (metafield) exposed on a storefront entity.
+ * Only PUBLIC metafields reach the storefront; the value is already coerced
+ * to its declared type by the platform (string/number/boolean/date/json/url).
+ * Themes usually bind these via a dynamic source
+ * (`product.metafield:{namespace}.{key}`) rather than reading the array, but
+ * the typed array is available for direct rendering (e.g. a spec table).
+ */
+interface Metafield {
+    namespace: string;
+    key: string;
+    type: string;
+    value: unknown;
+}
+/**
+ * Blog + Article (merchant content marketing). Text fields are bilingual
+ * maps (`{en, ar}`) — resolve with the theme's `localized()` helper or
+ * `useLocalization().locale`. Only PUBLISHED content reaches the
+ * storefront; the body arrives as UN-sanitized merchant HTML — render it
+ * through `<RichText>` (never raw dangerouslySetInnerHTML).
+ */
+interface BlogSummary {
+    handle: string;
+    title: Record<string, string>;
+    description?: Record<string, string> | null;
+}
+interface ArticleSummary {
+    handle: string;
+    title: Record<string, string>;
+    excerpt?: Record<string, string> | null;
+    image_url?: string | null;
+    published_at?: string | null;
+    author?: string | null;
+    tags?: string[];
+}
+interface ArticleDetail extends ArticleSummary {
+    body?: Record<string, string> | null;
+    seo?: Record<string, unknown> | null;
+    blog?: BlogSummary | null;
+}
 /** Core store entity */
 interface Store {
     id: string;
@@ -45,6 +85,8 @@ interface Product {
      * shape is open-ended; `useProductSizeChart` narrows the size-chart slot.
      */
     attributes?: Record<string, unknown>;
+    /** Public merchant-defined typed fields. See {@link Metafield}. */
+    metafields?: Metafield[];
 }
 /**
  * Size-chart resolution mode (mirrors the merchant hub's editor).
@@ -139,6 +181,8 @@ interface Collection {
     image_url?: string;
     product_count: number;
     products?: Product[];
+    /** Public merchant-defined typed fields. See {@link Metafield}. */
+    metafields?: Metafield[];
 }
 /** Cart entity */
 interface Cart {
@@ -150,6 +194,32 @@ interface Cart {
     discount_code?: string;
     discount_amount?: number;
     note?: string;
+    /**
+     * Total of the automatic (no-code) promotions priced into this cart, in
+     * MAJOR units — same convention as `subtotal` / `total` /
+     * `discount_amount`. `normalizeCartFromServer` converts it from the
+     * backend's `automatic_discount_cents` and renames it here on purpose:
+     * a field called `_cents` that holds pounds is the single easiest way to
+     * get a 100x bug into a theme.
+     */
+    automatic_discount?: number;
+    /**
+     * Which automatic offers fired, and what each one saved — same shape as
+     * `Order.applied_promotions` so one component renders the cart, the
+     * checkout summary and the order.
+     *
+     * ⚠️ `amount` is in MAJOR units here (unlike the identically-named field
+     * on `Order`, which a theme reads straight from the API in cents). The
+     * cart passes through `normalizeCartFromServer`; the order does not.
+     * Never divide these by 100 again, and never recompute a saving in the
+     * theme — this number is the engine's, and the engine is what charges.
+     */
+    applied_promotions?: {
+        id: string;
+        title: string;
+        title_ar?: string;
+        amount: number;
+    }[];
 }
 interface CartItem {
     id: string;
@@ -160,6 +230,12 @@ interface CartItem {
     price: number;
     quantity: number;
     variant_name?: string;
+    /**
+     * The product's category. Present so a theme can count how many cart units
+     * belong to a category-scoped offer (see `offerProgress`'s `eligibleUnits`)
+     * without a second fetch. Not always populated — treat it as a hint.
+     */
+    category_id?: string | null;
 }
 /** Customer entity */
 interface Customer {
@@ -237,4 +313,4 @@ interface Page {
     template?: string;
 }
 
-export type { Address as A, Cart as C, Order as O, Page as P, SizeChart as S, CartItem as a, Collection as b, Customer as c, OrderItem as d, Product as e, ProductImage as f, ProductVariant as g, SizeChartMode as h, Store as i, ProductOption as j };
+export type { Address as A, BlogSummary as B, Cart as C, Metafield as M, Order as O, Page as P, SizeChart as S, CartItem as a, Collection as b, Customer as c, OrderItem as d, Product as e, ProductImage as f, ProductVariant as g, SizeChartMode as h, Store as i, ArticleDetail as j, ArticleSummary as k, ProductOption as l };

package/dist/{entities-B8378GKp.d.ts → entities-DRKn04q0.d.ts}

@@ -1,3 +1,43 @@
+/**
+ * A merchant-defined typed field (metafield) exposed on a storefront entity.
+ * Only PUBLIC metafields reach the storefront; the value is already coerced
+ * to its declared type by the platform (string/number/boolean/date/json/url).
+ * Themes usually bind these via a dynamic source
+ * (`product.metafield:{namespace}.{key}`) rather than reading the array, but
+ * the typed array is available for direct rendering (e.g. a spec table).
+ */
+interface Metafield {
+    namespace: string;
+    key: string;
+    type: string;
+    value: unknown;
+}
+/**
+ * Blog + Article (merchant content marketing). Text fields are bilingual
+ * maps (`{en, ar}`) — resolve with the theme's `localized()` helper or
+ * `useLocalization().locale`. Only PUBLISHED content reaches the
+ * storefront; the body arrives as UN-sanitized merchant HTML — render it
+ * through `<RichText>` (never raw dangerouslySetInnerHTML).
+ */
+interface BlogSummary {
+    handle: string;
+    title: Record<string, string>;
+    description?: Record<string, string> | null;
+}
+interface ArticleSummary {
+    handle: string;
+    title: Record<string, string>;
+    excerpt?: Record<string, string> | null;
+    image_url?: string | null;
+    published_at?: string | null;
+    author?: string | null;
+    tags?: string[];
+}
+interface ArticleDetail extends ArticleSummary {
+    body?: Record<string, string> | null;
+    seo?: Record<string, unknown> | null;
+    blog?: BlogSummary | null;
+}
 /** Core store entity */
 interface Store {
     id: string;
@@ -45,6 +85,8 @@ interface Product {
      * shape is open-ended; `useProductSizeChart` narrows the size-chart slot.
      */
     attributes?: Record<string, unknown>;
+    /** Public merchant-defined typed fields. See {@link Metafield}. */
+    metafields?: Metafield[];
 }
 /**
  * Size-chart resolution mode (mirrors the merchant hub's editor).
@@ -139,6 +181,8 @@ interface Collection {
     image_url?: string;
     product_count: number;
     products?: Product[];
+    /** Public merchant-defined typed fields. See {@link Metafield}. */
+    metafields?: Metafield[];
 }
 /** Cart entity */
 interface Cart {
@@ -150,6 +194,32 @@ interface Cart {
     discount_code?: string;
     discount_amount?: number;
     note?: string;
+    /**
+     * Total of the automatic (no-code) promotions priced into this cart, in
+     * MAJOR units — same convention as `subtotal` / `total` /
+     * `discount_amount`. `normalizeCartFromServer` converts it from the
+     * backend's `automatic_discount_cents` and renames it here on purpose:
+     * a field called `_cents` that holds pounds is the single easiest way to
+     * get a 100x bug into a theme.
+     */
+    automatic_discount?: number;
+    /**
+     * Which automatic offers fired, and what each one saved — same shape as
+     * `Order.applied_promotions` so one component renders the cart, the
+     * checkout summary and the order.
+     *
+     * ⚠️ `amount` is in MAJOR units here (unlike the identically-named field
+     * on `Order`, which a theme reads straight from the API in cents). The
+     * cart passes through `normalizeCartFromServer`; the order does not.
+     * Never divide these by 100 again, and never recompute a saving in the
+     * theme — this number is the engine's, and the engine is what charges.
+     */
+    applied_promotions?: {
+        id: string;
+        title: string;
+        title_ar?: string;
+        amount: number;
+    }[];
 }
 interface CartItem {
     id: string;
@@ -160,6 +230,12 @@ interface CartItem {
     price: number;
     quantity: number;
     variant_name?: string;
+    /**
+     * The product's category. Present so a theme can count how many cart units
+     * belong to a category-scoped offer (see `offerProgress`'s `eligibleUnits`)
+     * without a second fetch. Not always populated — treat it as a hint.
+     */
+    category_id?: string | null;
 }
 /** Customer entity */
 interface Customer {
@@ -237,4 +313,4 @@ interface Page {
     template?: string;
 }
 
-export type { Address as A, Cart as C, Order as O, Page as P, SizeChart as S, CartItem as a, Collection as b, Customer as c, OrderItem as d, Product as e, ProductImage as f, ProductVariant as g, SizeChartMode as h, Store as i, ProductOption as j };
+export type { Address as A, BlogSummary as B, Cart as C, Metafield as M, Order as O, Page as P, SizeChart as S, CartItem as a, Collection as b, Customer as c, OrderItem as d, Product as e, ProductImage as f, ProductVariant as g, SizeChartMode as h, Store as i, ArticleDetail as j, ArticleSummary as k, ProductOption as l };