@samva/markup 0.16.0 → 0.17.0

package/dist/preview-rNoJBEIY.d.ts

@@ -0,0 +1,104 @@
+import { t as BrandPlugin } from "./brand-plugin-Dj9SMpfS.js";
+import { r as JsxSourceLocation } from "./source-locations-C8wCsiAy.js";
+import { v as CompiledTemplate } from "./compiled-template-Bc4Dq9zy.js";
+//#region src/preview.d.ts
+/**
+ * The attribute a preview stamps so a click in a rendered document resolves to exactly one
+ * rendered element. A delivered message never carries it.
+ */
+declare const INSTANCE_PATH_ATTRIBUTE = "data-samva-instance";
+/** Where one element sits in the emitted document, with the authoring that produced it. */
+interface EmittedPosition {
+  readonly start: number;
+  readonly end: number;
+  readonly origins: ReadonlyArray<JsxSourceLocation>;
+  /**
+   * Dot-separated element indices from the document root, assigned in document order. It is the
+   * identity of one rendered instance.
+   */
+  readonly instancePath: string;
+  readonly tag: string;
+  /** False when a compiler primitive generated this element. */
+  readonly authored: boolean;
+}
+/** One rendered element, and the authoring it came from. */
+interface EmailElementSelection {
+  /**
+   * Dot-separated element indices from the document root. It is the identity of one rendered
+   * instance, which is what tells two iterations of the same authored element apart: their
+   * origins are identical.
+   */
+  readonly instancePath: string;
+  readonly tag: string;
+  /**
+   * The authored JSX element. Empty when the compiler generated this element with no authoring
+   * behind it, the hidden preheader block for instance.
+   */
+  readonly origins: ReadonlyArray<JsxSourceLocation>;
+  /**
+   * False when a compiler primitive generated this element. `origins[0]` is then the authoring
+   * element that asked for it rather than this element itself, so the wrapper selects the
+   * primitive the author wrote.
+   */
+  readonly authored: boolean;
+  /** 1-based position among the rendered elements sharing this origin and tag. */
+  readonly occurrence: number;
+  /**
+   * How many rendered elements share that origin and tag. Above one, one piece of authoring
+   * produced several rendered elements (a loop, or a primitive that generates a repeated cell),
+   * so an edit there changes all of them.
+   */
+  readonly occurrences: number;
+  /** Absent for the document root. */
+  readonly parentPath?: string;
+  /** Offset range in the rendered HTML this selection was taken from. */
+  readonly start: number;
+  readonly end: number;
+}
+/** A render of one fixture for an editor: the delivered content plus the identity of every element. */
+interface EmailPreview {
+  readonly subject: string;
+  readonly preheader: string | undefined;
+  /** Carries `INSTANCE_PATH_ATTRIBUTE` on every element. Preview-only. */
+  readonly html: string;
+  readonly text: string;
+  /** Every rendered element in document order. */
+  readonly selections: readonly EmailElementSelection[];
+}
+/**
+ * Turn one render's positions into selections, in document order. `occurrence` and `occurrences`
+ * count the rendered elements that share an authored origin and tag.
+ */
+declare const emailSelections: (positions: readonly EmittedPosition[]) => readonly EmailElementSelection[];
+/**
+ * Render one fixture with an instance path stamped on every element, and the selection each path
+ * resolves to. The selections come from the spans the compiler recorded, so a click on the canvas
+ * lands on the exact node of the source that produced it.
+ */
+declare const previewEmail: (template: CompiledTemplate, input: unknown, options?: {
+  readonly locale?: string | undefined;
+  readonly timeZone?: string | undefined;
+  readonly brandPlugin?: BrandPlugin | undefined;
+}) => EmailPreview;
+/** Look selections up by the instance path a rendered document carries. */
+declare const emailSelectionIndex: (selections: readonly EmailElementSelection[]) => ReadonlyMap<string, EmailElementSelection>;
+/**
+ * The authoring element a selection edits. For an authored element that is the element itself; for
+ * a generated wrapper it is the primitive that asked for it. Undefined only where the compiler
+ * generated markup with no authoring behind it, which nothing can edit in place.
+ */
+declare const emailAuthoringTarget: (selection: EmailElementSelection) => JsxSourceLocation | undefined;
+/** Root-first ancestry of a selection, itself last. */
+declare const emailSelectionAncestry: (index: ReadonlyMap<string, EmailElementSelection>, instancePath: string) => readonly EmailElementSelection[];
+/**
+ * Every rendered instance produced by the same authored element, in document order. One entry
+ * means it rendered once; several mean it repeated.
+ */
+declare const emailSelectionSiblings: (selections: readonly EmailElementSelection[], selection: EmailElementSelection) => readonly EmailElementSelection[];
+/**
+ * Every rendered instance of the same authored element. A partial edited at its definition changes
+ * all of these, which is the scope a control has to name before it applies.
+ */
+declare const emailDefinitionInstances: (selections: readonly EmailElementSelection[], selection: EmailElementSelection) => readonly EmailElementSelection[];
+//#endregion
+export { emailAuthoringTarget as a, emailSelectionIndex as c, previewEmail as d, INSTANCE_PATH_ATTRIBUTE as i, emailSelectionSiblings as l, EmailPreview as n, emailDefinitionInstances as o, EmittedPosition as r, emailSelectionAncestry as s, EmailElementSelection as t, emailSelections as u };