@thallylabs/migrate 0.2.1 → 0.2.3

package/README.md

@@ -5,7 +5,17 @@ Cloud. It imports documentation repositories and public documentation URLs
 into one canonical bundle before any caller writes files.
 
 Repository migration includes dedicated Mintlify and Docusaurus adapters.
-Mintlify configuration is projected from `docs.json`/`mint.json`. Docusaurus
-sidebars are parsed as bounded, data-only JSON5—never executed—and preserve
-explicit categories, autogenerated slices, document IDs/slugs, positions,
-generated indexes, admonitions, tabs, and `static/` assets where supported.
+Mintlify repositories are located inside monorepos automatically. Their
+`docs.json`/`mint.json` page and group trees are projected without flattening
+authored nesting or order. The adapter supports tabs, dropdowns, products,
+versions, languages, and reusable `$ref` navigation files; it also preserves
+dropdown presentation, collection descriptions and icons, explicit default
+versions, page route casing, redirects, local snippets, static assets,
+compatible page frontmatter, site identity, and OpenAPI configuration. For public Mintlify
+sites, the URL adapter reads the structured configuration embedded in the
+rendered application before falling back to DOM link inference.
+
+Docusaurus sidebars are parsed as bounded, data-only JSON5—never executed—and
+preserve explicit categories, autogenerated slices, document IDs/slugs,
+positions, generated indexes, admonitions, tabs, and `static/` assets where
+supported.

package/dist/index.d.ts

@@ -7,20 +7,81 @@ type MigrationPlatform = 'mintlify' | 'docusaurus' | 'gitbook' | 'nextra' | 'vit
 interface MigrationNavigationGroup {
     group: string;
     icon?: string;
+    hidden?: boolean;
     pages: Array<string | MigrationNavigationGroup>;
 }
 interface MigrationNavigationTab {
     tab: string;
+    description?: string;
+    icon?: string;
     href?: string;
+    hidden?: boolean;
+    /** Root page/group nodes used when the source has no synthetic section heading. */
+    pages?: Array<string | MigrationNavigationGroup>;
     groups?: Array<MigrationNavigationGroup>;
     api?: {
         source: string;
         navigation?: boolean;
     };
 }
+interface MigrationBannerConfig {
+    content: string | Record<string, string>;
+    dismissible?: boolean;
+    id?: string;
+    revision?: string;
+    type?: 'info' | 'warning' | 'critical';
+    color?: {
+        light?: string;
+        dark?: string;
+    };
+}
+interface MigrationNavbarConfig {
+    links?: Array<{
+        label: string;
+        href: string;
+        type?: 'github';
+    }>;
+    primary?: {
+        label: string;
+        href: string;
+    };
+}
+interface MigrationFooterConfig {
+    socials?: Record<string, string>;
+    links?: Array<{
+        heading: string;
+        items: Array<{
+            label: string;
+            href: string;
+        }>;
+    }>;
+}
 interface MigrationDocsConfig {
     tabs: Array<MigrationNavigationTab>;
+    navigation?: {
+        /** How sibling documentation collections are presented to readers. */
+        display?: 'tabs' | 'dropdown';
+    };
     theme?: 'default' | 'maple' | 'sharp' | 'minimal';
+    banner?: MigrationBannerConfig;
+    navbar?: MigrationNavbarConfig;
+    footer?: MigrationFooterConfig;
+    seo?: {
+        indexing?: 'navigable' | 'all';
+    };
+    fonts?: {
+        body?: {
+            family: string;
+            weight?: Array<string>;
+        };
+        heading?: {
+            family: string;
+            weight?: Array<string>;
+        };
+    };
+    feedback?: {
+        thumbsRating?: boolean;
+    };
     ai?: {
         chat?: boolean;
         label?: string;
@@ -52,8 +113,13 @@ interface MigrationPage {
     navigationId: string;
     locale?: string;
     title: string;
+    navTitle?: string;
     description: string;
+    badge?: string;
     keywords: Array<string>;
+    mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
+    hidden?: boolean;
+    noindex?: boolean;
     /** OpenAPI operation key rendered by Thally instead of ordinary MDX. */
     openapi?: string;
     body: string;
@@ -76,6 +142,10 @@ interface MigrationBundle {
     pages: Array<MigrationPage>;
     assets: Array<MigrationAsset>;
     docsConfig: MigrationDocsConfig;
+    site?: {
+        name?: string;
+        description?: string;
+    };
     warnings: Array<MigrationWarning>;
     stats: {
         discovered: number;
@@ -134,7 +204,7 @@ declare function parseGitHubRepositoryUrl(rawUrl: string): GitHubRepositorySourc
 /** Clone a repository without a shell; callers own and remove `targetDir`. */
 declare function cloneGitHubRepository(source: GitHubRepositorySource, targetDir: string): Promise<void>;
 /** Detect a supported repository docs platform from unambiguous config files. */
-declare function detectRepositoryPlatform(repositoryDir: string): MigrationPlatform;
+declare function detectRepositoryPlatform(repositoryDir: string, docsDir?: string): MigrationPlatform;
 /** Pick the first conventional content root containing Markdown. */
 declare function detectRepositoryDocsDir(repositoryDir: string): string;
 /** Import an already-available repository directory into a canonical bundle. */
@@ -156,10 +226,16 @@ interface MintlifyNavigationResult {
     pageReferences: Array<MintlifyPageReference>;
     warnings: Array<MigrationWarning>;
 }
+interface MintlifyProjectionOptions {
+    /** Public URL migrations may expose page hrefs including the docs mount path. */
+    pathPrefix?: string;
+}
+/** Preserve Mintlify's implicit `/section` route for section landing pages. */
+declare function addMintlifyDirectoryRedirects(config: MigrationDocsConfig, pages: Array<MigrationPage>): MigrationDocsConfig;
 /** Read `docs.json`/`mint.json`, including bounded local JSON references. */
 declare function readMintlifyConfig(repositoryRoot: string): Record<string, unknown> | null;
 /** Convert current and legacy Mintlify navigation into Thally's schema. */
-declare function projectMintlifyNavigation(config: Record<string, unknown>): MintlifyNavigationResult;
+declare function projectMintlifyNavigation(config: Record<string, unknown>, options?: MintlifyProjectionOptions): MintlifyNavigationResult;
 interface GeneratedNavigationOptions {
     /** Dedicated docs platforms expose their primary sections as top-level tabs. */
     topLevelTabs?: boolean;
@@ -224,4 +300,4 @@ declare const defaultMigrationFetcher: MigrationFetcher;
 /** Crawl one public docs origin into a canonical, caller-independent bundle. */
 declare function migrateUrl(options: UrlMigrationOptions): Promise<MigrationBundle>;
 
-export { type GitHubRepositorySource, type MigrationAsset, type MigrationBundle, type MigrationDocsConfig, type MigrationFetchRequest, type MigrationFetchResponse, type MigrationFetcher, type MigrationNavigationGroup, type MigrationNavigationTab, type MigrationPage, type MigrationPlatform, type MigrationWarning, type RenderedMigrationFile, type RepositoryMigrationOptions, type UrlMigrationOptions, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectMintlifyNavigation, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };
+export { type GitHubRepositorySource, type MigrationAsset, type MigrationBundle, type MigrationDocsConfig, type MigrationFetchRequest, type MigrationFetchResponse, type MigrationFetcher, type MigrationNavigationGroup, type MigrationNavigationTab, type MigrationPage, type MigrationPlatform, type MigrationWarning, type RenderedMigrationFile, type RepositoryMigrationOptions, type UrlMigrationOptions, addMintlifyDirectoryRedirects, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectMintlifyNavigation, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };