@swishapp/sdk 0.130.0 → 0.131.0

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

@@ -1,3 +1,4 @@
+import { Signal } from "@preact/signals-core";
 import { SwishApp } from "../swish";
 export interface ItemContext {
     loading: boolean;
@@ -6,4 +7,10 @@ export interface ItemContext {
     variantId?: string;
     itemId?: string;
 }
-export declare const itemContextSignal: (swish: SwishApp) => (source: HTMLElement | Location) => import("@preact/signals-core").Signal<ItemContext>;
+export interface ItemContextIds {
+    productId?: string | number | null;
+    variantId?: string | number | null;
+    itemId?: string | null;
+}
+export declare const itemContextFromIds: (ids: ItemContextIds) => Signal<ItemContext>;
+export declare const itemContextSignal: (swish: SwishApp) => (source: HTMLElement | Location) => Signal<ItemContext>;

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

@@ -1,19 +1,47 @@
 import { Signal } from "@preact/signals-core";
 import { ApiError } from "@swishapp/api-client";
-import { ItemContext } from "./item-context-signal";
+import type { EditItemListsSuccessResponse, EditItemVariantSuccessResponse, SaveItemSuccessResponse, UnsaveItemSuccessResponse } from "../intents/types";
 import { SwishApp } from "../swish";
-export declare const itemStateSignal: (swish: SwishApp) => (context: Signal<ItemContext>) => import("@preact/signals-core").ReadonlySignal<{
+import { ItemContext } from "./item-context-signal";
+export type ItemMatch = "variant" | "product" | "auto";
+export interface ItemStateCallbacks {
+    onSave?: (data: SaveItemSuccessResponse["data"]) => void;
+    onUnsave?: (data: UnsaveItemSuccessResponse["data"]) => void;
+    onListsUpdate?: (data: EditItemListsSuccessResponse["data"]) => void;
+    onVariantUpdate?: (data: EditItemVariantSuccessResponse["data"]) => void;
+}
+export interface ItemStateOptions extends ItemStateCallbacks {
+    /**
+     * How to interpret the API response when deciding `saved`:
+     * - `"variant"`: only count the item as saved if the variant matches.
+     * - `"product"`: count any saved variant of the product as saved. Also
+     *   causes `save()` to ignore `variantId` so the saved item is not pinned
+     *   to whichever variant the consumer happened to render.
+     * - `"auto"` (default): variant-match when a `variantId` is in the context,
+     *   product-match otherwise.
+     */
+    match?: ItemMatch;
+}
+export declare const itemStateSignal: (swish: SwishApp) => (context: Signal<ItemContext>, optionsInput?: ItemStateOptions) => import("@preact/signals-core").ReadonlySignal<{
     error: ApiError | null;
-    status: string;
+    status: "saving" | "saved" | "unsaved";
     savedItemId: string | null;
+    savedItemIds: string[];
     loading: boolean;
     submitting: boolean;
     saved: boolean;
     saving: boolean;
+    unsaving: boolean;
 }> & {
     save: () => Promise<void>;
     unsave: () => Promise<void>;
+    updateLists: () => Promise<void>;
+    updateVariant: () => Promise<void>;
+    /** @deprecated Use `updateLists` instead. */
     update: () => Promise<void>;
     toggle: () => Promise<void>;
+    setOptions: (next: ItemStateOptions) => void;
+    /** @deprecated Use `setOptions` instead. */
+    setCallbacks: (next: ItemStateOptions) => void;
     dispose: () => void;
 };

package/dist/swish.d.ts

@@ -61,19 +61,26 @@ declare class SwishApp {
     };
     readonly state: {
         itemContext: (source: HTMLElement | Location) => import("@preact/signals-core").Signal<import("./state").ItemContext>;
-        itemState: (context: import("@preact/signals-core").Signal<import("./state").ItemContext>) => import("@preact/signals-core").ReadonlySignal<{
+        itemContextFromIds: (ids: import("./state").ItemContextIds) => import("@preact/signals-core").Signal<import("./state").ItemContext>;
+        itemState: (context: import("@preact/signals-core").Signal<import("./state").ItemContext>, optionsInput?: import("./state").ItemStateOptions) => import("@preact/signals-core").ReadonlySignal<{
             error: import("@swishapp/api-client").ApiError | null;
-            status: string;
+            status: "saving" | "saved" | "unsaved";
             savedItemId: string | null;
+            savedItemIds: string[];
             loading: boolean;
             submitting: boolean;
             saved: boolean;
             saving: boolean;
+            unsaving: boolean;
         }> & {
             save: () => Promise<void>;
             unsave: () => Promise<void>;
+            updateLists: () => Promise<void>;
+            updateVariant: () => Promise<void>;
             update: () => Promise<void>;
             toggle: () => Promise<void>;
+            setOptions: (next: import("./state").ItemStateOptions) => void;
+            setCallbacks: (next: import("./state").ItemStateOptions) => void;
             dispose: () => void;
         };
         itemCount: () => import("@preact/signals-core").ReadonlySignal<{
@@ -107,6 +114,8 @@ export type * from "./intents/types";
 export type { SwishOptionsInput } from "./options/swish-options";
 export type * from "./options/types";
 export { getSwishQueryStorageKey } from "./query";
+export type { ItemMatch, ItemStateCallbacks, ItemStateOptions, } from "./state/item-state-signal";
+export type { ItemContext, ItemContextIds } from "./state/item-context-signal";
 export type * from "./storefront-api/storefront-api-client";
 export type { Ref, SwishUiElement } from "./swish-ui/swish-ui-element";
 export type { ListSelectOptions, ListSelectSubmitData, QuickBuyOptions, QuickBuySubmitData, Toast, ToastManager, UnsaveAlertOptions, UnsaveAlertSubmitData, VariantSelectOptions, VariantSelectSubmitData, } from "./swish-ui/types";