@stainless-api/docs-search 0.1.0-beta.8 → 1.0.0-beta.50

package/dist/context.d.ts

@@ -1,5 +1,5 @@
-import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-Gg968wOz.js";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
+import { d as ResultType, h as SearchSettings, m as SearchParams } from "./types-D0suCLuC.js";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/context.d.ts
 type SearchContextType = {
@@ -15,6 +15,6 @@ type SearchProviderProps = SearchContextType & {
 declare function SearchProvider({
   children,
   ...props
-}: SearchProviderProps): react_jsx_runtime0.JSX.Element;
+}: SearchProviderProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 export { SearchContextType, SearchProvider, SearchProviderProps, useSearch, useSearchContext };

package/dist/context.js

@@ -1,5 +1,30 @@
-import "./indexer-DBU0POrK.js";
-import "./algolia-BOY-OcxU.js";
-import { n as useSearch, r as useSearchContext, t as SearchProvider } from "./context-CBZeYd0O.js";
-
-export { SearchProvider, useSearch, useSearchContext };
+import { search } from "./providers/algolia.js";
+import { createContext, use, useCallback } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/context.tsx
+function createStrictContext(displayName) {
+	const Context = createContext(null);
+	Context.displayName = displayName;
+	function useStrictContext() {
+		const context = use(Context);
+		if (context === null) throw new Error(`use${displayName} must be used within a ${displayName}Provider`);
+		return context;
+	}
+	return [Context.Provider, useStrictContext];
+}
+const [Provider, useSearchContext] = createStrictContext("SearchContext");
+function useSearch() {
+	const { settings } = useSearchContext();
+	return useCallback((params) => search({
+		settings,
+		params
+	}), [settings]);
+}
+function SearchProvider({ children, ...props }) {
+	return /* @__PURE__ */ jsx(Provider, {
+		value: props,
+		children
+	});
+}
+//#endregion
+export { SearchProvider, useSearch, useSearchContext };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { l as QueryKindsType, u as ResultData } from "./types-Gg968wOz.js";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
+import { c as QueryKindsType, l as ResultData } from "./types-D0suCLuC.js";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 
 //#region src/form.d.ts
-declare function SearchForm(): react_jsx_runtime0.JSX.Element;
+declare function SearchForm(): _$react_jsx_runtime0.JSX.Element;
 type SearchFilterProps = {
   results: ResultData;
   filterKind: QueryKindsType;
@@ -12,7 +12,7 @@ declare function SearchFilter({
   results,
   filterKind,
   onChange
-}: SearchFilterProps): react_jsx_runtime0.JSX.Element;
+}: SearchFilterProps): _$react_jsx_runtime0.JSX.Element;
 type SearchModalProps = {
   id?: string;
   open?: boolean;
@@ -20,6 +20,6 @@ type SearchModalProps = {
 declare function SearchModal({
   id,
   open: isOpen
-}: SearchModalProps): react_jsx_runtime0.JSX.Element;
+}: SearchModalProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 export { SearchFilter, SearchFilterProps, SearchForm, SearchModal, SearchModalProps };

package/dist/index.js

@@ -1,8 +1,6 @@
-import "./indexer-DBU0POrK.js";
-import { t as QueryKinds } from "./types-BhJLoaNF.js";
-import "./algolia-BOY-OcxU.js";
-import { n as useSearch, r as useSearchContext } from "./context-CBZeYd0O.js";
-import { t as guideSearch } from "./pagefind-Dcn-gjDe.js";
+import { QueryKinds } from "./types.js";
+import { useSearch, useSearchContext } from "./context.js";
+import { guideSearch } from "./providers/pagefind.js";
 import { createElement, useEffect, useRef, useState } from "react";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { BookOpenText, Box, Code, Folder, Search, Wrench } from "lucide-react";
@@ -10,7 +8,6 @@ import { useLanguage } from "@stainless-api/docs-ui/contexts";
 import { useComponents } from "@stainless-api/docs-ui/contexts/use-components";
 import style from "@stainless-api/docs-ui/style";
 import { Button } from "@stainless-api/ui-primitives";
-
 //#region src/results.tsx
 const QueryKindDisplay = {
 	all: {
@@ -216,7 +213,6 @@ function SearchResultContent({ result }) {
 		});
 	}
 }
-
 //#endregion
 //#region src/form.tsx
 function SearchForm() {
@@ -229,21 +225,25 @@ function SearchForm() {
 	const [searchQuery, setSearchQuery] = useState("");
 	const inputRef = useRef(null);
 	useEffect(() => {
-		const guideLimit = filterKind === "guide" ? 25 : 5;
-		const kind = ["all", "guide"].includes(filterKind) ? void 0 : filterKind;
+		const guideLimit = 25;
+		const apiKindFilter = ["all", "guide"].includes(filterKind) ? void 0 : filterKind;
 		const ac = new AbortController();
 		Promise.all([pageFind ? guideSearch(pageFind, searchQuery, guideLimit) : [], search({
 			query: searchQuery,
-			kind,
+			kind: apiKindFilter,
 			language
 		})]).then(([guideResults, apiResults]) => {
 			if (ac.signal.aborted) return;
 			setResults({
-				items: filterKind === "guide" ? guideResults : filterKind === "all" ? [...guideResults.slice(0, 5), ...apiResults?.hits ?? []] : apiResults?.hits ?? [],
+				items: filterKind === "guide" ? guideResults : filterKind === "all" ? [
+					...guideResults.slice(0, 5),
+					...apiResults?.hits ?? [],
+					...guideResults.slice(5)
+				] : apiResults?.hits ?? [],
 				counts: {
 					...apiResults?.facets?.["kind"],
 					guide: guideResults.length,
-					all: apiResults?.nbHits
+					all: (apiResults?.nbHits ?? 0) + guideResults.length
 				}
 			});
 		}).catch(() => {});
@@ -272,7 +272,7 @@ function SearchForm() {
 			/* @__PURE__ */ jsx(SearchFilter, {
 				results,
 				filterKind,
-				onChange: (filterKind$1) => setFilterKind(filterKind$1)
+				onChange: (filterKind) => setFilterKind(filterKind)
 			}),
 			/* @__PURE__ */ jsx(Docs.ListView, {
 				items: results?.items ?? [],
@@ -284,7 +284,7 @@ function SearchForm() {
 }
 function SearchFilter({ results, filterKind, onChange }) {
 	const { pageFind } = useSearchContext();
-	const toggles = pageFind ? QueryKinds : QueryKinds.slice(0, -1);
+	const toggles = pageFind ? QueryKinds : QueryKinds.filter((k) => k !== "guide");
 	return /* @__PURE__ */ jsx("div", {
 		className: style.SearchFilter,
 		children: toggles.map((kind, index) => /* @__PURE__ */ jsxs(Button, {
@@ -325,6 +325,5 @@ function SearchModal({ id, open: isOpen }) {
 		children: open && /* @__PURE__ */ jsx(SearchForm, {})
 	});
 }
-
 //#endregion
-export { SearchFilter, SearchForm, SearchModal };
+export { SearchFilter, SearchForm, SearchModal };

package/dist/indexer.d.ts

@@ -0,0 +1,35 @@
+import { n as IndexEntry, v as Resource, y as Spec } from "./types-D0suCLuC.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-DBU0POrK.js → indexer.js}

@@ -1,9 +1,9 @@
 import { Languages, generateRoute, parseStainlessPath, walkTree } from "@stainless-api/docs-ui/routing";
 import { printer, renderMarkdown } from "@stainless-api/docs-ui/markdown";
-
+import { isResourceEmpty } from "@stainless-api/docs-ui/utils";
 //#region src/indexer.ts
 function getResourceNames(resourceIds, topResources) {
-	let element = void 0;
+	let element;
 	let resources = topResources;
 	const resourceName = [];
 	for (const resource of resourceIds) {
@@ -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,8 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 		const crumbs = getResourceNames(parseStainlessPath(stainlessPath).resource, spec.resources);
 		switch (kind) {
 			case "resource":
-				for (const language of Languages) {
+				if (isResourceEmpty(data)) break;
+				for (const language of targetLangs) {
 					if (!data[language]) continue;
 					parentCrumbs[stainlessPath] = crumbs;
 					const { Name, QualifiedName } = data[language];
@@ -101,7 +103,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 +125,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 +145,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) {
@@ -176,6 +178,5 @@ function* generateIndex(spec, renderMarkdownFn, includeTypes) {
 		}
 	}
 }
-
 //#endregion
-export { generateIndex as n, generateChatIndex as t };
+export { generateChatIndex, generateIndex, getResourceNames };

package/dist/mcp.d.ts

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

package/dist/mcp.js

@@ -1,8 +1,7 @@
-import { n as generateIndex } from "./indexer-DBU0POrK.js";
+import { generateIndex } from "./indexer.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";
-
 //#region src/mcp.ts
 function consolidate(results) {
 	const resources = /* @__PURE__ */ new Set();
@@ -31,6 +30,5 @@ function render(spec, language, items, includeModelProperties) {
 	});
 	return Object.fromEntries(output);
 }
-
 //#endregion
-export { generateIndex, render };
+export { generateIndex, render };

package/dist/providers/algolia.d.ts

@@ -1,10 +1,8 @@
-import { f as ResultType, g as SearchSettings, h as SearchParams, s as ProseIndexEntry } from "../types-Gg968wOz.js";
-import * as SDKJSON from "@stainless/sdk-json";
+import { d as ResultType, h as SearchSettings, m as SearchParams, n as IndexEntry, y as Spec } from "../types-D0suCLuC.js";
 
 //#region src/providers/algolia.d.ts
-declare function buildIndex(appId: string, indexName: string, writeKey: string, spec: SDKJSON.Spec, renderMarkdown: (_: string) => string | null): Promise<void>;
-declare function buildChatIndex(appId: string, indexName: string, writeKey: string, spec: SDKJSON.Spec): Promise<void>;
-declare function buildProseIndex(appId: string, indexName: string, writeKey: string, objects: ProseIndexEntry[]): 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 search({
   settings: {
     appId,
@@ -21,4 +19,4 @@ declare function search({
   settings: SearchSettings;
 }): Promise<ResultType | undefined>;
 //#endregion
-export { buildChatIndex, buildIndex, buildProseIndex, search };
+export { buildChatIndex, buildIndex, search };

package/dist/providers/algolia.js

@@ -1,4 +1,69 @@
-import "../indexer-DBU0POrK.js";
-import { i as search, n as buildIndex, r as buildProseIndex, t as buildChatIndex } from "../algolia-BOY-OcxU.js";
-
-export { buildChatIndex, buildIndex, buildProseIndex, search };
+import { generateChatIndex, generateIndex } from "../indexer.js";
+import { SearchableAttributes, SearchableAttributesChat } from "../types.js";
+import { searchClient } from "@algolia/client-search";
+//#region src/providers/algolia.ts
+async function buildIndex(appId, indexName, writeKey, content, renderMarkdown) {
+	if (!appId || !indexName || !writeKey) return;
+	const objects = Array.isArray(content) ? content : Array.from(generateIndex(content, renderMarkdown));
+	const client = searchClient(appId, writeKey);
+	await client.setSettings({
+		indexName,
+		indexSettings: {
+			highlightPreTag: "<mark>",
+			highlightPostTag: "</mark>",
+			customRanking: ["asc(priority)"],
+			attributesForFaceting: ["language", "kind"],
+			searchableAttributes: [...SearchableAttributes]
+		}
+	});
+	await client.replaceAllObjects({
+		indexName,
+		objects
+	});
+}
+async function buildChatIndex(appId, indexName, writeKey, spec) {
+	if (!appId || !indexName || !writeKey) return;
+	const objects = Array.from(generateChatIndex(spec));
+	const client = searchClient(appId, writeKey);
+	await client.setSettings({
+		indexName,
+		indexSettings: {
+			attributesForFaceting: ["language"],
+			attributeForDistinct: "stainlessPath",
+			searchableAttributes: SearchableAttributesChat
+		}
+	});
+	await client.replaceAllObjects({
+		indexName,
+		objects
+	});
+}
+async function search({ settings: { appId, indexName, searchKey }, params: { query, language, kind } }) {
+	const client = searchClient(appId, searchKey);
+	const filters = language ? `language:${language}` : void 0;
+	const facetFilters = kind ? [`kind:${kind}`] : void 0;
+	const { results } = await client.search({ requests: [{
+		query,
+		indexName,
+		filters,
+		hitsPerPage: 5,
+		facets: ["kind"]
+	}, {
+		query,
+		indexName,
+		filters,
+		facetFilters,
+		facets: ["kind"],
+		hitsPerPage: 50
+	}] });
+	if ("hits" in results[0] && "hits" in results[1]) {
+		const [{ nbHits, facets }, { hits }] = results;
+		return {
+			hits,
+			nbHits: nbHits ?? 0,
+			facets
+		};
+	}
+}
+//#endregion
+export { buildChatIndex, buildIndex, search };

package/dist/providers/fuse.d.ts

@@ -1,18 +1,17 @@
-import { n as IndexEntry } from "../types-Gg968wOz.js";
+import { n as IndexEntry, y as Spec } from "../types-D0suCLuC.js";
 import { DocsLanguage } from "@stainless-api/docs-ui/routing";
-import * as fuse_js0 from "fuse.js";
+import * as _$fuse_js0 from "fuse.js";
 import { FuseIndex } from "fuse.js";
-import * as SDKJSON from "@stainless/sdk-json";
 
 //#region src/providers/fuse.d.ts
 type FuseIndexData = {
   content: IndexEntry[];
   index: FuseIndex<IndexEntry>;
 };
-declare function buildIndex(spec: SDKJSON.Spec, language?: DocsLanguage): FuseIndexData;
+declare function buildIndex(spec: Spec, language?: DocsLanguage): FuseIndexData;
 declare function search({
   content,
   index
-}: FuseIndexData, query: string, limit?: number): fuse_js0.FuseResult<IndexEntry>[];
+}: FuseIndexData, query: string, limit?: number): _$fuse_js0.FuseResult<IndexEntry>[];
 //#endregion
 export { FuseIndexData, buildIndex, search };

package/dist/providers/fuse.js

@@ -1,7 +1,6 @@
-import { n as generateIndex } from "../indexer-DBU0POrK.js";
-import { n as SearchableAttributes } from "../types-BhJLoaNF.js";
+import { generateIndex } from "../indexer.js";
+import { SearchableAttributes } from "../types.js";
 import Fuse from "fuse.js";
-
 //#region src/providers/fuse.ts
 function buildIndex(spec, language) {
 	const idx = Array.from(generateIndex(spec, void 0, false));
@@ -14,6 +13,5 @@ function buildIndex(spec, language) {
 function search({ content, index }, query, limit = 100) {
 	return new Fuse(content, { keys: [...SearchableAttributes] }, index).search(query).slice(0, limit);
 }
-
 //#endregion
-export { buildIndex, search };
+export { buildIndex, search };

package/dist/providers/pagefind.d.ts

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

package/dist/providers/pagefind.js

@@ -1,3 +1,22 @@
-import { t as guideSearch } from "../pagefind-Dcn-gjDe.js";
-
-export { guideSearch };
+//#region src/providers/pagefind.ts
+async function loadPagefind(path) {
+	return await import(
+		/* @vite-ignore */
+		new URL(path, import.meta.url).href
+);
+}
+async function guideSearch(loadPath, query, limit) {
+	try {
+		const response = await (await loadPagefind(loadPath)).search(query);
+		const items = limit ? response.results.slice(0, limit) : response.results;
+		return Promise.all(items.map((result) => result.data().then((data) => ({
+			...result,
+			data
+		}))));
+	} catch (error) {
+		console.error(error);
+		return [];
+	}
+}
+//#endregion
+export { guideSearch };

package/dist/providers/walker.d.ts

@@ -1,9 +1,8 @@
-import { n as IndexEntry } from "../types-Gg968wOz.js";
+import { n as IndexEntry, y as Spec } from "../types-D0suCLuC.js";
 import { DocsLanguage } from "@stainless-api/docs-ui/routing";
-import * as SDKJSON from "@stainless/sdk-json";
 
 //#region src/providers/walker.d.ts
-declare function buildIndex(spec: SDKJSON.Spec): Generator<IndexEntry, any, any>;
+declare function buildIndex(spec: Spec): Generator<IndexEntry, any, any>;
 declare function search(index: Generator<IndexEntry>, language: DocsLanguage, query: string, limit?: number): IndexEntry[];
 //#endregion
 export { buildIndex, search };

package/dist/providers/walker.js

@@ -1,6 +1,5 @@
-import { n as generateIndex } from "../indexer-DBU0POrK.js";
-import { n as SearchableAttributes } from "../types-BhJLoaNF.js";
-
+import { generateIndex } from "../indexer.js";
+import { SearchableAttributes } from "../types.js";
 //#region src/providers/walker.ts
 function buildIndex(spec) {
 	return generateIndex(spec, void 0, false);
@@ -18,6 +17,5 @@ function search(index, language, query, limit = 100) {
 	const results = findEntryInIndex(index, language, query);
 	return Array.from(results).sort((a, b) => a.priority - b.priority).slice(0, limit);
 }
-
 //#endregion
-export { buildIndex, search };
+export { buildIndex, search };