@stainless-api/docs 0.1.0-beta.20 → 0.1.0-beta.22

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [f7ba067]
+  - @stainless-api/docs-ui@0.1.0-beta.17
+
+## 0.1.0-beta.21
+
+### Patch Changes
+
+- 41e87cb: fix virtual module imports
+
 ## 0.1.0-beta.20
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.20",
+  "version": "0.1.0-beta.22",
   "publishConfig": {
     "access": "public"
   },
@@ -50,8 +50,8 @@
     "remark-gfm": "^4.0.1",
     "remark-stringify": "^11.0.0",
     "unified": "^11.0.5",
-    "@stainless-api/ui-primitives": "0.1.0-beta.16",
-    "@stainless-api/docs-ui": "0.1.0-beta.16"
+    "@stainless-api/docs-ui": "0.1.0-beta.17",
+    "@stainless-api/ui-primitives": "0.1.0-beta.16"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.5",

package/plugin/index.ts

@@ -225,8 +225,7 @@ async function stlStarlightAstroIntegration(
                         EXPERIMENTAL_COLLAPSIBLE_SNIPPETS: pluginConfig.experimentalCollapsibleSnippets,
                         PROPERTY_SETTINGS: pluginConfig.propertySettings,
                         SEARCH: pluginConfig.search,
-                        // @ts-expect-error internal prop
-                        ENABLE_CONTEXT_MENU: pluginConfig._contextMenu,
+                        ENABLE_CONTEXT_MENU: pluginConfig.contextMenu,
                       }),
                       vmMiddlewareExport,
                     ].join('\n');

package/plugin/loadPluginConfig.ts

@@ -128,6 +128,13 @@ export type StainlessStarlightUserConfig = {
    * Default: `false`
    */
   experimentalCollapsibleSnippets?: boolean;
+
+  /**
+   * Whether to show the context menu with options like "Copy as Markdown" and "Open in ChatGPT".
+   *
+   * Default: `true`
+   */
+  contextMenu?: boolean;
 };
 
 export type ExternalSpecServerUserConfig = Omit<StainlessStarlightUserConfig, 'stainlessProject'> & {
@@ -262,6 +269,7 @@ function normalizeConfig(partial: SomeStainlessStarlightUserConfig, command: Ast
     search: {
       enableAISearch: partial.search?.enableAISearch ?? false,
     },
+    contextMenu: partial.contextMenu ?? true,
   };
 
   function getSpecRetrieverConfig(): SpecRetrieverConfig {

package/stl-docs/components/PageTitle.astro

@@ -1,10 +1,9 @@
 ---
-import { ENABLE_PROSE_MARKDOWN_RENDERING } from 'virtual:stl-docs-virtual-module';
+import { ENABLE_PROSE_MARKDOWN_RENDERING, ENABLE_CONTEXT_MENU } from 'virtual:stl-docs-virtual-module';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 import Default from '@astrojs/starlight/components/PageTitle.astro';
 import { ContentBreadcrumbs } from './ContentBreadcrumbs';
 import { AIDropdown } from './AIDropdown';
-import { ENABLE_CONTEXT_MENU } from 'virtual:stl-starlight-virtual-module';
 
 function sidebarHasEntry(sidebarEntry: StarlightRouteData['sidebar'], currentPath?: string) {
   if (!currentPath) return false;

package/stl-docs/index.ts

@@ -66,8 +66,7 @@ function stainlessDocsStarlightIntegration(config: NormalizedStainlessDocsConfig
     plugins.push(
       stainlessStarlight({
         ...config.apiReference,
-        // @ts-expect-error internal prop
-        _contextMenu: config.contextMenu,
+        contextMenu: config.contextMenu,
       }),
     );
     componentOverrides.Sidebar = resolveSrcFile(COMPONENTS_FOLDER, './sidebars/SDKSelectSidebar.astro');
@@ -172,6 +171,8 @@ function stainlessDocsIntegration(
                       ENABLE_CLIENT_ROUTER: config.enableClientRouter,
                       API_REFERENCE_BASE_PATH: apiReferenceBasePath,
                       ENABLE_PROSE_MARKDOWN_RENDERING: config.enableProseMarkdownRendering,
+                      // TODO: do not duplicate this between both virtual modules
+                      ENABLE_CONTEXT_MENU: config.contextMenu,
                     });
                   }
                 },

package/virtual-module.d.ts

@@ -43,4 +43,5 @@ declare module 'virtual:stl-docs-virtual-module' {
   export const ENABLE_CLIENT_ROUTER: boolean;
   export const API_REFERENCE_BASE_PATH: string | null;
   export const ENABLE_PROSE_MARKDOWN_RENDERING: boolean;
+  export const ENABLE_CONTEXT_MENU: boolean;
 }