@thallylabs/migrate 0.2.40 → 0.2.41

package/dist/{url-run-DFnoqEi-.d.ts → url-run-mSKFqHx_.d.ts}

@@ -195,6 +195,25 @@ interface MigrationApiGroup {
     icon?: string;
     pages: Array<string | MigrationApiGroup>;
 }
+/**
+ * Where an API tab sat in the source navigation, kept for the tab that lists its operations as pages: the tab as the projection
+ * built it (label, icon, presentation; no content) and the labels of the tabs before it, nearest first. Its API tab is not in
+ * `docsConfig.tabs` until the spec is bound (a remote spec only after its download), so the tab is put back after the first
+ * of those that is still there, or first when it had none.
+ */
+interface EndpointTabSlot {
+    tab: MigrationNavigationTab;
+    preceding: Array<string>;
+}
+/**
+ * A spec whose `METHOD /path` operations docs.json lists, served by Mintlify as one generated page each at
+ * `/<directory>/<first tag>/<summary>`: they become pages of that tab rather than an API-bound tab's operations.
+ */
+interface EndpointPagesTarget {
+    /** Mintlify's output folder for the generated pages (no surrounding slashes); `api-reference`, Mintlify's default, when docs.json names none. */
+    directory: string;
+    slot?: EndpointTabSlot;
+}
 interface MigrationNavigationTab {
     tab: string;
     /** Reader-facing label when `tab` includes a version for unique identity. */
@@ -271,10 +290,14 @@ interface MigrationDocsConfig {
     breadcrumbs?: boolean;
     /** `path` shows the full group path above the title (Mintlify `styling.eyebrows: "breadcrumbs"`); the default shows the nearest group. */
     eyebrow?: 'group' | 'path';
+    /** `true` renders straight quotes in prose as curly ones, as Mintlify does. */
+    smartQuotes?: boolean;
     tabs: Array<MigrationNavigationTab>;
     navigation?: {
         /** How sibling documentation collections are presented to readers. */
         display?: 'tabs' | 'dropdown';
+        /** `all` keeps the heading of a sidebar group named after its tab, as Mintlify does. */
+        groupHeadings?: 'all';
         versions?: Array<{
             label: string;
             prefix: string;
@@ -414,13 +437,15 @@ interface MigrationPage {
     icon?: string;
     iconType?: 'regular' | 'solid' | 'outline' | 'brands';
     description: string;
-    /** Keep SEO/search description without repeating it above Docusaurus body copy. */
-    descriptionPlacement?: 'body';
+    /** Keep the SEO/search summary while prose is already in the body, or comes from the bound operation. */
+    descriptionPlacement?: 'body' | 'operation';
     badge?: string;
     keywords: Array<string>;
     mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
     hidden?: boolean;
     noindex?: boolean;
+    /** Mintlify frontmatter `url`: a web address the page's sidebar entry leaves for, which the page's own path redirects to. */
+    externalUrl?: string;
     /**
      * Reader access groups (frontmatter `groups`): trimmed, non-empty names the
      * runtime matches exactly. The page needs a signed-in reader in one of them.
@@ -477,6 +502,8 @@ interface RemoteApiSpec {
     groups?: Array<MigrationApiGroup>;
     /** Every reference sharing the tab lists operations and none survives (all hidden or restricted): no endpoint navigation is generated for it. */
     navigation?: false;
+    /** With `groups`: the listed operations become pages under this directory, in the tab's place, once the spec is downloaded. */
+    endpointPages?: EndpointPagesTarget;
     /** 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. */
@@ -494,11 +521,14 @@ interface MigrationBundle {
      * Repository OpenAPI specs docs.json mounts under a `directory` (no surrounding slashes), with the tab each is bound to; the remote ones are in
      * `remoteApiSpecs[].directories`. Present only alongside remote specs: a spec's id depends on which remote tabs bind ahead of it, so
      * hydration links the local and remote mounts together once every download has settled, and the links stay as authored until then.
+     * `endpointOperations` marks a mount whose listed operations are already pages of the site (those operations, in listed order): its endpoint
+     * URLs are those pages, so nothing is redirected from them.
      */
     localApiMounts?: Array<{
         filename: string;
         directory: string;
         tab?: string;
+        endpointOperations?: Array<string>;
     }>;
     /** Customer-owned component source and registry; paths are repository-relative. */
     componentFiles?: Array<RenderedMigrationFile>;
@@ -580,4 +610,4 @@ declare function validateUrlMigration(checkpoint: UrlMigrationCheckpoint, cancel
 /** Run capture/conversion in bounded batches and resume only reconciled artifacts. */
 declare function runUrlMigration(options: UrlMigrationRunOptions): Promise<UrlMigrationRun>;
 
-export { runUrlMigration as A, validateUrlMigration as B, type MigrationPage as M, type RenderedMigrationFile as R, type UrlMigrationCheckpoint as U, type MigrationAsset as a, type MigrationNavigationGroup as b, type MigrationWarning as c, type MigrationFetcher as d, type MigrationPlatform as e, type MigrationBundle as f, type MigrationDocsConfig as g, type MigrationCapture as h, type MigrationCaptureProvider as i, type MigrationCaptureState as j, type MigrationCapturedAsset as k, type MigrationEvidence as l, type MigrationFetchRequest as m, type MigrationFetchResponse as n, type MigrationJournalAsset as o, type MigrationNavigationOccurrence as p, type MigrationNavigationTab as q, type UrlMigrationCheckpointDelta as r, type UrlMigrationIssue as s, type UrlMigrationRecord as t, type UrlMigrationRun as u, type UrlMigrationRunOptions as v, type UrlMigrationValidation as w, classifyMigrationResponse as x, mergeMigrationConfig as y, renderMigrationFiles as z };
+export { runUrlMigration as A, validateUrlMigration as B, type EndpointTabSlot as E, type MigrationPage as M, type RenderedMigrationFile as R, type UrlMigrationCheckpoint as U, type MigrationAsset as a, type MigrationNavigationGroup as b, type MigrationWarning as c, type MigrationFetcher as d, type MigrationPlatform as e, type MigrationBundle as f, type MigrationDocsConfig as g, type MigrationCapture as h, type MigrationCaptureProvider as i, type MigrationCaptureState as j, type MigrationCapturedAsset as k, type MigrationEvidence as l, type MigrationFetchRequest as m, type MigrationFetchResponse as n, type MigrationJournalAsset as o, type MigrationNavigationOccurrence as p, type MigrationNavigationTab as q, type UrlMigrationCheckpointDelta as r, type UrlMigrationIssue as s, type UrlMigrationRecord as t, type UrlMigrationRun as u, type UrlMigrationRunOptions as v, type UrlMigrationValidation as w, classifyMigrationResponse as x, mergeMigrationConfig as y, renderMigrationFiles as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thallylabs/migrate",
-  "version": "0.2.40",
+  "version": "0.2.41",
   "description": "Shared repository and live-site migration engine for Thally",
   "type": "module",
   "publishConfig": {