@shoppexio/storefront 1.0.93 → 1.0.94

package/dist/index.d.cts

@@ -451,6 +451,12 @@ interface ProductVariant {
     /** Merchant-selected storefront highlight. It does not affect selection or availability. */
     is_featured?: boolean;
     isFeatured?: boolean;
+    /**
+     * A private option, sold only through its direct link. The server lists it
+     * only on `getProduct(id, { variant })` naming it, never in product lists.
+     * Absent on servers older than private variants.
+     */
+    is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
 }
@@ -507,6 +513,12 @@ interface PriceVariant {
     /** Merchant-selected storefront highlight. It does not affect selection or availability. */
     is_featured?: boolean;
     isFeatured?: boolean;
+    /**
+     * A private option, sold only through its direct link. The server lists it
+     * only on `getProduct(id, { variant })` naming it, never in product lists.
+     * Absent on servers older than private variants.
+     */
+    is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
 }
@@ -1538,7 +1550,14 @@ declare function getStorefrontProductsPage(options?: GetStorefrontProductsPageOp
     products: Product[];
     pagination: CursorPagination | null;
 }>>;
-declare function getProduct(idOrSlug: string): Promise<SDKResponse<Product>>;
+declare function getProduct(idOrSlug: string, options?: {
+    /**
+     * A variant id from the page URL (`?variant=<id>`). A private variant is
+     * listed only when it is named here; it then comes first in the variants,
+     * so a buy box that opens on the first sellable option preselects it.
+     */
+    variant?: string;
+}): Promise<SDKResponse<Product>>;
 declare function getCategories(): Promise<SDKResponse<string[]>>;
 
 /**

package/dist/index.d.ts

@@ -451,6 +451,12 @@ interface ProductVariant {
     /** Merchant-selected storefront highlight. It does not affect selection or availability. */
     is_featured?: boolean;
     isFeatured?: boolean;
+    /**
+     * A private option, sold only through its direct link. The server lists it
+     * only on `getProduct(id, { variant })` naming it, never in product lists.
+     * Absent on servers older than private variants.
+     */
+    is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
 }
@@ -507,6 +513,12 @@ interface PriceVariant {
     /** Merchant-selected storefront highlight. It does not affect selection or availability. */
     is_featured?: boolean;
     isFeatured?: boolean;
+    /**
+     * A private option, sold only through its direct link. The server lists it
+     * only on `getProduct(id, { variant })` naming it, never in product lists.
+     * Absent on servers older than private variants.
+     */
+    is_private?: boolean;
     /** License validity in days for this option. Zero means lifetime. */
     license_period?: number | null;
 }
@@ -1538,7 +1550,14 @@ declare function getStorefrontProductsPage(options?: GetStorefrontProductsPageOp
     products: Product[];
     pagination: CursorPagination | null;
 }>>;
-declare function getProduct(idOrSlug: string): Promise<SDKResponse<Product>>;
+declare function getProduct(idOrSlug: string, options?: {
+    /**
+     * A variant id from the page URL (`?variant=<id>`). A private variant is
+     * listed only when it is named here; it then comes first in the variants,
+     * so a buy box that opens on the first sellable option preselects it.
+     */
+    variant?: string;
+}): Promise<SDKResponse<Product>>;
 declare function getCategories(): Promise<SDKResponse<string[]>>;
 
 /**

package/dist/index.js

@@ -1244,7 +1244,8 @@ function priceVariantToProductVariant(variant) {
     cloudflare_image_id: variant.cloudflare_image_id,
     cloudflareImageId: variant.cloudflareImageId,
     image_url: variant.image_url,
-    imageUrl: variant.imageUrl
+    imageUrl: variant.imageUrl,
+    is_private: variant.is_private
   };
 }
 function normalizeProduct(product) {
@@ -1328,7 +1329,7 @@ async function getStorefrontProductsPage(options) {
   }
   return forwardFailure(response);
 }
-async function getProduct(idOrSlug) {
+async function getProduct(idOrSlug, options = {}) {
   let shopId = getShopId();
   if (!shopId) {
     const store = await getStore();
@@ -1337,13 +1338,16 @@ async function getProduct(idOrSlug) {
     }
     shopId = store.data?.id ?? null;
   }
-  const queryParams = shopId ? `?slug_shop_id=${encodeURIComponent(shopId)}` : "";
+  const query = new URLSearchParams();
+  if (shopId) query.set("slug_shop_id", shopId);
+  if (options.variant) query.set("variant", options.variant);
+  const queryParams = query.size > 0 ? `?${query.toString()}` : "";
   const response = await get(
     `${buildEndpoint("/v1/storefront/products/unique/:idOrSlug", { idOrSlug })}${queryParams}`,
     {
       buyerCurrency: true,
       cache: {
-        key: `product:${idOrSlug}:${shopId ?? "no-shop"}`,
+        key: `product:${idOrSlug}:${shopId ?? "no-shop"}:${options.variant ?? "no-variant"}`,
         ttl: PRODUCTS_CACHE_TTL,
         staleWhileRevalidate: true
       }