@bluepic/embed 0.6.5 → 0.6.6

package/dist/components/BxSelect.vue.d.ts

@@ -48,6 +48,8 @@ declare const _default: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>
          * field-level selects where the input-chrome is needed.
          */
         bordered?: boolean;
+        /** Extra classes for the popover (e.g. `flush-content-x` for an edge-to-edge `render-options` layout). */
+        popoverClasses?: string[];
         /** Accessible name for the default trigger. */
         ariaLabel?: string;
         /** Id of a visible label element; takes precedence over `ariaLabel`. */
@@ -66,6 +68,9 @@ declare const _default: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>
         suffix?: () => VNode[] | VNode;
         'render-options'?: (scope: {
             options: BxSelectOption<T>[];
+            isActive: (option: BxSelectOption<T>) => boolean;
+            select: (option: BxSelectOption<T>) => void;
+            close: () => void;
         }) => VNode[];
         'render-option-label'?: (scope: {
             option: BxSelectOption<T>;

package/dist/components/TemplateEditor/BxTemplateEditor.vue.d.ts

@@ -7,6 +7,7 @@ import 'swiper/css';
 import 'swiper/css/navigation';
 import 'swiper/css/pagination';
 import 'swiper/css/scrollbar';
+import type { EditorCanvas } from '../../util/canvases';
 import type { ExportAnalyticsSink } from '../../util/analytics';
 import { nextTick } from 'vue';
 type __VLS_Props = {
@@ -45,6 +46,15 @@ type __VLS_Props = {
      * byte-identical to before multi-canvas existed.
      */
     canvasId?: string;
+    /**
+     * True multi-format templates (canvases v2): EVERY canvas of the template,
+     * in position order, `canvasId` among them. With >= 2 the editor shows a
+     * format switcher next to Export (emitting `switch-canvas` — the host
+     * navigates and re-mounts with the same `data`) and the export popup offers
+     * the other formats for the same export. Omit for single-format templates
+     * and legacy name-collision groups (distinct templates — never switchable).
+     */
+    canvases?: EditorCanvas[];
     campaignId?: number;
     name: string;
     /**
@@ -3066,12 +3076,14 @@ declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {
     }) => any;
     back: () => any;
     "update:batchRows": (args_0: BatchRow[]) => any;
+    "switch-canvas": (canvasId: string, snapshotUrl: string | undefined) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
     "onUpdate:data"?: ((args_0: {
         [k: string]: unknown;
     }) => any) | undefined;
     onBack?: (() => any) | undefined;
     "onUpdate:batchRows"?: ((args_0: BatchRow[]) => any) | undefined;
+    "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
 }>, {
     zoomAndPan: boolean;
     editMode: "single" | "batch" | "all";

package/dist/components/TemplateEditor/CanvasFormatList.vue.d.ts

@@ -0,0 +1,20 @@
+import { type EditorCanvas } from '../../util/canvases';
+type __VLS_Props = {
+    canvases: EditorCanvas[];
+    modelValue: string;
+    snapshots: Record<string, string>;
+    snapshotFailed?: Record<string, boolean>;
+    /** Long side of the preview box. */
+    boxSize?: number;
+    /** Move focus to the active option on mount (keyboard users land on it). */
+    autofocus?: boolean;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    select: (canvasId: string) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSelect?: ((canvasId: string) => any) | undefined;
+}>, {
+    boxSize: number;
+    autofocus: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/TemplateEditor/CanvasSiblings.vue.d.ts

@@ -0,0 +1,52 @@
+import type { Template } from '@bluepic/types';
+import BxLiveTemplate from './BxLiveTemplate.vue';
+import type { AssetProxyConfig } from '../../util/assetProxy';
+import type { EditorCanvas } from '../../util/canvases';
+type LiveTemplate = InstanceType<typeof BxLiveTemplate>;
+type __VLS_Props = {
+    /** Scope of the page-wide snapshot cache (see util/canvasSnapshots). */
+    templateId: string;
+    canvases: EditorCanvas[];
+    activeCanvasId?: string;
+    data: {
+        [k: string]: unknown;
+    };
+    watermark: boolean;
+    /**
+     * The editor's own live template (the ACTIVE canvas). Snapshotted alongside
+     * the siblings so a picker shows every format with the same freshness.
+     */
+    activeLive?: LiveTemplate;
+    bxCoreVersion?: string;
+    cloudflarePagesHostname?: string;
+    assetProxy?: AssetProxyConfig;
+};
+/** Mount the sibling sandboxes (idempotent). */
+declare function activate(): void;
+/**
+ * The live renderer + serial of a sibling, once its sandbox is ready. Rejects
+ * on timeout / load error — the export pipeline then renders that canvas on
+ * the server instead (it addresses it by canvasId).
+ */
+declare function renderer(id: string): Promise<{
+    live: LiveTemplate;
+    serial: Template.Serial;
+}>;
+/**
+ * Register a viewer of `snapshots` (switcher open, export popup open). Returns
+ * the release function. Snapshots only refresh while at least one is held.
+ */
+declare function demand(): () => void;
+/** The current snapshot of a format (the switch hands it to the host as stand-in). */
+declare function snapshotUrl(id: string): string | undefined;
+declare const _default: import("vue").DefineComponent<__VLS_Props, {
+    activate: typeof activate;
+    demand: typeof demand;
+    renderer: typeof renderer;
+    snapshots: Record<string, string>;
+    snapshotFailed: Record<string, boolean>;
+    serials: import("vue").ShallowReactive<Record<string, Template.Serial>>;
+    serialErrors: Record<string, string>;
+    snapshotUrl: typeof snapshotUrl;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/TemplateEditor/CanvasSwitcher.vue.d.ts

@@ -0,0 +1,21 @@
+import { type EditorCanvas } from '../../util/canvases';
+type __VLS_Props = {
+    canvases: EditorCanvas[];
+    modelValue: string;
+    /** canvasId → live snapshot URL (CanvasSiblings.snapshots). */
+    snapshots: Record<string, string>;
+    /** canvasId → the live snapshot failed; the stand-in is final (no shimmer). */
+    snapshotFailed?: Record<string, boolean>;
+    /** Called while the formats are shown; returns the release function. */
+    demand?: () => () => void;
+    /** Phone layout: icon button + bottom sheet instead of select + popover. */
+    mobile?: boolean;
+    /** Long side of the preview box. */
+    previewSize?: number;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (canvasId: string) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:modelValue"?: ((canvasId: string) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/TemplateEditor/ExportPopoup.vue.d.ts

@@ -1,6 +1,7 @@
 import { FieldsBridge, Studio } from '@bluepic/types';
 import { z } from '@hono/zod-openapi';
 import { ExportAnalytics } from '../../util/analytics';
+import type { MultiCanvasExport } from '../../util/multiCanvasExport';
 type __VLS_Props = {
     templateId: string;
     campaignId: number;
@@ -29,6 +30,31 @@ type __VLS_Props = {
      * No-op when absent or when the export shouldn't bill.
      */
     consumeCredit?: () => Promise<void>;
+    /**
+     * The canvas `assets` were rendered from (its size drives the preview box;
+     * `segments` split it into several files). Absent = sized from the files.
+     */
+    primaryCanvas?: {
+        id: string;
+        width: number;
+        height: number;
+        segments?: {
+            x: number;
+            y: number;
+        };
+    };
+    /**
+     * True multi-format templates: every format of this export press, with the
+     * selection. When present, outputs deliver the ticked formats (and bill each)
+     * instead of just `assets`.
+     */
+    multiCanvas?: MultiCanvasExport;
+    /** canvasId → live snapshot of that format with the current data. */
+    snapshots?: Record<string, string>;
+    /** canvasId → its live snapshot failed; the server stand-in is final. */
+    snapshotFailed?: Record<string, boolean>;
+    /** Keeps `snapshots` fresh while the popup is open; returns the release. */
+    demandSnapshots?: () => () => void;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
     mediaType: "image" | "video";

package/dist/components/TemplateEditor/PreviewStrip.vue.d.ts

@@ -0,0 +1,12 @@
+declare var __VLS_5: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_5) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/embed/embed.d.ts

@@ -32,6 +32,7 @@ export declare class BluepicEmbed extends EventTarget {
             readonly env: "prod" | "dev";
             readonly templateId: string;
             readonly canvasId?: string | undefined;
+            readonly canvases?: import("../main").EditorCanvas[] | undefined;
             readonly campaignId?: number | undefined;
             readonly name: string;
             readonly captions?: {
@@ -75,6 +76,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any) | undefined;
             readonly onBack?: (() => any) | undefined;
             readonly "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+            readonly "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
         } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
         $attrs: {
             [x: string]: unknown;
@@ -90,7 +92,7 @@ export declare class BluepicEmbed extends EventTarget {
         $host: Element | null;
         $emit: ((event: "update:data", args_0: {
             [k: string]: unknown;
-        }) => void) & ((event: "back") => void) & ((event: "update:batchRows", args_0: import("../util/batch/useBatchRows").BatchRow[]) => void);
+        }) => void) & ((event: "back") => void) & ((event: "update:batchRows", args_0: import("../util/batch/useBatchRows").BatchRow[]) => void) & ((event: "switch-canvas", canvasId: string, snapshotUrl: string | undefined) => void);
         $el: any;
         $options: import("vue").ComponentOptionsBase<Readonly<{
             bxCoreVersion?: string;
@@ -112,6 +114,7 @@ export declare class BluepicEmbed extends EventTarget {
             env: "prod" | "dev";
             templateId: string;
             canvasId?: string;
+            canvases?: import("../main").EditorCanvas[];
             campaignId?: number;
             name: string;
             captions?: {
@@ -156,6 +159,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any) | undefined;
             onBack?: (() => any) | undefined;
             "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+            "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
         }>, {
             templateViewRef: Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<{
                 bxCoreVersion?: string;
@@ -3082,6 +3086,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any;
             back: () => any;
             "update:batchRows": (args_0: import("../util/batch/useBatchRows").BatchRow[]) => any;
+            "switch-canvas": (canvasId: string, snapshotUrl: string | undefined) => any;
         }, string, {
             zoomAndPan: boolean;
             editMode: "single" | "batch" | "all";
@@ -3156,6 +3161,7 @@ export declare class BluepicEmbed extends EventTarget {
         env: "prod" | "dev";
         templateId: string;
         canvasId?: string;
+        canvases?: import("../main").EditorCanvas[];
         campaignId?: number;
         name: string;
         captions?: {
@@ -3200,6 +3206,7 @@ export declare class BluepicEmbed extends EventTarget {
         }) => any) | undefined;
         onBack?: (() => any) | undefined;
         "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+        "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
     }>, "templateViewRef" | ("zoomAndPan" | "editMode" | "videoBatchMaxSize" | "preCacheLocalRendering" | "liveViewOffsetDesktop" | "liveViewOffsetMobile")> & import("vue").ShallowUnwrapRef<{
         templateViewRef: Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<{
             bxCoreVersion?: string;
@@ -6150,6 +6157,7 @@ export declare class BluepicEmbed extends EventTarget {
             readonly env: "prod" | "dev";
             readonly templateId: string;
             readonly canvasId?: string | undefined;
+            readonly canvases?: import("../main").EditorCanvas[] | undefined;
             readonly campaignId?: number | undefined;
             readonly name: string;
             readonly captions?: {
@@ -6193,6 +6201,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any) | undefined;
             readonly onBack?: (() => any) | undefined;
             readonly "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+            readonly "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
         } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
         $attrs: {
             [x: string]: unknown;
@@ -6208,7 +6217,7 @@ export declare class BluepicEmbed extends EventTarget {
         $host: Element | null;
         $emit: ((event: "update:data", args_0: {
             [k: string]: unknown;
-        }) => void) & ((event: "back") => void) & ((event: "update:batchRows", args_0: import("../util/batch/useBatchRows").BatchRow[]) => void);
+        }) => void) & ((event: "back") => void) & ((event: "update:batchRows", args_0: import("../util/batch/useBatchRows").BatchRow[]) => void) & ((event: "switch-canvas", canvasId: string, snapshotUrl: string | undefined) => void);
         $el: any;
         $options: import("vue").ComponentOptionsBase<Readonly<{
             bxCoreVersion?: string;
@@ -6230,6 +6239,7 @@ export declare class BluepicEmbed extends EventTarget {
             env: "prod" | "dev";
             templateId: string;
             canvasId?: string;
+            canvases?: import("../main").EditorCanvas[];
             campaignId?: number;
             name: string;
             captions?: {
@@ -6274,6 +6284,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any) | undefined;
             onBack?: (() => any) | undefined;
             "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+            "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
         }>, {
             templateViewRef: Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<{
                 bxCoreVersion?: string;
@@ -9200,6 +9211,7 @@ export declare class BluepicEmbed extends EventTarget {
             }) => any;
             back: () => any;
             "update:batchRows": (args_0: import("../util/batch/useBatchRows").BatchRow[]) => any;
+            "switch-canvas": (canvasId: string, snapshotUrl: string | undefined) => any;
         }, string, {
             zoomAndPan: boolean;
             editMode: "single" | "batch" | "all";
@@ -9274,6 +9286,7 @@ export declare class BluepicEmbed extends EventTarget {
         env: "prod" | "dev";
         templateId: string;
         canvasId?: string;
+        canvases?: import("../main").EditorCanvas[];
         campaignId?: number;
         name: string;
         captions?: {
@@ -9318,6 +9331,7 @@ export declare class BluepicEmbed extends EventTarget {
         }) => any) | undefined;
         onBack?: (() => any) | undefined;
         "onUpdate:batchRows"?: ((args_0: import("../util/batch/useBatchRows").BatchRow[]) => any) | undefined;
+        "onSwitch-canvas"?: ((canvasId: string, snapshotUrl: string | undefined) => any) | undefined;
     }>, "templateViewRef" | ("zoomAndPan" | "editMode" | "videoBatchMaxSize" | "preCacheLocalRendering" | "liveViewOffsetDesktop" | "liveViewOffsetMobile")> & import("vue").ShallowUnwrapRef<{
         templateViewRef: Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<{
             bxCoreVersion?: string;