@commerce-blocks/sdk 1.3.0 → 2.0.0-alpha.1

package/dist/index.d.ts

@@ -28,7 +28,7 @@ export declare interface ApiError {
 
 declare type ApiErrorCode = 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'RATE_LIMITED' | 'SERVICE_UNAVAILABLE' | 'GRAPHQL_ERROR' | 'PARSE_ERROR' | 'UNKNOWN';
 
-declare type ApiSource = 'layers' | 'shopify';
+declare type ApiSource = 'layers' | 'storefront';
 
 export declare interface AutocompleteController {
     execute: (query: string) => void;
@@ -52,14 +52,8 @@ declare interface BaseProduct {
     description: string;
     availableForSale: boolean;
     images: Image_2[];
-    priceRange: {
-        min: Price;
-        max: Price;
-    };
-    compareAtPriceRange?: {
-        min: Price;
-        max: Price;
-    };
+    priceRange: PriceRange;
+    compareAtPriceRange?: PriceRange;
     options: RichProductOption[];
     tags: string[];
     variants: ProductVariant[];
@@ -67,9 +61,19 @@ declare interface BaseProduct {
     metafields: Record<string, Record<string, unknown>> | unknown[];
     calculated?: Record<string, unknown>;
     isGiftCard: boolean;
-    onlineStoreUrl: string | null;
-    /** @deprecated Use variant `inventoryLevels` for location-specific inventory */
-    totalInventory: number;
+    category: ProductCategory | null;
+    createdAt: string | null;
+    publishedAt: string | null;
+    updatedAt: string | null;
+    featuredMedia: FeaturedMedia | null;
+    namedTags?: NamedTag[];
+    combinedListingParentProductId: number | null;
+    combinedListingRole: string | null;
+    hasVariantsThatRequireComponents: boolean;
+    originalOptions: Record<string, string[]>;
+    selectedVariant: ProductVariant | null;
+    breakoutOptions?: ProductOption[];
+    breakoutVariantId?: number;
 }
 
 declare type BaseResult<P extends Product = Product> = QueryResult<P>;
@@ -115,6 +119,7 @@ export declare type BlocksExtender<P extends Product = Product> = (result: Block
 
 declare interface BlocksInfo {
     id: string;
+    label: string;
     title: string;
     anchor_type: 'product' | 'collection' | 'cart' | 'none';
     strategy_type: 'interaction' | 'similar_products' | 'manual';
@@ -184,7 +189,7 @@ export declare interface CollectionOptions {
 }
 
 export declare interface CollectionResult<P extends Product = Product> extends BaseResult<P> {
-    collection?: ShopifyCollection;
+    collection?: StorefrontCollection;
 }
 
 declare type Collections = Record<string, Omit<CollectionMeta, 'handle'>>;
@@ -207,6 +212,14 @@ export declare interface ConfigError {
 
 declare type ConfigErrorCode = 'MISSING_CONFIG' | 'INVALID_CONFIG';
 
+export declare function createProductCard({ product, selectedOptions: initialSelectedOptions, breakoutOptions: initialBreakoutOptions, }: CreateProductCardParams): ProductCardController;
+
+export declare interface CreateProductCardParams {
+    product: Product | ExtendedProduct;
+    selectedOptions?: ProductOption[];
+    breakoutOptions?: ProductOption[];
+}
+
 export declare function createSdk<P extends Product = Product>(config: SdkConfig<P>): Result<Sdk<P>, ConfigError>;
 
 declare type CustomFetch = (url: string, init?: RequestInit) => Promise<Response>;
@@ -235,7 +248,24 @@ export declare function eq(property: string, value: FilterValue): FilterExpressi
 
 export declare function exists(property: string): FilterExpression;
 
+declare interface ExtendedProduct extends BaseProduct {
+    _base: BaseProduct;
+}
+
+declare interface Facet {
+    name: string;
+    code: string;
+}
+
 declare interface FeaturedMedia {
+    mediaContentType: string | null;
+    url: string;
+    alt: string;
+    width: number;
+    height: number;
+}
+
+declare interface FeaturedMedia_2 {
     mediaContentType?: string;
     alt: string;
     src: string;
@@ -250,7 +280,7 @@ declare interface FileSystem_2 {
 }
 export { FileSystem_2 as FileSystem }
 
-export declare function filter(expression: FilterExpression | FilterGroup): FilterGroupParam;
+export declare function filter(expression: FilterExpression | FilterGroup): FilterGroup;
 
 declare enum FilterConditional {
     And = "AND",
@@ -268,10 +298,6 @@ export declare interface FilterGroup {
     expressions: (FilterExpression | FilterGroup)[];
 }
 
-declare interface FilterGroupParam {
-    filter_group: FilterGroup;
-}
-
 export declare type FilterMap = Record<string, FilterMapEntry>;
 
 export declare type FilterMapEntry = string | {
@@ -344,6 +370,8 @@ declare interface Image_2 {
     alt: string;
     width: number;
     height: number;
+    position: number;
+    variantIds: number[];
 }
 export { Image_2 as Image }
 
@@ -382,7 +410,7 @@ export declare function jsonFileAdapter(filePath: string, fs: FileSystem_2): Sto
 
 declare interface LayersClientConfig extends LayersFetchConfig {
     sorts: Sort[];
-    facets: string[];
+    facets: Facet[];
     attributes?: string[];
 }
 
@@ -406,7 +434,9 @@ declare interface LayersMeta {
         group: 'control' | 'variation';
     }[];
     appliedRules?: string[];
-    variantBreakouts?: Record<string, string | number>[];
+    variantBreakouts?: {
+        optionCode: string;
+    }[];
 }
 
 declare interface LayersPagination {
@@ -416,15 +446,15 @@ declare interface LayersPagination {
     resultsPerPage?: number;
 }
 
-declare type LayersProduct = ProductResult;
-
 declare interface LayersResponse extends LayersPagination, LayersFacets {
-    results: (ProductResult | VariantResult_2)[];
+    results: (ProductResult | VariantResult)[];
     attributionToken?: string;
     _meta?: LayersMeta;
     _workflow?: unknown;
 }
 
+declare type LayersResult = ProductResult | VariantResult;
+
 declare interface LayersTuning {
     textualWeight?: number;
     visualWeight?: number;
@@ -448,7 +478,7 @@ declare interface LayersVariant {
         };
     }[];
     position: number;
-    featured_media?: FeaturedMedia | null;
+    featured_media?: FeaturedMedia_2 | null;
     created_at?: string;
     updated_at?: string;
     requires_selling_plan?: boolean;
@@ -500,6 +530,11 @@ declare interface MoneyResult {
     currencyCode: string;
 }
 
+declare interface NamedTag {
+    name: string;
+    value: string | number | boolean | string[];
+}
+
 export declare interface NetworkError {
     readonly _tag: 'NetworkError';
     readonly code: NetworkErrorCode;
@@ -519,6 +554,8 @@ export declare function notExists(property: string): FilterExpression;
 
 export declare function notIn(property: string, values: FilterValue[]): FilterExpression;
 
+declare type OptionAvailabilityStatus = 'available' | 'backorderable' | 'sold-out' | 'unavailable';
+
 declare type OptionSegment = `${string}:${string}`;
 
 declare interface OptionV2 {
@@ -553,14 +590,10 @@ declare interface PageMeta {
     lastFetched: number;
 }
 
-export declare type ParamDefinition<T = unknown> = (input: ParamInput) => T | undefined | null;
+export declare type ParamDefinition = (key: string) => unknown | undefined | null;
 
 export declare type ParamDefinitions = Record<string, ParamDefinition>;
 
-export declare interface ParamInput {
-    key: string;
-}
-
 declare interface PredictiveSearchResponse {
     matchedQueries: {
         query_text: string;
@@ -591,6 +624,11 @@ export declare interface Price {
     formatted: string;
 }
 
+export declare interface PriceRange {
+    min: Price;
+    max: Price;
+}
+
 declare interface PriceRangeResult {
     minVariantPrice: MoneyResult;
     maxVariantPrice: MoneyResult;
@@ -598,7 +636,40 @@ declare interface PriceRangeResult {
 
 export declare type Product = BaseProduct;
 
+export declare interface ProductCardController {
+    product: Product;
+    variants: ReadonlySignal<ProductVariant[]>;
+    selectedVariant: ReadonlySignal<ProductVariant | null>;
+    selectedOptions: ReadonlySignal<ProductOption[]>;
+    options: ReadonlySignal<RichProductOption[]>;
+    optionNames: ReadonlySignal<string[]>;
+    swatchOptionName: ReadonlySignal<string | null>;
+    images: ReadonlySignal<Image_2[]>;
+    allImages: ReadonlySignal<Image_2[]>;
+    carouselIndex: ReadonlySignal<number>;
+    isSelectionComplete: ReadonlySignal<boolean>;
+    selectOption(name: string, value: string): void;
+    setSelectedOptions(options: ProductOption[]): void;
+    setBreakoutOptions(options: ProductOption[]): void;
+    getOptionValues(name: string): string[];
+    getSwatches(name: string): Swatch[];
+    getVariantByOptions(options: ProductOption[]): ProductVariant | null;
+    getCarouselIndexForVariant(variant: ProductVariant): number;
+    isOptionAvailable(name: string, value: string): boolean;
+    isVariantAvailable(variant: ProductVariant): boolean;
+    getOptionAvailabilityStatus(name: string, value: string): OptionAvailabilityStatus;
+    dispose(): void;
+}
+
 declare interface ProductCategory {
+    id: string;
+    name: string;
+    fullName: string;
+    isLeaf: boolean;
+    isRoot: boolean;
+}
+
+declare interface ProductCategory_2 {
     id: string;
     name: string;
     full_name: string;
@@ -610,8 +681,8 @@ declare type ProductExtender<P extends Product = Product> = (input: ProductExten
 
 declare interface ProductExtenderInput {
     base: Product;
-    raw: LayersProduct;
-    shopify: ShopifyProduct | null;
+    raw: LayersResult;
+    storefront: StorefrontProduct | null;
 }
 
 declare type ProductGID = ShopifyGID<'Product'>;
@@ -653,9 +724,9 @@ declare interface ProductResult {
     images?: ProductImage[];
     metafields?: Record<string, Record<string, unknown>> | unknown[];
     calculated?: Record<string, unknown> | unknown[];
-    category?: ProductCategory | null;
+    category?: ProductCategory_2 | null;
     first_or_matched_variant?: MatchedVariant;
-    featured_media?: FeaturedMedia | null;
+    featured_media?: FeaturedMedia_2 | null;
     available?: boolean;
     price_range?: {
         from: number;
@@ -678,20 +749,18 @@ export declare interface ProductVariant {
     title: string;
     availableForSale: boolean;
     currentlyNotInStock: boolean;
-    /** @deprecated Use `inventoryLevels` for location-specific inventory */
-    quantityAvailable: number;
     sku: string | null;
-    barcode: string | null;
-    weight: number | null;
-    weightUnit: 'KILOGRAMS' | 'GRAMS' | 'POUNDS' | 'OUNCES' | null;
-    requiresShipping: boolean;
+    position: number;
     price: Price;
     compareAtPrice: Price | null;
     image: Image_2 | null;
     selectedOptions: ProductOption[];
     metafields: Metafield[];
     inventoryLevels: InventoryLevels;
+    inventoryPolicy: 'DENY' | 'CONTINUE' | null;
     inStockLocationIds: number[];
+    requiresSellingPlan: boolean;
+    hasSellingPlan: boolean;
 }
 
 declare type Queries<P extends Product = Product> = Record<string, QueryResult<P>>;
@@ -707,6 +776,7 @@ declare interface QueryResult<P extends Product = Product> {
         min: number;
         max: number;
     }>;
+    priceRange?: PriceRange;
     attributionToken?: string;
     _meta?: LayersMeta;
     _workflow?: unknown;
@@ -839,63 +909,8 @@ declare interface SeoResult {
     description: string | null;
 }
 
-declare interface ShopifyCollection {
-    id: string;
-    handle: string;
-    title: string;
-    description: string;
-    descriptionHtml: string;
-    image: ImageResult | null;
-    seo: SeoResult;
-    updatedAt: string;
-    metafields?: (MetafieldResult | null)[];
-    products?: {
-        filters: FilterResult[];
-    };
-}
-
 declare type ShopifyGID<T extends ShopifyType> = `gid://shopify/${T}/${number}`;
 
-declare interface ShopifyPage {
-    id: string;
-    handle: string;
-    title: string;
-    body: string;
-    bodySummary: string;
-    seo: SeoResult;
-    createdAt: string;
-    updatedAt: string;
-    onlineStoreUrl: string | null;
-    metafields?: (MetafieldResult | null)[];
-}
-
-declare interface ShopifyProduct {
-    id: string;
-    title: string;
-    handle: string;
-    description: string;
-    descriptionHtml: string;
-    vendor: string;
-    productType: string;
-    tags: string[];
-    availableForSale: boolean;
-    isGiftCard: boolean;
-    totalInventory: number;
-    onlineStoreUrl: string | null;
-    featuredImage: ImageResult | null;
-    images: {
-        nodes: ImageResult[];
-    };
-    priceRange: PriceRangeResult;
-    compareAtPriceRange: PriceRangeResult;
-    options: ProductOptionResult[];
-    variants: {
-        nodes: VariantResult[];
-    };
-    selectedOrFirstAvailableVariant: VariantResult | null;
-    metafields?: (MetafieldResult | null)[];
-}
-
 declare type ShopifyType = 'Product' | 'ProductVariant' | 'Collection';
 
 export { Signal }
@@ -903,10 +918,14 @@ export { Signal }
 export { signal }
 
 declare interface Sort {
-    label: string;
+    name: string;
     code: string;
+    scope?: SortScope[];
+    order?: number;
 }
 
+declare type SortScope = 'search' | 'collection';
+
 export declare interface StorageAdapter {
     read(): string | null;
     write(data: string): void;
@@ -957,6 +976,59 @@ declare interface StorefrontClientConfig {
     fetch?: CustomFetch;
 }
 
+declare interface StorefrontCollection {
+    id: string;
+    handle: string;
+    title: string;
+    description: string;
+    descriptionHtml: string;
+    image: ImageResult | null;
+    seo: SeoResult;
+    updatedAt: string;
+    metafields?: (MetafieldResult | null)[];
+    products?: {
+        filters: FilterResult[];
+    };
+}
+
+declare interface StorefrontPage {
+    id: string;
+    handle: string;
+    title: string;
+    body: string;
+    bodySummary: string;
+    seo: SeoResult;
+    createdAt: string;
+    updatedAt: string;
+    onlineStoreUrl: string | null;
+    metafields?: (MetafieldResult | null)[];
+}
+
+declare interface StorefrontProduct {
+    id: string;
+    title: string;
+    handle: string;
+    description: string;
+    descriptionHtml: string;
+    vendor: string;
+    productType: string;
+    tags: string[];
+    availableForSale: boolean;
+    isGiftCard: boolean;
+    featuredImage: ImageResult | null;
+    images: {
+        nodes: ImageResult[];
+    };
+    priceRange: PriceRangeResult;
+    compareAtPriceRange: PriceRangeResult;
+    options: ProductOptionResult[];
+    variants: {
+        nodes: VariantResult_2[];
+    };
+    selectedOrFirstAvailableVariant: VariantResult_2 | null;
+    metafields?: (MetafieldResult | null)[];
+}
+
 export declare interface StorefrontQuery {
     ids: string[];
     meta?: {
@@ -985,8 +1057,8 @@ export declare interface StorefrontQuery {
 
 export declare interface StorefrontResult<P extends Product = Product> {
     products: P[];
-    collection?: ShopifyCollection;
-    page?: ShopifyPage;
+    collection?: StorefrontCollection;
+    page?: StorefrontPage;
 }
 
 export declare interface StoreOptions {
@@ -1064,17 +1136,18 @@ declare interface VariantMetafield {
     compare_digest: string;
 }
 
-declare interface VariantResult {
+declare interface VariantResult extends Omit<ProductResult, '__typename'> {
+    __typename: 'Variant';
+    product_id: number;
+    variant_id: number;
+}
+
+declare interface VariantResult_2 {
     id: string;
     title: string;
     availableForSale: boolean;
     currentlyNotInStock: boolean;
-    quantityAvailable: number;
     sku: string | null;
-    barcode: string | null;
-    weight: number | null;
-    weightUnit: 'KILOGRAMS' | 'GRAMS' | 'POUNDS' | 'OUNCES' | null;
-    requiresShipping: boolean;
     price: MoneyResult;
     compareAtPrice: MoneyResult | null;
     selectedOptions: SelectedOptionResult[];
@@ -1082,10 +1155,4 @@ declare interface VariantResult {
     metafields?: (MetafieldResult | null)[];
 }
 
-declare interface VariantResult_2 extends Omit<ProductResult, '__typename'> {
-    __typename: 'Variant';
-    product_id: number;
-    variant_id: number;
-}
-
 export { }