@thallylabs/migrate 0.2.33 → 0.2.35

package/README.md

@@ -92,9 +92,48 @@ 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.
 
+`METHOD /path` entries (`"POST /v2/keys.createKey"`) under a container that
+binds an `openapi` spec become `api.groups` on the tab that spec binds to:
+nested groups, icons and authored order are kept, and page entries stay in the
+tab's own groups (a group that mixes pages and operations is split, so the
+sidebar lists the API groups after the page groups). Operations written
+straight under a tab form a group named after the tab, at their place among the
+tab's own groups (each uninterrupted run is its own group, so authored order is
+kept). Hidden groups (and containers under one), groups under access-restricted
+containers, and groups left empty are left out. Groups nest at most 32 levels
+deep, as the renderer follows no deeper: operations below that are not migrated,
+and one warning says so. With `navigation.languages`, only the default language's
+containers contribute groups; operation entries under another language are
+reported, since its API tab is the default language's.
+When several containers bind one spec to the same tab (one API tab per product,
+say), their groups are concatenated in order and an operation already listed
+earlier in that tab is dropped (the method is compared without case, the path
+exactly), unless one of those containers lists no operation (Mintlify generated
+every operation there), in which case the tab gets no `api.groups` and keeps the
+generated, tag-grouped navigation. A container whose operations are all hidden or
+access-restricted adds no groups but still counts as listing operations; when
+every container bound to a tab is like that, the tab gets `navigation: false`
+(the source sidebar showed none of those operations, so no generated list is
+added). Operations dropped only for nesting too deep are Thally's limit, not the
+author's choice: such a container counts as listing nothing, so the tab keeps
+the generated navigation. Groups with the same title are not folded together. With `api.groups`
+the authored list is the tab's navigation, so `navigation: false` is not
+written. Operation entries with no `openapi` container above them, and every one in a
+site imported by URL, cannot be placed: one warning says they were not added to the API navigation, and the
+operations still have their pages. This is separate from a `directory`'s flat
+operation list, which still only drives the endpoint redirects.
+
+Mintlify `styling.eyebrows: "breadcrumbs"` becomes `eyebrow: "path"` (the full
+group path above the page title); `"section"` or no setting writes nothing.
+
 Page `openapi:` frontmatter with a spec prefix
 (`openapi: "specs/openapi-b.yaml GET /widgets/{id}"`) is rewritten to where the
-spec lands in the output (`/openapi-b.yaml GET /widgets/{id}`). A prefix naming
+spec lands in the output (`/openapi-b.yaml GET /widgets/{id}`). As in Mintlify,
+the prefix may name the spec by path, by file name, or by file name without its
+extension (`v3-openapi GET /tasks`); a name that fits more than one spec is kept
+and reported with its candidates. A declared spec that a published page names
+but that cannot be its tab's spec is bound through a hidden tab, so the page
+still renders its endpoint. A prefix naming
 a spec that was not migrated is kept and reported. Manual API pages keep their
 `api:` and `authMethod:` frontmatter, and `api.mdx.server` / `api.mdx.auth` map
 into `docs.json`; invalid values are dropped with a warning.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { M as MigrationPage, a as MigrationAsset, b as MigrationNavigationGroup, R as RenderedMigrationFile, c as MigrationWarning, d as MigrationFetcher, e as MigrationPlatform, f as MigrationBundle, g as MigrationDocsConfig } from './url-migration-_wVauqSg.js';
-export { h as MigrationCapture, i as MigrationCaptureProvider, j as MigrationCaptureState, k as MigrationCapturedAsset, l as MigrationEvidence, m as MigrationFetchRequest, n as MigrationFetchResponse, o as MigrationJournalAsset, p as MigrationNavigationOccurrence, q as MigrationNavigationTab, U as UrlMigrationCheckpoint, r as UrlMigrationCheckpointDelta, s as UrlMigrationIssue, t as UrlMigrationRecord, u as UrlMigrationRun, v as UrlMigrationRunOptions, w as UrlMigrationValidation, x as classifyMigrationResponse, y as mergeMigrationConfig, z as renderMigrationFiles, A as runUrlMigration, B as validateUrlMigration } from './url-migration-_wVauqSg.js';
+import { M as MigrationPage, a as MigrationAsset, b as MigrationNavigationGroup, R as RenderedMigrationFile, c as MigrationWarning, d as MigrationFetcher, e as MigrationPlatform, f as MigrationBundle, g as MigrationDocsConfig } from './url-migration-peVzTLjL.js';
+export { h as MigrationCapture, i as MigrationCaptureProvider, j as MigrationCaptureState, k as MigrationCapturedAsset, l as MigrationEvidence, m as MigrationFetchRequest, n as MigrationFetchResponse, o as MigrationJournalAsset, p as MigrationNavigationOccurrence, q as MigrationNavigationTab, U as UrlMigrationCheckpoint, r as UrlMigrationCheckpointDelta, s as UrlMigrationIssue, t as UrlMigrationRecord, u as UrlMigrationRun, v as UrlMigrationRunOptions, w as UrlMigrationValidation, x as classifyMigrationResponse, y as mergeMigrationConfig, z as renderMigrationFiles, A as runUrlMigration, B as validateUrlMigration } from './url-migration-peVzTLjL.js';
 export { isPassiveSvg } from './svg-policy.js';
 
 /**
@@ -182,6 +182,11 @@ interface MintlifyProjectionOptions {
      * when the repository was not mapped with `--source-ref`.
      */
     resolveSourceRef?: (repo: string) => Array<string | MigrationNavigationGroup> | null;
+    /**
+     * Set by a caller that binds the authored operation lists (`mintlifyNavigationApiReferences`
+     * `groups`) to their API tabs. Without it every "METHOD /path" entry is reported as not carried over.
+     */
+    operationGroups?: boolean;
 }
 /** Preserve Mintlify's implicit `/section` route for section landing pages. */
 declare function addMintlifyDirectoryRedirects(config: MigrationDocsConfig, pages: Array<MigrationPage>): MigrationDocsConfig;