@thallylabs/migrate 0.1.1 → 0.2.0
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/README.md +6 -0
- package/dist/index.d.ts +21 -1
- package/dist/index.js +1277 -125
- package/dist/index.js.map +1 -1
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -3,3 +3,9 @@
|
|
|
3
3
|
The shared migration engine used by the Thally CLI, MCP server, and Thally
|
|
4
4
|
Cloud. It imports documentation repositories and public documentation URLs
|
|
5
5
|
into one canonical bundle before any caller writes files.
|
|
6
|
+
|
|
7
|
+
Repository migration includes dedicated Mintlify and Docusaurus adapters.
|
|
8
|
+
Mintlify configuration is projected from `docs.json`/`mint.json`. Docusaurus
|
|
9
|
+
sidebars are parsed as bounded, data-only JSON5—never executed—and preserve
|
|
10
|
+
explicit categories, autogenerated slices, document IDs/slugs, positions,
|
|
11
|
+
generated indexes, admonitions, tabs, and `static/` assets where supported.
|
package/dist/index.d.ts
CHANGED
|
@@ -15,6 +15,7 @@ interface MigrationNavigationTab {
|
|
|
15
15
|
groups?: Array<MigrationNavigationGroup>;
|
|
16
16
|
api?: {
|
|
17
17
|
source: string;
|
|
18
|
+
navigation?: boolean;
|
|
18
19
|
};
|
|
19
20
|
}
|
|
20
21
|
interface MigrationDocsConfig {
|
|
@@ -53,6 +54,8 @@ interface MigrationPage {
|
|
|
53
54
|
title: string;
|
|
54
55
|
description: string;
|
|
55
56
|
keywords: Array<string>;
|
|
57
|
+
/** OpenAPI operation key rendered by Thally instead of ordinary MDX. */
|
|
58
|
+
openapi?: string;
|
|
56
59
|
body: string;
|
|
57
60
|
source: string;
|
|
58
61
|
}
|
|
@@ -117,6 +120,14 @@ interface RepositoryMigrationOptions {
|
|
|
117
120
|
sourceUrl: string;
|
|
118
121
|
docsDir?: string;
|
|
119
122
|
platform?: MigrationPlatform;
|
|
123
|
+
/** @internal Prefix used by additional Docusaurus docs-plugin instances. */
|
|
124
|
+
docusaurusRoutePrefix?: string;
|
|
125
|
+
/** @internal Prevent recursive discovery while importing one plugin root. */
|
|
126
|
+
docusaurusSkipPlugins?: boolean;
|
|
127
|
+
/** @internal Additional docs plugins default to autogenerated navigation. */
|
|
128
|
+
docusaurusSkipSidebar?: boolean;
|
|
129
|
+
/** @internal Static assets are shared across docs-plugin instances. */
|
|
130
|
+
docusaurusSkipAssets?: boolean;
|
|
120
131
|
}
|
|
121
132
|
/** Parse and validate a public GitHub repository URL. */
|
|
122
133
|
declare function parseGitHubRepositoryUrl(rawUrl: string): GitHubRepositorySource;
|
|
@@ -164,7 +175,12 @@ declare function buildNavigationFromPages(pages: Array<MigrationPage>, options?:
|
|
|
164
175
|
|
|
165
176
|
/** Markdown/MDX normalization that preserves every component Thally supports. */
|
|
166
177
|
|
|
167
|
-
|
|
178
|
+
interface MarkdownPageIdentity {
|
|
179
|
+
id: string;
|
|
180
|
+
navigationId: string;
|
|
181
|
+
locale?: string;
|
|
182
|
+
}
|
|
183
|
+
/** Normalize only syntax Thally cannot render; supported source JSX stays intact. */
|
|
168
184
|
declare function normalizeMdx(body: string): string;
|
|
169
185
|
/** Parse source Markdown or MDX into the canonical page representation. */
|
|
170
186
|
declare function parseMarkdownPage(input: {
|
|
@@ -173,6 +189,8 @@ declare function parseMarkdownPage(input: {
|
|
|
173
189
|
locale?: string;
|
|
174
190
|
raw: string;
|
|
175
191
|
source: string;
|
|
192
|
+
/** Resolve platform-specific routes from the already-parsed frontmatter. */
|
|
193
|
+
resolveIdentity?: (frontmatter: Record<string, unknown>, fallback: MarkdownPageIdentity) => MarkdownPageIdentity;
|
|
176
194
|
}): MigrationPage | null;
|
|
177
195
|
|
|
178
196
|
/** Render canonical migration bundles into a portable Thally repository tree. */
|
|
@@ -192,6 +210,8 @@ declare function renderMigrationFiles(bundle: MigrationBundle, options?: {
|
|
|
192
210
|
|
|
193
211
|
interface UrlMigrationOptions {
|
|
194
212
|
sourceUrl: string;
|
|
213
|
+
/** Explicit caller selection; omitted callers retain source auto-detection. */
|
|
214
|
+
platform?: MigrationPlatform;
|
|
195
215
|
fetcher?: MigrationFetcher;
|
|
196
216
|
maxPages?: number;
|
|
197
217
|
concurrency?: number;
|