@bettercms-ai/convert 0.8.0 → 0.10.0

package/dist/index.d.ts

@@ -37,6 +37,18 @@ interface BriefPath {
     kind: string;
     /** The declared field type, which `kind` deliberately loses (richtext vs document). */
     type: string;
+    /**
+     * The richtext value IS the element's whole inline subtree — the field's `config.inline`.
+     *
+     * A heading with a styled run (`<h1>Notes from a <span class="serif">web studio</span></h1>`)
+     * derives as ONE richtext field whose value is that innerHTML, not as the text node beside the
+     * span. Without this the codemod cannot tell it from the icon+text shape, whose value really is
+     * one text node — and it wraps the text node in a `<span>`, leaving the styled run rendered
+     * twice. Optional on purpose: a brief written before the distinction existed carries none, and
+     * the old wrap-the-text-node reading is still the right answer for it.
+     * @see derive-schema.ts textType, which mints `config: { inline: true }` for exactly this shape.
+     */
+    inline?: true;
     label: string;
     /** The copy the REPO renders today. Null when the import captured no default. */
     original: string | null;
@@ -56,6 +68,11 @@ interface BriefPage {
 /** Only what the codemod reads. A backend `ConversionBrief` satisfies it. */
 interface Brief {
     pages: BriefPage[];
+    /**
+     * The project's forms, for the `--forms` lane. OPTIONAL: a brief issued before that lane
+     * existed carries none, and a run over one simply has no form to wire. @see BriefForm
+     */
+    forms?: BriefForm[];
 }
 /**
  * The name of one brief — `(route, path, kind, original)` for every page, hashed.
@@ -72,6 +89,29 @@ interface Brief {
  * coverage meter read zero forever. `brief-digest.test.ts` pins both against one literal hash.
  */
 declare function briefDigest(brief: Brief): string;
+/**
+ * One CMS form, as the brief lists it — the half the codemod cannot derive from the repository.
+ *
+ * The `<form>` in the source and the row in the Forms tab are two halves of one thing, and only
+ * the platform knows the id that joins them. `submitUrl` is the absolute endpoint a browser posts
+ * to (`packages/sdk/src/forms.ts`), so a wired form needs no helper, no import and no snapshot:
+ * it posts to a URL. `status` is carried because a DRAFT form 403s that endpoint — wiring one is
+ * correct and incomplete, and the receipt says so rather than leaving a live form that silently
+ * rejects every visitor.
+ */
+interface BriefForm {
+    id: string;
+    name: string;
+    status: "draft" | "published";
+    /** `/api/v1/forms/public/<id>/submissions`, absolute or origin-relative as the brief states it. */
+    submitUrl: string;
+    successMessage?: string;
+    /** The control this form expects, by `name`. `type` is informative; the key is the match. */
+    fields: {
+        key: string;
+        type: string;
+    }[];
+}
 
 /**
  * Where in the source does each of the brief's paths actually appear?
@@ -114,8 +154,13 @@ interface UnlocatedPath {
  * correctly formatted file, which is every file.
  */
 declare const flat: (value: string) => string;
-/** The same text with tags removed — what a reader sees, not what the file says. */
-declare const stripTags: (value: string) => string;
+/**
+ * The same text with tags removed — what a reader sees, not what the file says.
+ *
+ * `br` is what a line break becomes. A SPACE is what a reader sees; the empty string is what
+ * `textContent` sees, and the matcher works on the latter. @see locate, which searches both.
+ */
+declare const stripTags: (value: string, br?: string) => string;
 interface BriefLike {
     pages: {
         route: string;
@@ -164,7 +209,9 @@ declare function locate(brief: BriefLike, sources: SourceFile[], options?: Locat
  * sentence appears in three files" and "this field is bound" are different questions — and a path
  * is only `rewritten` when EVERY located occurrence of it was.
  */
-type PendingReason = "NO_ORIGINAL" | "NOT_IN_SOURCE" | "DIALECT_UNSUPPORTED" | "IN_EXPRESSION" | "IN_SCRIPT_OR_COMMENT" | "IN_DATA_FILE" | "AMBIGUOUS_LITERAL" | "KIND_MISMATCH" | "SUBSTRING_ONLY" | "PROP_TARGET_NOT_FOUND" | "PROP_DRILLED_DEEP" | "REPEATER_FIXED_LENGTH"
+type PendingReason = "NO_ORIGINAL" | "NOT_IN_SOURCE" | "DIALECT_UNSUPPORTED" | "IN_EXPRESSION" | "IN_SCRIPT_OR_COMMENT" | "IN_DATA_FILE" | "AMBIGUOUS_LITERAL" | "KIND_MISMATCH" | "SUBSTRING_ONLY"
+/** An INLINE richtext value whose element holds a component, a `<slot>` or an expression. */
+ | "SUBTREE_NOT_HTML" | "PROP_TARGET_NOT_FOUND" | "PROP_DRILLED_DEEP" | "REPEATER_FIXED_LENGTH"
 /** One array declaration, two loops over it: the row this leaf belongs to has two homes. */
  | "REPEATER_AMBIGUOUS"
 /** An image whose built url maps to no repository asset, or to more than one. */
@@ -255,7 +302,59 @@ interface ConversionReceipt {
         lane: "bridge" | "pending";
         files?: string[];
     };
+    /**
+     * What `--forms` wired, and what it could not. OPTIONAL, and ADDITIVE ON PURPOSE: the server's
+     * `receiptInvariantHolds` reads `paths` only, so a receipt carrying this is accepted verbatim by
+     * a server that has never heard of the lane. @see FormsReceipt
+     */
+    forms?: FormsReceipt;
 }
+/**
+ * Why one CMS form could not be wired to a `<form>` in the repository.
+ *
+ * `FORM_NOT_IN_SOURCE`      no `<form>` in any file this run read holds any of its fields.
+ * `FORM_AMBIGUOUS`          two `<form>`s hold its fields, or two CMS forms want the same one.
+ * `FIELD_UNMATCHED`         a `<form>` is plainly the one, but a field's key names no control in it.
+ * `ACTION_IS_EXPRESSION`    the `<form>`'s `action` is code; replacing it would rewrite a program.
+ * `DIALECT_UNSUPPORTED`     the `<form>` is in a svelte/vue file, which this lane does not write.
+ * `PARSE_ERROR`             the file holding it did not parse.
+ */
+type FormPendingReason = "FORM_NOT_IN_SOURCE" | "FORM_AMBIGUOUS" | "FIELD_UNMATCHED" | "ACTION_IS_EXPRESSION" | "DIALECT_UNSUPPORTED" | "PARSE_ERROR";
+interface PendingForm {
+    id: string;
+    name: string;
+    reason: FormPendingReason;
+    /** The file the reason is about, when the reason is about one. */
+    file?: string;
+    /** What exactly could not be done. Informative; the reason is the contract. */
+    message?: string;
+}
+interface FormsReceipt {
+    /** A `<form>` this run pointed at the CMS: action, method, id, field markers and the script. */
+    wired: number;
+    /**
+     * Already ours, from a previous run — the `<form>` carries `data-bcms-form`.
+     *
+     * Its own bucket for the same reason componentize keeps one: a second run over a wired tree has
+     * to report `wired: 0, pending: []` AND still account for every form of the brief.
+     */
+    alreadyWired: number;
+    pending: PendingForm[];
+    /** Prose a human has to act on — a draft form still 403s every submission. */
+    notes?: string[];
+}
+/** Raised when the receipt does not account for every form. Never caught inside this package. */
+declare class FormInvariantError extends Error {
+    readonly code = "FORM_INVARIANT";
+    constructor(message: string);
+}
+/**
+ * The invariant, checked where the receipt is built — the same shape as `assertSections`.
+ *
+ * A form in none of the buckets is a form the codemod forgot, and a forgotten form is a live site
+ * whose submit button does nothing at all.
+ */
+declare function assertForms(total: number, forms: FormsReceipt): FormsReceipt;
 /**
  * One binding whose `data-bcms-field` is an expression, and where its value is written literally.
  *
@@ -435,6 +534,12 @@ interface Site {
     literal: string;
     /** The literal is only PART of what this element renders; rewriting it would eat the rest. */
     partial: boolean;
+    /**
+     * The subtree holds markup only the FRAMEWORK renders — a component, a `<slot>`, an expression.
+     *
+     * Absent on every site whose children are plain html, which is the common case. @see ownsSubtree
+     */
+    nonHtml?: true;
     /** Tag chain from the document root down to the element's parent, outermost first. */
     ancestors: string[];
     /** Index among the element's ELEMENT siblings. */
@@ -549,6 +654,8 @@ interface Rewrite {
     path: string;
     /** The brief's kind: "text" | "richtext" | "image". */
     kind: string;
+    /** The richtext value is the element's whole inline subtree. @see BriefPath.inline */
+    inline?: true;
     /** The copy the repo renders today, kept as the in-code fallback. */
     fallback: string;
     /** The identifier this page's snapshot is imported under. */
@@ -749,6 +856,32 @@ declare function helperSource(dialect: Dialect): string;
  */
 declare function isKnownHelper(content: string, dialect: Dialect): number | null;
 
+/**
+ * The submit runtime, LIFTED VERBATIM from `src/lib/sites/render-page.ts` `FORM_SCRIPT`.
+ *
+ * 🔴 THE SAME BYTES, AND A TEST THAT SAYS SO. The hosted renderer and this codemod ship the same
+ * form contract to two different kinds of site, and the `cf-turnstile-response` hoist in the
+ * middle is the part that cannot drift: the token must travel as a TOP-LEVEL key and never inside
+ * `data`, or the ingest route reads `token === undefined` and — once any Turnstile secret resolves
+ * — answers 403 to every single submission. A copy that fell behind would turn enabling Turnstile
+ * into a kill switch for the customer's live form, on their own repository, where nothing here can
+ * see it. `src/__tests__/content/form-script-pin.test.ts` reads THIS FILE as text and asserts the
+ * renderer's constant occurs in it byte for byte, which is the only thing that keeps the copy a
+ * copy. Change it there first, then paste it here.
+ */
+declare const FORM_SCRIPT = "<script>\ndocument.querySelectorAll('form[data-bcms-form]').forEach(function(f){\n  f.addEventListener('submit',function(e){\n    e.preventDefault();\n    var msg=f.querySelector('.bcms-form-msg');\n    var data={};\n    // A checkboxes group posts one entry per checked box under the SAME name; the old\n    // one-at-a-time assignment kept only the last, so \"pick many\" delivered one answer.\n    // One checked box still arrives as a scalar \u2014 FormData cannot tell a group from a\n    // lone field \u2014 which is exactly why lib/forms/validate.ts's chosenValues() accepts\n    // both an array and a comma string.\n    new FormData(f).forEach(function(v,k){\n      if(k==='cf-turnstile-response')return;\n      if(Object.prototype.hasOwnProperty.call(data,k))data[k]=(Array.isArray(data[k])?data[k]:[data[k]]).concat(v);\n      else data[k]=v;\n    });\n    var body={data:data};\n    var tok=f.querySelector('[name=\"cf-turnstile-response\"]');\n    if(tok&&tok.value)body['cf-turnstile-response']=tok.value;\n    fetch(f.action,{method:'POST',headers:{'Content-Type':'application/json'},body:JSON.stringify(body)})\n      .then(function(r){return r.ok;})\n      .then(function(ok){if(msg){msg.hidden=false;msg.textContent=ok?(f.getAttribute('data-bcms-form-success')||'Thanks! Your submission was received.'):'Sorry, something went wrong.';}if(ok)f.reset();})\n      .catch(function(){if(msg){msg.hidden=false;msg.textContent='Sorry, something went wrong.';}});\n  });\n});\n</script>";
+/**
+ * Wire every form the brief lists, and say what could not be.
+ *
+ * PURE, like the rest of this package: files in as values, files out as values. The receipt is a
+ * `ConversionReceipt` with an empty path arithmetic and the lane's own account under `forms`, so
+ * `submit_conversion_receipt` takes it unchanged — the server's invariant reads `paths` only.
+ */
+declare function wireForms(briefIn: Brief, sources: SourceFile[]): Promise<{
+    files: PlanFile[];
+    receipt: ConversionReceipt;
+}>;
+
 /**
  * Copy that lives in a DATA LITERAL beside the markup, rendered through `.map`.
  *
@@ -1026,6 +1159,41 @@ declare const SOURCE_EXTENSIONS: string[];
 /** Is this repository-relative path a file worth opening? */
 declare function isSourceCandidate(path: string): boolean;
 
+/**
+ * Text that is NOT copy, and is therefore outside both halves of the ratio.
+ *
+ * 🔴 IN THE DENOMINATOR TOO. Counting a `✓`, a `01`, the platform badge or a skip link as
+ * unaddressable text would put a floor under every route's percentage that no amount of binding
+ * could lift — and the target is a number someone has to be able to reach. They are not copy an
+ * author edits, so they are not copy this measures.
+ *
+ *  - a decorative glyph: two characters or fewer, a single non-letter symbol, or an ordinal
+ *    (`01`, `2.`, `3 /`) that numbers a list rather than saying anything;
+ *  - the platform badge every free site renders;
+ *  - a skip link, which exists for keyboards and is never edited.
+ */
+declare const isDecorativeGlyph: (text: string) => boolean;
+interface XrayBucket {
+    /** The element that renders it. */
+    tag: string;
+    /** Its landmark chain, outermost first — `main>ul`. */
+    context: string;
+    chars: number;
+    nodes: number;
+    /** Up to two examples, ≤ 50 characters each. */
+    samples: string[];
+}
+interface Xray {
+    /** Characters of visible copy, decorative glyphs excluded. */
+    visible: number;
+    /** Of those, the characters no binding owns. */
+    unaddressable: number;
+    /** The biggest buckets, largest first — at most 12. */
+    buckets: XrayBucket[];
+}
+/** What a reader sees on this page, and how much of it no field owns. */
+declare function measureUnaddressable(html: string): Xray;
+
 /**
  * The project's own `compilerOptions.paths`, when a tsconfig is among the files.
  *
@@ -1538,4 +1706,4 @@ declare function convertSources(briefIn: Brief, sources: SourceFile[], options?:
     receipt: ConversionReceipt;
 }>;
 
-export { ASTRO_LANE_PENDING, type AstNode, type AttrBinding, type Brief, type BriefPage, type BriefPath, COMPONENT_DIR, CONTENT_DIR, type CanvasResult, type CanvasSource, type Carried, type ComponentizeOptions, type ComponentizePlan, type ComponentizePlanComponent, type ComponentizePlanField, type ComponentizePlanPage, type ComponentizePlanSection, type ComponentizeReceipt, type ConversionReceipt, ConvertError, type ConvertErrorCode, type ConvertOptions, DIALECT_RULES, type DataMember, type DataResult, type DeclaredPath, type Dialect, type DynamicBinding, type FileDeclaration, type FindSitesResult, HELPER_PATH, HELPER_VERSION, type ImageResult, type ImageTarget, type ImportedFrom, type LlmFallback, type LocatedPath, type Node, PARSE_FILE, type ParsedFile, type ParserError, type PathLocator, type PendingPath, type PendingReason, type PendingSection, type PlanFile, REGISTRY_MARKER, type ReceiptFile, ReceiptInvariantError, type ReceiptNote, type Rewrite, SECTIONS_LIB, SECTION_MARKER, SKIP_DIRS, SKIP_FILES, SOURCE_EXTENSIONS, SSR_DRAFT_RECIPE, STUB_CONTENT, SectionInvariantError, type SectionPendingReason, type SectionsReceipt, type Site, type SiteWhere, type SourceFile, type Splice, type TargetIdentity, type UnlocatedPath, type ValidationCode, ValidationError, aliasesFrom, assertReceipt, assertSections, assetCandidates, assetImport, attrsFor, bindDataLiterals, bindImages, briefDigest, canvasBridge, carryFor, componentizeSources, convertSources, convertedHere, coverageOf, declaringElements, dialectOf, exportedFunction, extendedConfigs, findSites, findSitesTolerant, flat, helperSource, importsIn, isDynamicRoute, isKnownHelper, isSourceCandidate, locate, overlapping, pageFilesFor, parseFile, propsAttribute, readBrief, readComponentizePlan, readDeclarations, readExpr, readPlan, relativeImport, resolveSpecifier, rewriteFile, routeOfFile, stripTags, unreadableConfigs, walkAst };
+export { ASTRO_LANE_PENDING, type AstNode, type AttrBinding, type Brief, type BriefForm, type BriefPage, type BriefPath, COMPONENT_DIR, CONTENT_DIR, type CanvasResult, type CanvasSource, type Carried, type ComponentizeOptions, type ComponentizePlan, type ComponentizePlanComponent, type ComponentizePlanField, type ComponentizePlanPage, type ComponentizePlanSection, type ComponentizeReceipt, type ConversionReceipt, ConvertError, type ConvertErrorCode, type ConvertOptions, DIALECT_RULES, type DataMember, type DataResult, type DeclaredPath, type Dialect, type DynamicBinding, FORM_SCRIPT, type FileDeclaration, type FindSitesResult, FormInvariantError, type FormPendingReason, type FormsReceipt, HELPER_PATH, HELPER_VERSION, type ImageResult, type ImageTarget, type ImportedFrom, type LlmFallback, type LocatedPath, type Node, PARSE_FILE, type ParsedFile, type ParserError, type PathLocator, type PendingForm, type PendingPath, type PendingReason, type PendingSection, type PlanFile, REGISTRY_MARKER, type ReceiptFile, ReceiptInvariantError, type ReceiptNote, type Rewrite, SECTIONS_LIB, SECTION_MARKER, SKIP_DIRS, SKIP_FILES, SOURCE_EXTENSIONS, SSR_DRAFT_RECIPE, STUB_CONTENT, SectionInvariantError, type SectionPendingReason, type SectionsReceipt, type Site, type SiteWhere, type SourceFile, type Splice, type TargetIdentity, type UnlocatedPath, type ValidationCode, ValidationError, type Xray, type XrayBucket, aliasesFrom, assertForms, assertReceipt, assertSections, assetCandidates, assetImport, attrsFor, bindDataLiterals, bindImages, briefDigest, canvasBridge, carryFor, componentizeSources, convertSources, convertedHere, coverageOf, declaringElements, dialectOf, exportedFunction, extendedConfigs, findSites, findSitesTolerant, flat, helperSource, importsIn, isDecorativeGlyph, isDynamicRoute, isKnownHelper, isSourceCandidate, locate, measureUnaddressable, overlapping, pageFilesFor, parseFile, propsAttribute, readBrief, readComponentizePlan, readDeclarations, readExpr, readPlan, relativeImport, resolveSpecifier, rewriteFile, routeOfFile, stripTags, unreadableConfigs, walkAst, wireForms };