@thallylabs/migrate 0.2.9 → 0.2.11

package/README.md

@@ -26,6 +26,25 @@ instead of silently dropping that API tab's reference. AsyncAPI has no Thally
 renderer, so it always produces a clear warning naming the spec instead of
 disappearing.
 
+In-content links to auto-generated API operation pages are rewritten to the
+matching Thally `/api/...` route. A link under a known API section that matches
+no operation points to that section's overview page instead, and one warning
+lists the affected links (up to ten). A Mintlify default version's pages also
+get a redirect from their address without the version segment, since the
+original site serves them both ways.
+
+A repository is limited to 5,000 documentation files and, separately, 5,000
+asset files. Past that, files are kept in navigation order with the default
+version first, then pages not listed in navigation, and one warning counts and
+names (the first three of) the pages left out and suggests `--docs-dir` to
+migrate a smaller part of the repository. Scanning itself stops after 100,000
+files with its own warning. Individual assets over 25 MB, or beyond 500 MB in
+total, are not copied and are warned about one by one.
+
+Headings written with an explicit `{#custom-id}` become a preceding
+`<a id="custom-id"></a>` anchor and keep their text, so links to that id still
+work and the page still compiles as MDX.
+
 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

package/dist/index.d.ts

@@ -47,12 +47,13 @@ interface MigrationNavbarConfig {
         href: string;
     } | null;
     /** Local public assets used until an owner uploads a brand replacement. */
+    /** Explicit null requests a text-only brand when the source has no logo. */
     logo?: {
         light: string;
         dark?: string;
         showTitle?: boolean;
         rightText?: string;
-    };
+    } | null;
 }
 interface MigrationFooterConfig {
     socials?: Record<string, string>;
@@ -76,6 +77,15 @@ interface MigrationDocsConfig {
         display?: 'tabs' | 'dropdown';
     };
     theme?: 'default' | 'maple' | 'sharp' | 'minimal';
+    appearance?: {
+        default?: 'system' | 'light' | 'dark';
+        showToggle?: boolean;
+    };
+    background?: {
+        image?: string;
+        imageDark?: string;
+        decoration?: 'none' | 'grid' | 'gradient';
+    };
     /** Icon set for content `icon` names; Mintlify's `icons.library` carries through. */
     icons?: {
         library?: 'lucide' | 'fontawesome' | 'tabler';
@@ -149,6 +159,8 @@ interface MigrationPage {
     openapi?: string;
     body: string;
     source: string;
+    /** Set when the page's frontmatter was invalid YAML; the page is kept with a best-effort salvage. */
+    frontmatterError?: string;
 }
 interface MigrationAsset {
     /** Path below `public`, always normalized and traversal-free. */
@@ -166,6 +178,11 @@ interface MigrationBundle {
     platform: MigrationPlatform;
     pages: Array<MigrationPage>;
     assets: Array<MigrationAsset>;
+    /** Repository-configured remote specs awaiting a bounded network fetch by the host. */
+    remoteApiSpecs?: Array<{
+        url: string;
+        tabLabel?: string;
+    }>;
     /** Customer-owned component source and registry; paths are repository-relative. */
     componentFiles?: Array<RenderedMigrationFile>;
     docsConfig: MigrationDocsConfig;
@@ -374,6 +391,13 @@ declare function readFernConfig(fernRoot: string): {
 declare function projectFernNavigation(input: {
     config: Record<string, unknown>;
     fernRoot: string;
+    /**
+     * The whole repository checkout — the security boundary for anything a
+     * config file references (e.g. a `versions:` file living outside
+     * `fern/`). Defaults to `fernRoot` for callers with no wider repository
+     * context (e.g. unit tests), which reproduces the previous fernRoot-only
+     * confinement.
+     */
     repositoryRoot?: string;
 }): FernNavigationResult;
 
@@ -431,4 +455,11 @@ 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, addMintlifyDirectoryRedirects, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, gitmodulePaths, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectFernNavigation, projectMintlifyNavigation, pruneMissingNavigationPages, readFernConfig, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };
+/**
+ * Attach safely downloaded specs to the exact authored API tabs. Source links
+ * to Mintlify's tag/summary routes receive redirects only when an operation
+ * can be identified uniquely; guessing would silently route to wrong APIs.
+ */
+declare function hydrateRemoteApiSpecs(bundle: MigrationBundle, fetcher?: MigrationFetcher): 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, addMintlifyDirectoryRedirects, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, gitmodulePaths, hydrateRemoteApiSpecs, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectFernNavigation, projectMintlifyNavigation, pruneMissingNavigationPages, readFernConfig, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };