pagepilot-visual-editor 1.0.25 → 1.0.26

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-RcTlEXS2.cjs");exports.EditorContext=e.EditorContext;exports.PagePilotEditor=e.PagePilotEditor;exports.PagepilotApiClient=e.PagepilotApiClient;exports.Reader=e.Reader;exports.ReaderBlock=e.ReaderBlock;exports.ReaderBlockSchema=e.ReaderBlockSchema;exports.ReaderDocumentSchema=e.ReaderDocumentSchema;exports.pagePilotEditorDarkTheme=e.pagePilotEditorDarkTheme;exports.pagePilotEditorLightTheme=e.pagePilotEditorLightTheme;exports.renderToStaticHtml=e.renderToStaticHtml;exports.renderToStaticMarkup=e.renderToStaticMarkup;exports.resetDocument=e.resetDocument;exports.resetPagePilotEditorTranslations=e.resetPagePilotEditorTranslations;exports.setDocument=e.setDocument;exports.setPagePilotEditorTranslations=e.setPagePilotEditorTranslations;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-BNqa-SV3.cjs");exports.EditorContext=e.EditorContext;exports.PagePilotEditor=e.PagePilotEditor;exports.PagepilotApiClient=e.PagepilotApiClient;exports.Reader=e.Reader;exports.ReaderBlock=e.ReaderBlock;exports.ReaderBlockSchema=e.ReaderBlockSchema;exports.ReaderDocumentSchema=e.ReaderDocumentSchema;exports.extractApiRows=e.extractApiRows;exports.pagePilotEditorDarkTheme=e.pagePilotEditorDarkTheme;exports.pagePilotEditorLightTheme=e.pagePilotEditorLightTheme;exports.refreshApiDataSources=e.refreshApiDataSources;exports.refreshDocumentApiDataSources=e.refreshDocumentApiDataSources;exports.renderToStaticHtml=e.renderToStaticHtml;exports.renderToStaticMarkup=e.renderToStaticMarkup;exports.resetDocument=e.resetDocument;exports.resetPagePilotEditorTranslations=e.resetPagePilotEditorTranslations;exports.setDocument=e.setDocument;exports.setPagePilotEditorTranslations=e.setPagePilotEditorTranslations;

package/dist/index.d.ts

@@ -4,8 +4,8 @@ export type { BlockKey, BlockToggles } from './editor/blockToggles';
 export { pagePilotEditorLightTheme, pagePilotEditorDarkTheme, } from './editor/theme';
 export { setPagePilotEditorTranslations, resetPagePilotEditorTranslations, } from './host-stubs/i18n';
 export { Reader, ReaderBlock, renderToStaticMarkup, ReaderBlockSchema, ReaderDocumentSchema, } from './email-builder-core';
-export { renderToStaticHtml } from './renderToStaticHtml';
-export type { RenderToStaticHtmlOptions, RenderToStaticHtmlSyncOptions, RenderToStaticHtmlPageOptions, RenderToStaticHtmlTemplateOptions, } from './renderToStaticHtml';
+export { renderToStaticHtml, refreshApiDataSources, refreshDocumentApiDataSources, extractApiRows, } from './renderToStaticHtml';
+export type { RenderToStaticHtmlOptions, RenderToStaticHtmlSyncOptions, RenderToStaticHtmlPageOptions, RenderToStaticHtmlPagePathOptions, RenderToStaticHtmlTemplateOptions, RefreshApiDataSourcesOptions, RefreshApiDataSourcesResult, } from './renderToStaticHtml';
 export type { TReaderBlock, TReaderDocument, TReaderBlockProps, TReaderProps, } from './email-builder-core';
 export * as EditorContext from './editor-sample/documents/editor/EditorContext';
 export { PagepilotApiClient } from './api/PagepilotApiClient';

package/dist/index.js

@@ -1,18 +1,21 @@
-import { E as t, P as o, b as s, R as r, d as i, e as d, f as l, p as n, h as P, r as c, i as m, j as g, k as p, s as E, l as h } from "./index-txCEAgzG.js";
+import { E as t, P as s, b as r, R as o, d as i, e as c, f as d, h as l, p as n, i as m, r as p, j as P, k as h, l as g, m as u, n as D, s as E, o as R } from "./index-Dk7bp7l0.js";
 export {
   t as EditorContext,
-  o as PagePilotEditor,
-  s as PagepilotApiClient,
-  r as Reader,
+  s as PagePilotEditor,
+  r as PagepilotApiClient,
+  o as Reader,
   i as ReaderBlock,
-  d as ReaderBlockSchema,
-  l as ReaderDocumentSchema,
+  c as ReaderBlockSchema,
+  d as ReaderDocumentSchema,
+  l as extractApiRows,
   n as pagePilotEditorDarkTheme,
-  P as pagePilotEditorLightTheme,
-  c as renderToStaticHtml,
-  m as renderToStaticMarkup,
-  g as resetDocument,
-  p as resetPagePilotEditorTranslations,
+  m as pagePilotEditorLightTheme,
+  p as refreshApiDataSources,
+  P as refreshDocumentApiDataSources,
+  h as renderToStaticHtml,
+  g as renderToStaticMarkup,
+  u as resetDocument,
+  D as resetPagePilotEditorTranslations,
   E as setDocument,
-  h as setPagePilotEditorTranslations
+  R as setPagePilotEditorTranslations
 };

package/dist/render-core/apiDataSource.d.ts

@@ -0,0 +1,50 @@
+import { TemplateFormField } from './templateBaking';
+export interface RefreshApiDataSourcesOptions {
+    /** Optional custom fetch. Defaults to global `fetch`. */
+    fetchFn?: typeof fetch;
+    /** Per-request timeout in ms. Defaults to 10000. */
+    timeoutMs?: number;
+    /** Extra headers sent with every API-datasource GET (e.g. auth). */
+    headers?: Record<string, string>;
+    /**
+     * Called for each field whose refetch failed (bad URL, network error,
+     * non-OK status, non-JSON body, no array found). The field's existing
+     * `value` is left untouched so the render still succeeds with the last
+     * known-good rows.
+     */
+    onError?: (field: TemplateFormField, error: Error) => void;
+}
+export interface RefreshApiDataSourcesResult {
+    /** The (possibly) updated fields — same array identity only if nothing changed. */
+    fields: TemplateFormField[];
+    /** How many `api` datasource fields were found. */
+    attempted: number;
+    /** How many were successfully refetched and re-seeded. */
+    refreshed: number;
+    /** field id → error message, for any that failed. */
+    errors: Record<string, string>;
+}
+/**
+ * Pull the array of row-objects out of an arbitrary API response.
+ *
+ *  - If `apiItemPath` is set, resolve that dot-path first (supports both
+ *    "the array itself lives at this path" and "each row's real payload is
+ *    nested one level under this key inside an already-found array").
+ *  - Otherwise fall back to: top-level array, or a common wrapper key
+ *    (data / rows / results / items / records).
+ */
+export declare function extractApiRows(body: any, apiItemPath?: string): Record<string, any>[] | null;
+/**
+ * Re-fetch every `array`-type formField whose `dataSource.type === 'api'`
+ * and replace its `value` with freshly-extracted rows. Fields with any other
+ * (or no) `dataSource.type` pass through unchanged. Failures are isolated
+ * per-field — one bad endpoint never aborts the whole render; that field
+ * simply keeps its last-saved `value`.
+ */
+export declare function refreshApiDataSources(fields: TemplateFormField[] | null | undefined, options?: RefreshApiDataSourcesOptions): Promise<RefreshApiDataSourcesResult>;
+/**
+ * Convenience wrapper: refresh a document's OWN `root.data.formFields`
+ * (the shape every saved section/page/template uses) in place and return
+ * the updated field list, ready to pass into `bakeTemplateValues`.
+ */
+export declare function refreshDocumentApiDataSources(document: any, options?: RefreshApiDataSourcesOptions): Promise<RefreshApiDataSourcesResult>;

package/dist/render-core/dateFormats.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Preset date display formats offered to the author. `relative` is recomputed at
+ * view time (see formatRelativeDate); every other preset is a fixed absolute
+ * format resolved via `Intl.DateTimeFormat` in a chosen timezone.
+ */
+export type DateFormatPreset = 'relative' | 'do-mmm-yyyy' | 'mmm-d-yyyy' | 'd-mmm-yyyy' | 'dd-mm-yyyy' | 'mm-dd-yyyy' | 'yyyy-mm-dd' | 'do-mmm' | 'full';
+export declare const DEFAULT_DATE_FORMAT: DateFormatPreset;
+export declare const DATE_FORMAT_PRESETS: {
+    value: DateFormatPreset;
+    label: string;
+}[];
+/**
+ * Time display formats offered for a `time` scalar variable. Unlike `date`,
+ * `time` has no `relative` mode — it always bakes to a fixed string, rendered
+ * in the field's chosen `dateTz` (reusing the timezone control).
+ *   - `24h` → "20:42"
+ *   - `12h` → "8:42 PM"
+ */
+export type TimeFormatPreset = '24h' | '12h';
+export declare const DEFAULT_TIME_FORMAT: TimeFormatPreset;
+export declare const TIME_FORMAT_PRESETS: {
+    value: TimeFormatPreset;
+    label: string;
+}[];
+/**
+ * Friendly relative label for a date, compared against `now` in the HOST's local
+ * timezone (the reader's browser, or the app user's machine):
+ *
+ *   -1 day  → "Yesterday"
+ *    0 day  → "Today"
+ *   +1 day  → "Tomorrow"
+ *   ±2..6   → weekday ("Mon", "Sat")
+ *   further → "Mar 25", or "Mar 25, 2027" when not the current year
+ *
+ * Returns '' for a missing/invalid input.
+ *
+ * NOTE: keep this ladder in sync with `formatRelativeDateLabel` in
+ * `src/email-builder-core/utils/substituteTemplateVars.ts` (the standalone
+ * copy the marker-span runtime uses) and the inlined copy in
+ * `src/email-builder-core/renderers/pageScripts.ts`.
+ */
+export declare function formatRelativeDate(value: string | number | Date | null | undefined, opts?: {
+    now?: Date;
+    locale?: string;
+}): string;
+/**
+ * Format a date value with one of the presets.
+ *  - `relative` → formatRelativeDate (host-local day math; `tz` is ignored)
+ *  - any other  → the value's Y/M/D in `tz` (defaults to the host's local
+ *    zone), assembled into the preset's pattern.
+ *
+ * `tz` is an IANA name (e.g. "America/New_York"). Returns '' for a
+ * missing/invalid input.
+ */
+export declare function formatDateValue(value: string | number | Date | null | undefined, preset?: DateFormatPreset, opts?: {
+    tz?: string;
+    now?: Date;
+    locale?: string;
+}): string;
+/**
+ * Format the time portion of a date value with one of the time presets, in the
+ * given IANA `tz` (defaults to the host's local zone). Returns '' for a
+ * missing/invalid input.
+ */
+export declare function formatTimeValue(value: string | number | Date | null | undefined, preset?: TimeFormatPreset, opts?: {
+    tz?: string;
+}): string;

package/dist/render-core/templateBaking.d.ts

@@ -1,10 +1,30 @@
-export type TemplateScalarType = 'text' | 'textarea' | 'number' | 'image';
+import { DateFormatPreset, TimeFormatPreset } from './dateFormats';
+/**
+ * The kinds of single-value template field. `array` is repeatable and handled
+ * separately. `text` / `textarea` substitute as plain strings, `number` as a
+ * numeric string, `image` as an image URL (used in Image/Avatar/Logo blocks),
+ * `date` an ISO date string rendered through a display format (see `dateFormat`).
+ * `time` an ISO date string rendered as just its time portion (see `timeFormat`).
+ * `datetime` one ISO string exposing TWO sub-tokens — `{{id.date}}` (formatted
+ *   via `dateFormat`) and `{{id.time}}` (via `timeFormat`) — so a single value /
+ *   API mapping can print its date and time in separate blocks.
+ */
+export type TemplateScalarType = 'text' | 'textarea' | 'number' | 'image' | 'date' | 'time' | 'datetime';
 export type TemplateFormType = TemplateScalarType | 'array';
+/** All scalar types — used by both top-level fields and array sub-fields. */
+export declare const TEMPLATE_SCALAR_TYPES: TemplateScalarType[];
 export type TemplateItemFieldDef = {
     id: string;
     name: string;
+    /** Sub-field input kind. Defaults to `text` when absent (legacy rows). */
     type?: TemplateScalarType;
+    /** Author-set default value, used to prefill the row when a template is applied. */
     defaultValue?: string;
+    /** `date` sub-fields only — see the same fields on TemplateFormField. */
+    dateFormat?: DateFormatPreset;
+    /** `time` sub-fields only — 24h / AM/PM. Timezone reuses `dateTz`. */
+    timeFormat?: TimeFormatPreset;
+    dateTz?: string;
 };
 export type TemplateArrayRow = Record<string, string>;
 export type TemplateFormField = {
@@ -16,20 +36,103 @@ export type TemplateFormField = {
     itemFields?: TemplateItemFieldDef[];
     sourceBlockId?: string;
     rowIds?: string[];
+    /**
+     * `date` fields only. How the ISO `value` is displayed:
+     *   - `relative` (default) → "Today" / "Tomorrow" / "Mar 25", recomputed in the
+     *     reader's browser at view time (emitted as a `data-ahd-date` marker span,
+     *     NOT baked to a fixed string). Uses the reader's local timezone.
+     *   - any absolute preset → a fixed string ("9th Sep 2026" …) resolved at bake
+     *     time in `dateTz`.
+     * See `dateFormats.ts` for the preset list.
+     */
+    dateFormat?: DateFormatPreset;
+    /**
+     * `time` fields only. How the ISO `value`'s time portion is displayed:
+     *   - `24h` (default) → "20:42"
+     *   - `12h` → "8:42 PM"
+     */
+    timeFormat?: TimeFormatPreset;
+    /**
+     * `date` fields with an absolute `dateFormat`, and all `time` fields. IANA
+     * timezone the value is rendered in (e.g. "America/New_York"). Ignored by
+     * `date`'s `relative` preset.
+     */
+    dateTz?: string;
+    /**
+     * Set on a container-repeat array field driven from the Variables tab's
+     * "Repeatable container" flow: the id of the Grid/FlexColumns/ColumnsContainer
+     * whose EMPTY slots get stamped with clones of `sourceBlockId`'s subtree.
+     * (`sourceBlockId` = the block sitting in the container's first filled slot;
+     * `rowIds` = the stamped clones' roots, one per filled empty slot.)
+     */
     containerId?: string;
+    /**
+     * Set on a direct items-array data-source field: the id of the block whose
+     * OWN `data.props.items` gets seeded straight from the Data Reference
+     * source. Unlike `sourceBlockId`, there's no cloned subtree — `itemsBlockId`
+     * points at the block itself, and rows write directly into its `items`
+     * array. Presence of `itemsBlockId` (instead of `sourceBlockId`) is what
+     * routes ArrayFieldEditor/DataReferencePanel down the items-array path
+     * instead of the container-repeat path.
+     */
+    itemsBlockId?: string;
+    /**
+     * Author flag set from "Set template details" → Template Fields: marks this
+     * field's content as intended to be repeated once the template is applied
+     * (e.g. across grid cells / carousel slides). Pure metadata — carried through
+     * from the saved template record, doesn't drive any runtime behavior itself.
+     */
     repeatable?: boolean;
+    /**
+     * The id of the block template this repeatable field is bound to — captured
+     * when the field's block is saved via the Variables-panel "Save as New
+     * Template" shortcut.
+     */
     templateId?: string;
+    /**
+     * "Data Reference" binding for a repeatable field: where the repetition data
+     * comes from. `custom` = the manual rows editor (default). `api`/`menu` pull
+     * an array of objects whose keys map to this field's sub-field ids; each
+     * object seeds one repeated copy. `customJson` holds the pasted JSON text for
+     * the `custom-json` source.
+     */
     dataSource?: {
+        /** `api` = fetch an array of objects from a REST endpoint. */
         type: 'custom' | 'custom-json' | 'api' | 'menu';
+        /** Raw JSON text for `custom-json`. */
         customJson?: string;
+        /** Endpoint URL for the `api` source. Persisted in config. */
         apiUrl?: string;
+        /** HTTP method for the `api` source. Only GET works today; POST is planned. */
         apiMethod?: 'GET' | 'POST';
+        /**
+         * Optional dot-path (e.g. "data.ALL.games") into the response body where
+         * the array of objects lives. When empty, the array is auto-detected from
+         * common wrapper keys (data / rows / results / items / records).
+         */
+        apiResponsePath?: string;
+        /**
+         * REPEATABLE fields: optional dot-path applied to EACH array element before
+         * its keys are matched to sub-field ids. Use it when the fields you want are
+         * nested inside a wrapper on every row, e.g. `[{ "event": { "nextStart": … } }]`
+         * → set `apiItemPath: "event"` so `nextStart` maps directly.
+         * Works for the `api` and `custom-json` sources.
+         */
+        apiItemPath?: string;
+        /** Selected menu id for `menu`. */
         menuId?: string;
+        /**
+         * SCALAR fields only: dot-path into the fetched object for THIS field's
+         * value, overriding the default key lookup by field id. e.g. field `name`
+         * with `apiObjectPath: "user.fullName"` reads `body.user.fullName`.
+         * (`apiResponsePath` still points at the object itself within the response.)
+         */
+        apiObjectPath?: string;
     };
 };
 export declare function buildRepeatRowIndex(document: any | null | undefined, fields: TemplateFormField[] | null | undefined): Map<string, TemplateArrayRow>;
 export declare function getTextFieldsForType(type: string | undefined): string[] | undefined;
 export declare function getTemplateForms(document: any | null | undefined): TemplateFormField[];
 export declare function applyVariables(input: string | null | undefined, fields: TemplateFormField[] | null | undefined, rowContext?: TemplateArrayRow | null): string;
-export declare function substituteBlockText(block: any, fields: TemplateFormField[] | null | undefined, rowContext?: TemplateArrayRow | null): any;
+export declare function substituteBlockText(block: any, fields: TemplateFormField[] | null | undefined, rowContext?: TemplateArrayRow | null, rowIndex?: Map<string, TemplateArrayRow> | null): any;
 export declare function bakeTemplateValues<T = any>(document: T, fields: TemplateFormField[] | null | undefined): T;