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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/context.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-2WWqDCEW.js";
1
+ import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-CvCRt8tg.js";
2
2
  import * as react_jsx_runtime0 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/context.d.ts
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { l as QueryKindsType, u as ResultData } from "./types-2WWqDCEW.js";
1
+ import { l as QueryKindsType, u as ResultData } from "./types-CvCRt8tg.js";
2
2
  import * as react_jsx_runtime0 from "react/jsx-runtime";
3
3
 
4
4
  //#region src/form.d.ts
package/dist/indexer.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { b as Resource, n as IndexEntry, x as Spec } from "./types-2WWqDCEW.js";
1
+ import { b as Resource, n as IndexEntry, x as Spec } from "./types-CvCRt8tg.js";
2
2
  import { DocsLanguage } from "@stainless-api/docs-ui/routing";
3
3
 
4
4
  //#region src/indexer.d.ts
package/dist/mcp.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { n as IndexEntry, r as IndexMethod, x as Spec } from "./types-2WWqDCEW.js";
1
+ import { n as IndexEntry, r as IndexMethod, x as Spec } from "./types-CvCRt8tg.js";
2
2
  import { generateIndex } from "./indexer.js";
3
3
  import { DocsLanguage } from "@stainless-api/docs-ui/routing";
4
4
 
@@ -1,4 +1,4 @@
1
- import { f as ResultType, g as SearchSettings, h as SearchParams, n as IndexEntry, s as ProseIndexEntry, x as Spec } from "../types-2WWqDCEW.js";
1
+ import { f as ResultType, g as SearchSettings, h as SearchParams, n as IndexEntry, s as ProseIndexEntry, x as Spec } from "../types-CvCRt8tg.js";
2
2
 
3
3
  //#region src/providers/algolia.d.ts
4
4
  declare function buildIndex(appId: string, indexName: string, writeKey: string, content: Spec | IndexEntry[], renderMarkdown: (_: string) => string | null): Promise<void>;
@@ -1,4 +1,4 @@
1
- import { n as IndexEntry, x as Spec } from "../types-2WWqDCEW.js";
1
+ import { n as IndexEntry, x as Spec } from "../types-CvCRt8tg.js";
2
2
  import { DocsLanguage } from "@stainless-api/docs-ui/routing";
3
3
  import * as fuse_js0 from "fuse.js";
4
4
  import { FuseIndex } from "fuse.js";
@@ -1,4 +1,4 @@
1
- import { t as GuideResultType } from "../types-2WWqDCEW.js";
1
+ import { t as GuideResultType } from "../types-CvCRt8tg.js";
2
2
 
3
3
  //#region src/providers/pagefind.d.ts
4
4
  declare function guideSearch(loadPath: string, query: string, limit?: number): Promise<GuideResultType[]>;
@@ -1,4 +1,4 @@
1
- import { n as IndexEntry, x as Spec } from "../types-2WWqDCEW.js";
1
+ import { n as IndexEntry, x as Spec } from "../types-CvCRt8tg.js";
2
2
  import { DocsLanguage } from "@stainless-api/docs-ui/routing";
3
3
 
4
4
  //#region src/providers/walker.d.ts
@@ -111,7 +111,7 @@ type DiscriminatorObject = {
111
111
  type ExampleObject = {
112
112
  summary?: string;
113
113
  description?: string;
114
- value?: any;
114
+ value?: unknown;
115
115
  externalValue?: string;
116
116
  };
117
117
  type EncodingsObject = {
@@ -139,7 +139,7 @@ type ResponseContentObject = {
139
139
  type HeadersObject = {
140
140
  [key: string]: HeaderObject;
141
141
  };
142
- type SupportedLanguage = 'node' | 'typescript' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby' | 'terraform' | 'cli' | 'php' | 'csharp' | 'http';
142
+ type SupportedLanguage = 'node' | 'typescript' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby' | 'terraform' | 'cli' | 'php' | 'csharp' | 'sql' | 'http' | 'openapi';
143
143
  interface Config {
144
144
  docs: {
145
145
  title?: string | undefined;
@@ -160,22 +160,7 @@ interface Config {
160
160
  show_security?: boolean | undefined;
161
161
  show_readme?: boolean | undefined;
162
162
  base_path?: string | undefined;
163
- navigation?: {
164
- menubar?: {
165
- title: string;
166
- icon?: 'Github' | 'BookOpen' | 'Code' | 'Folder' | 'Mail' | 'NPM' | 'Search' | 'Package' | 'User' | 'Pen' | 'Pencil' | 'Wrench' | 'Bot' | 'FileText' | 'Lightbulb' | 'Sparkles' | 'Menu' | 'History' | undefined;
167
- variant?: 'ghost-muted' | 'outline-muted' | 'outline' | undefined;
168
- href?: string | undefined;
169
- page?: string | undefined;
170
- }[] | undefined;
171
- sidebar?: {
172
- title: string;
173
- icon?: 'Github' | 'BookOpen' | 'Code' | 'Folder' | 'Mail' | 'NPM' | 'Search' | 'Package' | 'User' | 'Pen' | 'Pencil' | 'Wrench' | 'Bot' | 'FileText' | 'Lightbulb' | 'Sparkles' | 'Menu' | 'History' | undefined;
174
- variant?: 'ghost-muted' | 'outline-muted' | 'outline' | undefined;
175
- href?: string | undefined;
176
- page?: string | undefined;
177
- }[] | undefined;
178
- } | undefined;
163
+ navigation?: unknown;
179
164
  pages?: Record<string, string> | undefined;
180
165
  resources?: {
181
166
  title: string;
@@ -225,7 +210,8 @@ type HttpDeclProperty = BaseDeclaration & {
225
210
  location?: string;
226
211
  type: HttpType;
227
212
  constraints?: Constraints;
228
- default?: any;
213
+ default?: unknown;
214
+ examples?: unknown[];
229
215
  optional?: boolean;
230
216
  nullable?: boolean;
231
217
  declare?: boolean;
@@ -333,6 +319,7 @@ type RubyDeclProperty = BaseDeclaration & {
333
319
  type: RubyType;
334
320
  constraints?: Constraints;
335
321
  optional?: boolean;
322
+ examples?: unknown[];
336
323
  schemaType?: SchemaType;
337
324
  modelPath?: string;
338
325
  childrenParentSchema?: SchemaType;
@@ -430,7 +417,7 @@ type RubyTypeUnknown = BaseType & {
430
417
  kind: 'RubyTypeUnknown';
431
418
  };
432
419
  type SDKSchemaReference = never;
433
- type SDKSchemaType = never;
420
+ type SDKSchemaType = string;
434
421
  type SDKPropertySchemaReference<T = never> = never;
435
422
  /**
436
423
  * Base declaration types for CLI command AST
@@ -455,7 +442,7 @@ type CLICommand = BaseDeclaration & {
455
442
  ident: string;
456
443
  qualified?: string;
457
444
  docstring?: string;
458
- parameters?: any[];
445
+ parameters?: unknown[];
459
446
  responseType?: HttpType;
460
447
  };
461
448
  /**
@@ -483,10 +470,10 @@ type CLIFlag = BaseDeclaration & {
483
470
  docstring?: string;
484
471
  optional?: boolean;
485
472
  type?: HttpType;
486
- constraints?: any;
473
+ constraints?: unknown;
487
474
  schemaType?: string;
488
475
  modelPath?: string;
489
- childrenParentSchema?: any;
476
+ childrenParentSchema?: unknown;
490
477
  children?: ID[];
491
478
  };
492
479
  /**
@@ -499,10 +486,10 @@ type CLISchemaProperty = BaseDeclaration & {
499
486
  type?: HttpType;
500
487
  docstring?: string;
501
488
  optional?: boolean;
502
- constraints?: any;
489
+ constraints?: unknown;
503
490
  schemaType?: string;
504
491
  children?: ID[];
505
- childrenParentSchema?: any;
492
+ childrenParentSchema?: unknown;
506
493
  };
507
494
  /**
508
495
  * Represents data piped in to stdin
@@ -557,6 +544,7 @@ type CSharpDeclProperty = BaseDeclaration & {
557
544
  type: CSharpType;
558
545
  optional?: boolean;
559
546
  nullable?: boolean;
547
+ examples?: unknown[];
560
548
  schemaType?: SchemaType;
561
549
  modelPath?: string;
562
550
  childrenParentSchema?: SchemaType;
@@ -648,6 +636,7 @@ type JavaDeclProperty = BaseDeclaration & {
648
636
  ident: JavaIdentifier;
649
637
  type: JavaType;
650
638
  optional?: boolean;
639
+ examples?: unknown[];
651
640
  schemaType?: SchemaType;
652
641
  modelPath?: string;
653
642
  childrenParentSchema?: SchemaType;
@@ -735,6 +724,7 @@ type PhpDeclParam = BaseDeclaration & {
735
724
  optional: boolean;
736
725
  isPositional: boolean;
737
726
  default?: unknown;
727
+ examples?: unknown[];
738
728
  oasRef?: string;
739
729
  modelPath?: string;
740
730
  docstring?: string;
@@ -760,6 +750,7 @@ type PhpDeclClassProperty = BaseDeclaration & {
760
750
  nullable: boolean;
761
751
  docstring?: string;
762
752
  default?: string;
753
+ examples?: unknown[];
763
754
  deprecated?: string | boolean;
764
755
  modelPath?: string;
765
756
  children?: ID[];
@@ -888,7 +879,8 @@ type PythonDeclProperty = BaseDeclaration & {
888
879
  type: PythonType;
889
880
  constraints?: Constraints;
890
881
  optional?: boolean;
891
- default?: any;
882
+ default?: unknown;
883
+ examples?: unknown[];
892
884
  schemaType?: SchemaType;
893
885
  modelPath?: string;
894
886
  childrenParentSchema?: SchemaType;
@@ -1032,7 +1024,8 @@ type TerraformAttribute = {
1032
1024
  isBodyRootParam?: boolean;
1033
1025
  syntheticType?: 'id' | 'find-by' | 'max-items' | 'items' | 'timeout';
1034
1026
  schemaType: TerraformSchemaType;
1035
- pathExpr: PathExpression$1;
1027
+ pathExpr: PathExpression$1; /** whether this attribute is immediately nested inside a computed (or computed_optional) collection/object */
1028
+ nestedInComputedAttribute?: boolean;
1036
1029
  };
1037
1030
  declare const TerraformPathValidations: readonly ['requiredTogether', 'atLeastOneOf', 'exactlyOneOf', 'conflicting'];
1038
1031
  type PathValidators = Record<(typeof TerraformPathValidations)[number], PathExpression$1[][]>;
@@ -1148,7 +1141,8 @@ type TSDeclProperty = BaseDeclaration & {
1148
1141
  constraints?: Constraints;
1149
1142
  optional?: boolean;
1150
1143
  declare?: boolean;
1151
- default?: any;
1144
+ default?: unknown;
1145
+ examples?: unknown[];
1152
1146
  schemaType?: SchemaType;
1153
1147
  modelPath?: string;
1154
1148
  childrenParentSchema?: SchemaType;
@@ -1302,7 +1296,27 @@ type Spec = {
1302
1296
  } };
1303
1297
  readme: { [lang in SpecLanguage]?: string };
1304
1298
  decls: { [lang in SpecLanguage]?: Record<string, LanguageDeclNodes[lang]> };
1305
- snippets: { [key in SnippetLanguage]?: Record<string, string> };
1299
+ snippets: { [key in SnippetLanguage]?: Record<string, {
1300
+ default: {
1301
+ content: string;
1302
+ };
1303
+ [key: `custom:${string}`]: {
1304
+ content: string;
1305
+ };
1306
+ }> };
1307
+ snippetResponses: {
1308
+ http: Record<string, {
1309
+ default?: {
1310
+ status: string;
1311
+ content: string;
1312
+ contentType?: string;
1313
+ }[];
1314
+ [key: `custom:${string}`]: {
1315
+ status?: string;
1316
+ content: string;
1317
+ }[];
1318
+ }>;
1319
+ };
1306
1320
  };
1307
1321
  type Resource = (HasConfigRef & HasStainlessPath) & {
1308
1322
  kind: 'resource';
@@ -1326,7 +1340,7 @@ type Method = (HasStainlessPath & HasOASRef) & {
1326
1340
  summary?: string;
1327
1341
  httpMethod: string;
1328
1342
  endpoint: string;
1329
- deprecated?: string | boolean;
1343
+ deprecated?: string | boolean; /** @deprecated - use snippetResponses at the top level */
1330
1344
  exampleResponses?: Record<string, ResponseContentObject>;
1331
1345
  security: Record<string, string[]>[] | undefined;
1332
1346
  'x-api-token-group'?: string[];
@@ -1430,7 +1444,8 @@ type GoDeclProperty = BaseDeclaration & {
1430
1444
  type: GoType;
1431
1445
  constraints?: Constraints;
1432
1446
  optional?: boolean;
1433
- default?: any;
1447
+ default?: unknown;
1448
+ examples?: unknown[];
1434
1449
  schemaType?: SchemaType;
1435
1450
  modelPath?: string;
1436
1451
  childrenParentSchema?: SchemaType;
package/dist/types.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- 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-2WWqDCEW.js";
1
+ 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";
2
2
  export { GuideResultType, IndexEntry, IndexMethod, IndexModel, IndexProperty, IndexResource, ProseIndexEntry, QueryKinds, QueryKindsType, ResultData, ResultRecordType, ResultType, RoutableJsonNode, SearchAttributeNames, SearchParams, SearchSettings, SearchableAttributes, SearchableAttributesChat, SearchableAttributesProse };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stainless-api/docs-search",
3
- "version": "0.1.0-beta.24",
3
+ "version": "0.1.0-beta.25",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -19,7 +19,7 @@
19
19
  "fuse.js": "^7.1.0",
20
20
  "htmlparser2": "^10.1.0",
21
21
  "lucide-react": "^0.562.0",
22
- "@stainless-api/docs-ui": "0.1.0-beta.71",
22
+ "@stainless-api/docs-ui": "0.1.0-beta.72",
23
23
  "@stainless-api/ui-primitives": "0.1.0-beta.47"
24
24
  },
25
25
  "devDependencies": {
@@ -32,7 +32,7 @@
32
32
  "tsdown": "^0.20.0",
33
33
  "typescript": "5.9.3",
34
34
  "@stainless/eslint-config": "0.1.0-beta.1",
35
- "@stainless/sdk-json": "^0.1.0-beta.4"
35
+ "@stainless/sdk-json": "^0.1.0-beta.5"
36
36
  },
37
37
  "exports": {
38
38
  ".": {