@bettercms-ai/convert 0.7.0 → 0.9.0

package/dist/index.d.ts

@@ -56,6 +56,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 +77,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?
@@ -255,7 +283,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.
  *
@@ -283,9 +363,15 @@ interface DynamicBinding {
  * later reason may name the wrong cause. `TSCONFIG_UNREADABLE` is the first — a project config this
  * package could not parse declares no `paths` aliases as far as it is concerned, so every aliased
  * import resolves to nothing and the component behind it reads as one the page does not import.
+ *
+ * `PRIMITIVE_LIST` is the second, and it is about a CONVERSION rather than a silence: an array of
+ * primitives or tuples renders exactly the paths the codemod wrote into it, so every row's text is
+ * editable and the NUMBER of rows is still the template's — a row added in the CMS does not appear
+ * and a deleted one falls back to the template's own copy. The paths are `rewritten` and true; what
+ * the note adds is that ceiling. @see bindLists
  */
 interface ReceiptNote {
-    code: "TSCONFIG_UNREADABLE";
+    code: "TSCONFIG_UNREADABLE" | "TSCONFIG_EXTENDS_ONLY" | "PRIMITIVE_LIST";
     file: string;
     message: string;
 }
@@ -716,7 +802,7 @@ declare function attrsFor(path: string, kind: string, props?: AttrBinding[], sco
 declare function propsAttribute(props: AttrBinding[]): string;
 
 /** Bumped whenever the emitted source changes. `isKnownHelper` upgrades anything older. */
-declare const HELPER_VERSION = 5;
+declare const HELPER_VERSION = 6;
 /** Where each dialect's helper lives. Null = this dialect reads nothing at build time. */
 declare const HELPER_PATH: Record<Dialect, string | null>;
 /** The directory the snapshots live in, at the repository root. */
@@ -743,6 +829,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`.
  *
@@ -794,18 +906,41 @@ interface DataSplice {
     end: number;
     text: string;
 }
+/** What one drill did, or why it could not. @see drillProp, which is the implementation. */
+type DrillOutcome = {
+    ok: true;
+    edits: {
+        file: string;
+        splices: DataSplice[];
+    }[];
+} | {
+    ok: false;
+    reason: PendingReason;
+};
 interface DataContext {
     content: string;
     parsed: ParsedFile;
     dialect: Dialect;
     /** The name `bcmsRowsAs` is imported under here. @see scope.ts */
     rowsAs: string;
+    /** The names `bcmsList` and `bcmsTuples` are imported under here. @see bindLists */
+    list: string;
+    tuples: string;
     /** The name `bcms` is imported under here — the scalar lane's read. @see scope.ts */
     read: string;
     /** The identifier a page's snapshot is imported under in this file. @see scope.ts */
     snapshotName: (slug: string) => string;
     /** How this file reads its route parameter, on a dynamic route. Null off one. */
     slug: string | null;
+    /**
+     * Follow one prop from a call site in THIS file into the component that renders it.
+     *
+     * Handed in rather than imported: the drill needs every source file, the alias table and the set
+     * of files this conversion already rewrites, and none of that is one file's business. Absent on
+     * a caller that cannot drill (the tests of this lane alone), which makes a row leaf passed as a
+     * prop the refusal it was before. @see index.ts
+     */
+    drill?: (component: string, prop: string, kind: string) => Promise<DrillOutcome>;
 }
 interface DataResult {
     splices: DataSplice[];
@@ -813,6 +948,16 @@ interface DataResult {
     usesRead: boolean;
     /** Did anything here write a `bcmsRowsAs(…)` read? */
     usesRows: boolean;
+    /** Did anything here write a `bcmsList(…)` / `bcmsTuples(…)` read? @see bindLists */
+    usesList: boolean;
+    usesTuples: boolean;
+    /**
+     * One sentence per list this lane bound, for the receipt's `PRIMITIVE_LIST` notes.
+     *
+     * The FILE is the caller's to add: this lane is handed one file's bytes and does not know its
+     * name, exactly as `findSites` does not. @see ReceiptNote
+     */
+    notes: string[];
     /** The page slugs whose snapshot this lane now reads, so the file imports them. */
     slugs: string[];
     /** Target keys this plan bound. */
@@ -827,6 +972,24 @@ interface DataResult {
         key: string;
         reason: PendingReason;
     }[];
+    /** Edits to the COMPONENT files this lane drilled a row leaf into. @see DataContext.drill */
+    componentEdits: {
+        file: string;
+        splices: DataSplice[];
+    }[];
+    /**
+     * One drilled row leaf: the component file that now declares it, and the call site's own entry.
+     *
+     * The receipt records both halves of a prop conversion — the element is in another file and the
+     * path it reads is at the call site — and a reader cannot verify either half from the other
+     * alone. @see DynamicBinding
+     */
+    props: {
+        file: string;
+        prop: string;
+        path: string;
+        literal: string;
+    }[];
 }
 /**
  * Bind every repeater group whose copy lives in a data literal in this same file.
@@ -835,7 +998,7 @@ interface DataResult {
  * account for are returned in `refused` with the reason, and are never partially written — a group
  * half bound is a row whose second field silently stops reflecting.
  */
-declare function bindDataLiterals(ctx: DataContext, members: DataMember[]): DataResult;
+declare function bindDataLiterals(ctx: DataContext, members: DataMember[]): Promise<DataResult>;
 
 /**
  * An image whose `original` is a BUILT url, and the import the template actually renders.
@@ -986,6 +1149,17 @@ declare function aliasesFrom(sources: SourceFile[]): Map<string, string[]>;
  * The note says which file to look at. @see ConversionReceipt.notes
  */
 declare function unreadableConfigs(sources: SourceFile[]): string[];
+/**
+ * Project configs whose aliases are NOT in them — they `extends` another file.
+ *
+ * 🔴 AN ABSENT ALIAS TABLE LOOKS EXACTLY LIKE A PROJECT THAT HAS NONE, and the two have opposite
+ * consequences: the second converts relative imports and is complete, the first refuses every
+ * component reached through `@components/*` with the file sitting right there. `extends` chains
+ * are not followed — the base may be a published package (`@tsconfig/strict`) rather than a file
+ * in the tree — so the honest answer is to say so in the receipt rather than to resolve nothing
+ * silently. @see aliasesFrom
+ */
+declare function extendedConfigs(sources: SourceFile[]): string[];
 /** The repository path a specifier names, or null when it is not among the files we were given. */
 declare function resolveSpecifier(fromFile: string, specifier: string, files: Set<string>, aliases: Map<string, string[]>): string | null;
 /** What one local name was imported from, and WHICH export of it. */
@@ -1470,4 +1644,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, 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, 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, isDynamicRoute, isKnownHelper, isSourceCandidate, locate, overlapping, pageFilesFor, parseFile, propsAttribute, readBrief, readComponentizePlan, readDeclarations, readExpr, readPlan, relativeImport, resolveSpecifier, rewriteFile, routeOfFile, stripTags, unreadableConfigs, walkAst, wireForms };