@stainless-api/docs-search 0.1.0-beta.23 → 0.1.0-beta.25

package/dist/{algolia-gvZUkKkS.js → algolia-elwP_mmI.js}

@@ -1,11 +1,11 @@
-import { n as generateIndex, t as generateChatIndex } from "./indexer-BDmIxFRi.js";
+import { n as generateIndex, t as generateChatIndex } from "./indexer-CajKYSRj.js";
 import { i as SearchableAttributesProse, n as SearchableAttributes, r as SearchableAttributesChat } from "./types-DyGUPDP0.js";
 import { searchClient } from "@algolia/client-search";
 
 //#region src/providers/algolia.ts
-async function buildIndex(appId, indexName, writeKey, spec, renderMarkdown) {
+async function buildIndex(appId, indexName, writeKey, content, renderMarkdown) {
 	if (!appId || !indexName || !writeKey) return;
-	const objects = Array.from(generateIndex(spec, renderMarkdown));
+	const objects = Array.isArray(content) ? content : Array.from(generateIndex(content, renderMarkdown));
 	const client = searchClient(appId, writeKey);
 	await client.setSettings({
 		indexName,

package/dist/{context-BeqLpg4u.js → context-DIYY3XIj.js}

@@ -1,4 +1,4 @@
-import { i as search } from "./algolia-gvZUkKkS.js";
+import { i as search } from "./algolia-elwP_mmI.js";
 import { createContext, useCallback, useContext } from "react";
 import { jsx } from "react/jsx-runtime";
 

package/dist/context.d.ts

@@ -1,4 +1,4 @@
-import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-fPzO2V0p.js";
+import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-CvCRt8tg.js";
 import * as react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/context.d.ts

package/dist/context.js

@@ -1,5 +1,5 @@
-import "./indexer-BDmIxFRi.js";
-import "./algolia-gvZUkKkS.js";
-import { n as useSearch, r as useSearchContext, t as SearchProvider } from "./context-BeqLpg4u.js";
+import "./indexer-CajKYSRj.js";
+import "./algolia-elwP_mmI.js";
+import { n as useSearch, r as useSearchContext, t as SearchProvider } from "./context-DIYY3XIj.js";
 
 export { SearchProvider, useSearch, useSearchContext };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { l as QueryKindsType, u as ResultData } from "./types-fPzO2V0p.js";
+import { l as QueryKindsType, u as ResultData } from "./types-CvCRt8tg.js";
 import * as react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/form.d.ts

package/dist/index.js

@@ -1,7 +1,7 @@
-import "./indexer-BDmIxFRi.js";
+import "./indexer-CajKYSRj.js";
 import { t as QueryKinds } from "./types-DyGUPDP0.js";
-import "./algolia-gvZUkKkS.js";
-import { n as useSearch, r as useSearchContext } from "./context-BeqLpg4u.js";
+import "./algolia-elwP_mmI.js";
+import { n as useSearch, r as useSearchContext } from "./context-DIYY3XIj.js";
 import { t as guideSearch } from "./pagefind-DCvI8YmZ.js";
 import { createElement, useEffect, useRef, useState } from "react";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";

package/dist/{indexer-BDmIxFRi.js → indexer-CajKYSRj.js}

@@ -72,8 +72,9 @@ function* generateChatIndex(spec) {
 		}
 	}
 }
-function* generateIndex(spec, renderMarkdownFn, includeTypes) {
+function* generateIndex(spec, renderMarkdownFn, includeTypes, languages) {
 	const parentCrumbs = {};
+	const targetLangs = languages ?? Languages;
 	for (const { data } of walkTree(spec, true)) {
 		const { kind, name, title, stainlessPath } = data;
 		const common = {
@@ -84,7 +85,7 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 		const crumbs = getResourceNames(parseStainlessPath(stainlessPath).resource, spec.resources);
 		switch (kind) {
 			case "resource":
-				for (const language of Languages) {
+				for (const language of targetLangs) {
 					if (!data[language]) continue;
 					parentCrumbs[stainlessPath] = crumbs;
 					const { Name, QualifiedName } = data[language];
@@ -101,7 +102,7 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 				break;
 			case "http_method": {
 				const { summary, endpoint, httpMethod } = data;
-				for (const language of Languages) {
+				for (const language of targetLangs) {
 					const found = spec.decls[language]?.[stainlessPath];
 					if (!found) continue;
 					parentCrumbs[stainlessPath] = [...crumbs, title];
@@ -123,7 +124,7 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 				}
 				break;
 			}
-			case "model": for (const language of Languages) {
+			case "model": for (const language of targetLangs) {
 				if (!spec.decls[language]) continue;
 				parentCrumbs[stainlessPath] = [...crumbs, title];
 				const schema = spec.decls[language]?.[`${stainlessPath} > (schema)`];
@@ -143,7 +144,7 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 			}
 		}
 	}
-	for (const language of Languages) {
+	for (const language of targetLangs) {
 		const decls = spec.decls?.[language];
 		if (!decls) continue;
 		for (const decl of Object.values(decls)) switch (decl.kind) {
@@ -178,4 +179,4 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 }
 
 //#endregion
-export { generateIndex as n, generateChatIndex as t };
+export { generateIndex as n, getResourceNames as r, generateChatIndex as t };

package/dist/indexer.d.ts

@@ -0,0 +1,35 @@
+import { b as Resource, n as IndexEntry, x as Spec } from "./types-CvCRt8tg.js";
+import { DocsLanguage } from "@stainless-api/docs-ui/routing";
+
+//#region src/indexer.d.ts
+declare function getResourceNames(resourceIds: string[], topResources?: Record<string, Resource>): string[];
+declare function generateChatIndex(spec: Spec): Generator<{
+  language: string;
+  title: string;
+  content: string;
+  url: string;
+  name?: undefined;
+  endpoint?: undefined;
+  httpMethod?: undefined;
+  summary?: undefined;
+  description?: undefined;
+  stainlessPath?: undefined;
+  qualified?: undefined;
+  ident?: undefined;
+} | {
+  language: "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
+  title: string;
+  name: string;
+  endpoint: string;
+  httpMethod: string;
+  summary: string | undefined;
+  description: string | undefined;
+  stainlessPath: string;
+  qualified: string | undefined;
+  ident: string | undefined;
+  content: string;
+  url: string | null;
+}, void, unknown>;
+declare function generateIndex(spec: Spec, renderMarkdownFn?: (_: string) => string | null, includeTypes?: boolean, languages?: DocsLanguage[]): Generator<IndexEntry>;
+//#endregion
+export { generateChatIndex, generateIndex, getResourceNames };

package/dist/indexer.js

@@ -0,0 +1,3 @@
+import { n as generateIndex, r as getResourceNames, t as generateChatIndex } from "./indexer-CajKYSRj.js";
+
+export { generateChatIndex, generateIndex, getResourceNames };

package/dist/mcp.d.ts

@@ -1,9 +1,7 @@
-import { b as Spec, n as IndexEntry, r as IndexMethod } from "./types-fPzO2V0p.js";
+import { n as IndexEntry, r as IndexMethod, x as Spec } from "./types-CvCRt8tg.js";
+import { generateIndex } from "./indexer.js";
 import { DocsLanguage } from "@stainless-api/docs-ui/routing";
 
-//#region src/indexer.d.ts
-declare function generateIndex(spec: Spec, renderMarkdownFn?: (_: string) => string | null, includeTypes?: boolean): Generator<IndexEntry>;
-//#endregion
 //#region src/mcp.d.ts
 type Item = IndexEntry & IndexMethod;
 declare function render(spec: Spec, language: DocsLanguage, items: Item[], includeModelProperties: boolean): any;

package/dist/mcp.js

@@ -1,4 +1,4 @@
-import { n as generateIndex } from "./indexer-BDmIxFRi.js";
+import { n as generateIndex } from "./indexer-CajKYSRj.js";
 import { parseStainlessPath } from "@stainless-api/docs-ui/routing";
 import { renderMarkdown } from "@stainless-api/docs-ui/markdown";
 import { getResourceFromSpec } from "@stainless-api/docs-ui/utils";

package/dist/providers/algolia.d.ts

@@ -1,7 +1,7 @@
-import { b as Spec, f as ResultType, g as SearchSettings, h as SearchParams, s as ProseIndexEntry } from "../types-fPzO2V0p.js";
+import { f as ResultType, g as SearchSettings, h as SearchParams, n as IndexEntry, s as ProseIndexEntry, x as Spec } from "../types-CvCRt8tg.js";
 
 //#region src/providers/algolia.d.ts
-declare function buildIndex(appId: string, indexName: string, writeKey: string, spec: Spec, renderMarkdown: (_: string) => string | null): Promise<void>;
+declare function buildIndex(appId: string, indexName: string, writeKey: string, content: Spec | IndexEntry[], renderMarkdown: (_: string) => string | null): Promise<void>;
 declare function buildChatIndex(appId: string, indexName: string, writeKey: string, spec: Spec): Promise<void>;
 declare function buildProseIndex(appId: string, indexName: string, writeKey: string, objects: ProseIndexEntry[]): Promise<void>;
 declare function search({

package/dist/providers/algolia.js

@@ -1,4 +1,4 @@
-import "../indexer-BDmIxFRi.js";
-import { i as search, n as buildIndex, r as buildProseIndex, t as buildChatIndex } from "../algolia-gvZUkKkS.js";
+import "../indexer-CajKYSRj.js";
+import { i as search, n as buildIndex, r as buildProseIndex, t as buildChatIndex } from "../algolia-elwP_mmI.js";
 
 export { buildChatIndex, buildIndex, buildProseIndex, search };

package/dist/providers/fuse.d.ts

@@ -1,4 +1,4 @@
-import { b as Spec, n as IndexEntry } from "../types-fPzO2V0p.js";
+import { n as IndexEntry, x as Spec } from "../types-CvCRt8tg.js";
 import { DocsLanguage } from "@stainless-api/docs-ui/routing";
 import * as fuse_js0 from "fuse.js";
 import { FuseIndex } from "fuse.js";

package/dist/providers/fuse.js

@@ -1,4 +1,4 @@
-import { n as generateIndex } from "../indexer-BDmIxFRi.js";
+import { n as generateIndex } from "../indexer-CajKYSRj.js";
 import { n as SearchableAttributes } from "../types-DyGUPDP0.js";
 import Fuse from "fuse.js";
 

package/dist/providers/pagefind.d.ts

@@ -1,4 +1,4 @@
-import { t as GuideResultType } from "../types-fPzO2V0p.js";
+import { t as GuideResultType } from "../types-CvCRt8tg.js";
 
 //#region src/providers/pagefind.d.ts
 declare function guideSearch(loadPath: string, query: string, limit?: number): Promise<GuideResultType[]>;

package/dist/providers/walker.d.ts

@@ -1,4 +1,4 @@
-import { b as Spec, n as IndexEntry } from "../types-fPzO2V0p.js";
+import { n as IndexEntry, x as Spec } from "../types-CvCRt8tg.js";
 import { DocsLanguage } from "@stainless-api/docs-ui/routing";
 
 //#region src/providers/walker.d.ts

package/dist/providers/walker.js

@@ -1,4 +1,4 @@
-import { n as generateIndex } from "../indexer-BDmIxFRi.js";
+import { n as generateIndex } from "../indexer-CajKYSRj.js";
 import { n as SearchableAttributes } from "../types-DyGUPDP0.js";
 
 //#region src/providers/walker.ts

package/dist/{types-fPzO2V0p.d.ts → types-CvCRt8tg.d.ts}

@@ -111,7 +111,7 @@ type DiscriminatorObject = {
 type ExampleObject = {
   summary?: string;
   description?: string;
-  value?: any;
+  value?: unknown;
   externalValue?: string;
 };
 type EncodingsObject = {
@@ -139,7 +139,7 @@ type ResponseContentObject = {
 type HeadersObject = {
   [key: string]: HeaderObject;
 };
-type SupportedLanguage = 'node' | 'typescript' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby' | 'terraform' | 'cli' | 'php' | 'csharp' | 'http';
+type SupportedLanguage = 'node' | 'typescript' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby' | 'terraform' | 'cli' | 'php' | 'csharp' | 'sql' | 'http' | 'openapi';
 interface Config {
   docs: {
     title?: string | undefined;
@@ -160,22 +160,7 @@ interface Config {
     show_security?: boolean | undefined;
     show_readme?: boolean | undefined;
     base_path?: string | undefined;
-    navigation?: {
-      menubar?: {
-        title: string;
-        icon?: 'Github' | 'BookOpen' | 'Code' | 'Folder' | 'Mail' | 'NPM' | 'Search' | 'Package' | 'User' | 'Pen' | 'Pencil' | 'Wrench' | 'Bot' | 'FileText' | 'Lightbulb' | 'Sparkles' | 'Menu' | 'History' | undefined;
-        variant?: 'ghost-muted' | 'outline-muted' | 'outline' | undefined;
-        href?: string | undefined;
-        page?: string | undefined;
-      }[] | undefined;
-      sidebar?: {
-        title: string;
-        icon?: 'Github' | 'BookOpen' | 'Code' | 'Folder' | 'Mail' | 'NPM' | 'Search' | 'Package' | 'User' | 'Pen' | 'Pencil' | 'Wrench' | 'Bot' | 'FileText' | 'Lightbulb' | 'Sparkles' | 'Menu' | 'History' | undefined;
-        variant?: 'ghost-muted' | 'outline-muted' | 'outline' | undefined;
-        href?: string | undefined;
-        page?: string | undefined;
-      }[] | undefined;
-    } | undefined;
+    navigation?: unknown;
     pages?: Record<string, string> | undefined;
     resources?: {
       title: string;
@@ -225,7 +210,8 @@ type HttpDeclProperty = BaseDeclaration & {
   location?: string;
   type: HttpType;
   constraints?: Constraints;
-  default?: any;
+  default?: unknown;
+  examples?: unknown[];
   optional?: boolean;
   nullable?: boolean;
   declare?: boolean;
@@ -333,6 +319,7 @@ type RubyDeclProperty = BaseDeclaration & {
   type: RubyType;
   constraints?: Constraints;
   optional?: boolean;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -430,7 +417,7 @@ type RubyTypeUnknown = BaseType & {
   kind: 'RubyTypeUnknown';
 };
 type SDKSchemaReference = never;
-type SDKSchemaType = never;
+type SDKSchemaType = string;
 type SDKPropertySchemaReference<T = never> = never;
 /**
  * Base declaration types for CLI command AST
@@ -455,7 +442,7 @@ type CLICommand = BaseDeclaration & {
   ident: string;
   qualified?: string;
   docstring?: string;
-  parameters?: any[];
+  parameters?: unknown[];
   responseType?: HttpType;
 };
 /**
@@ -483,10 +470,10 @@ type CLIFlag = BaseDeclaration & {
   docstring?: string;
   optional?: boolean;
   type?: HttpType;
-  constraints?: any;
+  constraints?: unknown;
   schemaType?: string;
   modelPath?: string;
-  childrenParentSchema?: any;
+  childrenParentSchema?: unknown;
   children?: ID[];
 };
 /**
@@ -499,10 +486,10 @@ type CLISchemaProperty = BaseDeclaration & {
   type?: HttpType;
   docstring?: string;
   optional?: boolean;
-  constraints?: any;
+  constraints?: unknown;
   schemaType?: string;
   children?: ID[];
-  childrenParentSchema?: any;
+  childrenParentSchema?: unknown;
 };
 /**
  * Represents data piped in to stdin
@@ -557,6 +544,7 @@ type CSharpDeclProperty = BaseDeclaration & {
   type: CSharpType;
   optional?: boolean;
   nullable?: boolean;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -648,6 +636,7 @@ type JavaDeclProperty = BaseDeclaration & {
   ident: JavaIdentifier;
   type: JavaType;
   optional?: boolean;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -735,6 +724,7 @@ type PhpDeclParam = BaseDeclaration & {
   optional: boolean;
   isPositional: boolean;
   default?: unknown;
+  examples?: unknown[];
   oasRef?: string;
   modelPath?: string;
   docstring?: string;
@@ -760,6 +750,7 @@ type PhpDeclClassProperty = BaseDeclaration & {
   nullable: boolean;
   docstring?: string;
   default?: string;
+  examples?: unknown[];
   deprecated?: string | boolean;
   modelPath?: string;
   children?: ID[];
@@ -888,7 +879,8 @@ type PythonDeclProperty = BaseDeclaration & {
   type: PythonType;
   constraints?: Constraints;
   optional?: boolean;
-  default?: any;
+  default?: unknown;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -1032,7 +1024,8 @@ type TerraformAttribute = {
   isBodyRootParam?: boolean;
   syntheticType?: 'id' | 'find-by' | 'max-items' | 'items' | 'timeout';
   schemaType: TerraformSchemaType;
-  pathExpr: PathExpression$1;
+  pathExpr: PathExpression$1; /** whether this attribute is immediately nested inside a computed (or computed_optional) collection/object */
+  nestedInComputedAttribute?: boolean;
 };
 declare const TerraformPathValidations: readonly ['requiredTogether', 'atLeastOneOf', 'exactlyOneOf', 'conflicting'];
 type PathValidators = Record<(typeof TerraformPathValidations)[number], PathExpression$1[][]>;
@@ -1148,7 +1141,8 @@ type TSDeclProperty = BaseDeclaration & {
   constraints?: Constraints;
   optional?: boolean;
   declare?: boolean;
-  default?: any;
+  default?: unknown;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -1302,7 +1296,27 @@ type Spec = {
   } };
   readme: { [lang in SpecLanguage]?: string };
   decls: { [lang in SpecLanguage]?: Record<string, LanguageDeclNodes[lang]> };
-  snippets: { [key in SnippetLanguage]?: Record<string, string> };
+  snippets: { [key in SnippetLanguage]?: Record<string, {
+    default: {
+      content: string;
+    };
+    [key: `custom:${string}`]: {
+      content: string;
+    };
+  }> };
+  snippetResponses: {
+    http: Record<string, {
+      default?: {
+        status: string;
+        content: string;
+        contentType?: string;
+      }[];
+      [key: `custom:${string}`]: {
+        status?: string;
+        content: string;
+      }[];
+    }>;
+  };
 };
 type Resource = (HasConfigRef & HasStainlessPath) & {
   kind: 'resource';
@@ -1326,7 +1340,7 @@ type Method = (HasStainlessPath & HasOASRef) & {
   summary?: string;
   httpMethod: string;
   endpoint: string;
-  deprecated?: string | boolean;
+  deprecated?: string | boolean; /** @deprecated - use snippetResponses at the top level */
   exampleResponses?: Record<string, ResponseContentObject>;
   security: Record<string, string[]>[] | undefined;
   'x-api-token-group'?: string[];
@@ -1430,7 +1444,8 @@ type GoDeclProperty = BaseDeclaration & {
   type: GoType;
   constraints?: Constraints;
   optional?: boolean;
-  default?: any;
+  default?: unknown;
+  examples?: unknown[];
   schemaType?: SchemaType;
   modelPath?: string;
   childrenParentSchema?: SchemaType;
@@ -1582,4 +1597,4 @@ type ProseIndexEntry = {
   [additional: string]: unknown;
 };
 //#endregion
-export { SearchableAttributes as _, IndexProperty as a, Spec as b, QueryKinds as c, ResultRecordType as d, ResultType as f, SearchSettings as g, SearchParams as h, IndexModel as i, QueryKindsType as l, SearchAttributeNames as m, IndexEntry as n, IndexResource as o, RoutableJsonNode as p, IndexMethod as r, ProseIndexEntry as s, GuideResultType as t, ResultData as u, SearchableAttributesChat as v, SearchableAttributesProse as y };
+export { SearchableAttributes as _, IndexProperty as a, Resource as b, QueryKinds as c, ResultRecordType as d, ResultType as f, SearchSettings as g, SearchParams as h, IndexModel as i, QueryKindsType as l, SearchAttributeNames as m, IndexEntry as n, IndexResource as o, RoutableJsonNode as p, IndexMethod as r, ProseIndexEntry as s, GuideResultType as t, ResultData as u, SearchableAttributesChat as v, Spec as x, SearchableAttributesProse as y };

package/dist/types.d.ts

@@ -1,2 +1,2 @@
-import { _ as SearchableAttributes, a as IndexProperty, c as QueryKinds, d as ResultRecordType, f as ResultType, g as SearchSettings, h as SearchParams, i as IndexModel, l as QueryKindsType, m as SearchAttributeNames, n as IndexEntry, o as IndexResource, p as RoutableJsonNode, r as IndexMethod, s as ProseIndexEntry, t as GuideResultType, u as ResultData, v as SearchableAttributesChat, y as SearchableAttributesProse } from "./types-fPzO2V0p.js";
+import { _ as SearchableAttributes, a as IndexProperty, c as QueryKinds, d as ResultRecordType, f as ResultType, g as SearchSettings, h as SearchParams, i as IndexModel, l as QueryKindsType, m as SearchAttributeNames, n as IndexEntry, o as IndexResource, p as RoutableJsonNode, r as IndexMethod, s as ProseIndexEntry, t as GuideResultType, u as ResultData, v as SearchableAttributesChat, y as SearchableAttributesProse } from "./types-CvCRt8tg.js";
 export { GuideResultType, IndexEntry, IndexMethod, IndexModel, IndexProperty, IndexResource, ProseIndexEntry, QueryKinds, QueryKindsType, ResultData, ResultRecordType, ResultType, RoutableJsonNode, SearchAttributeNames, SearchParams, SearchSettings, SearchableAttributes, SearchableAttributesChat, SearchableAttributesProse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs-search",
-  "version": "0.1.0-beta.23",
+  "version": "0.1.0-beta.25",
   "publishConfig": {
     "access": "public"
   },
@@ -19,7 +19,7 @@
     "fuse.js": "^7.1.0",
     "htmlparser2": "^10.1.0",
     "lucide-react": "^0.562.0",
-    "@stainless-api/docs-ui": "0.1.0-beta.70",
+    "@stainless-api/docs-ui": "0.1.0-beta.72",
     "@stainless-api/ui-primitives": "0.1.0-beta.47"
   },
   "devDependencies": {
@@ -31,13 +31,16 @@
     "react-dom": "^19.2.4",
     "tsdown": "^0.20.0",
     "typescript": "5.9.3",
-    "@stainless/sdk-json": "^0.1.0-beta.4",
-    "@stainless/eslint-config": "0.1.0-beta.1"
+    "@stainless/eslint-config": "0.1.0-beta.1",
+    "@stainless/sdk-json": "^0.1.0-beta.5"
   },
   "exports": {
     ".": {
       "default": "./dist/index.js"
     },
+    "./indexer": {
+      "default": "./dist/indexer.js"
+    },
     "./context": {
       "default": "./dist/context.js"
     },