@see-ms/converter 1.0.0 → 1.1.0

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { ConversionOptions, FieldMapping, CollectionMapping, CMSManifest, StrapiSchema } from '@see-ms/types';
-export { ConversionOptions } from '@see-ms/types';
+import { ConversionOptions, SeeMSConfig, SharedComponent, ConversionReport, FieldMapping, CollectionMapping, CMSManifest, StrapiSchema } from '@see-ms/types';
+export { ConversionOptions, ConversionReport, SeeMSConfig, SharedComponent } from '@see-ms/types';
+import { CheerioAPI, Cheerio } from 'cheerio';
 
 /**
  * Main conversion logic
@@ -7,14 +8,120 @@ export { ConversionOptions } from '@see-ms/types';
 
 declare function convertWebflowExport(options: ConversionOptions): Promise<void>;
 
+/**
+ * Boilerplate cloning and setup utilities
+ */
+/**
+ * Setup boilerplate in output directory
+ */
+type ProjectTarget = 'nuxt' | 'astro-vue';
+declare function setupBoilerplate(boilerplateSource: string | undefined, outputDir: string, target?: ProjectTarget): Promise<void>;
+
+/**
+ * File system utilities for copying Webflow assets
+ */
+
+interface AssetPaths {
+    css: string[];
+    images: string[];
+    fonts: string[];
+    js: string[];
+}
+/**
+ * Scan Webflow export directory for assets
+ */
+declare function scanAssets(webflowDir: string): Promise<AssetPaths>;
+
+interface PageRouteInfo {
+    sourcePath: string;
+    pageId: string;
+    route: string;
+    outputPath: string;
+}
+
+interface ConversionAnalysis {
+    inputDir: string;
+    pages: PageRouteInfo[];
+    assets: Awaited<ReturnType<typeof scanAssets>>;
+    componentCandidates: SharedComponent[];
+    warnings: string[];
+}
+declare function analyzeWebflowExport(inputDir: string, config?: SeeMSConfig): Promise<ConversionAnalysis>;
+declare function createConversionReport(input: {
+    analysis: ConversionAnalysis;
+    provider: "strapi" | "contentful" | "sanity";
+    stages: ConversionReport["stages"];
+    components: SharedComponent[];
+    fields: number;
+    collections: number;
+    schemas: number;
+    seedPages: number;
+    warnings?: string[];
+}): ConversionReport;
+declare function writeConversionReport(outputDir: string, report: ConversionReport): Promise<void>;
+declare function renderReportMarkdown(report: ConversionReport): string;
+
+declare function mergeConfig(base?: SeeMSConfig, override?: SeeMSConfig): SeeMSConfig;
+declare function loadSeeMSConfig(configPath?: string): Promise<SeeMSConfig>;
+declare function writeSeeMSConfig(outputDir: string, config: SeeMSConfig): Promise<void>;
+declare function normalizeConfig(config?: SeeMSConfig): SeeMSConfig;
+
+/**
+ * Strapi Complete Setup Script
+ * Installs schemas, uploads images, and seeds content - all in one command
+ */
+interface SetupOptions {
+    projectDir: string;
+    strapiDir: string;
+    strapiUrl?: string;
+    apiToken?: string;
+    ignoreSavedToken?: boolean;
+    scaffold?: boolean;
+    scaffoldOptions?: StrapiScaffoldOptions;
+}
+interface StrapiScaffoldOptions {
+    strapiDir: string;
+    packageManager?: "npm" | "pnpm" | "yarn";
+    install?: boolean;
+    run?: boolean;
+    gitInit?: boolean;
+    typescript?: boolean;
+}
+/**
+ * Main setup function
+ * Exported for use by CLI and direct execution
+ */
+declare function completeSetup(options: SetupOptions): Promise<void>;
+/**
+ * Scaffold a new Strapi project using the official Strapi create CLI.
+ */
+declare function scaffoldStrapiProject(options: StrapiScaffoldOptions): Promise<void>;
+
 /**
  * Auto-detection of editable fields from Vue components
+ * Enhanced with universal detection, expanded collection keywords, and data-cms attributes
  */
 
+/**
+ * Detection options
+ */
+interface DetectionOptions {
+    /** Custom collection classes to detect */
+    collectionClasses?: string[];
+    /** Minimum items for collection detection */
+    collectionMin?: number;
+    /** Enable universal detection (default: true) */
+    universalDetection?: boolean;
+    /** Selectors to ignore */
+    ignoreSelectors?: string[];
+    /** Classes to ignore */
+    ignoreClasses?: string[];
+}
 /**
  * Detect editable fields from Vue template content
+ * Universal detection: finds ALL text, images, and links
  */
-declare function detectEditableFields(templateHtml: string): {
+declare function detectEditableFields(templateHtml: string, options?: DetectionOptions): {
     fields: Record<string, FieldMapping>;
     collections: Record<string, CollectionMapping>;
 };
@@ -23,12 +130,33 @@ declare function detectEditableFields(templateHtml: string): {
  * Manifest generation
  */
 
+/**
+ * Manifest generation options
+ */
+interface ManifestOptions {
+    /** Custom collection classes to detect */
+    collectionClasses?: string[];
+    /** Mapping of collection class names to display names */
+    collectionNames?: Record<string, string>;
+    /** Shared components extracted during conversion */
+    sharedComponents?: SharedComponent[];
+    /** Directory containing extracted shared Vue components */
+    componentsDir?: string;
+    /** Selectors to ignore during field detection */
+    ignoreSelectors?: string[];
+    /** Classes to ignore during field detection */
+    ignoreClasses?: string[];
+    /** CMS provider */
+    provider?: 'strapi' | 'contentful' | 'sanity';
+    /** Route lookup by page id */
+    pageRoutes?: Record<string, string>;
+}
 /**
  * Generate CMS manifest from analyzed pages
  */
-declare function generateManifest(pagesDir: string): Promise<CMSManifest>;
+declare function generateManifest(pagesDir: string, options?: ManifestOptions): Promise<CMSManifest>;
 /**
- * Read manifest from file
+ * Read manifest from file (from public directory)
  */
 declare function readManifest(outputDir: string): Promise<CMSManifest>;
 
@@ -43,26 +171,132 @@ declare function generateSchemas(_manifestPath: string, _cmsType: string): Promi
  * Transform CMS manifest to Strapi schemas
  */
 
+/**
+ * Link component schema for Strapi
+ * This is a shared component that represents a link with URL and text
+ */
+declare const LINK_COMPONENT_SCHEMA: {
+    collectionName: string;
+    info: {
+        displayName: string;
+        icon: string;
+        description: string;
+    };
+    options: {};
+    attributes: {
+        url: {
+            type: "string";
+            required: boolean;
+        };
+        text: {
+            type: "string";
+            required: boolean;
+        };
+        newTab: {
+            type: "boolean";
+            default: boolean;
+        };
+    };
+};
 /**
  * Transform entire manifest to Strapi schemas
+ * Returns content type schemas and optionally the link component schema
  */
 declare function manifestToSchemas(manifest: CMSManifest): Record<string, StrapiSchema>;
+/**
+ * Get the link component schema if needed
+ */
+declare function getLinkComponentSchema(manifest: CMSManifest): typeof LINK_COMPONENT_SCHEMA | null;
 
 /**
- * Boilerplate cloning and setup utilities
+ * Transform static Vue files to use reactive content from Strapi
  */
+
 /**
- * Setup boilerplate in output directory
+ * Transform all Vue pages in a directory
  */
-declare function setupBoilerplate(boilerplateSource: string | undefined, outputDir: string): Promise<void>;
+declare function transformAllVuePages(pagesDir: string, manifest: CMSManifest, options?: {
+    target?: "nuxt" | "astro-vue";
+}): Promise<void>;
 
 /**
- * Transform static Vue files to use reactive content from Strapi
+ * Component Extractor
+ * Detects reused HTML sections across pages and extracts them as Vue components
  */
 
 /**
- * Transform all Vue pages in a directory
+ * Parsed page with its HTML content
+ */
+interface ParsedPage {
+    name: string;
+    filePath: string;
+    sourcePath: string;
+    $: CheerioAPI;
+    sections: SectionInfo[];
+}
+/**
+ * Information about a section in a page
+ */
+interface SectionInfo {
+    /** CSS selector for the section */
+    selector: string;
+    /** Structural fingerprint (hash of DOM structure) */
+    fingerprint: string;
+    /** Exact-ish HTML fingerprint with normalized volatile attributes */
+    exactFingerprint: string;
+    /** Cheerio element reference */
+    $element: Cheerio<any>;
+    /** Original HTML content */
+    html: string;
+    /** Suggested component name */
+    suggestedName: string;
+}
+/**
+ * Extracted component ready to be written
+ */
+interface ExtractedComponent {
+    name: string;
+    selector: string;
+    pages: string[];
+    html: string;
+    fingerprint: string;
+    confidence: "high" | "medium" | "low";
+    reason: string;
+    role?: "shared-section" | "collection-item";
+    collectionName?: string;
+    collectionStorage?: "collection-type" | "page-repeatable" | "global-repeatable";
+    contentMode?: "shared-global" | "per-page" | "auto";
+}
+interface ComponentExtractionOptions {
+    match?: "exact" | "structure";
+    minOccurrences?: number;
+    minPages?: number;
+    minSectionSize?: number;
+    writeConfidence?: "high" | "medium" | "low";
+    include?: string[];
+    exclude?: string[];
+    rules?: Array<{
+        name: string;
+        selector: string;
+        role?: "shared-section" | "collection-item";
+        collectionName?: string;
+        collectionStorage?: "collection-type" | "page-repeatable" | "global-repeatable";
+        contentMode?: "shared-global" | "per-page" | "auto";
+        minOccurrences?: number;
+        minPages?: number;
+    }>;
+}
+/**
+ * Parse all HTML files in a directory
+ */
+declare function parseAllPages(inputDir: string, options?: Pick<ComponentExtractionOptions, "minSectionSize">): Promise<ParsedPage[]>;
+/**
+ * Find shared sections across pages (appear in 2+ pages with similar structure)
+ */
+declare function findSharedSections(pages: ParsedPage[], options?: Pick<ComponentExtractionOptions, "match" | "minOccurrences" | "minPages" | "include" | "exclude" | "rules">): ExtractedComponent[];
+/**
+ * Main entry point: extract shared components from HTML pages
  */
-declare function transformAllVuePages(pagesDir: string, manifest: CMSManifest): Promise<void>;
+declare function extractSharedComponents(inputDir: string, outputDir: string, options?: ComponentExtractionOptions): Promise<SharedComponent[]>;
 
-export { convertWebflowExport, detectEditableFields, generateManifest, generateSchemas, manifestToSchemas, readManifest, setupBoilerplate, transformAllVuePages };
+export { LINK_COMPONENT_SCHEMA, analyzeWebflowExport, completeSetup, convertWebflowExport, createConversionReport, detectEditableFields, extractSharedComponents, findSharedSections, generateManifest, generateSchemas, getLinkComponentSchema, loadSeeMSConfig, manifestToSchemas, mergeConfig, normalizeConfig, parseAllPages, readManifest, renderReportMarkdown, scaffoldStrapiProject, setupBoilerplate, transformAllVuePages, writeConversionReport, writeSeeMSConfig };