@swishapp/sdk 0.52.0

package/README.md

@@ -0,0 +1,50 @@
+# Swish SDK
+
+JavaScript library for integrating Swish on a Shopify web store (themes and headless stacks).
+
+## Installation
+
+To load the Swish app, you can either activate the Swish embed through your theme editor or install it via NPM. We recommend using the app embed for most scenarios. For headless stacks, NPM is necessary.
+
+## With Swish embed
+
+Make sure to activate the Swish embed in the theme editor!
+
+```html
+<script type="module">
+  const swishApp = () =>
+    new Promise((r) => {
+      window.swish
+        ? r(window.swish)
+        : document.addEventListener("swish-ready", () => r(window.swish));
+    });
+
+  const swish = await swishApp();
+
+  const { data } = await swish.api.items.list();
+</script>
+```
+
+## Code only
+
+```ts
+import { swishApp } from "/apps/wishlist/assets/sdk/swish.js";
+
+const swish = await swishApp({
+  proxy: {
+    baseUrl: "/apps/wishlist",
+  },
+});
+
+const { data } = await swish.api.items.list();
+```
+
+# Headless stacks
+
+The Swish SDK requires a proxy service that operates on the same domain as the store. This service facilitates the loading of additional resources and ensures secure communication with the Swish API.
+
+Please use the [Node.js library](https://www.npmjs.com/package/@swishapp/node) to implement the app proxy.
+
+## Documentation
+
+For more information visit [Swish DEV docs](https://developers.swish.app/libraries/sdk).

package/dist/ajax-api/ajax-api-client.d.ts

@@ -0,0 +1,81 @@
+export interface AjaxConfig {
+    storeDomain: string;
+    fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+    responseInterceptor?: (response: Response, request: Request) => Promise<void> | void;
+}
+export interface CartLineItem {
+    id: number;
+    properties: Record<string, string> | null;
+    quantity: number;
+    variant_id: number;
+    key: string;
+    title: string;
+    price: number;
+    original_price: number;
+    discounted_price: number;
+    line_price: number;
+    original_line_price: number;
+    total_discount: number;
+    discounts: any[];
+    sku: string;
+    grams: number;
+    vendor: string;
+    taxable: boolean;
+    product_id: number;
+    gift_card: boolean;
+    final_price: number;
+    final_line_price: number;
+    url: string;
+    image: string;
+    handle: string;
+    requires_shipping: boolean;
+    product_type: string;
+    product_title: string;
+    product_description: string;
+    variant_title: string;
+    variant_options: string[];
+    line_level_discount_allocations: any[];
+}
+export interface Cart {
+    token: string;
+    note: string | null;
+    attributes: Record<string, string>;
+    original_total_price: number;
+    total_price: number;
+    total_discount: number;
+    total_weight: number;
+    item_count: number;
+    items: CartLineItem[];
+    requires_shipping: boolean;
+    currency: string;
+    items_subtotal_price: number;
+    cart_level_discount_applications: any[];
+}
+export interface AddToCartItem {
+    id: string;
+    quantity: number;
+}
+export interface AddToCartRequest {
+    items: AddToCartItem[];
+}
+export interface AddToCartResponse {
+    items: CartLineItem[];
+}
+export interface CartError {
+    message: string;
+    status: string;
+    description: string;
+}
+export declare class AjaxApiClient {
+    private config;
+    private readonly cache;
+    constructor(config: AjaxConfig);
+    patchFetch(): void;
+    private getFetchRequest;
+    private getBaseUrl;
+    fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>;
+    private request;
+    fetchCart(): Promise<Cart>;
+    addToCart(request: AddToCartRequest): Promise<AddToCartResponse>;
+    clearCache(): Promise<void>;
+}

package/dist/ajax-api/ajax-api-publisher.d.ts

@@ -0,0 +1,9 @@
+import { EventBus } from "../events/event-bus";
+import { EventName } from "../events/event-bus";
+export declare class AjaxApiPublisher {
+    private readonly eventBus;
+    private readonly eventMap;
+    constructor(eventBus: EventBus);
+    processFetchResponse(response: Response, request: Request): Promise<void>;
+    getEventName(url: string): EventName | null;
+}

package/dist/cache/fetch-cache.d.ts

@@ -0,0 +1,87 @@
+export declare enum CacheControl {
+    None = "no-cache",
+    Minimal = "max-age=3, stale-while-revalidate=0",// 3 seconds, no stale
+    Short = "max-age=60, stale-while-revalidate=3600",// 1 minute, 1 hour stale
+    Long = "max-age=3600, stale-while-revalidate=86400"
+}
+export declare class FetchCache {
+    private readonly cacheName;
+    private readonly defaultCacheControl;
+    private readonly revalidationPromises;
+    private readonly inFlightRequests;
+    private readonly keyPrefix;
+    constructor(cacheName: string, defaultCacheControl: CacheControl | string, keyPrefix?: string);
+    /**
+     * Get a cached response by key
+     */
+    get(key: string): Promise<Response | undefined>;
+    /**
+     * Set a cached response with the specified policy
+     */
+    set(key: string, response: Response, cacheControl: CacheControl | string): Promise<void>;
+    /**
+     * Set a cached response from a fetch request
+     */
+    fetchWithCache(input: string | URL | Request, init?: RequestInit, cacheControl?: CacheControl | string): Promise<Response>;
+    /**
+     * Delete a specific cache entry
+     */
+    delete(key: string): Promise<boolean>;
+    /**
+     * Clear all cache entries
+     */
+    clear(): Promise<void>;
+    /**
+     * Get all cache keys
+     */
+    keys(): Promise<string[]>;
+    /**
+     * Check if a key exists in cache
+     */
+    has(key: string): Promise<boolean>;
+    /**
+     * Get cache statistics
+     */
+    getStats(): Promise<{
+        total: number;
+    }>;
+    /**
+     * Remove all expired entries from the cache
+     */
+    cleanupExpiredEntries(): Promise<{
+        removed: number;
+        remaining: number;
+    }>;
+    /**
+     * Get the cache key from fetch args
+     */
+    getCacheKey(input: string | URL | globalThis.Request, init?: RequestInit): Promise<string>;
+    /**
+     * Get the url from the fetch input
+     */
+    getInputUrl(input: string | URL | globalThis.Request): string;
+    /**
+     * Check if a response has expired based on its Cache-Control header
+     */
+    private isExpired;
+    /**
+     * Check if a response is stale but can be revalidated
+     */
+    private isStaleButRevalidatable;
+    /**
+     * Revalidate a cached response in the background
+     */
+    private revalidateInBackground;
+    /**
+     * Parse max-age value from Cache-Control header
+     */
+    private parseMaxAge;
+    /**
+     * Parse stale-while-revalidate value from Cache-Control header
+     */
+    private parseStaleWhileRevalidate;
+    /**
+     * Create a cacheable response with appropriate headers based on policy
+     */
+    private createCacheableResponse;
+}

package/dist/dom/dom-utils.d.ts

@@ -0,0 +1,16 @@
+export declare function waitForDOM(): Promise<Node>;
+export interface CreateElementLocatorArgs {
+    onElementFound: (element: Element) => void;
+    selector: string;
+    observerOptions?: IntersectionObserverInit;
+}
+export declare function createElementLocator({ onElementFound, selector, observerOptions, }: CreateElementLocatorArgs): MutationObserver;
+export interface CreateLocationObserverArgs {
+    onLocationChange: (location: Location) => void;
+}
+export declare function createLocationObserver({ onLocationChange, }: CreateLocationObserverArgs): () => void;
+export interface CreateHrefObserverArgs {
+    element: HTMLAnchorElement;
+    onHrefChange: (href: string) => void;
+}
+export declare function createHrefObserver({ element, onHrefChange, }: CreateHrefObserverArgs): () => void;

package/dist/events/event-bus.d.ts

@@ -0,0 +1,7 @@
+export type EventName = "cart-add" | "cart-update" | "cart-change" | "cart-clear" | "item-create" | "item-update" | "item-delete" | "item-lists-update" | "list-create" | "list-update" | "list-delete";
+export declare class EventBus {
+    private readonly eventBus;
+    subscribe(type: EventName | EventName[], callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): () => void;
+    unsubscribe(type: EventName, callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): void;
+    publish(type: EventName, detail: any): void;
+}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export type * from "@swishapp/api-client";
+export type * from "./ajax-api/ajax-api-client";
+export type { EventName } from "./events/event-bus";
+export type * from "./storefront-api/storefront-api-client";
+export { SwishApp } from "./swish";
+export type { Ref, SwishUiElement } from "./swish-ui/swish-ui-element";
+export type { Notification, Notifications, UnsaveAlertSubmitData, ListSelectSubmitData, VariantSelectSubmitData, UnsaveAlertOptions, ListSelectOptions, VariantSelectOptions, } from "./swish-ui/swish-ui-utils";
+export type { ShopBridge } from "./utils/shop-bridge";

package/dist/state/index.d.ts

@@ -0,0 +1,4 @@
+export { signal, effect } from "@preact/signals-core";
+export * from "./item-context-signal";
+export * from "./item-state-signal";
+export * from "./item-count-signal";

package/dist/state/item-context-signal.d.ts

@@ -0,0 +1,11 @@
+import { SwishApp } from "../swish";
+export interface ItemContext {
+    loading: boolean;
+    productHandle?: string;
+    productId?: string;
+    variantId?: string;
+    itemId?: string;
+    skipVariantSelect?: boolean;
+    defaultVariantId?: string;
+}
+export declare const itemContextSignal: (swish: SwishApp) => (source?: HTMLElement) => import("@preact/signals-core").Signal<ItemContext>;

package/dist/state/item-count-signal.d.ts

@@ -0,0 +1,7 @@
+import { ApiError } from "@swishapp/api-client";
+import { SwishApp } from "../swish";
+export declare const itemCountSignal: (swish: SwishApp) => () => import("@preact/signals-core").ReadonlySignal<{
+    count: number;
+    loading: boolean;
+    error: ApiError | null;
+}>;

package/dist/state/item-state-signal.d.ts

@@ -0,0 +1,19 @@
+import { Signal } from "@preact/signals-core";
+import { ApiError } from "@swishapp/api-client";
+import { ItemContext } from "./item-context-signal";
+import { SwishApp } from "../swish";
+export declare const itemStateSignal: (swish: SwishApp) => (context: Signal<ItemContext>) => import("@preact/signals-core").ReadonlySignal<{
+    error: ApiError | null;
+    status: string;
+    savedItemId: string | null;
+    loading: boolean;
+    submitting: boolean;
+    saved: boolean;
+    saving: boolean;
+    unsaving: boolean;
+}> & {
+    save: () => Promise<void>;
+    unsave: () => void;
+    update: () => void;
+    toggle: () => Promise<void>;
+};

package/dist/state/swish-query-signals.d.ts

@@ -0,0 +1,21 @@
+import { ApiError, ApiResponse, PageInfo, PaginatedApiResponse } from "@swishapp/api-client";
+import { EventName } from "../events/event-bus";
+import { SwishApp } from "../swish";
+import { Signal } from "@preact/signals-core";
+export type FetchFn<TResponse, TVariables> = (variables?: TVariables) => Promise<TResponse>;
+type DataOf<T> = T extends {
+    data: infer D;
+} ? D : never;
+type AnyApiResponse = ApiResponse<any> | PaginatedApiResponse<any>;
+export declare const swishQuerySignals: (swish: SwishApp) => <TResponse extends AnyApiResponse, TVariables>(fetch: FetchFn<TResponse, TVariables>, options?: {
+    variables?: Signal<TVariables>;
+    skip?: Signal<boolean>;
+    refetch?: EventName[];
+}) => {
+    data: Signal<DataOf<TResponse> | null>;
+    pageInfo: Signal<PageInfo | null>;
+    error: Signal<ApiError | null>;
+    loading: Signal<boolean>;
+    refetching: import("@preact/signals-core").ReadonlySignal<boolean>;
+};
+export {};

package/dist/storefront-api/load-product-card-data.d.ts

@@ -0,0 +1,15 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { GetProductCardDataQuery, GetProductCardDataWithVariantQuery } from "./types/storefront.generated";
+import type { HasMetafieldsIdentifier } from "./types/storefront.types";
+export type LoadProductCardDataResponse = StorefrontApiResponse<GetProductCardDataQuery | GetProductCardDataWithVariantQuery>;
+export type { GetProductCardDataQueryVariables } from "./types/storefront.generated";
+export interface LoadProductCardDataArgs {
+    productId?: string;
+    variantId?: string;
+    productMetafields?: HasMetafieldsIdentifier[];
+    variantMetafields?: HasMetafieldsIdentifier[];
+}
+export declare const loadProductCardData: (client: StorefrontApiClient, { productId, variantId, productMetafields, variantMetafields, }: LoadProductCardDataArgs) => Promise<{
+    data: GetProductCardDataQuery | GetProductCardDataWithVariantQuery | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/load-product-detail-data.d.ts

@@ -0,0 +1,15 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { GetProductDetailDataQuery, GetProductDetailDataWithVariantQuery } from "./types/storefront.generated";
+import type { HasMetafieldsIdentifier } from "./types/storefront.types";
+export type LoadProductDetailDataResponse = StorefrontApiResponse<GetProductDetailDataQuery | GetProductDetailDataWithVariantQuery>;
+export type { GetProductDetailDataQueryVariables } from "./types/storefront.generated";
+export interface LoadProductDetailDataArgs {
+    productId?: string;
+    variantId?: string;
+    productMetafields?: HasMetafieldsIdentifier[];
+    variantMetafields?: HasMetafieldsIdentifier[];
+}
+export declare const loadProductDetailData: (client: StorefrontApiClient, { productId, variantId, productMetafields, variantMetafields, }: LoadProductDetailDataArgs) => Promise<{
+    data: GetProductDetailDataQuery | GetProductDetailDataWithVariantQuery | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/load-product-id.d.ts

@@ -0,0 +1,11 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { GetProductIdByHandleQuery } from "./types/storefront.generated";
+export type LoadProductIdResponse = StorefrontApiResponse<GetProductIdByHandleQuery>;
+export type { GetProductIdByHandleQueryVariables } from "./types/storefront.generated";
+export interface LoadProductIdArgs {
+    productHandle?: string;
+}
+export declare const loadProductId: (client: StorefrontApiClient, { productHandle }: LoadProductIdArgs) => Promise<{
+    data: GetProductIdByHandleQuery | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/load-product-images.d.ts

@@ -0,0 +1,20 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+export type LoadProductImagesResponse = StorefrontApiResponse<{
+    id: string;
+    altText: string;
+    url: string;
+}[]>;
+export type { GetProductImagesByIdQueryVariables } from "./types/storefront.generated";
+export interface LoadProductImagesArgs {
+    items: {
+        productId: number;
+        variantId?: number | null;
+    }[];
+}
+export declare const loadProductImages: (client: StorefrontApiClient, { items }: LoadProductImagesArgs) => Promise<{
+    data: (Pick<import("./types/storefront.types").Image, "id" | "altText" | "url" | "thumbhash"> | undefined)[];
+    error: null;
+} | {
+    data: null;
+    error: Error;
+}>;

package/dist/storefront-api/load-product-options.d.ts

@@ -0,0 +1,13 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { GetProductOptionsQuery, GetProductOptionsWithVariantQuery } from "./types/storefront.generated";
+export type LoadProductOptionsResponse = StorefrontApiResponse<GetProductOptionsQuery | GetProductOptionsWithVariantQuery>;
+export type { GetProductOptionsQueryVariables } from "./types/storefront.generated";
+export interface LoadProductOptionsArgs {
+    productId?: string;
+    variantId?: string;
+    productHandle?: string;
+}
+export declare const loadProductOptions: (client: StorefrontApiClient, { productId, productHandle, variantId }: LoadProductOptionsArgs) => Promise<{
+    data: GetProductOptionsQuery | GetProductOptionsWithVariantQuery | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/load-product-recommendations.d.ts

@@ -0,0 +1,17 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { HasMetafieldsIdentifier, Product, ProductRecommendationIntent } from "./types/storefront.types";
+export type LoadProductRecommendationsResponse = StorefrontApiResponse<{
+    productRecommendations?: Product[] | null;
+}>;
+export interface LoadProductRecommendationsArgs {
+    productId?: string;
+    productHandle?: string;
+    intent?: ProductRecommendationIntent;
+    productMetafields?: HasMetafieldsIdentifier[];
+}
+export declare const loadProductRecommendations: (client: StorefrontApiClient, { productId, productHandle, intent, productMetafields, }: LoadProductRecommendationsArgs) => Promise<{
+    data: {
+        productRecommendations?: Product[] | null;
+    } | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/load-selected-variant.d.ts

@@ -0,0 +1,14 @@
+import { StorefrontApiClient, StorefrontApiResponse } from "./storefront-api-client";
+import type { SelectedOptionInput } from "./types/storefront.types";
+import type { GetSelectedVariantQuery } from "./types/storefront.generated";
+export type LoadSelectedVariantResponse = StorefrontApiResponse<GetSelectedVariantQuery>;
+export type { GetSelectedVariantQueryVariables } from "./types/storefront.generated";
+export interface LoadSelectedVariantArgs {
+    productId?: string;
+    productHandle?: string;
+    selectedOptions: SelectedOptionInput[];
+}
+export declare const loadSelectedVariant: (client: StorefrontApiClient, { productId, productHandle, selectedOptions }: LoadSelectedVariantArgs) => Promise<{
+    data: GetSelectedVariantQuery | undefined;
+    errors: import("@shopify/graphql-client").ResponseErrors | null;
+}>;

package/dist/storefront-api/queries/fragments.d.ts

@@ -0,0 +1,7 @@
+export declare const PRODUCT_IMAGE_FIELDS = "\n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n";
+export declare const PRODUCT_CARD_DATA_FIELDS = "\n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n";
+export declare const PRODUCT_VARIANT_DATA_FIELDS = "\n  fragment productVariantDataFields on ProductVariant {\n    id\n    availableForSale\n    compareAtPrice {\n      amount\n      currencyCode\n    }\n    currentlyNotInStock\n    image {\n      ...productImageFields\n    }\n    price {\n      amount\n      currencyCode\n    }\n    # quantityAvailable\n    selectedOptions {\n      name\n      value\n    }\n    sku\n    title\n    metafields(identifiers: $variantMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n";
+export declare const PRODUCT_OPTIONS_VARIANT_FIELDS = "\n  fragment productOptionsVariantFields on ProductVariant {\n    id\n    selectedOptions {\n      name\n      value\n    }\n  }\n";
+export declare const SELECTED_VARIANT_FIELDS = "\n  fragment selectedVariantFields on Product {\n    id\n    title\n    handle\n    featuredImage {\n      ...productImageFields\n    }\n    variantBySelectedOptions(selectedOptions: $selectedOptions) {\n      id\n      availableForSale\n      compareAtPrice {\n        amount\n        currencyCode\n      }\n      currentlyNotInStock\n      image {\n        ...productImageFields\n      }\n      price {\n        amount\n        currencyCode\n      }\n      title\n      selectedOptions {\n        name\n        value\n      }\n    }\n  }\n";
+export declare const PRODUCT_OPTIONS_FIELDS = "\n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n";
+export declare const PRODUCT_IMAGES_FIELDS = "\n  fragment productImagesFields on Product {\n    images(first: 20) {\n      nodes {\n        ...productImageFields\n      }\n    }\n  }\n";

package/dist/storefront-api/queries/index.d.ts

@@ -0,0 +1,14 @@
+export declare const GET_PRODUCT_CARD_DATA_BY_ID = "\n  query GetProductCardData(\n    $productId: ID!\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productCardDataFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_CARD_DATA_BY_ID_WITH_VARIANT = "\n  query GetProductCardDataWithVariant(\n    $productId: ID!\n    $variantId: ID!\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $variantMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productCardDataFields\n    }\n    variant: node(id: $variantId) {\n      ...productVariantDataFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productVariantDataFields on ProductVariant {\n    id\n    availableForSale\n    compareAtPrice {\n      amount\n      currencyCode\n    }\n    currentlyNotInStock\n    image {\n      ...productImageFields\n    }\n    price {\n      amount\n      currencyCode\n    }\n    # quantityAvailable\n    selectedOptions {\n      name\n      value\n    }\n    sku\n    title\n    metafields(identifiers: $variantMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_OPTIONS_BY_ID = "\n  query GetProductOptions(\n    $productId: ID!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productOptionsFields\n    }\n  }\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_OPTIONS_BY_HANDLE = "\n  query GetProductOptionsByHandle(\n    $handle: String!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(handle: $handle) {\n      ...productOptionsFields\n    }\n  }\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_OPTIONS_BY_ID_WITH_VARIANT = "\n  query GetProductOptionsWithVariant(\n    $productId: ID!\n    $variantId: ID!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productOptionsFields\n    }\n    variant: node(id: $variantId) {\n      ...productOptionsVariantFields\n    }\n  }\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productOptionsVariantFields on ProductVariant {\n    id\n    selectedOptions {\n      name\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_OPTIONS_BY_HANDLE_WITH_VARIANT = "\n  query GetProductOptionsByHandleWithVariant(\n    $handle: String!\n    $variantId: ID!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(handle: $handle) {\n      ...productOptionsFields\n    }\n    variant: node(id: $variantId) {\n      ...productOptionsVariantFields\n    }\n  }\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productOptionsVariantFields on ProductVariant {\n    id\n    selectedOptions {\n      name\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_SELECTED_VARIANT = "\n  query GetSelectedVariant(\n    $productId: ID!\n    $selectedOptions: [SelectedOptionInput!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...selectedVariantFields\n    }\n  }\n  \n  fragment selectedVariantFields on Product {\n    id\n    title\n    handle\n    featuredImage {\n      ...productImageFields\n    }\n    variantBySelectedOptions(selectedOptions: $selectedOptions) {\n      id\n      availableForSale\n      compareAtPrice {\n        amount\n        currencyCode\n      }\n      currentlyNotInStock\n      image {\n        ...productImageFields\n      }\n      price {\n        amount\n        currencyCode\n      }\n      title\n      selectedOptions {\n        name\n        value\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_SELECTED_VARIANT_BY_HANDLE = "\n  query GetSelectedVariantByHandle(\n    $handle: String!\n    $selectedOptions: [SelectedOptionInput!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(handle: $handle) {\n      ...selectedVariantFields\n    }\n  }\n  \n  fragment selectedVariantFields on Product {\n    id\n    title\n    handle\n    featuredImage {\n      ...productImageFields\n    }\n    variantBySelectedOptions(selectedOptions: $selectedOptions) {\n      id\n      availableForSale\n      compareAtPrice {\n        amount\n        currencyCode\n      }\n      currentlyNotInStock\n      image {\n        ...productImageFields\n      }\n      price {\n        amount\n        currencyCode\n      }\n      title\n      selectedOptions {\n        name\n        value\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_DETAIL_DATA_BY_ID = "\n  query GetProductDetailData(\n    $productId: ID!\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productCardDataFields\n      ...productOptionsFields\n      ...productImagesFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productImagesFields on Product {\n    images(first: 20) {\n      nodes {\n        ...productImageFields\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_DETAIL_DATA_BY_ID_WITH_VARIANT = "\n  query GetProductDetailDataWithVariant(\n    $productId: ID!\n    $variantId: ID!\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $variantMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    product(id: $productId) {\n      ...productCardDataFields\n      ...productOptionsFields\n      ...productImagesFields\n    }\n    variant: node(id: $variantId) {\n      ...productVariantDataFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productOptionsFields on Product {\n    id\n    title\n    featuredImage {\n      ...productImageFields\n    }\n    encodedVariantAvailability\n    encodedVariantExistence\n    variantsCount {\n      count\n      precision\n    }\n    options {\n      id\n      name\n      optionValues {\n        name\n        swatch {\n          color\n          image {\n            previewImage {\n              url\n            }\n          }\n        }\n        firstSelectableVariant {\n          id\n          image {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n\n  \n  fragment productVariantDataFields on ProductVariant {\n    id\n    availableForSale\n    compareAtPrice {\n      amount\n      currencyCode\n    }\n    currentlyNotInStock\n    image {\n      ...productImageFields\n    }\n    price {\n      amount\n      currencyCode\n    }\n    # quantityAvailable\n    selectedOptions {\n      name\n      value\n    }\n    sku\n    title\n    metafields(identifiers: $variantMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productImagesFields on Product {\n    images(first: 20) {\n      nodes {\n        ...productImageFields\n      }\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_IMAGES_BY_ID = "\n  query GetProductImagesById(\n    $ids: [ID!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    nodes(ids: $ids) {\n      ... on Product {\n        featuredImage {\n          ...productImageFields\n        }\n      }\n      ... on ProductVariant {\n        image {\n          ...productImageFields\n        }\n        product {\n          featuredImage {\n            ...productImageFields\n          }\n        }\n      }\n    }\n  }\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_RECOMMENDATIONS_BY_ID = "\n  query GetProductRecommendationsById(\n    $productId: ID!\n    $intent: ProductRecommendationIntent\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    productRecommendations(productId: $productId, intent: $intent) {\n      ...productCardDataFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_RECOMMENDATIONS_BY_HANDLE = "\n  query GetProductRecommendationsByHandle(\n    $handle: String!\n    $intent: ProductRecommendationIntent\n    $productMetafields: [HasMetafieldsIdentifier!]!\n    $country: CountryCode!\n    $language: LanguageCode!\n  ) @inContext(country: $country, language: $language) {\n    productRecommendations(productHandle: $handle, intent: $intent) {\n      ...productCardDataFields\n    }\n  }\n  \n  fragment productCardDataFields on Product {\n    id\n    availableForSale\n    category {\n      id\n      name\n    }\n    compareAtPriceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    featuredImage {\n      ...productImageFields\n    }\n    isGiftCard\n    onlineStoreUrl\n    description\n    handle\n    priceRange {\n      maxVariantPrice {\n        amount\n        currencyCode\n      }\n      minVariantPrice {\n        amount\n        currencyCode\n      }\n    }\n    productType\n    tags\n    title\n    variantsCount {\n      count\n    }\n    # totalInventory\n    metafields(identifiers: $productMetafields) {\n      key\n      namespace\n      value\n    }\n  }\n\n  \n  fragment productImageFields on Image {\n    id\n    altText\n    url\n    thumbhash\n  }\n\n";
+export declare const GET_PRODUCT_ID_BY_HANDLE = "\n  query GetProductIdByHandle($handle: String!) {\n    product(handle: $handle) {\n      id\n    }\n  }\n";

package/dist/storefront-api/storefront-api-client.d.ts

@@ -0,0 +1,67 @@
+import type { ResponseErrors } from "@shopify/graphql-client";
+import { LoadProductCardDataArgs } from "./load-product-card-data";
+import { LoadProductDetailDataArgs } from "./load-product-detail-data";
+import { LoadProductImagesArgs } from "./load-product-images";
+import { LoadProductOptionsArgs } from "./load-product-options";
+import { LoadSelectedVariantArgs } from "./load-selected-variant";
+import { LoadProductRecommendationsArgs } from "./load-product-recommendations";
+import { LoadProductIdArgs } from "./load-product-id";
+export * from "./load-product-card-data";
+export * from "./load-product-options";
+export * from "./load-selected-variant";
+export * from "./types/storefront.generated";
+export * from "./load-product-recommendations";
+export interface StorefrontApiResponse<TData> {
+    data: TData;
+    errors: ResponseErrors;
+}
+export declare const API_VERSION = "2025-07";
+export interface StorefrontConfig {
+    storeDomain: string;
+    accessToken: string;
+}
+export declare class StorefrontApiClient {
+    private client;
+    private readonly shortCache;
+    private readonly longCache;
+    constructor(config: StorefrontConfig);
+    fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>;
+    query: <TData, TVariables extends Record<string, unknown>>(query: string, variables: TVariables) => Promise<{
+        data: (TData extends undefined ? any : TData) | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadProductOptions: (args: LoadProductOptionsArgs) => Promise<{
+        data: import("./storefront-api-client").GetProductOptionsQuery | import("./storefront-api-client").GetProductOptionsWithVariantQuery | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadSelectedVariant: (args: LoadSelectedVariantArgs) => Promise<{
+        data: import("./storefront-api-client").GetSelectedVariantQuery | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadProductCardData: (args: LoadProductCardDataArgs) => Promise<{
+        data: import("./storefront-api-client").GetProductCardDataQuery | import("./storefront-api-client").GetProductCardDataWithVariantQuery | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadProductDetailData: (args: LoadProductDetailDataArgs) => Promise<{
+        data: import("./storefront-api-client").GetProductDetailDataQuery | import("./storefront-api-client").GetProductDetailDataWithVariantQuery | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadProductImages: (args: LoadProductImagesArgs) => Promise<{
+        data: (Pick<import("./types/storefront.types").Image, "id" | "altText" | "url" | "thumbhash"> | undefined)[];
+        error: null;
+    } | {
+        data: null;
+        error: Error;
+    }>;
+    loadProductRecommendations: (args: LoadProductRecommendationsArgs) => Promise<{
+        data: {
+            productRecommendations?: import("./types/storefront.types").Product[] | null;
+        } | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    loadProductId: (args: LoadProductIdArgs) => Promise<{
+        data: import("./storefront-api-client").GetProductIdByHandleQuery | undefined;
+        errors: ResponseErrors | null;
+    }>;
+    clearCache(): Promise<void>;
+}