@thallylabs/migrate 0.2.22 → 0.2.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -43,11 +43,16 @@ interface MigrationNavbarConfig {
43
43
  label: string;
44
44
  href: string;
45
45
  type?: 'github';
46
+ button?: {
47
+ background: string;
48
+ color?: string;
49
+ };
46
50
  }>;
47
51
  /** Explicit null suppresses the starter's sample call to action. */
48
52
  primary?: {
49
53
  label: string;
50
54
  href: string;
55
+ type?: 'github';
51
56
  } | null;
52
57
  /** Local public assets used until an owner uploads a brand replacement. */
53
58
  /** Explicit null requests a text-only brand when the source has no logo. */
@@ -85,6 +90,7 @@ interface MigrationDocsConfig {
85
90
  prefix: string;
86
91
  href: string;
87
92
  default?: boolean;
93
+ hidden?: boolean;
88
94
  }>;
89
95
  shortcuts?: Array<{
90
96
  label: string;
@@ -103,6 +109,13 @@ interface MigrationDocsConfig {
103
109
  decoration?: 'none' | 'grid' | 'gradient';
104
110
  };
105
111
  /** Icon set for content `icon` names; Mintlify's `icons.library` carries through. */
112
+ contextual?: {
113
+ options?: Array<string>;
114
+ };
115
+ colors?: Partial<Record<'light' | 'dark', {
116
+ primary?: string;
117
+ accent?: string;
118
+ }>>;
106
119
  icons?: {
107
120
  library?: 'lucide' | 'fontawesome' | 'tabler';
108
121
  };
@@ -115,6 +128,9 @@ interface MigrationDocsConfig {
115
128
  footer?: MigrationFooterConfig;
116
129
  seo?: {
117
130
  indexing?: 'navigable' | 'all';
131
+ titleSeparator?: string;
132
+ sitemap?: 'navigable';
133
+ metatags?: Record<string, string>;
118
134
  };
119
135
  fonts?: {
120
136
  body?: {
@@ -153,6 +169,10 @@ interface MigrationDocsConfig {
153
169
  name?: string;
154
170
  };
155
171
  };
172
+ /** Mintlify `api.playground.display`; `auth` is carried as `simple`. */
173
+ playground?: {
174
+ display: 'interactive' | 'simple' | 'none';
175
+ };
156
176
  };
157
177
  /** Third-party analytics in Mintlify's `integrations` shape; validated again by the renderer. */
158
178
  integrations?: {
@@ -195,6 +215,9 @@ interface MigrationPage {
195
215
  locale?: string;
196
216
  title: string;
197
217
  navTitle?: string;
218
+ /** Sidebar icon name or image URL from page frontmatter, with its optional style. */
219
+ icon?: string;
220
+ iconType?: 'regular' | 'solid' | 'outline' | 'brands';
198
221
  description: string;
199
222
  /** Keep SEO/search description without repeating it above Docusaurus body copy. */
200
223
  descriptionPlacement?: 'body';
@@ -203,12 +226,16 @@ interface MigrationPage {
203
226
  mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
204
227
  hidden?: boolean;
205
228
  noindex?: boolean;
229
+ /** Social/SEO overrides from `og:*` and `twitter:*` frontmatter, keyed by the migrated frontmatter field. */
230
+ meta?: Partial<Record<'ogTitle' | 'ogDescription' | 'ogImage' | 'twitterTitle' | 'twitterDescription' | 'twitterImage', string>>;
206
231
  /** OpenAPI operation key rendered by Thally instead of ordinary MDX. */
207
232
  openapi?: string;
208
233
  /** Manual API page: `METHOD <url-or-path>`; rendered by Thally's playground. */
209
234
  api?: string;
210
235
  /** Page-level playground auth override: bearer | basic | key | none. */
211
236
  authMethod?: string;
237
+ /** Page-level `playground` override: interactive | simple | none (`auth` becomes `simple`). */
238
+ playground?: 'interactive' | 'simple' | 'none';
212
239
  body: string;
213
240
  source: string;
214
241
  /** Set when the page's frontmatter was invalid YAML; the page is kept with a best-effort salvage. */