@swishapp/sdk 0.131.0 → 0.132.0

package/dist/options/schemas.d.ts

@@ -169,25 +169,36 @@ export declare const ListsSectionSchema: v.ObjectSchema<{
     readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
     readonly options: v.OptionalSchema<v.ObjectSchema<{
         readonly displayType: v.OptionalSchema<v.PicklistSchema<["list", "slider"], undefined>, "slider">;
-        readonly listDetailPage: v.OptionalSchema<v.ObjectSchema<{
-            readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
-            readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-            readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-            readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-        }, undefined>, {
-            readonly desktopColumns: 4;
-            readonly showBuyButton: true;
-            readonly showVariantOptionNames: false;
-            readonly enableVariantChange: true;
-        }>;
     }, undefined>, {
         readonly displayType: "slider";
-        readonly listDetailPage: {
-            readonly desktopColumns: 4;
-            readonly showBuyButton: true;
-            readonly showVariantOptionNames: false;
-            readonly enableVariantChange: true;
-        };
+    }>;
+}, undefined>;
+export declare const ListDetailPageSectionSchema: v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+    readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+    readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+    readonly options: v.OptionalSchema<v.ObjectSchema<{
+        readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
+        readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+        readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+        readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+    }, undefined>, {
+        readonly desktopColumns: 4;
+        readonly showBuyButton: true;
+        readonly showVariantOptionNames: false;
+        readonly enableVariantChange: true;
+    }>;
+}, undefined>;
+export declare const ListDetailSectionSchema: v.ObjectSchema<{
+    readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+    readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+    readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+    readonly options: v.OptionalSchema<v.ObjectSchema<{
+        readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+        readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+    }, undefined>, {
+        readonly showVariantOptionNames: false;
+        readonly enableVariantChange: false;
     }>;
 }, undefined>;
 export declare const OrdersSectionSchema: v.ObjectSchema<{
@@ -276,10 +287,6 @@ export declare const NotificationsSectionSchema: v.ObjectSchema<{
     readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
     readonly options: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, {}>;
 }, undefined>;
-export declare const FullpageListDetailSchema: v.ObjectSchema<{
-    readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-    readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-}, undefined>;
 export declare const DrawerViewSchema: v.ObjectSchema<{
     readonly sections: v.OptionalSchema<v.ArraySchema<v.VariantSchema<"type", [v.ObjectSchema<{
         readonly type: v.LiteralSchema<"drawer-header", undefined>;
@@ -602,30 +609,49 @@ export declare const ListsViewSchema: v.ObjectSchema<{
         readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
         readonly options: v.OptionalSchema<v.ObjectSchema<{
             readonly displayType: v.OptionalSchema<v.PicklistSchema<["list", "slider"], undefined>, "slider">;
-            readonly listDetailPage: v.OptionalSchema<v.ObjectSchema<{
-                readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
-                readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-                readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-                readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-            }, undefined>, {
-                readonly desktopColumns: 4;
-                readonly showBuyButton: true;
-                readonly showVariantOptionNames: false;
-                readonly enableVariantChange: true;
-            }>;
         }, undefined>, {
             readonly displayType: "slider";
-            readonly listDetailPage: {
-                readonly desktopColumns: 4;
-                readonly showBuyButton: true;
-                readonly showVariantOptionNames: false;
-                readonly enableVariantChange: true;
-            };
         }>;
     }, undefined>, undefined>, readonly [{
         readonly type: "lists-grid";
     }]>;
 }, undefined>;
+export declare const ListDetailPageViewSchema: v.ObjectSchema<{
+    readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+        readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+        readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+        readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+        readonly options: v.OptionalSchema<v.ObjectSchema<{
+            readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
+            readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+            readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+            readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+        }, undefined>, {
+            readonly desktopColumns: 4;
+            readonly showBuyButton: true;
+            readonly showVariantOptionNames: false;
+            readonly enableVariantChange: true;
+        }>;
+    }, undefined>, undefined>, readonly [{
+        readonly type: "list-items-grid";
+    }]>;
+}, undefined>;
+export declare const ListDetailViewSchema: v.ObjectSchema<{
+    readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+        readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+        readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+        readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+        readonly options: v.OptionalSchema<v.ObjectSchema<{
+            readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+            readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+        }, undefined>, {
+            readonly showVariantOptionNames: false;
+            readonly enableVariantChange: false;
+        }>;
+    }, undefined>, undefined>, readonly [{
+        readonly type: "list-items-grid";
+    }]>;
+}, undefined>;
 export declare const OrdersViewSchema: v.ObjectSchema<{
     readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
         readonly type: v.LiteralSchema<"orders-list", undefined>;
@@ -761,14 +787,6 @@ export declare const UiSchema: v.ObjectSchema<{
     }, undefined>, {
         readonly baseTint: true;
     }>;
-    readonly fullpage: v.OptionalSchema<v.ObjectSchema<{
-        readonly listDetail: v.OptionalSchema<v.ObjectSchema<{
-            readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-            readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-        }, undefined>, {}>;
-    }, undefined>, {
-        readonly listDetail: {};
-    }>;
     readonly drawer: v.OptionalSchema<v.ObjectSchema<{
         readonly sections: v.OptionalSchema<v.ArraySchema<v.VariantSchema<"type", [v.ObjectSchema<{
             readonly type: v.LiteralSchema<"drawer-header", undefined>;
@@ -1091,30 +1109,49 @@ export declare const UiSchema: v.ObjectSchema<{
             readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
             readonly options: v.OptionalSchema<v.ObjectSchema<{
                 readonly displayType: v.OptionalSchema<v.PicklistSchema<["list", "slider"], undefined>, "slider">;
-                readonly listDetailPage: v.OptionalSchema<v.ObjectSchema<{
-                    readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
-                    readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-                    readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
-                    readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
-                }, undefined>, {
-                    readonly desktopColumns: 4;
-                    readonly showBuyButton: true;
-                    readonly showVariantOptionNames: false;
-                    readonly enableVariantChange: true;
-                }>;
             }, undefined>, {
                 readonly displayType: "slider";
-                readonly listDetailPage: {
-                    readonly desktopColumns: 4;
-                    readonly showBuyButton: true;
-                    readonly showVariantOptionNames: false;
-                    readonly enableVariantChange: true;
-                };
             }>;
         }, undefined>, undefined>, readonly [{
             readonly type: "lists-grid";
         }]>;
     }, undefined>, {}>;
+    readonly listDetail: v.OptionalSchema<v.ObjectSchema<{
+        readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+            readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+            readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+            readonly options: v.OptionalSchema<v.ObjectSchema<{
+                readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+                readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+            }, undefined>, {
+                readonly showVariantOptionNames: false;
+                readonly enableVariantChange: false;
+            }>;
+        }, undefined>, undefined>, readonly [{
+            readonly type: "list-items-grid";
+        }]>;
+    }, undefined>, {}>;
+    readonly listDetailPage: v.OptionalSchema<v.ObjectSchema<{
+        readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"list-items-grid", undefined>;
+            readonly hidden: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+            readonly design: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, undefined>, {}>;
+            readonly options: v.OptionalSchema<v.ObjectSchema<{
+                readonly desktopColumns: v.OptionalSchema<v.NumberSchema<undefined>, 4>;
+                readonly showBuyButton: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+                readonly showVariantOptionNames: v.OptionalSchema<v.BooleanSchema<undefined>, false>;
+                readonly enableVariantChange: v.OptionalSchema<v.BooleanSchema<undefined>, true>;
+            }, undefined>, {
+                readonly desktopColumns: 4;
+                readonly showBuyButton: true;
+                readonly showVariantOptionNames: false;
+                readonly enableVariantChange: true;
+            }>;
+        }, undefined>, undefined>, readonly [{
+            readonly type: "list-items-grid";
+        }]>;
+    }, undefined>, {}>;
     readonly orders: v.OptionalSchema<v.ObjectSchema<{
         readonly sections: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
             readonly type: v.LiteralSchema<"orders-list", undefined>;
@@ -1238,10 +1275,13 @@ export type DrawerSectionParsed = v.InferOutput<typeof DrawerSectionSchema>;
 export type HomeSectionParsed = v.InferOutput<typeof HomeSectionSchema>;
 export type SavesSectionParsed = v.InferOutput<typeof SavesSectionSchema>;
 export type ListsSectionParsed = v.InferOutput<typeof ListsSectionSchema>;
+export type ListDetailSectionParsed = v.InferOutput<typeof ListDetailSectionSchema>;
+export type ListDetailPageSectionParsed = v.InferOutput<typeof ListDetailPageSectionSchema>;
 export type OrdersSectionParsed = v.InferOutput<typeof OrdersSectionSchema>;
 export type OrderDetailSectionParsed = v.InferOutput<typeof OrderDetailSectionSchema>;
 export type ProductDetailSectionParsed = v.InferOutput<typeof ProductDetailSectionSchema>;
 export type ProfileSectionParsed = v.InferOutput<typeof ProfileSectionSchema>;
 export type NotificationsSectionParsed = v.InferOutput<typeof NotificationsSectionSchema>;
+export type ListDetailViewParsed = v.InferOutput<typeof ListDetailViewSchema>;
+export type ListDetailPageViewParsed = v.InferOutput<typeof ListDetailPageViewSchema>;
 export type UiOptionsParsed = v.InferOutput<typeof UiSchema>;
-export type FullpageListDetailParsed = v.InferOutput<typeof FullpageListDetailSchema>;

package/dist/options/swish-options.d.ts

@@ -2,7 +2,7 @@ import type { LanguageCode as I18nLanguageCode } from "@swishapp/i18n";
 import type { PlacementSpec } from "../dom/create-placement";
 import { IntentOptions } from "../intents/intents";
 import { StorefrontApiOptions } from "../swish";
-import type { AuthOptions, DrawerSectionInput, FullpageListDetailOptions, HomeSectionInput, ListsSectionInput, MetafieldOptions, NotificationsSectionInput, OrderDetailSectionInput, OrdersSectionInput, ProductDetailSectionInput, ProfileSectionInput, SavesSectionInput, StorefrontContext, SwishOptions, TransformOptions, UiDesignOptions } from "./types";
+import type { AuthOptions, DrawerSectionInput, HomeSectionInput, ListDetailPageSectionInput, ListDetailSectionInput, ListsSectionInput, MetafieldOptions, NotificationsSectionInput, OrderDetailSectionInput, OrdersSectionInput, ProductDetailSectionInput, ProfileSectionInput, SavesSectionInput, StorefrontContext, SwishOptions, TransformOptions, UiDesignOptions } from "./types";
 export type SwishOptionsInput = {
     storefront: StorefrontApiOptions;
     context: StorefrontContext;
@@ -22,9 +22,6 @@ interface UiOptions {
     images?: {
         baseTint?: boolean;
     };
-    fullpage?: {
-        listDetail?: Partial<FullpageListDetailOptions>;
-    };
     drawer?: {
         sections?: DrawerSectionInput[];
     };
@@ -37,6 +34,12 @@ interface UiOptions {
     lists?: {
         sections?: ListsSectionInput[];
     };
+    listDetail?: {
+        sections?: ListDetailSectionInput[];
+    };
+    listDetailPage?: {
+        sections?: ListDetailPageSectionInput[];
+    };
     orders?: {
         sections?: OrdersSectionInput[];
     };

package/dist/options/types.d.ts

@@ -4,7 +4,7 @@ import { IntentOptions } from "../intents/intents";
 import { CountryCode, LanguageCode } from "../storefront-api/types/storefront.types";
 import { Intent, StorefrontApiOptions } from "../swish";
 import type { Product, ProductVariant } from "../types";
-import type { DrawerSectionParsed, FullpageListDetailParsed, HomeSectionParsed, ListsSectionParsed, NotificationsSectionParsed, OrderDetailSectionParsed, OrdersSectionParsed, ProductDetailSectionParsed, ProfileSectionParsed, SavesSectionParsed, UiOptionsParsed } from "./schemas";
+import type { DrawerSectionParsed, HomeSectionParsed, ListDetailPageSectionParsed, ListDetailSectionParsed, ListsSectionParsed, NotificationsSectionParsed, OrderDetailSectionParsed, OrdersSectionParsed, ProductDetailSectionParsed, ProfileSectionParsed, SavesSectionParsed, UiOptionsParsed } from "./schemas";
 export interface SwishOptions {
     auth: AuthOptions;
     storefront: StorefrontApiOptions;
@@ -50,17 +50,24 @@ export type Badge = {
     style?: Record<string, string | number>;
 };
 export interface TransformOptions {
-    badges?: (args: {
+    productTitle?: (args: {
+        product: Product;
+    }) => string;
+    productDescription?: (args: {
+        product: Product;
+    }) => string;
+    productBadges?: (args: {
         product: Product;
         variant?: ProductVariant;
         defaultBadges: string[];
     }) => (string | Badge)[];
-    title?: (args: {
+    productPrice?: (args: {
         product: Product;
-    }) => string;
-    description?: (args: {
+        variant?: ProductVariant;
+    }) => string | false | undefined;
+    addToCartButton?: (args: {
         product: Product;
-    }) => string;
+    }) => boolean;
     variantTitle?: (args: {
         variant: ProductVariant;
     }) => string;
@@ -68,9 +75,6 @@ export interface TransformOptions {
         option: NonNullable<Product>["options"][number];
         optionValues: NonNullable<Product>["options"][number]["optionValues"];
     }) => NonNullable<Product>["options"][number]["optionValues"];
-    addToCartButton?: (args: {
-        product: Product;
-    }) => boolean;
 }
 export type TransformOptionsResolved = Required<TransformOptions>;
 export type UiOptions = UiOptionsParsed;
@@ -181,12 +185,13 @@ export type DrawerSection = DrawerSectionParsed;
 export type HomeSection = HomeSectionParsed;
 export type SavesSection = SavesSectionParsed;
 export type ListsSection = ListsSectionParsed;
+export type ListDetailSection = ListDetailSectionParsed;
+export type ListDetailPageSection = ListDetailPageSectionParsed;
 export type OrdersSection = OrdersSectionParsed;
 export type OrderDetailSection = OrderDetailSectionParsed;
 export type ProductDetailSection = ProductDetailSectionParsed;
 export type ProfileSection = ProfileSectionParsed;
 export type NotificationsSection = NotificationsSectionParsed;
-export type FullpageListDetailOptions = FullpageListDetailParsed;
 export interface DrawerLogoInput {
     url?: string;
     altText?: string;
@@ -248,16 +253,23 @@ export type SavesSectionInput = (ViewSection<"lists-section"> & {
         showVariantOptionNames?: boolean;
     };
 });
-export interface ListDetailPageInput {
-    desktopColumns?: number;
-    showBuyButton?: boolean;
-    showVariantOptionNames?: boolean;
-    enableVariantChange?: boolean;
-}
 export type ListsSectionInput = ViewSection<"lists-grid"> & {
     options?: {
         displayType?: "list" | "slider";
-        listDetailPage?: ListDetailPageInput;
+    };
+};
+export type ListDetailPageSectionInput = ViewSection<"list-items-grid"> & {
+    options?: {
+        desktopColumns?: number;
+        showBuyButton?: boolean;
+        showVariantOptionNames?: boolean;
+        enableVariantChange?: boolean;
+    };
+};
+export type ListDetailSectionInput = ViewSection<"list-items-grid"> & {
+    options?: {
+        showVariantOptionNames?: boolean;
+        enableVariantChange?: boolean;
     };
 };
 export type OrdersSectionInput = ViewSection<"orders-list">;
@@ -300,6 +312,12 @@ export interface SavesViewOptions {
 export interface ListsViewOptions {
     sections: ListsSection[];
 }
+export interface ListDetailViewOptions {
+    sections: ListDetailSection[];
+}
+export interface ListDetailPageViewOptions {
+    sections: ListDetailPageSection[];
+}
 export interface OrdersViewOptions {
     sections: OrdersSection[];
 }
@@ -320,6 +338,8 @@ export type ViewSectionMap = {
     home: HomeSection;
     saves: SavesSection;
     lists: ListsSection;
+    listDetail: ListDetailSection;
+    listDetailPage: ListDetailPageSection;
     orders: OrdersSection;
     orderDetail: OrderDetailSection;
     productDetail: ProductDetailSection;