@samva/markup 0.9.0 → 0.10.0

package/dist/ir-aaqNE987.d.ts

@@ -1,252 +0,0 @@
-//#region src/ir.d.ts
-/** The IR version this package writes. A publication pins the version it was built with. */
-declare const SML_IR_VERSION = 1;
-/**
- * Where a node came from: `[line, column]` in the entry file, or `[line, column, file]` with an
- * index into `TemplateIr.sources` when the node came from an imported project file. Published
- * sends strip these.
- */
-type IrSource = readonly [line: number, column: number, file?: number];
-/**
- * A value read at render time.
- *
- * - a string, number, boolean or `null` is a literal;
- * - `bind` reads the input: `"order.id"` is a path from the input root, `"$item.title"` a path
- *   from the enclosing `each` variable named `item` (the `$` prefix keeps loop variables from
- *   colliding with input fields);
- * - `lit` is a literal object or array, for formatter options;
- * - `concat` joins the text of its parts (a template string);
- * - `format` calls one formatter from `@samva/markup/fmt`;
- * - `if` selects between two values (a conditional attribute or class);
- * - `op` is arithmetic, allowed inside formatter arguments and conditions;
- * - `length` is `.length` of a bound array or string;
- * - `count` is `.filter(...).length`: the items of an array that satisfy a condition.
- */
-type IrValue = string | number | boolean | null | {
-  readonly bind: string;
-} | {
-  readonly lit: unknown;
-} | {
-  readonly concat: readonly IrValue[];
-} | {
-  readonly format: IrFormatter;
-  readonly args: readonly IrValue[];
-} | {
-  readonly if: IrPredicate;
-  readonly then: IrValue;
-  readonly else: IrValue;
-} | {
-  readonly op: IrArithmetic;
-  readonly args: readonly [IrValue, IrValue];
-} | {
-  readonly length: IrValue;
-} |
-/** How many items of a bound array satisfy `where`, with each item bound as `$as` while it runs. */
-{
-  readonly count: IrValue;
-  readonly as: string;
-  readonly where: IrPredicate;
-};
-type IrFormatter = "money" | "number" | "date" | "time" | "plural" | "list";
-type IrArithmetic = "+" | "-" | "*" | "/" | "%";
-type IrComparison = "eq" | "ne" | "lt" | "gt" | "le" | "ge";
-/** A condition over the input. Truthiness follows JavaScript: `""`, `0`, `null` and absent are false. */
-type IrPredicate =
-/** The bound value at this path is truthy. */
-{
-  readonly present: string;
-} |
-/** Any value is truthy. */
-{
-  readonly truthy: IrValue;
-} | {
-  readonly not: IrPredicate;
-} | {
-  readonly and: readonly IrPredicate[];
-} | {
-  readonly or: readonly IrPredicate[];
-} | {
-  readonly cmp: IrComparison;
-  readonly args: readonly [IrValue, IrValue];
-};
-/**
- * An element's inline style. A string is fully static and was checked at compile time; a list
- * carries declarations whose values are read at render time; `if` selects between two styles.
- */
-type IrStyle = string | readonly (readonly [property: string, value: IrValue])[] | {
-  readonly if: IrPredicate;
-  readonly then: IrStyle;
-  readonly else: IrStyle;
-};
-/** A part of compatibility markup the primitives emit verbatim. */
-type IrRawPart = string | {
-  readonly attr: IrValue;
-} | {
-  readonly text: IrValue;
-};
-interface IrElement {
-  readonly el: string;
-  readonly attrs?: Readonly<Record<string, IrValue>>;
-  readonly style?: IrStyle;
-  readonly children?: readonly IrNode[];
-  /**
-   * Set by the compiler on the elements `BrandFooter` writes: only they may carry the reserved
-   * footer markers, so an element the author wrote cannot claim a footer the send path would
-   * then not append.
-   */
-  readonly reserved?: true;
-  readonly src?: IrSource;
-}
-/** Content that appears when the predicate holds, or else `else`. */
-interface IrIf {
-  readonly if: IrPredicate;
-  readonly then: readonly IrNode[];
-  readonly else?: readonly IrNode[];
-  readonly src?: IrSource;
-}
-/**
- * Repeat `children` for each item of a bound array.
- *
- * `where` skips the items that fail a condition (`.filter(...)`), with the item bound as `$as`.
- * `chunk` groups the items into consecutive slices of that size instead: the loop variable `$as`
- * then holds one slice, an array, and the last slice may be shorter. Filtering applies first.
- */
-interface IrEach {
-  readonly each: IrValue;
-  /** The loop variable, referenced as `$as.field`. */
-  readonly as: string;
-  /** The zero-based index variable, referenced as `$index`. */
-  readonly index?: string;
-  readonly where?: IrPredicate;
-  readonly chunk?: number;
-  readonly children: readonly IrNode[];
-  readonly src?: IrSource;
-}
-/**
- * Compatibility markup the email primitives emit verbatim (conditional comments, VML). Bound
- * parts are escaped for the context they sit in. `text` is what the plain-text part reads.
- */
-interface IrRaw {
-  readonly raw: readonly IrRawPart[];
-  readonly text?: IrValue;
-  readonly src?: IrSource;
-}
-/** Where the hidden inbox-preview block goes; it renders the channel's `preheader`. */
-interface IrPreheader {
-  readonly preheader: true;
-}
-/** A node in an email body. A bare value in child position is rendered as escaped text. */
-type IrNode = IrValue | IrElement | IrIf | IrEach | IrRaw | IrPreheader;
-interface IrEmail {
-  readonly subject: IrValue;
-  readonly preheader?: IrValue;
-  readonly body: IrNode;
-}
-/** A plain-text channel body: text pieces, conditionals and loops. */
-interface IrSms {
-  readonly category?: string;
-  readonly body: readonly IrNode[];
-}
-type IrWhatsAppButton = {
-  readonly type: "quick-reply";
-  readonly text: IrValue;
-} | {
-  readonly type: "url";
-  readonly text: IrValue;
-  readonly url: IrValue;
-} | {
-  readonly type: "phone";
-  readonly text: IrValue;
-  readonly phone: IrValue;
-} | {
-  readonly type: "copy-code";
-  readonly code: IrValue;
-};
-/** A button, or buttons that appear when a condition over the input holds. */
-type IrWhatsAppButtonNode = IrWhatsAppButton | {
-  readonly if: IrPredicate;
-  readonly then: readonly IrWhatsAppButtonNode[];
-  readonly else?: readonly IrWhatsAppButtonNode[];
-  readonly src?: IrSource;
-};
-interface IrWhatsApp {
-  readonly name?: string;
-  readonly category: string;
-  readonly language: string;
-  /** For a media header, `content` is the media URL. */
-  readonly header?: {
-    readonly type: "text" | "image" | "video" | "document";
-    readonly content: readonly IrNode[];
-  };
-  readonly body: readonly IrNode[];
-  readonly footer?: readonly IrNode[];
-  readonly buttons?: readonly IrWhatsAppButtonNode[];
-}
-interface TemplateIr {
-  readonly sml: typeof SML_IR_VERSION;
-  readonly template: string;
-  readonly locale?: string;
-  /** Project paths that `IrSource` file indexes name; index 0 is the entry. */
-  readonly sources?: readonly string[];
-  readonly email?: IrEmail;
-  readonly sms?: IrSms;
-  readonly whatsapp?: IrWhatsApp;
-  /** The portable JSON Schema every send's input is validated against. */
-  readonly schema: Readonly<Record<string, unknown>>;
-}
-/** How the renderer resolves formatters that take no explicit locale or time zone. */
-interface RenderOptions {
-  /** Overrides the template's `locale`. */
-  readonly locale?: string;
-  /** IANA time zone; defaults to UTC. */
-  readonly timeZone?: string;
-  /** Also return where each element landed in the HTML, for mapping findings back to source. */
-  readonly positions?: boolean;
-}
-/** One rendered element's offset range in the HTML, and the source it was lowered from. */
-interface RenderedPosition {
-  readonly start: number;
-  readonly end: number;
-  readonly tag: string;
-  readonly src?: IrSource;
-}
-interface RenderedIrEmail {
-  readonly subject: string;
-  readonly preheader: string | undefined;
-  readonly html: string;
-  readonly text: string;
-  /** Present when the render asked for `positions`. */
-  readonly positions?: readonly RenderedPosition[];
-}
-type RenderedWhatsAppButton = {
-  readonly type: "quick-reply";
-  readonly text: string;
-} | {
-  readonly type: "url";
-  readonly text: string;
-  readonly url: string;
-} | {
-  readonly type: "phone";
-  readonly text: string;
-  readonly phone: string;
-} | {
-  readonly type: "copy-code";
-  readonly code: string;
-};
-/** A WhatsApp message with every text rendered and every conditional button resolved. */
-interface RenderedIrWhatsApp {
-  readonly name?: string;
-  readonly language: string;
-  readonly category: string;
-  /** For a media header, `text` is the media URL. */
-  readonly header?: {
-    readonly type: "text" | "image" | "video" | "document";
-    readonly text: string;
-  };
-  readonly body: string;
-  readonly footer?: string;
-  readonly buttons: readonly RenderedWhatsAppButton[];
-}
-//#endregion
-export { RenderedPosition as C, TemplateIr as E, RenderedIrWhatsApp as S, SML_IR_VERSION as T, IrWhatsApp as _, IrEmail as a, RenderOptions as b, IrNode as c, IrRaw as d, IrRawPart as f, IrValue as g, IrStyle as h, IrElement as i, IrPredicate as l, IrSource as m, IrComparison as n, IrFormatter as o, IrSms as p, IrEach as r, IrIf as s, IrArithmetic as t, IrPreheader as u, IrWhatsAppButton as v, RenderedWhatsAppButton as w, RenderedIrEmail as x, IrWhatsAppButtonNode as y };
-//# sourceMappingURL=ir-aaqNE987.d.ts.map

package/dist/ir.d.ts

@@ -1,2 +0,0 @@
-import { C as RenderedPosition, E as TemplateIr, S as RenderedIrWhatsApp, T as SML_IR_VERSION, _ as IrWhatsApp, a as IrEmail, b as RenderOptions, c as IrNode, d as IrRaw, f as IrRawPart, g as IrValue, h as IrStyle, i as IrElement, l as IrPredicate, m as IrSource, n as IrComparison, o as IrFormatter, p as IrSms, r as IrEach, s as IrIf, t as IrArithmetic, u as IrPreheader, v as IrWhatsAppButton, w as RenderedWhatsAppButton, x as RenderedIrEmail, y as IrWhatsAppButtonNode } from "./ir-aaqNE987.js";
-export { IrArithmetic, IrComparison, IrEach, IrElement, IrEmail, IrFormatter, IrIf, IrNode, IrPredicate, IrPreheader, IrRaw, IrRawPart, IrSms, IrSource, IrStyle, IrValue, IrWhatsApp, IrWhatsAppButton, IrWhatsAppButtonNode, RenderOptions, RenderedIrEmail, RenderedIrWhatsApp, RenderedPosition, RenderedWhatsAppButton, SML_IR_VERSION, TemplateIr };

package/dist/ir.js

@@ -1,7 +0,0 @@
-//#region src/ir.ts
-/** The IR version this package writes. A publication pins the version it was built with. */
-const SML_IR_VERSION = 1;
-//#endregion
-export { SML_IR_VERSION };
-
-//# sourceMappingURL=ir.js.map

package/dist/preview-Ekdg1dXG.d.ts

@@ -1,100 +0,0 @@
-import { r as JsxSourceLocation } from "./source-locations-C8wCsiAy.js";
-import { E as TemplateIr, b as RenderOptions } from "./ir-aaqNE987.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 IrPreview {
-  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 renderIrPreview: (ir: TemplateIr, input: unknown, options?: Omit<RenderOptions, "positions">) => IrPreview;
-/** 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, renderIrPreview as d, IrPreview as i, emailSelectionSiblings as l, EmittedPosition as n, emailDefinitionInstances as o, INSTANCE_PATH_ATTRIBUTE as r, emailSelectionAncestry as s, EmailElementSelection as t, emailSelections as u };
-//# sourceMappingURL=preview-Ekdg1dXG.d.ts.map

package/dist/preview.d.ts

@@ -1,2 +0,0 @@
-import { a as emailAuthoringTarget, c as emailSelectionIndex, d as renderIrPreview, i as IrPreview, l as emailSelectionSiblings, n as EmittedPosition, o as emailDefinitionInstances, r as INSTANCE_PATH_ATTRIBUTE, s as emailSelectionAncestry, t as EmailElementSelection, u as emailSelections } from "./preview-Ekdg1dXG.js";
-export { EmailElementSelection, EmittedPosition, INSTANCE_PATH_ATTRIBUTE, IrPreview, emailAuthoringTarget, emailDefinitionInstances, emailSelectionAncestry, emailSelectionIndex, emailSelectionSiblings, emailSelections, renderIrPreview };

package/dist/preview.js

@@ -1,160 +0,0 @@
-import { renderIr } from "./render-ir.js";
-//#region src/preview.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.
-*/
-const INSTANCE_PATH_ATTRIBUTE = "data-samva-instance";
-const locationKey = (origin) => `${origin.fileName}:${origin.lineNumber}:${origin.columnNumber}`;
-const originKey = (selection) => `${selection.tag}\u0000${selection.origins.map(locationKey).join("\0")}`;
-const parentOf = (instancePath) => {
-	const cut = instancePath.lastIndexOf(".");
-	return cut === -1 ? void 0 : instancePath.slice(0, cut);
-};
-/**
-* Turn one render's positions into selections, in document order. `occurrence` and `occurrences`
-* count the rendered elements that share an authored origin and tag.
-*/
-const emailSelections = (positions) => {
-	const counts = /* @__PURE__ */ new Map();
-	for (const position of positions) {
-		const key = originKey(position);
-		counts.set(key, (counts.get(key) ?? 0) + 1);
-	}
-	const seen = /* @__PURE__ */ new Map();
-	return [...positions].toSorted((left, right) => left.start === right.start ? right.end - left.end : left.start - right.start).map((position) => {
-		const key = originKey(position);
-		const occurrence = (seen.get(key) ?? 0) + 1;
-		seen.set(key, occurrence);
-		const parentPath = parentOf(position.instancePath);
-		return {
-			instancePath: position.instancePath,
-			tag: position.tag,
-			origins: position.origins,
-			authored: position.authored,
-			occurrence,
-			occurrences: counts.get(key) ?? 1,
-			...parentPath === void 0 ? {} : { parentPath },
-			start: position.start,
-			end: position.end
-		};
-	});
-};
-/**
-* 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.
-*/
-const renderIrPreview = (ir, input, options = {}) => {
-	const rendered = renderIr(ir, input, {
-		...options,
-		positions: true
-	});
-	const sources = ir.sources ?? [];
-	const ordered = (rendered.positions ?? []).map((position) => {
-		const src = position.src;
-		const origins = src === void 0 ? [] : [{
-			fileName: sources[src[2] ?? 0] ?? "",
-			lineNumber: src[0],
-			columnNumber: src[1]
-		}];
-		return {
-			start: position.start,
-			end: position.end,
-			tag: position.tag,
-			src: src === void 0 ? void 0 : src.join(":"),
-			origins,
-			path: "",
-			parent: void 0
-		};
-	}).toSorted((left, right) => left.start === right.start ? right.end - left.end : left.start - right.start);
-	const open = [];
-	const childCount = /* @__PURE__ */ new Map();
-	for (const element of ordered) {
-		while (open.length > 0 && open[open.length - 1].end <= element.start) open.pop();
-		const parent = open[open.length - 1];
-		const index = childCount.get(parent) ?? 0;
-		childCount.set(parent, index + 1);
-		element.parent = parent;
-		element.path = parent === void 0 ? String(index) : `${parent.path}.${index}`;
-		open.push(element);
-	}
-	const inserts = ordered.map((element) => ({
-		at: element.start + 1 + element.tag.length,
-		text: ` ${INSTANCE_PATH_ATTRIBUTE}="${element.path}"`
-	}));
-	inserts.sort((left, right) => left.at - right.at);
-	let html = "";
-	let cursor = 0;
-	for (const insert of inserts) {
-		html += rendered.html.slice(cursor, insert.at) + insert.text;
-		cursor = insert.at;
-	}
-	html += rendered.html.slice(cursor);
-	const shift = (offset) => {
-		let moved = 0;
-		for (const insert of inserts) {
-			if (insert.at > offset) break;
-			moved += insert.text.length;
-		}
-		return offset + moved;
-	};
-	const positions = ordered.map((element) => ({
-		start: shift(element.start),
-		end: shift(element.end),
-		origins: element.origins,
-		instancePath: element.path,
-		tag: element.tag,
-		authored: element.src !== void 0 && (element.parent === void 0 || element.parent.src !== element.src)
-	}));
-	const selections = emailSelections(positions);
-	return {
-		subject: rendered.subject,
-		preheader: rendered.preheader,
-		html,
-		text: rendered.text,
-		selections
-	};
-};
-/** Look selections up by the instance path a rendered document carries. */
-const emailSelectionIndex = (selections) => new Map(selections.map((selection) => [selection.instancePath, selection]));
-/**
-* 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.
-*/
-const emailAuthoringTarget = (selection) => selection.origins[0];
-/** Root-first ancestry of a selection, itself last. */
-const emailSelectionAncestry = (index, instancePath) => {
-	const chain = [];
-	let current = index.get(instancePath);
-	while (current !== void 0) {
-		chain.unshift(current);
-		current = current.parentPath === void 0 ? void 0 : index.get(current.parentPath);
-	}
-	return chain;
-};
-/**
-* Every rendered instance produced by the same authored element, in document order. One entry
-* means it rendered once; several mean it repeated.
-*/
-const emailSelectionSiblings = (selections, selection) => {
-	const key = originKey(selection);
-	return selections.filter((candidate) => originKey(candidate) === key);
-};
-/**
-* 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.
-*/
-const emailDefinitionInstances = (selections, selection) => {
-	const authoring = selection.origins[0];
-	const key = `${selection.tag}\u0000${authoring === void 0 ? "" : locationKey(authoring)}`;
-	return selections.filter((candidate) => {
-		const origin = candidate.origins[0];
-		return `${candidate.tag}\u0000${origin === void 0 ? "" : locationKey(origin)}` === key;
-	});
-};
-//#endregion
-export { INSTANCE_PATH_ATTRIBUTE, emailAuthoringTarget, emailDefinitionInstances, emailSelectionAncestry, emailSelectionIndex, emailSelectionSiblings, emailSelections, renderIrPreview };
-
-//# sourceMappingURL=preview.js.map

package/dist/render-ir.d.ts

@@ -1,19 +0,0 @@
-import { E as TemplateIr, S as RenderedIrWhatsApp, b as RenderOptions, x as RenderedIrEmail } from "./ir-aaqNE987.js";
-//#region src/render-ir.d.ts
-interface IrRenderDiagnostic {
-  readonly code: string;
-  readonly message: string;
-}
-declare class IrRenderError extends Error {
-  readonly diagnostics: readonly IrRenderDiagnostic[];
-  constructor(diagnostics: readonly IrRenderDiagnostic[]);
-}
-/** Render the email channel of a compiled template against one validated input. */
-declare const renderIr: (ir: TemplateIr, input: unknown, options?: RenderOptions) => RenderedIrEmail;
-/** Render the SMS channel of a compiled template to plain text. */
-declare const renderIrSms: (ir: TemplateIr, input: unknown, options?: RenderOptions) => string;
-/** Render the WhatsApp channel of a compiled template: every text rendered, conditional buttons resolved. */
-declare const renderIrWhatsApp: (ir: TemplateIr, input: unknown, options?: RenderOptions) => RenderedIrWhatsApp;
-//#endregion
-export { IrRenderDiagnostic, IrRenderError, renderIr, renderIrSms, renderIrWhatsApp };
-//# sourceMappingURL=render-ir.d.ts.map