@talqui-oss/template-builder 0.0.0-stage → 0.1.0-beta.0

package/dist/index.d.cts

@@ -0,0 +1,315 @@
+import { T as Template, H as HttpRequest, A as Adapter, V as Variables, C as Category, S as StandardTemplate } from './types-CRH48UOs.cjs';
+export { a as AuthenticationTemplate, B as Button, b as CarouselCard, c as CatalogButton, d as CopyCodeButton, F as FlowButton, e as Header, L as LimitedTimeOffer, f as LocationHeader, M as MediaHeader, g as MultiProductButton, O as OrderDetailsButton, h as OtpButton, P as PaymentRequestButton, i as PhoneNumberButton, j as ProductHeader, Q as QuickReplyButton, k as SingleProductButton, l as SupportedApp, m as TextHeader, U as UnsupportedByProviderError, n as UrlButton, o as Variable, p as VoiceCallButton, q as defineAdapter } from './types-CRH48UOs.cjs';
+
+/** Every issue `validate` can report, with its default severity. Codes are stable across releases. */
+declare const codes: {
+    readonly SCHEMA_INVALID: "error";
+    readonly NAME_INVALID: "error";
+    readonly NAME_TOO_LONG: "error";
+    readonly LANGUAGE_INVALID: "error";
+    readonly CATEGORY_MISMATCH: "error";
+    readonly TTL_OUT_OF_RANGE: "error";
+    readonly PLACEHOLDER_INVALID: "error";
+    readonly PLACEHOLDER_DUPLICATED: "error";
+    readonly VARIABLE_NOT_DECLARED: "error";
+    readonly VARIABLE_MISSING_EXAMPLE: "error";
+    readonly VARIABLE_UNUSED: "warning";
+    readonly PARAM_RATIO_TOO_HIGH: "error";
+    readonly PARAM_ADJACENT: "error";
+    readonly PARAM_AT_EDGE: "error";
+    readonly HEADER_TEXT_REQUIRED: "error";
+    readonly HEADER_TOO_LONG: "error";
+    readonly HEADER_TOO_MANY_PARAMS: "error";
+    readonly HEADER_NEWLINE: "error";
+    readonly HEADER_EMOJI: "error";
+    readonly HEADER_FORMATTING: "error";
+    readonly HEADER_MEDIA_URL_INVALID: "error";
+    readonly BODY_REQUIRED: "error";
+    readonly BODY_TOO_LONG: "error";
+    readonly BODY_MULTIPLE_NEWLINES: "error";
+    readonly BODY_EMOJI_LIMIT: "error";
+    readonly FOOTER_TOO_LONG: "error";
+    readonly FOOTER_PARAMETER: "error";
+    readonly FOOTER_NEWLINE: "error";
+    readonly FOOTER_EMOJI: "error";
+    readonly COMPONENT_NOT_ALLOWED: "error";
+    readonly FOOTER_OPT_OUT_MISSING: "warning";
+    readonly BUTTONS_TOO_MANY: "error";
+    readonly BUTTONS_TYPE_LIMIT: "error";
+    readonly QUICK_REPLIES_NOT_GROUPED: "error";
+    readonly BUTTONS_PARTLY_HIDDEN: "warning";
+    readonly BUTTONS_DESKTOP_UNSUPPORTED: "warning";
+    readonly BUTTON_LABEL_REQUIRED: "error";
+    readonly BUTTON_LABEL_TOO_LONG: "error";
+    readonly BUTTON_LABEL_PARAMETER: "error";
+    readonly BUTTON_LABEL_FORMATTING: "error";
+    readonly BUTTON_LABEL_DUPLICATED: "error";
+    readonly BUTTON_URL_INVALID: "error";
+    readonly BUTTON_URL_TOO_LONG: "error";
+    readonly BUTTON_URL_PARAM_POSITION: "error";
+    readonly BUTTON_URL_WHATSAPP_DIRECT: "error";
+    readonly BUTTON_URL_SHORTENED: "error";
+    readonly BUTTON_URL_REDIRECT: "error";
+    readonly BUTTON_PHONE_INVALID: "error";
+    readonly BUTTON_COPY_CODE_EXAMPLE_REQUIRED: "error";
+    readonly BUTTON_COPY_CODE_EXAMPLE_TOO_LONG: "error";
+    readonly LTO_TEXT_REQUIRED: "error";
+    readonly LTO_TEXT_TOO_LONG: "error";
+    readonly LTO_URL_BUTTON_REQUIRED: "error";
+    readonly CAROUSEL_CARDS_COUNT: "error";
+    readonly CAROUSEL_CARDS_MISMATCH: "error";
+    readonly CAROUSEL_CARD_MEDIA_URL_INVALID: "error";
+    readonly CAROUSEL_CARD_BODY_REQUIRED: "error";
+    readonly CAROUSEL_CARD_BODY_TOO_LONG: "error";
+    readonly CAROUSEL_CARD_BODY_NEWLINES: "error";
+    readonly CAROUSEL_CARD_BUTTONS_REQUIRED: "error";
+    readonly CAROUSEL_CARD_BUTTONS_TOO_MANY: "error";
+    readonly CALL_PERMISSION_NOT_COMBINABLE: "error";
+    readonly ORDER_DETAILS_MISMATCH: "error";
+    readonly BUTTON_ORDER_DETAILS_TEXT: "error";
+    readonly OTP_CODE_EXPIRATION_RANGE: "error";
+    readonly OTP_BUTTON_TEXT_TOO_LONG: "error";
+    readonly OTP_BUTTON_TEXT_URL: "error";
+    readonly OTP_SUPPORTED_APPS_REQUIRED: "error";
+    readonly OTP_SUPPORTED_APPS_TOO_MANY: "error";
+    readonly OTP_SUPPORTED_APP_DUPLICATED: "error";
+    readonly OTP_PACKAGE_NAME_INVALID: "error";
+    readonly OTP_SIGNATURE_HASH_INVALID: "error";
+    readonly OTP_ZERO_TAP_TERMS_NOT_ACCEPTED: "error";
+};
+type Code = keyof typeof codes;
+
+type Severity = "error" | "warning";
+type Issue = {
+    code: Code;
+    /** Dot path to the field, e.g. `buttons.1.text`. Empty for the whole template. */
+    path: string;
+    message: string;
+    severity: Severity;
+};
+type ValidationResult = {
+    /** `true` when there are no errors. Warnings do not make a template invalid. */
+    valid: boolean;
+    issues: Issue[];
+};
+type ValidateOptions = {
+    /** Rules to skip, e.g. when a provider has exempted your account from one of them. */
+    disable?: Code[];
+    /** Domains rejected in URL buttons. */
+    shortenerDomains?: string[];
+    /** Maximum characters for the limited-time offer text. */
+    limitedTimeOfferTextLimit?: number;
+    /** Maximum characters for a carousel card body. */
+    carouselCardBodyLimit?: number;
+};
+
+/** Checks a template against the rules WhatsApp applies before review. */
+declare function validate(template: Template, options?: ValidateOptions): ValidationResult;
+
+/** Variable names in order of first appearance: header, body, carousel cards, then button URLs. */
+declare function extractVariables(template: Template): string[];
+
+/** Thrown by `toRequests` when the template has validation errors. */
+declare class TemplateValidationError extends Error {
+    readonly issues: Issue[];
+    constructor(issues: Issue[]);
+}
+/** Validates the template and returns the HTTP requests that create it on the adapter's provider. */
+declare function toRequests(template: Template, adapter: Adapter, options?: ValidateOptions): HttpRequest[];
+/** Prints requests as `curl` commands, in order, ready to paste in a shell. */
+declare function toCurl(requests: HttpRequest | HttpRequest[]): string;
+
+/**
+ * WhatsApp text formatting, parsed into lines and styled spans.
+ *
+ * Supported, as WhatsApp renders them:
+ *   *bold*  _italic_  ~strike~  ```monospace```  `inline code`
+ *   "- " or "* " bullet lines, "1. " numbered lines, "> " quote lines,
+ *   and ``` blocks spanning several lines.
+ */
+type Span = {
+    text: string;
+    bold?: true;
+    italic?: true;
+    strike?: true;
+    /** ```monospace``` inside a line. */
+    mono?: true;
+    /** `inline code`. */
+    code?: true;
+    /** Set when the span is a `{{name}}` placeholder; `text` holds its value. */
+    variable?: string;
+};
+type Line = {
+    kind: "paragraph" | "quote";
+    spans: Span[];
+} | {
+    kind: "bullet";
+    spans: Span[];
+} | {
+    kind: "numbered";
+    marker: string;
+    spans: Span[];
+} | {
+    kind: "code";
+    text: string;
+};
+
+/** Icon shown next to a button label. Bindings map each one to an SVG. */
+type ButtonIcon = "reply" | "link" | "phone" | "copy" | "list" | "cart";
+type PreviewButton = {
+    label: string;
+    icon: ButtonIcon;
+};
+type PreviewHeader = {
+    type: "TEXT";
+    lines: Line[];
+} | {
+    type: "IMAGE" | "VIDEO" | "GIF";
+    url: string;
+} | {
+    type: "DOCUMENT";
+    url: string;
+    filename: string;
+} | {
+    type: "LOCATION";
+} | {
+    type: "PRODUCT";
+};
+type PreviewCard = {
+    header: PreviewHeader;
+    body: Line[];
+    buttons: PreviewButton[];
+};
+/** Everything a binding needs to draw a template, already resolved. */
+type PreviewModel = {
+    header?: PreviewHeader;
+    /** Shown by WhatsApp at the top when there is no header and a button links out. */
+    linkPreview?: {
+        domain: string;
+    };
+    limitedTimeOffer?: {
+        text: string;
+        hasExpiration: boolean;
+    };
+    body: Line[];
+    footer?: Line[];
+    /** Buttons inside the bubble, in display order. */
+    buttons: PreviewButton[];
+    /** Buttons moved behind "See all options" when there are more than 3. */
+    overflow: PreviewButton[];
+    carousel?: PreviewCard[];
+    issues: Issue[];
+};
+type PreviewOptions = {
+    /** Values for `{{name}}` placeholders. Falls back to each variable's `example`. */
+    values?: Record<string, string>;
+    /** Language of the phone, for the texts WhatsApp itself writes there. Default `en`. */
+    deviceLanguage?: string;
+};
+/**
+ * Turns a template into a render-ready model. Invalid templates still render,
+ * so editors can preview while the user types; problems are listed in `issues`.
+ */
+declare function toPreviewModel(template: Template, { values, deviceLanguage }?: PreviewOptions): PreviewModel;
+
+type PreviewNode = {
+    tag: string;
+    class?: string;
+    attrs?: Record<string, string>;
+    children?: (PreviewNode | string)[];
+};
+/** Platforms the preview can imitate. Android is planned. */
+type Platform = "ios";
+type TreeOptions = {
+    platform?: Platform;
+    /** Time shown in the bubble, e.g. "21:11". */
+    time?: string;
+};
+declare function previewTree(model: PreviewModel, { platform, time }?: TreeOptions): PreviewNode;
+
+/**
+ * The template editor as data: sections of fields that a binding renders, and `applyEdit`
+ * to turn a change in one field into the next template. React and Vue share this logic and
+ * only translate it into elements.
+ */
+type EditorOption = {
+    value: string;
+    label: string;
+};
+type FieldBase = {
+    /** Identifies the field in `applyEdit`, e.g. `"body"` or `"buttons.1.url"`. */
+    id: string;
+    label: string;
+    /** Short note next to the label, such as a character count. */
+    hint?: string;
+};
+type EditorField = (FieldBase & {
+    kind: "text" | "textarea";
+    value: string;
+    placeholder?: string;
+    /** Code-like values (names, URLs, numbers) use a monospaced font. */
+    mono?: boolean;
+}) | (FieldBase & {
+    kind: "select";
+    value: string;
+    options: EditorOption[];
+}) | (FieldBase & {
+    kind: "segment";
+    value: string;
+    options: EditorOption[];
+}) | (FieldBase & {
+    kind: "checkbox";
+    checked: boolean;
+}) | (FieldBase & {
+    kind: "action";
+    icon: "add" | "remove";
+    disabled?: boolean;
+});
+type EditorRow = {
+    fields: EditorField[];
+    /** Rows of a list (one per button) get a compact layout. */
+    list?: boolean;
+};
+type EditorSection = {
+    id: "basics" | "content" | "buttons" | "variables" | "code";
+    title: string;
+    rows: EditorRow[];
+    /** Help text under the section, e.g. the formatting syntax. */
+    note?: string;
+};
+type EditorOptions = {
+    /** Languages offered in the language select. Default: English (US), Portuguese (BR), Spanish. */
+    languages?: EditorOption[];
+};
+/** The sections of the editor for a template. */
+declare function editorSections(template: Template, options?: EditorOptions): EditorSection[];
+/**
+ * The template after an edit. `value` is the new text or option for inputs and selects, a
+ * boolean for checkboxes, and nothing for actions. Placeholders added or removed in the text
+ * are synced into `variables`, keeping the examples already typed.
+ *
+ * `remembered` holds examples of variables seen earlier: while someone types `{{name}}` the
+ * placeholder is briefly incomplete, and its example comes back from here once it is whole.
+ */
+declare function applyEdit(template: Template, id: string, value?: string | boolean, remembered?: Variables): Template;
+/**
+ * Switches category. Authentication has its own shape, so moving in or out of it keeps only
+ * the name and language.
+ */
+declare function changeCategory(template: Template, category: Category): Template;
+/** Keeps `variables` in step with the placeholders used in the text, preserving typed examples. */
+declare function syncVariables(template: StandardTemplate, remembered?: Variables): StandardTemplate;
+
+/**
+ * The editor as a framework-neutral element tree, like `previewTree`. Every control carries
+ * `data-edit` (the field id for `applyEdit`); segment items and actions are buttons, the
+ * selected value of a segment item is in `data-value`. Boolean attributes (`checked`,
+ * `disabled`, `selected`) are present as `""` when true and left out when false.
+ */
+declare function editorTree(template: Template, options?: EditorOptions & {
+    /** Prefix for element ids, so two editors on a page do not clash. Default: `"tb"`. */
+    idPrefix?: string;
+}): PreviewNode;
+
+export { Adapter, Category, HttpRequest, StandardTemplate, Template, TemplateValidationError, Variables, applyEdit, changeCategory, codes, editorSections, editorTree, extractVariables, previewTree, syncVariables, toCurl, toPreviewModel, toRequests, validate };
+export type { ButtonIcon, Code, EditorField, EditorOption, EditorOptions, EditorRow, EditorSection, Issue, Line, Platform, PreviewButton, PreviewCard, PreviewHeader, PreviewModel, PreviewNode, PreviewOptions, Severity, Span, TreeOptions, ValidateOptions, ValidationResult };

package/dist/index.d.ts

@@ -0,0 +1,315 @@
+import { T as Template, H as HttpRequest, A as Adapter, V as Variables, C as Category, S as StandardTemplate } from './types-CRH48UOs.js';
+export { a as AuthenticationTemplate, B as Button, b as CarouselCard, c as CatalogButton, d as CopyCodeButton, F as FlowButton, e as Header, L as LimitedTimeOffer, f as LocationHeader, M as MediaHeader, g as MultiProductButton, O as OrderDetailsButton, h as OtpButton, P as PaymentRequestButton, i as PhoneNumberButton, j as ProductHeader, Q as QuickReplyButton, k as SingleProductButton, l as SupportedApp, m as TextHeader, U as UnsupportedByProviderError, n as UrlButton, o as Variable, p as VoiceCallButton, q as defineAdapter } from './types-CRH48UOs.js';
+
+/** Every issue `validate` can report, with its default severity. Codes are stable across releases. */
+declare const codes: {
+    readonly SCHEMA_INVALID: "error";
+    readonly NAME_INVALID: "error";
+    readonly NAME_TOO_LONG: "error";
+    readonly LANGUAGE_INVALID: "error";
+    readonly CATEGORY_MISMATCH: "error";
+    readonly TTL_OUT_OF_RANGE: "error";
+    readonly PLACEHOLDER_INVALID: "error";
+    readonly PLACEHOLDER_DUPLICATED: "error";
+    readonly VARIABLE_NOT_DECLARED: "error";
+    readonly VARIABLE_MISSING_EXAMPLE: "error";
+    readonly VARIABLE_UNUSED: "warning";
+    readonly PARAM_RATIO_TOO_HIGH: "error";
+    readonly PARAM_ADJACENT: "error";
+    readonly PARAM_AT_EDGE: "error";
+    readonly HEADER_TEXT_REQUIRED: "error";
+    readonly HEADER_TOO_LONG: "error";
+    readonly HEADER_TOO_MANY_PARAMS: "error";
+    readonly HEADER_NEWLINE: "error";
+    readonly HEADER_EMOJI: "error";
+    readonly HEADER_FORMATTING: "error";
+    readonly HEADER_MEDIA_URL_INVALID: "error";
+    readonly BODY_REQUIRED: "error";
+    readonly BODY_TOO_LONG: "error";
+    readonly BODY_MULTIPLE_NEWLINES: "error";
+    readonly BODY_EMOJI_LIMIT: "error";
+    readonly FOOTER_TOO_LONG: "error";
+    readonly FOOTER_PARAMETER: "error";
+    readonly FOOTER_NEWLINE: "error";
+    readonly FOOTER_EMOJI: "error";
+    readonly COMPONENT_NOT_ALLOWED: "error";
+    readonly FOOTER_OPT_OUT_MISSING: "warning";
+    readonly BUTTONS_TOO_MANY: "error";
+    readonly BUTTONS_TYPE_LIMIT: "error";
+    readonly QUICK_REPLIES_NOT_GROUPED: "error";
+    readonly BUTTONS_PARTLY_HIDDEN: "warning";
+    readonly BUTTONS_DESKTOP_UNSUPPORTED: "warning";
+    readonly BUTTON_LABEL_REQUIRED: "error";
+    readonly BUTTON_LABEL_TOO_LONG: "error";
+    readonly BUTTON_LABEL_PARAMETER: "error";
+    readonly BUTTON_LABEL_FORMATTING: "error";
+    readonly BUTTON_LABEL_DUPLICATED: "error";
+    readonly BUTTON_URL_INVALID: "error";
+    readonly BUTTON_URL_TOO_LONG: "error";
+    readonly BUTTON_URL_PARAM_POSITION: "error";
+    readonly BUTTON_URL_WHATSAPP_DIRECT: "error";
+    readonly BUTTON_URL_SHORTENED: "error";
+    readonly BUTTON_URL_REDIRECT: "error";
+    readonly BUTTON_PHONE_INVALID: "error";
+    readonly BUTTON_COPY_CODE_EXAMPLE_REQUIRED: "error";
+    readonly BUTTON_COPY_CODE_EXAMPLE_TOO_LONG: "error";
+    readonly LTO_TEXT_REQUIRED: "error";
+    readonly LTO_TEXT_TOO_LONG: "error";
+    readonly LTO_URL_BUTTON_REQUIRED: "error";
+    readonly CAROUSEL_CARDS_COUNT: "error";
+    readonly CAROUSEL_CARDS_MISMATCH: "error";
+    readonly CAROUSEL_CARD_MEDIA_URL_INVALID: "error";
+    readonly CAROUSEL_CARD_BODY_REQUIRED: "error";
+    readonly CAROUSEL_CARD_BODY_TOO_LONG: "error";
+    readonly CAROUSEL_CARD_BODY_NEWLINES: "error";
+    readonly CAROUSEL_CARD_BUTTONS_REQUIRED: "error";
+    readonly CAROUSEL_CARD_BUTTONS_TOO_MANY: "error";
+    readonly CALL_PERMISSION_NOT_COMBINABLE: "error";
+    readonly ORDER_DETAILS_MISMATCH: "error";
+    readonly BUTTON_ORDER_DETAILS_TEXT: "error";
+    readonly OTP_CODE_EXPIRATION_RANGE: "error";
+    readonly OTP_BUTTON_TEXT_TOO_LONG: "error";
+    readonly OTP_BUTTON_TEXT_URL: "error";
+    readonly OTP_SUPPORTED_APPS_REQUIRED: "error";
+    readonly OTP_SUPPORTED_APPS_TOO_MANY: "error";
+    readonly OTP_SUPPORTED_APP_DUPLICATED: "error";
+    readonly OTP_PACKAGE_NAME_INVALID: "error";
+    readonly OTP_SIGNATURE_HASH_INVALID: "error";
+    readonly OTP_ZERO_TAP_TERMS_NOT_ACCEPTED: "error";
+};
+type Code = keyof typeof codes;
+
+type Severity = "error" | "warning";
+type Issue = {
+    code: Code;
+    /** Dot path to the field, e.g. `buttons.1.text`. Empty for the whole template. */
+    path: string;
+    message: string;
+    severity: Severity;
+};
+type ValidationResult = {
+    /** `true` when there are no errors. Warnings do not make a template invalid. */
+    valid: boolean;
+    issues: Issue[];
+};
+type ValidateOptions = {
+    /** Rules to skip, e.g. when a provider has exempted your account from one of them. */
+    disable?: Code[];
+    /** Domains rejected in URL buttons. */
+    shortenerDomains?: string[];
+    /** Maximum characters for the limited-time offer text. */
+    limitedTimeOfferTextLimit?: number;
+    /** Maximum characters for a carousel card body. */
+    carouselCardBodyLimit?: number;
+};
+
+/** Checks a template against the rules WhatsApp applies before review. */
+declare function validate(template: Template, options?: ValidateOptions): ValidationResult;
+
+/** Variable names in order of first appearance: header, body, carousel cards, then button URLs. */
+declare function extractVariables(template: Template): string[];
+
+/** Thrown by `toRequests` when the template has validation errors. */
+declare class TemplateValidationError extends Error {
+    readonly issues: Issue[];
+    constructor(issues: Issue[]);
+}
+/** Validates the template and returns the HTTP requests that create it on the adapter's provider. */
+declare function toRequests(template: Template, adapter: Adapter, options?: ValidateOptions): HttpRequest[];
+/** Prints requests as `curl` commands, in order, ready to paste in a shell. */
+declare function toCurl(requests: HttpRequest | HttpRequest[]): string;
+
+/**
+ * WhatsApp text formatting, parsed into lines and styled spans.
+ *
+ * Supported, as WhatsApp renders them:
+ *   *bold*  _italic_  ~strike~  ```monospace```  `inline code`
+ *   "- " or "* " bullet lines, "1. " numbered lines, "> " quote lines,
+ *   and ``` blocks spanning several lines.
+ */
+type Span = {
+    text: string;
+    bold?: true;
+    italic?: true;
+    strike?: true;
+    /** ```monospace``` inside a line. */
+    mono?: true;
+    /** `inline code`. */
+    code?: true;
+    /** Set when the span is a `{{name}}` placeholder; `text` holds its value. */
+    variable?: string;
+};
+type Line = {
+    kind: "paragraph" | "quote";
+    spans: Span[];
+} | {
+    kind: "bullet";
+    spans: Span[];
+} | {
+    kind: "numbered";
+    marker: string;
+    spans: Span[];
+} | {
+    kind: "code";
+    text: string;
+};
+
+/** Icon shown next to a button label. Bindings map each one to an SVG. */
+type ButtonIcon = "reply" | "link" | "phone" | "copy" | "list" | "cart";
+type PreviewButton = {
+    label: string;
+    icon: ButtonIcon;
+};
+type PreviewHeader = {
+    type: "TEXT";
+    lines: Line[];
+} | {
+    type: "IMAGE" | "VIDEO" | "GIF";
+    url: string;
+} | {
+    type: "DOCUMENT";
+    url: string;
+    filename: string;
+} | {
+    type: "LOCATION";
+} | {
+    type: "PRODUCT";
+};
+type PreviewCard = {
+    header: PreviewHeader;
+    body: Line[];
+    buttons: PreviewButton[];
+};
+/** Everything a binding needs to draw a template, already resolved. */
+type PreviewModel = {
+    header?: PreviewHeader;
+    /** Shown by WhatsApp at the top when there is no header and a button links out. */
+    linkPreview?: {
+        domain: string;
+    };
+    limitedTimeOffer?: {
+        text: string;
+        hasExpiration: boolean;
+    };
+    body: Line[];
+    footer?: Line[];
+    /** Buttons inside the bubble, in display order. */
+    buttons: PreviewButton[];
+    /** Buttons moved behind "See all options" when there are more than 3. */
+    overflow: PreviewButton[];
+    carousel?: PreviewCard[];
+    issues: Issue[];
+};
+type PreviewOptions = {
+    /** Values for `{{name}}` placeholders. Falls back to each variable's `example`. */
+    values?: Record<string, string>;
+    /** Language of the phone, for the texts WhatsApp itself writes there. Default `en`. */
+    deviceLanguage?: string;
+};
+/**
+ * Turns a template into a render-ready model. Invalid templates still render,
+ * so editors can preview while the user types; problems are listed in `issues`.
+ */
+declare function toPreviewModel(template: Template, { values, deviceLanguage }?: PreviewOptions): PreviewModel;
+
+type PreviewNode = {
+    tag: string;
+    class?: string;
+    attrs?: Record<string, string>;
+    children?: (PreviewNode | string)[];
+};
+/** Platforms the preview can imitate. Android is planned. */
+type Platform = "ios";
+type TreeOptions = {
+    platform?: Platform;
+    /** Time shown in the bubble, e.g. "21:11". */
+    time?: string;
+};
+declare function previewTree(model: PreviewModel, { platform, time }?: TreeOptions): PreviewNode;
+
+/**
+ * The template editor as data: sections of fields that a binding renders, and `applyEdit`
+ * to turn a change in one field into the next template. React and Vue share this logic and
+ * only translate it into elements.
+ */
+type EditorOption = {
+    value: string;
+    label: string;
+};
+type FieldBase = {
+    /** Identifies the field in `applyEdit`, e.g. `"body"` or `"buttons.1.url"`. */
+    id: string;
+    label: string;
+    /** Short note next to the label, such as a character count. */
+    hint?: string;
+};
+type EditorField = (FieldBase & {
+    kind: "text" | "textarea";
+    value: string;
+    placeholder?: string;
+    /** Code-like values (names, URLs, numbers) use a monospaced font. */
+    mono?: boolean;
+}) | (FieldBase & {
+    kind: "select";
+    value: string;
+    options: EditorOption[];
+}) | (FieldBase & {
+    kind: "segment";
+    value: string;
+    options: EditorOption[];
+}) | (FieldBase & {
+    kind: "checkbox";
+    checked: boolean;
+}) | (FieldBase & {
+    kind: "action";
+    icon: "add" | "remove";
+    disabled?: boolean;
+});
+type EditorRow = {
+    fields: EditorField[];
+    /** Rows of a list (one per button) get a compact layout. */
+    list?: boolean;
+};
+type EditorSection = {
+    id: "basics" | "content" | "buttons" | "variables" | "code";
+    title: string;
+    rows: EditorRow[];
+    /** Help text under the section, e.g. the formatting syntax. */
+    note?: string;
+};
+type EditorOptions = {
+    /** Languages offered in the language select. Default: English (US), Portuguese (BR), Spanish. */
+    languages?: EditorOption[];
+};
+/** The sections of the editor for a template. */
+declare function editorSections(template: Template, options?: EditorOptions): EditorSection[];
+/**
+ * The template after an edit. `value` is the new text or option for inputs and selects, a
+ * boolean for checkboxes, and nothing for actions. Placeholders added or removed in the text
+ * are synced into `variables`, keeping the examples already typed.
+ *
+ * `remembered` holds examples of variables seen earlier: while someone types `{{name}}` the
+ * placeholder is briefly incomplete, and its example comes back from here once it is whole.
+ */
+declare function applyEdit(template: Template, id: string, value?: string | boolean, remembered?: Variables): Template;
+/**
+ * Switches category. Authentication has its own shape, so moving in or out of it keeps only
+ * the name and language.
+ */
+declare function changeCategory(template: Template, category: Category): Template;
+/** Keeps `variables` in step with the placeholders used in the text, preserving typed examples. */
+declare function syncVariables(template: StandardTemplate, remembered?: Variables): StandardTemplate;
+
+/**
+ * The editor as a framework-neutral element tree, like `previewTree`. Every control carries
+ * `data-edit` (the field id for `applyEdit`); segment items and actions are buttons, the
+ * selected value of a segment item is in `data-value`. Boolean attributes (`checked`,
+ * `disabled`, `selected`) are present as `""` when true and left out when false.
+ */
+declare function editorTree(template: Template, options?: EditorOptions & {
+    /** Prefix for element ids, so two editors on a page do not clash. Default: `"tb"`. */
+    idPrefix?: string;
+}): PreviewNode;
+
+export { Adapter, Category, HttpRequest, StandardTemplate, Template, TemplateValidationError, Variables, applyEdit, changeCategory, codes, editorSections, editorTree, extractVariables, previewTree, syncVariables, toCurl, toPreviewModel, toRequests, validate };
+export type { ButtonIcon, Code, EditorField, EditorOption, EditorOptions, EditorRow, EditorSection, Issue, Line, Platform, PreviewButton, PreviewCard, PreviewHeader, PreviewModel, PreviewNode, PreviewOptions, Severity, Span, TreeOptions, ValidateOptions, ValidationResult };