efficient-storefront-blocks 0.47.0 → 0.48.0

package/dist/index.d.ts

@@ -17,15 +17,27 @@ export type EditorTarget =
   | { kind: "page"; slug: string; siteId?: string; originSlug?: string }
   | { kind: "template"; id: string; pageSlug?: string };
 
-/** The standalone one-section editor's target (a section template). */
-export type SectionEditorTarget = { kind: "section"; id: string; type?: string; name?: string };
-
-/** A media item the host's picker returns. */
-export interface HostPickedMedia {
-  id: string;
-  url: string;
-  kind: "image" | "video";
-}
+// The editor's host contract IS easel's (efficient-easel/screen/lib/host), under
+// the names this package has always used: re-exported, never a second copy, so
+// a message easel adds (`publish-failed`) reaches hosts with no line here.
+import type {
+  EaselHost as EditorHost,
+  EaselHostAddress as EditorHostAddress,
+  EaselToHostMessage as EditorToHostMessage,
+  HostPickedMedia,
+  HostToEaselMessage as HostToEditorMessage,
+} from "efficient-easel/screen/lib/host";
+export type {
+  EaselHost as EditorHost,
+  EaselHostAddress as EditorHostAddress,
+  EaselMessageType as EditorMessageType,
+  EaselToHostMessage as EditorToHostMessage,
+  HostPickedMedia,
+  HostToEaselMessage as HostToEditorMessage,
+  InboundHostMessage,
+  SectionScreenTarget as SectionEditorTarget,
+  SendToHost,
+} from "efficient-easel/screen/lib/host";
 
 /** What a field asked the media panel for. `file` is a file dropped straight on
  *  the field: the host uploads it and picks it without waiting for a click. */
@@ -56,88 +68,6 @@ export interface MediaPanelProps {
  *  panel (the rail's Media view, and every image field's pick mode). */
 export type MediaPanelComponent = ComponentType<MediaPanelProps>;
 
-/** Every message the editor sends its host. */
-export type EditorToHostMessage =
-  | { type: "storefront-editor:ready" }
-  | { type: "storefront-editor:auth-expired" }
-  | { type: "storefront-editor:dirty" }
-  | { type: "storefront-editor:saved" }
-  | { type: "storefront-editor:published" }
-  | { type: "storefront-editor:save-failed" }
-  | { type: "storefront-editor:navigated"; target: EditorTarget }
-  | {
-      type: "storefront-editor:open-media-picker";
-      requestId: string;
-      accept: string;
-      title: string;
-      file?: File;
-    }
-  /** `mode: "create"` asks for a new form and carries a `requestId` to answer
-   *  with `form-saved` / `form-closed`. `mode: "edit"` opens the form builder on
-   *  `formId` and carries none: nothing waits on it. */
-  | { type: "storefront-editor:open-form"; requestId?: string; mode: "create" | "edit"; formId?: string }
-  | { type: "storefront-editor:open-category"; categoryId: string; name?: string }
-  | { type: "storefront-editor:open-product"; slug: string; name?: string }
-  | { type: "storefront-editor:open-post"; slug: string; title?: string }
-  /** Open the website's Settings (`"settings"`, e.g. Selling, where the stock
-   *  rules live) or its Shipping (`"shipping"`, the pickup places) in the host,
-   *  from a panel row that reads a rule the editor does not own. Nothing
-   *  answers it. */
-  | { type: "storefront-editor:open-site-section"; section: "settings" | "shipping" }
-  | { type: "storefront-editor:open-menus"; menuId?: string | null }
-  | { type: "storefront-editor:open-page"; slug: string }
-  | { type: "storefront-editor:new-page" }
-  | { type: "storefront-editor:save-as-template"; siteId: string; slug: string };
-
-/** Every message a host sends the editor. */
-export type HostToEditorMessage =
-  | {
-      type: "storefront-editor:auth";
-      token: string;
-      siteId?: string;
-      brandId?: string;
-      theme?: string;
-      can?: { canCreatePlatformTemplate?: boolean };
-    }
-  | { type: "storefront-editor:navigate"; target: EditorTarget | SectionEditorTarget }
-  | { type: "storefront-editor:category-updated"; categoryId?: string }
-  | { type: "storefront-editor:menus-updated" }
-  | { type: "storefront-editor:form-saved"; requestId?: string; form?: { id: string; slug: string } }
-  | { type: "storefront-editor:form-closed"; requestId?: string }
-  | { type: "storefront-editor:media-picked"; requestId: string; media: HostPickedMedia }
-  | { type: "storefront-editor:media-pick-cancelled"; requestId: string };
-
-export type EditorMessageType = EditorToHostMessage["type"];
-type PayloadOf<T extends EditorMessageType> = Omit<Extract<EditorToHostMessage, { type: T }>, "type">;
-
-export type SendToHost = <T extends EditorMessageType>(
-  type: T,
-  ...payload: Record<string, never> extends PayloadOf<T> ? [PayloadOf<T>?] : [PayloadOf<T>]
-) => void;
-
-export type InboundHostMessage = { type: string } & Record<string, unknown>;
-
-/** The editor's address — for an embedder, retargets of its own window. */
-export interface EditorHostAddress {
-  /** The query the editor was opened with. An embedder that opens templates to
-   *  edit their layout answers `"?editTemplate=1"`. */
-  search(): string;
-  /** Keep the embedder's notion of "where" in step (no load). */
-  show(target: EditorTarget | SectionEditorTarget): void;
-  /** Leave for another document by LOADING it — re-mount the editor there. */
-  load(target: EditorTarget): void;
-  /** Reload the editor from scratch — re-mount it on the same target. */
-  reload(): void;
-}
-
-export interface EditorHost {
-  readonly connected: boolean;
-  readonly ownsDocument: boolean;
-  send: SendToHost;
-  subscribe(listener: (message: InboundHostMessage) => void): () => void;
-  readonly address: EditorHostAddress;
-}
-
 /** A host for an editor mounted in the embedder's own page. One per editor. */
 export function createEditorHost(options: {
   onMessage: (message: EditorToHostMessage) => void;