@thallylabs/migrate 0.2.22 → 0.2.24

package/dist/index.d.ts

@@ -43,11 +43,16 @@ interface MigrationNavbarConfig {
         label: string;
         href: string;
         type?: 'github';
+        button?: {
+            background: string;
+            color?: string;
+        };
     }>;
     /** Explicit null suppresses the starter's sample call to action. */
     primary?: {
         label: string;
         href: string;
+        type?: 'github';
     } | 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. */
@@ -85,6 +90,7 @@ interface MigrationDocsConfig {
             prefix: string;
             href: string;
             default?: boolean;
+            hidden?: boolean;
         }>;
         shortcuts?: Array<{
             label: string;
@@ -103,6 +109,13 @@ interface MigrationDocsConfig {
         decoration?: 'none' | 'grid' | 'gradient';
     };
     /** Icon set for content `icon` names; Mintlify's `icons.library` carries through. */
+    contextual?: {
+        options?: Array<string>;
+    };
+    colors?: Partial<Record<'light' | 'dark', {
+        primary?: string;
+        accent?: string;
+    }>>;
     icons?: {
         library?: 'lucide' | 'fontawesome' | 'tabler';
     };
@@ -115,6 +128,9 @@ interface MigrationDocsConfig {
     footer?: MigrationFooterConfig;
     seo?: {
         indexing?: 'navigable' | 'all';
+        titleSeparator?: string;
+        sitemap?: 'navigable';
+        metatags?: Record<string, string>;
     };
     fonts?: {
         body?: {
@@ -153,6 +169,10 @@ interface MigrationDocsConfig {
                 name?: string;
             };
         };
+        /** Mintlify `api.playground.display`; `auth` is carried as `simple`. */
+        playground?: {
+            display: 'interactive' | 'simple' | 'none';
+        };
     };
     /** Third-party analytics in Mintlify's `integrations` shape; validated again by the renderer. */
     integrations?: {
@@ -195,6 +215,9 @@ interface MigrationPage {
     locale?: string;
     title: string;
     navTitle?: string;
+    /** Sidebar icon name or image URL from page frontmatter, with its optional style. */
+    icon?: string;
+    iconType?: 'regular' | 'solid' | 'outline' | 'brands';
     description: string;
     /** Keep SEO/search description without repeating it above Docusaurus body copy. */
     descriptionPlacement?: 'body';
@@ -203,12 +226,16 @@ interface MigrationPage {
     mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
     hidden?: boolean;
     noindex?: boolean;
+    /** Social/SEO overrides from `og:*` and `twitter:*` frontmatter, keyed by the migrated frontmatter field. */
+    meta?: Partial<Record<'ogTitle' | 'ogDescription' | 'ogImage' | 'twitterTitle' | 'twitterDescription' | 'twitterImage', string>>;
     /** OpenAPI operation key rendered by Thally instead of ordinary MDX. */
     openapi?: string;
     /** Manual API page: `METHOD <url-or-path>`; rendered by Thally's playground. */
     api?: string;
     /** Page-level playground auth override: bearer | basic | key | none. */
     authMethod?: string;
+    /** Page-level `playground` override: interactive | simple | none (`auth` becomes `simple`). */
+    playground?: 'interactive' | 'simple' | 'none';
     body: string;
     source: string;
     /** Set when the page's frontmatter was invalid YAML; the page is kept with a best-effort salvage. */
@@ -228,6 +255,18 @@ interface MigrationWarning {
     message: string;
     source?: string;
 }
+/** A repository-configured remote OpenAPI spec, downloaded after the bundle is built. */
+interface RemoteApiSpec {
+    url: string;
+    tabLabel?: string;
+    parentTab?: string;
+    icon?: string;
+    hidden?: boolean;
+    /** Operation keys (`get /x`) only access-restricted pages document; marked `x-excluded` after download. */
+    withheldOperations?: Array<string>;
+    /** Operation keys published pages or docs.json also name; keeps a shared `$ref` path item public. */
+    keptOperations?: Array<string>;
+}
 interface MigrationBundle {
     sourceUrl: string;
     sourceKind: 'repository' | 'url';
@@ -235,13 +274,7 @@ interface MigrationBundle {
     pages: Array<MigrationPage>;
     assets: Array<MigrationAsset>;
     /** Repository-configured remote specs awaiting a bounded network fetch by the host. */
-    remoteApiSpecs?: Array<{
-        url: string;
-        tabLabel?: string;
-        parentTab?: string;
-        icon?: string;
-        hidden?: boolean;
-    }>;
+    remoteApiSpecs?: Array<RemoteApiSpec>;
     /** Customer-owned component source and registry; paths are repository-relative. */
     componentFiles?: Array<RenderedMigrationFile>;
     /** Access-restricted source pages, written outside every published path. */