@stainless-api/docs 0.1.0-beta.106 → 0.1.0-beta.107

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.107
+
+### Minor Changes
+
+- 971a12f: Adds an experimental flag to disable indexing
+
 ## 0.1.0-beta.106
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.106",
+  "version": "0.1.0-beta.107",
   "publishConfig": {
     "access": "public"
   },

package/shared/conditionalIntegration.ts

@@ -0,0 +1,28 @@
+import { AstroIntegration, type AstroIntegrationLogger } from 'astro';
+import { getSharedLogger } from './getSharedLogger';
+
+export default function conditionalIntegration({
+  condition,
+  integration,
+  reason,
+}: {
+  condition: boolean;
+  integration: AstroIntegration;
+  reason?: string | undefined;
+}): AstroIntegration {
+  if (condition) {
+    return integration;
+  }
+  return {
+    name: integration.name,
+    hooks: Object.fromEntries(
+      Object.keys(integration.hooks).map((hookName) => [
+        hookName,
+        ({ logger: localLogger }: { logger: AstroIntegrationLogger }) => {
+          const logger = getSharedLogger({ fallback: localLogger });
+          logger.info(`Skipping ${integration.name} integration. Reason: ${reason ?? 'not provided'}`);
+        },
+      ]),
+    ),
+  };
+}

package/stl-docs/index.ts

@@ -25,6 +25,7 @@ import { stainlessDocsVectorProseIndexing } from './proseDocSync';
 import { stainlessDocsAlgoliaProseIndexing } from './proseSearchIndexing';
 import { stainlessStarlight } from '../plugin';
 import { getFontRoles, flattenFonts } from './fonts';
+import conditionalIntegration from '../shared/conditionalIntegration';
 
 export * from '../plugin';
 
@@ -189,14 +190,14 @@ function stainlessDocsIntegration(
             } satisfies typeof StlDocsVirtualModule),
 
             'virtual:stl-docs/components/AiChat.tsx': `
-        ${
-          config.aiChat
-            ? `export { default } from ${JSON.stringify(config.aiChat.chatComponentPath)};`
-            : // export null when no AI chat component is provided
-              `export default null;`
-        }
-        export const STAINLESS_PROJECT = ${config.apiReference ? JSON.stringify(config.apiReference.stainlessProject) : 'undefined'};
-      `,
+              ${
+                config.aiChat
+                  ? `export { default } from ${JSON.stringify(config.aiChat.chatComponentPath)};`
+                  : // export null when no AI chat component is provided
+                    `export default null;`
+              }
+              export const STAINLESS_PROJECT = ${config.apiReference ? JSON.stringify(config.apiReference.stainlessProject) : 'undefined'};
+            `,
           }),
         );
 
@@ -284,11 +285,20 @@ export function stainlessDocs(config: StainlessDocsUserConfig): StarlightPlugin[
     react(),
     stainlessDocsStarlightIntegration(normalizedConfig),
     stainlessDocsIntegration(normalizedConfig, apiReferenceBasePath),
-    stainlessDocsMarkdownRenderer({
-      enabled: normalizedConfig.enableProseMarkdownRendering,
-      apiReferenceBasePath,
+    conditionalIntegration({
+      condition: !config.experimental?.disableProseMarkdownRendering,
+      integration: stainlessDocsMarkdownRenderer({ apiReferenceBasePath }),
+      reason: 'disabled by experimental config "disableProseMarkdownRendering"',
+    }),
+    conditionalIntegration({
+      condition: !config.experimental?.disableStainlessProseIndexing,
+      integration: stainlessDocsAlgoliaProseIndexing({ apiReferenceBasePath }),
+      reason: 'disabled by experimental config "disableStainlessProseIndexing"',
+    }),
+    conditionalIntegration({
+      condition: !config.experimental?.disableStainlessProseIndexing,
+      integration: stainlessDocsVectorProseIndexing(normalizedConfig, apiReferenceBasePath),
+      reason: 'disabled by experimental config "disableStainlessProseIndexing"',
     }),
-    stainlessDocsAlgoliaProseIndexing({ apiReferenceBasePath }),
-    stainlessDocsVectorProseIndexing(normalizedConfig, apiReferenceBasePath),
   ];
 }

package/stl-docs/loadStlDocsConfig.ts

@@ -77,6 +77,7 @@ export type StainlessDocsUserConfig = {
      * @default false
      */
     disableProseMarkdownRendering?: boolean;
+    disableStainlessProseIndexing?: boolean;
     aiChat?: { chatComponentPath: string };
     /**
      * Whether to link group titles to overview pages. Note: overview pages must already be present in the sidebar for this to work.
@@ -172,6 +173,8 @@ function normalizeConfig(userConfig: StainlessDocsUserConfig) {
     enableClientRouter: userConfig.experimental?.enableClientRouter ?? false,
     apiReference: userConfig.apiReference ?? null,
     sidebar: userConfig.sidebar,
+    enableStainlessProseIndexing:
+      userConfig.experimental?.disableStainlessProseIndexing === true ? false : true,
     enableProseMarkdownRendering:
       userConfig.experimental?.disableProseMarkdownRendering === true ? false : true,
     contextMenu: userConfig.contextMenu ?? true,

package/stl-docs/proseDocSync.ts

@@ -201,7 +201,7 @@ async function deleteDocuments(
       try {
         const response = await docsApiRequest(
           'DELETE',
-          `/api/docs-sites/${docsSiteId}/documents/${encodeURIComponent(docId)}?project=${encodeURIComponent(project)}`,
+          `/api/docs-sites/${docsSiteId}/documents?documentId=${encodeURIComponent(docId)}&project=${encodeURIComponent(project)}`,
           apiKey,
         );
         if (response.ok) {

package/stl-docs/proseMarkdown/proseMarkdownIntegration.ts

@@ -7,29 +7,21 @@ import { bold } from '../../shared/terminalUtils';
 import { getProsePages } from '../../shared/getProsePages';
 
 export function stainlessDocsMarkdownRenderer({
-  enabled,
   apiReferenceBasePath,
 }: {
-  enabled: boolean;
   apiReferenceBasePath: string | null;
 }): AstroIntegration {
   return {
     name: 'stl-docs-md',
     hooks: {
       'astro:config:setup': ({ addMiddleware }) => {
-        if (enabled) {
-          addMiddleware({
-            entrypoint: resolveSrcFile('/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts'),
-            order: 'post',
-          });
-        }
+        addMiddleware({
+          entrypoint: resolveSrcFile('/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts'),
+          order: 'post',
+        });
       },
       'astro:build:done': async ({ logger: localLogger, dir }) => {
         const logger = getSharedLogger({ fallback: localLogger });
-        if (!enabled) {
-          logger.info('Stainless Docs prose Markdown rendering is disabled, skipping...');
-          return;
-        }
         const outputBasePath = dir.pathname;
         const pagesToRender = await getProsePages({ apiReferenceBasePath, outputBasePath });