@bettercms-ai/convert 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -164,7 +164,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" | "DYNAMIC_PARAMS_UNAVAILABLE" | "BRIEF_META_UNPLACED" | "PARSE_ERROR" | "TIER3_UNVERIFIABLE";
+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" | "DYNAMIC_PARAMS_UNAVAILABLE" | "BRIEF_META_UNPLACED" | "PARSE_ERROR" | "TIER3_UNVERIFIABLE"
+/** @see CANVAS_REASONS — these two are about the SITE's live-preview lane, not a brief path. */
+ | "CANVAS_BRIDGE_MANUAL" | "SSR_DRAFT_ROUTE";
 interface PendingPath {
     route: string;
     scope: "page" | "layout";
@@ -174,6 +176,10 @@ interface PendingPath {
     file?: string;
     reason: PendingReason;
     message?: string;
+    /** 1-based line in `file`, when the reason points at one place a human has to go. */
+    line?: number;
+    /** What to do about it, in prose — a recipe, not a diagnosis. @see message */
+    hint?: string;
 }
 /**
  * One path that was already DECLARED before this run — and how honestly.
@@ -237,6 +243,14 @@ interface ConversionReceipt {
     dynamicBindings: DynamicBinding[];
     /** Facts about the repository that shaped this run. OPTIONAL: an older receipt carries none. */
     notes?: ReceiptNote[];
+    /**
+     * Can the visual editor push drafts to this site? OPTIONAL: an older receipt carries none, and a
+     * reader must treat absent as unknown rather than as `"pending"`.
+     */
+    canvas?: {
+        lane: "bridge" | "pending";
+        files?: string[];
+    };
 }
 /**
  * One binding whose `data-bcms-field` is an expression, and where its value is written literally.
@@ -725,6 +739,35 @@ declare function helperSource(dialect: Dialect): string;
  */
 declare function isKnownHelper(content: string, dialect: Dialect): number | null;
 
+/** The recipe an Astro site needs instead — never auto-migrate a site to SSR. */
+declare const SSR_DRAFT_RECIPE: string;
+interface CanvasSource {
+    path: string;
+    content: string;
+    /** The babel AST from `parseFile("jsx", …)`. Absent for every non-jsx dialect. */
+    ast?: unknown;
+}
+interface CanvasResult {
+    lane: "bridge" | "pending";
+    /** Files the bridge was installed in. */
+    files: string[];
+    /** Rewritten contents, by path. Empty when the lane is pending. */
+    edits: Map<string, string>;
+    pending: PendingPath[];
+}
+/**
+ * The one row every Astro conversion carries. Exported so a test names it instead of restating it.
+ */
+declare const ASTRO_LANE_PENDING: PendingPath;
+/**
+ * Install the draft bridge, or say why not.
+ *
+ * `routes` maps a brief route (`/about`) to its slug, so a route written as a literal in the page
+ * can name itself. An Astro project is refused wholesale: bridging it needs a server render, which
+ * is a deploy-shaped decision and never a codemod's.
+ */
+declare function canvasBridge(sources: CanvasSource[], routes: Map<string, string>): CanvasResult;
+
 /**
  * Which files in a repository can possibly render a page's copy.
  *
@@ -1249,4 +1292,4 @@ declare function convertSources(briefIn: Brief, sources: SourceFile[], options?:
     receipt: ConversionReceipt;
 }>;
 
-export { type AstNode, type AttrBinding, type Brief, type BriefPage, type BriefPath, COMPONENT_DIR, CONTENT_DIR, 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 DeclaredPath, type Dialect, type DynamicBinding, type FileDeclaration, type FindSitesResult, HELPER_PATH, HELPER_VERSION, 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, 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, attrsFor, briefDigest, 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 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 DeclaredPath, type Dialect, type DynamicBinding, type FileDeclaration, type FindSitesResult, HELPER_PATH, HELPER_VERSION, 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, attrsFor, 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 };