@bettercms-ai/convert 0.9.0 → 0.11.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;
@@ -142,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;
@@ -192,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. */
@@ -515,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. */
@@ -629,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. */
@@ -802,7 +829,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 = 6;
+declare const HELPER_VERSION = 7;
 /** 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. */
@@ -1132,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.
  *
@@ -1354,6 +1416,11 @@ declare function carryFor(options: {
  * an unexpected extra key is simply carried past. The shape is frozen; the reader is not brittle.
  */
 interface ComponentizePlanField {
+    /**
+     * Where an instance holds this leaf's copy (`h2_latest`, `group_webgl[0].a_webgl`) — allocated by the
+     * server, which alone knows the dedupe suffixes and table keys. Absent from older plans.
+     */
+    overrideKey?: string;
     /** The leaf's key inside the group — `title`, `items[0].q`. */
     key?: string;
     /** The whole page path — `hero.title`. Derived from `groupKey` + `key` when absent. */
@@ -1497,6 +1564,15 @@ interface ComponentizeReceipt {
     sections: SectionsReceipt;
     /** The component slugs this run wrote a file for, sorted. */
     components: string[];
+    /**
+     * The file each of those components was written to — what lets the server record a component's source
+     * (kind `section`) without anyone claiming it by hand. Additive: readers of `components` are unchanged.
+     */
+    componentFiles?: {
+        slug: string;
+        path: string;
+        export: "default";
+    }[];
     /**
      * Sections the SERVER already marked pending (`NO_GROUP_ROOT`, `ALREADY_COMPONENTIZED`, …).
      *
@@ -1644,4 +1720,4 @@ declare function convertSources(briefIn: Brief, sources: SourceFile[], options?:
     receipt: ConversionReceipt;
 }>;
 
-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 };
+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 };