@stainless-api/docs-search 0.1.0-beta.11 → 0.1.0-beta.13
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 +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/mcp.d.ts +1 -1
- package/dist/providers/algolia.d.ts +1 -1
- package/dist/providers/fuse.d.ts +1 -1
- package/dist/providers/pagefind.d.ts +1 -1
- package/dist/providers/walker.d.ts +1 -1
- package/dist/{types-DPHYAARH.d.ts → types-B5G2N6Aw.d.ts} +104 -10
- package/dist/types.d.ts +1 -1
- package/package.json +4 -4
package/dist/context.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-
|
|
1
|
+
import { f as ResultType, g as SearchSettings, h as SearchParams } from "./types-B5G2N6Aw.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
package/dist/mcp.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { b as Spec, f as ResultType, g as SearchSettings, h as SearchParams, s as ProseIndexEntry } from "../types-
|
|
1
|
+
import { b as Spec, f as ResultType, g as SearchSettings, h as SearchParams, s as ProseIndexEntry } from "../types-B5G2N6Aw.js";
|
|
2
2
|
|
|
3
3
|
//#region src/providers/algolia.d.ts
|
|
4
4
|
declare function buildIndex(appId: string, indexName: string, writeKey: string, spec: Spec, renderMarkdown: (_: string) => string | null): Promise<void>;
|
package/dist/providers/fuse.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { b as Spec, n as IndexEntry } from "../types-
|
|
1
|
+
import { b as Spec, n as IndexEntry } from "../types-B5G2N6Aw.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-
|
|
1
|
+
import { t as GuideResultType } from "../types-B5G2N6Aw.js";
|
|
2
2
|
|
|
3
3
|
//#region src/providers/pagefind.d.ts
|
|
4
4
|
declare function guideSearch(loadPath: string, query: string, limit?: number): Promise<GuideResultType[]>;
|
|
@@ -432,6 +432,97 @@ type RubyTypeUnknown = BaseType & {
|
|
|
432
432
|
type SDKSchemaReference = never;
|
|
433
433
|
type SDKSchemaType = never;
|
|
434
434
|
type SDKPropertySchemaReference<T = never> = never;
|
|
435
|
+
/**
|
|
436
|
+
* Base declaration types for CLI command AST
|
|
437
|
+
*/
|
|
438
|
+
type CLIDeclaration = CLICommand | CLIFlag | CLISchemaProperty | CLIStdin | CLIFunction | ErrorDecl;
|
|
439
|
+
/**
|
|
440
|
+
* Represents a command in a CLI environment
|
|
441
|
+
*/
|
|
442
|
+
type CLICommand = BaseDeclaration & {
|
|
443
|
+
kind: 'CLICommand';
|
|
444
|
+
invocation: string[];
|
|
445
|
+
name: string;
|
|
446
|
+
arguments?: CLIArgument[];
|
|
447
|
+
options?: CLIFlag[];
|
|
448
|
+
stdin?: CLIStdin;
|
|
449
|
+
background?: boolean;
|
|
450
|
+
subshell?: boolean;
|
|
451
|
+
workingDir?: string;
|
|
452
|
+
children?: ID[];
|
|
453
|
+
paramsChildren?: ID[];
|
|
454
|
+
responseChildren?: ID[];
|
|
455
|
+
ident: string;
|
|
456
|
+
qualified?: string;
|
|
457
|
+
docstring?: string;
|
|
458
|
+
parameters?: any[];
|
|
459
|
+
responseType?: HttpType;
|
|
460
|
+
};
|
|
461
|
+
/**
|
|
462
|
+
* Represents a command argument
|
|
463
|
+
*/
|
|
464
|
+
type CLIArgument = {
|
|
465
|
+
kind: 'CLIArgument';
|
|
466
|
+
value: string;
|
|
467
|
+
quoted?: boolean;
|
|
468
|
+
docstring?: string;
|
|
469
|
+
quoteType?: 'single' | 'double' | 'backtick';
|
|
470
|
+
};
|
|
471
|
+
/**
|
|
472
|
+
* Represents a command line flag --foo
|
|
473
|
+
*/
|
|
474
|
+
type CLIFlag = BaseDeclaration & {
|
|
475
|
+
kind: 'CLIFlag';
|
|
476
|
+
name?: string;
|
|
477
|
+
enabled?: boolean;
|
|
478
|
+
ident: string;
|
|
479
|
+
flag?: string | {
|
|
480
|
+
name: string;
|
|
481
|
+
};
|
|
482
|
+
title?: string;
|
|
483
|
+
docstring?: string;
|
|
484
|
+
optional?: boolean;
|
|
485
|
+
type?: HttpType;
|
|
486
|
+
constraints?: any;
|
|
487
|
+
schemaType?: string;
|
|
488
|
+
modelPath?: string;
|
|
489
|
+
childrenParentSchema?: any;
|
|
490
|
+
children?: ID[];
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* Represents a CLI property (for return values/response fields)
|
|
494
|
+
*/
|
|
495
|
+
type CLISchemaProperty = BaseDeclaration & {
|
|
496
|
+
kind: 'CLISchemaProperty';
|
|
497
|
+
name: string;
|
|
498
|
+
ident: string;
|
|
499
|
+
type?: HttpType;
|
|
500
|
+
docstring?: string;
|
|
501
|
+
optional?: boolean;
|
|
502
|
+
constraints?: any;
|
|
503
|
+
schemaType?: string;
|
|
504
|
+
children?: ID[];
|
|
505
|
+
childrenParentSchema?: any;
|
|
506
|
+
};
|
|
507
|
+
/**
|
|
508
|
+
* Represents data piped in to stdin
|
|
509
|
+
*/
|
|
510
|
+
type CLIStdin = BaseDeclaration & {
|
|
511
|
+
kind: 'CLIStdin';
|
|
512
|
+
text: string;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Represents a shell function
|
|
516
|
+
*/
|
|
517
|
+
type CLIFunction = BaseDeclaration & {
|
|
518
|
+
kind: 'CLIFunction';
|
|
519
|
+
name: string;
|
|
520
|
+
body: CLICommand[];
|
|
521
|
+
parameters?: string[];
|
|
522
|
+
description?: string;
|
|
523
|
+
docstring?: string;
|
|
524
|
+
children?: ID[];
|
|
525
|
+
};
|
|
435
526
|
type CSharpDeclaration = CSharpDeclFunction | CSharpDeclType | CSharpDeclProperty | CSharpDeclConst | CSharpDeclReference | ErrorDecl;
|
|
436
527
|
type CSharpDeclFunction = BaseDeclaration & {
|
|
437
528
|
kind: 'CSharpDeclFunction';
|
|
@@ -627,6 +718,7 @@ type PhpMethodParameter = {
|
|
|
627
718
|
kind: 'PhpMethodParameter';
|
|
628
719
|
ident: PhpIdentifier;
|
|
629
720
|
typeAnnotation: PhpType;
|
|
721
|
+
optional: boolean;
|
|
630
722
|
hasDefault?: boolean;
|
|
631
723
|
};
|
|
632
724
|
type PhpDeclReference = BaseDeclaration & {
|
|
@@ -642,7 +734,6 @@ type PhpDeclParam = BaseDeclaration & {
|
|
|
642
734
|
type: PhpType;
|
|
643
735
|
optional: boolean;
|
|
644
736
|
isPositional: boolean;
|
|
645
|
-
parentPath?: string;
|
|
646
737
|
default?: unknown;
|
|
647
738
|
oasRef?: string;
|
|
648
739
|
modelPath?: string;
|
|
@@ -701,6 +792,7 @@ type PhpTypeReference<T extends Code = string> = BaseType & {
|
|
|
701
792
|
kind: 'PhpTypeReference';
|
|
702
793
|
typeName: SDKJSONPhpIdentifier<T>;
|
|
703
794
|
$ref?: ID | string;
|
|
795
|
+
typeParameters?: PhpType[];
|
|
704
796
|
};
|
|
705
797
|
type PhpTypeMapArray<T extends Code = string> = BaseType & {
|
|
706
798
|
kind: 'PhpTypeMapArray';
|
|
@@ -780,6 +872,7 @@ type PythonDeclType = BaseDeclaration & {
|
|
|
780
872
|
ident: PythonIdentifier;
|
|
781
873
|
generics?: PythonGenericParameter[];
|
|
782
874
|
type: PythonType;
|
|
875
|
+
childrenParentSchema?: SchemaType;
|
|
783
876
|
children?: ID[];
|
|
784
877
|
};
|
|
785
878
|
type PythonIdentifier = string;
|
|
@@ -1179,9 +1272,9 @@ type ID = string & {
|
|
|
1179
1272
|
type SchemaType = SDKSchemaType;
|
|
1180
1273
|
declare const constraints: readonly ['minLength', 'maxLength', 'format', 'minimum', 'exclusiveMinimum', 'maximum', 'exclusiveMaximum', 'multipleOf'];
|
|
1181
1274
|
type Constraints = Pick<SchemaObject, (typeof constraints)[number]>;
|
|
1182
|
-
declare const SpecLanguages: readonly ['
|
|
1275
|
+
declare const SpecLanguages: readonly ['cli', 'csharp', 'go', 'http', 'java', 'kotlin', 'node', 'php', 'python', 'ruby', 'terraform', 'typescript'];
|
|
1183
1276
|
type SpecLanguage = (typeof SpecLanguages)[number];
|
|
1184
|
-
declare const SnippetLanguages: readonly ['
|
|
1277
|
+
declare const SnippetLanguages: readonly ['cli.default', 'csharp.default', 'go.default', 'http.curl', 'http.powershell', 'java.default', 'kotlin.default', 'node.default', 'php.default', 'python.default', 'ruby.default', 'terraform.default', 'typescript.default'];
|
|
1185
1278
|
type SnippetLanguage<lang extends SpecLanguage = SpecLanguage> = (typeof SnippetLanguages)[number] & `${lang}.${string}`;
|
|
1186
1279
|
/**
|
|
1187
1280
|
* A literal property path from Spec down to a given node
|
|
@@ -1263,17 +1356,18 @@ type BaseType = {
|
|
|
1263
1356
|
};
|
|
1264
1357
|
type Diagnostics = Record<string, DiagnosticExport[]>;
|
|
1265
1358
|
type LanguageDeclNodes = {
|
|
1266
|
-
|
|
1267
|
-
|
|
1359
|
+
cli: CLIDeclaration;
|
|
1360
|
+
csharp: CSharpDeclaration;
|
|
1268
1361
|
go: GoDeclaration;
|
|
1269
|
-
|
|
1270
|
-
terraform: TerraformDeclaration;
|
|
1362
|
+
http: HttpDeclaration;
|
|
1271
1363
|
java: JavaDeclaration;
|
|
1272
1364
|
kotlin: JavaDeclaration;
|
|
1273
|
-
|
|
1274
|
-
csharp: CSharpDeclaration;
|
|
1275
|
-
http: HttpDeclaration;
|
|
1365
|
+
node: TSDeclaration;
|
|
1276
1366
|
php: PhpDeclaration;
|
|
1367
|
+
python: PythonDeclaration;
|
|
1368
|
+
ruby: RubyDeclaration;
|
|
1369
|
+
terraform: TerraformDeclaration;
|
|
1370
|
+
typescript: TSDeclaration;
|
|
1277
1371
|
};
|
|
1278
1372
|
type ErrorDecl = BaseDeclaration & {
|
|
1279
1373
|
kind: 'ErrorDecl';
|
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-
|
|
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-B5G2N6Aw.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.
|
|
3
|
+
"version": "0.1.0-beta.13",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
"fuse.js": "^7.1.0",
|
|
20
20
|
"htmlparser2": "^10.0.0",
|
|
21
21
|
"lucide-react": "^0.562.0",
|
|
22
|
-
"@stainless-api/docs-ui": "0.1.0-beta.
|
|
23
|
-
"@stainless-api/ui-primitives": "0.1.0-beta.
|
|
22
|
+
"@stainless-api/docs-ui": "0.1.0-beta.60",
|
|
23
|
+
"@stainless-api/ui-primitives": "0.1.0-beta.44"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
26
|
"@types/node": "24.10.9",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"tsdown": "^0.20.0-beta.3",
|
|
33
33
|
"typescript": "5.9.3",
|
|
34
34
|
"@stainless/eslint-config": "0.1.0-beta.1",
|
|
35
|
-
"@stainless/sdk-json": "^0.1.0-beta.
|
|
35
|
+
"@stainless/sdk-json": "^0.1.0-beta.3"
|
|
36
36
|
},
|
|
37
37
|
"exports": {
|
|
38
38
|
".": {
|