@scalar/workspace-store 0.52.0 → 0.54.0
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/CHANGELOG.md +55 -0
- package/dist/channel-example/build-connection-url.d.ts.map +1 -1
- package/dist/channel-example/build-connection-url.js +11 -8
- package/dist/channel-example/get-all-channel-messages.d.ts +10 -0
- package/dist/channel-example/get-all-channel-messages.d.ts.map +1 -0
- package/dist/channel-example/get-all-channel-messages.js +16 -0
- package/dist/channel-example/get-asyncapi-security-requirements.d.ts +7 -0
- package/dist/channel-example/get-asyncapi-security-requirements.d.ts.map +1 -0
- package/dist/channel-example/get-asyncapi-security-requirements.js +76 -0
- package/dist/channel-example/get-channel-connection-context.d.ts +16 -0
- package/dist/channel-example/get-channel-connection-context.d.ts.map +1 -0
- package/dist/channel-example/get-channel-connection-context.js +120 -0
- package/dist/channel-example/get-channel-connection-security.d.ts +8 -0
- package/dist/channel-example/get-channel-connection-security.d.ts.map +1 -0
- package/dist/channel-example/get-channel-connection-security.js +20 -0
- package/dist/channel-example/get-channel-operations.d.ts +11 -0
- package/dist/channel-example/get-channel-operations.d.ts.map +1 -0
- package/dist/channel-example/get-channel-operations.js +20 -0
- package/dist/channel-example/get-channel-parameters.d.ts +14 -0
- package/dist/channel-example/get-channel-parameters.d.ts.map +1 -0
- package/dist/channel-example/get-channel-parameters.js +59 -0
- package/dist/channel-example/index.d.ts +15 -0
- package/dist/channel-example/index.d.ts.map +1 -1
- package/dist/channel-example/index.js +9 -0
- package/dist/channel-example/resolve-channel.d.ts +11 -0
- package/dist/channel-example/resolve-channel.d.ts.map +1 -0
- package/dist/channel-example/resolve-channel.js +13 -0
- package/dist/channel-example/resolve-operation-channel.d.ts +11 -0
- package/dist/channel-example/resolve-operation-channel.d.ts.map +1 -0
- package/dist/channel-example/resolve-operation-channel.js +39 -0
- package/dist/channel-example/resolve-operation-with-traits.d.ts +6 -0
- package/dist/channel-example/resolve-operation-with-traits.d.ts.map +1 -0
- package/dist/channel-example/resolve-operation-with-traits.js +41 -0
- package/dist/channel-example/servers.d.ts.map +1 -1
- package/dist/channel-example/servers.js +23 -0
- package/dist/channel-example/types.d.ts +41 -0
- package/dist/channel-example/types.d.ts.map +1 -0
- package/dist/channel-example/types.js +1 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +8 -8
- package/dist/entities/auth/schema.d.ts +1473 -88
- package/dist/entities/auth/schema.d.ts.map +1 -1
- package/dist/events/definitions/meta.d.ts +5 -3
- package/dist/events/definitions/meta.d.ts.map +1 -1
- package/dist/events/definitions/server.d.ts +21 -0
- package/dist/events/definitions/server.d.ts.map +1 -1
- package/dist/events/definitions/workspace.d.ts +7 -3
- package/dist/events/definitions/workspace.d.ts.map +1 -1
- package/dist/helpers/get-name-from-ref.d.ts +15 -0
- package/dist/helpers/get-name-from-ref.d.ts.map +1 -0
- package/dist/helpers/get-name-from-ref.js +37 -0
- package/dist/mutators/index.d.ts +4 -0
- package/dist/mutators/index.d.ts.map +1 -1
- package/dist/mutators/server.d.ts +26 -0
- package/dist/mutators/server.d.ts.map +1 -1
- package/dist/mutators/server.js +44 -1
- package/dist/navigation/get-navigation-options.d.ts +2 -2
- package/dist/navigation/get-navigation-options.d.ts.map +1 -1
- package/dist/navigation/get-navigation-options.js +26 -3
- package/dist/navigation/helpers/traverse-asyncapi-document.d.ts +23 -0
- package/dist/navigation/helpers/traverse-asyncapi-document.d.ts.map +1 -0
- package/dist/navigation/helpers/traverse-asyncapi-document.js +479 -0
- package/dist/navigation/helpers/traverse-description.d.ts +4 -3
- package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-description.js +2 -2
- package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-document.js +3 -3
- package/dist/navigation/index.d.ts +1 -0
- package/dist/navigation/index.d.ts.map +1 -1
- package/dist/navigation/index.js +1 -0
- package/dist/navigation/types.d.ts +3 -0
- package/dist/navigation/types.d.ts.map +1 -1
- package/dist/request-example/builder/body/build-request-body.d.ts.map +1 -1
- package/dist/request-example/builder/body/build-request-body.js +32 -1
- package/dist/request-example/builder/body/serialize-form-property.d.ts +23 -0
- package/dist/request-example/builder/body/serialize-form-property.d.ts.map +1 -0
- package/dist/request-example/builder/body/serialize-form-property.js +101 -0
- package/dist/request-example/builder/header/de-serialize-parameter.d.ts +4 -1
- package/dist/request-example/builder/header/de-serialize-parameter.d.ts.map +1 -1
- package/dist/request-example/builder/header/de-serialize-parameter.js +19 -13
- package/dist/request-example/builder/index.d.ts +1 -0
- package/dist/request-example/builder/index.d.ts.map +1 -1
- package/dist/request-example/builder/index.js +1 -0
- package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts +1 -1
- package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts.map +1 -1
- package/dist/request-example/context/security/extract-security-scheme-secrets.js +12 -8
- package/dist/request-example/context/security/merge-security.d.ts +1 -1
- package/dist/request-example/context/security/merge-security.d.ts.map +1 -1
- package/dist/request-example/context/security/merge-security.js +2 -2
- package/dist/request-example/index.d.ts +1 -1
- package/dist/request-example/index.d.ts.map +1 -1
- package/dist/request-example/index.js +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +1 -3
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.js +0 -2
- package/dist/schemas/extensions/operation/index.d.ts +1 -1
- package/dist/schemas/extensions/operation/index.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.d.ts +71 -0
- package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.js +50 -7
- package/dist/schemas/navigation.d.ts +113 -4
- package/dist/schemas/navigation.d.ts.map +1 -1
- package/dist/schemas/navigation.js +22 -0
- package/dist/schemas/reference-config/index.d.ts +286 -9
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.d.ts +286 -9
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/v3.1/openapi/index.d.ts +0 -1
- package/dist/schemas/v3.1/openapi/index.d.ts.map +1 -1
- package/dist/schemas/v3.1/openapi/index.js +59 -17
- package/dist/schemas/v3.1/strict/info.d.ts +0 -1
- package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +11168 -1473
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.js +4 -1
- package/dist/schemas/v3.1/strict/operation.d.ts +25 -0
- package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/ref-definitions.d.ts +3 -0
- package/dist/schemas/v3.1/strict/ref-definitions.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/ref-definitions.js +3 -0
- package/dist/schemas/v3.1/strict/schema.d.ts +387 -26
- package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/schema.js +53 -28
- package/dist/schemas/workspace-specification/index.d.ts +1 -1
- package/dist/schemas/workspace.d.ts +2 -3
- package/dist/schemas/workspace.d.ts.map +1 -1
- package/dist/schemas/workspace.js +5 -1
- package/package.json +7 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-code-samples.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/x-code-samples.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"x-code-samples.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/x-code-samples.ts"],"names":[],"mappings":"AAqCA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQ7B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,eAAO,MAAM,WAAW;;;;EAItB,CAAA;AAuBF,MAAM,MAAM,YAAY,GAAG;IACzB,eAAe,CAAC,EAAE,WAAW,EAAE,CAAA;IAC/B,gBAAgB,CAAC,EAAE,WAAW,EAAE,CAAA;IAChC,mBAAmB,CAAC,EAAE,WAAW,EAAE,CAAA;IACnC,UAAU,CAAC,EAAE;QACX,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAA;QACpC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;KAC/B,CAAA;IACD,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/C,sBAAsB,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;IAC9D,mBAAmB,CAAC,EAAE,WAAW,EAAE,CAAA;CACpC,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQvB,CAAA"}
|
|
@@ -1,28 +1,71 @@
|
|
|
1
1
|
import { Type } from '@scalar/typebox';
|
|
2
|
-
import { array, object, optional, string } from '@scalar/validation';
|
|
2
|
+
import { array, object, optional, record, string, union, unknown } from '@scalar/validation';
|
|
3
3
|
const XCodeSampleSchema = Type.Object({
|
|
4
4
|
lang: Type.Optional(Type.String()),
|
|
5
5
|
label: Type.Optional(Type.String()),
|
|
6
6
|
source: Type.String(),
|
|
7
7
|
});
|
|
8
|
+
/** A single ReadMe custom code sample (`x-readme.code-samples`). */
|
|
9
|
+
const XReadmeCodeSampleSchema = Type.Object({
|
|
10
|
+
language: Type.Optional(Type.String()),
|
|
11
|
+
code: Type.String(),
|
|
12
|
+
name: Type.Optional(Type.String()),
|
|
13
|
+
install: Type.Optional(Type.String()),
|
|
14
|
+
correspondingExample: Type.Optional(Type.String()),
|
|
15
|
+
});
|
|
16
|
+
/** ReadMe extension object. Only `code-samples` carries source code. */
|
|
17
|
+
const XReadmeSchema = Type.Object({
|
|
18
|
+
'code-samples': Type.Optional(Type.Array(XReadmeCodeSampleSchema)),
|
|
19
|
+
'samples-languages': Type.Optional(Type.Array(Type.String())),
|
|
20
|
+
});
|
|
21
|
+
/**
|
|
22
|
+
* A Stainless/Scalar example: per-language request snippets, with an optional
|
|
23
|
+
* title and response. Matches the shape of `x-stainless-examples`.
|
|
24
|
+
*/
|
|
25
|
+
const XLanguageExampleSchema = Type.Object({
|
|
26
|
+
title: Type.Optional(Type.String()),
|
|
27
|
+
request: Type.Optional(Type.Record(Type.String(), Type.String())),
|
|
28
|
+
response: Type.Optional(Type.Unknown()),
|
|
29
|
+
});
|
|
30
|
+
/** A single example or an array of examples. */
|
|
31
|
+
const XLanguageExamplesSchema = Type.Union([XLanguageExampleSchema, Type.Array(XLanguageExampleSchema)]);
|
|
8
32
|
export const XCodeSamplesSchema = Type.Object({
|
|
9
33
|
'x-codeSamples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
10
34
|
'x-code-samples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
11
35
|
'x-custom-examples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
36
|
+
'x-readme': Type.Optional(XReadmeSchema),
|
|
37
|
+
'x-stainless-snippets': Type.Optional(Type.Record(Type.String(), Type.String())),
|
|
38
|
+
'x-stainless-examples': Type.Optional(XLanguageExamplesSchema),
|
|
39
|
+
'x-scalar-examples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
12
40
|
});
|
|
13
41
|
export const XCodeSample = object({
|
|
14
42
|
lang: optional(string()),
|
|
15
43
|
label: optional(string()),
|
|
16
44
|
source: string(),
|
|
17
|
-
}, {
|
|
18
|
-
typeName: 'XCodeSample',
|
|
19
|
-
typeComment: 'A single code sample for documentation or examples',
|
|
20
45
|
});
|
|
46
|
+
const XReadmeCodeSample = object({
|
|
47
|
+
language: optional(string()),
|
|
48
|
+
code: string(),
|
|
49
|
+
name: optional(string()),
|
|
50
|
+
install: optional(string()),
|
|
51
|
+
correspondingExample: optional(string()),
|
|
52
|
+
});
|
|
53
|
+
const XReadme = object({
|
|
54
|
+
'code-samples': optional(array(XReadmeCodeSample)),
|
|
55
|
+
'samples-languages': optional(array(string())),
|
|
56
|
+
});
|
|
57
|
+
const XLanguageExample = object({
|
|
58
|
+
title: optional(string()),
|
|
59
|
+
request: optional(record(string(), string())),
|
|
60
|
+
response: optional(unknown()),
|
|
61
|
+
});
|
|
62
|
+
const XLanguageExamples = union([XLanguageExample, array(XLanguageExample)]);
|
|
21
63
|
export const XCodeSamples = object({
|
|
22
64
|
'x-codeSamples': optional(array(XCodeSample)),
|
|
23
65
|
'x-code-samples': optional(array(XCodeSample)),
|
|
24
66
|
'x-custom-examples': optional(array(XCodeSample)),
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
67
|
+
'x-readme': optional(XReadme),
|
|
68
|
+
'x-stainless-snippets': optional(record(string(), string())),
|
|
69
|
+
'x-stainless-examples': optional(XLanguageExamples),
|
|
70
|
+
'x-scalar-examples': optional(array(XCodeSample)),
|
|
28
71
|
});
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type HttpMethod } from '@scalar/helpers/http/http-methods';
|
|
2
2
|
import { type TLiteral } from '@scalar/typebox';
|
|
3
|
+
import type { AsyncApiInfoObject } from '@scalar/types/asyncapi/3.1';
|
|
3
4
|
import type { InfoObject } from '../schemas/v3.1/strict/info.js';
|
|
4
5
|
import type { OperationObject } from '../schemas/v3.1/strict/operation.js';
|
|
5
6
|
import type { SchemaObject } from '../schemas/v3.1/strict/schema.js';
|
|
@@ -90,6 +91,71 @@ export type TraversedOperation = BaseSchema & {
|
|
|
90
91
|
isDeprecated?: boolean;
|
|
91
92
|
children?: TraversedEntry[];
|
|
92
93
|
};
|
|
94
|
+
export declare const TraversedAsyncApiOperationSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
95
|
+
id: import("@scalar/typebox").TString;
|
|
96
|
+
title: import("@scalar/typebox").TString;
|
|
97
|
+
}>, import("@scalar/typebox").TObject<{
|
|
98
|
+
type: TLiteral<"asyncapi-operation">;
|
|
99
|
+
operationName: import("@scalar/typebox").TString;
|
|
100
|
+
action: import("@scalar/typebox").TUnion<[TLiteral<"send">, TLiteral<"receive">]>;
|
|
101
|
+
channelName: import("@scalar/typebox").TString;
|
|
102
|
+
channelAddress: import("@scalar/typebox").TString;
|
|
103
|
+
children: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"TraversedEntryObject">>>;
|
|
104
|
+
}>]>;
|
|
105
|
+
/**
|
|
106
|
+
* An entry representing an AsyncAPI operation in the navigation structure.
|
|
107
|
+
*/
|
|
108
|
+
export type TraversedAsyncApiOperation = BaseSchema & {
|
|
109
|
+
type: 'asyncapi-operation';
|
|
110
|
+
/** Key in `document.operations` */
|
|
111
|
+
operationName: string;
|
|
112
|
+
action: 'send' | 'receive';
|
|
113
|
+
/** Resolved channel key in `document.channels` */
|
|
114
|
+
channelName: string;
|
|
115
|
+
/** Channel address for display and routing */
|
|
116
|
+
channelAddress: string;
|
|
117
|
+
/** Messages available on this operation */
|
|
118
|
+
children?: TraversedEntry[];
|
|
119
|
+
};
|
|
120
|
+
export declare const TraversedAsyncApiChannelSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
121
|
+
id: import("@scalar/typebox").TString;
|
|
122
|
+
title: import("@scalar/typebox").TString;
|
|
123
|
+
}>, import("@scalar/typebox").TObject<{
|
|
124
|
+
type: TLiteral<"asyncapi-channel">;
|
|
125
|
+
channelName: import("@scalar/typebox").TString;
|
|
126
|
+
channelAddress: import("@scalar/typebox").TString;
|
|
127
|
+
children: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"TraversedEntryObject">>>;
|
|
128
|
+
}>]>;
|
|
129
|
+
/**
|
|
130
|
+
* An entry representing an AsyncAPI channel in the navigation structure.
|
|
131
|
+
*/
|
|
132
|
+
export type TraversedAsyncApiChannel = BaseSchema & {
|
|
133
|
+
type: 'asyncapi-channel';
|
|
134
|
+
/** Key in `document.channels` */
|
|
135
|
+
channelName: string;
|
|
136
|
+
/** Channel address for display and routing */
|
|
137
|
+
channelAddress: string;
|
|
138
|
+
/** Operations on the channel */
|
|
139
|
+
children?: TraversedEntry[];
|
|
140
|
+
};
|
|
141
|
+
export declare const TraversedAsyncApiMessageSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
142
|
+
id: import("@scalar/typebox").TString;
|
|
143
|
+
title: import("@scalar/typebox").TString;
|
|
144
|
+
}>, import("@scalar/typebox").TObject<{
|
|
145
|
+
type: TLiteral<"asyncapi-message">;
|
|
146
|
+
messageName: import("@scalar/typebox").TString;
|
|
147
|
+
channelName: import("@scalar/typebox").TString;
|
|
148
|
+
}>]>;
|
|
149
|
+
/**
|
|
150
|
+
* An entry representing an AsyncAPI message in the navigation structure.
|
|
151
|
+
*/
|
|
152
|
+
export type TraversedAsyncApiMessage = BaseSchema & {
|
|
153
|
+
type: 'asyncapi-message';
|
|
154
|
+
/** Key in `channel.messages` */
|
|
155
|
+
messageName: string;
|
|
156
|
+
/** Parent channel key in `document.channels` */
|
|
157
|
+
channelName: string;
|
|
158
|
+
};
|
|
93
159
|
export declare const TraversedSchemaSchemaDefinition: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
94
160
|
id: import("@scalar/typebox").TString;
|
|
95
161
|
title: import("@scalar/typebox").TString;
|
|
@@ -187,6 +253,31 @@ export declare const TraversedEntrySchemaDefinition: import("@scalar/typebox").T
|
|
|
187
253
|
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
188
254
|
id: import("@scalar/typebox").TString;
|
|
189
255
|
title: import("@scalar/typebox").TString;
|
|
256
|
+
}>, import("@scalar/typebox").TObject<{
|
|
257
|
+
type: TLiteral<"asyncapi-operation">;
|
|
258
|
+
operationName: import("@scalar/typebox").TString;
|
|
259
|
+
action: import("@scalar/typebox").TUnion<[TLiteral<"send">, TLiteral<"receive">]>;
|
|
260
|
+
channelName: import("@scalar/typebox").TString;
|
|
261
|
+
channelAddress: import("@scalar/typebox").TString;
|
|
262
|
+
children: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"TraversedEntryObject">>>;
|
|
263
|
+
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
264
|
+
id: import("@scalar/typebox").TString;
|
|
265
|
+
title: import("@scalar/typebox").TString;
|
|
266
|
+
}>, import("@scalar/typebox").TObject<{
|
|
267
|
+
type: TLiteral<"asyncapi-channel">;
|
|
268
|
+
channelName: import("@scalar/typebox").TString;
|
|
269
|
+
channelAddress: import("@scalar/typebox").TString;
|
|
270
|
+
children: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"TraversedEntryObject">>>;
|
|
271
|
+
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
272
|
+
id: import("@scalar/typebox").TString;
|
|
273
|
+
title: import("@scalar/typebox").TString;
|
|
274
|
+
}>, import("@scalar/typebox").TObject<{
|
|
275
|
+
type: TLiteral<"asyncapi-message">;
|
|
276
|
+
messageName: import("@scalar/typebox").TString;
|
|
277
|
+
channelName: import("@scalar/typebox").TString;
|
|
278
|
+
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
279
|
+
id: import("@scalar/typebox").TString;
|
|
280
|
+
title: import("@scalar/typebox").TString;
|
|
190
281
|
}>, import("@scalar/typebox").TObject<{
|
|
191
282
|
type: TLiteral<"model">;
|
|
192
283
|
ref: import("@scalar/typebox").TString;
|
|
@@ -233,7 +324,7 @@ export declare const TraversedEntrySchemaDefinition: import("@scalar/typebox").T
|
|
|
233
324
|
name: import("@scalar/typebox").TString;
|
|
234
325
|
children: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TRef<"TraversedEntryObject">>>;
|
|
235
326
|
}>]>]>;
|
|
236
|
-
export type TraversedEntry = TraversedDescription | TraversedOperation | TraversedSchema | TraversedTag | TraversedWebhook | TraversedExample | TraversedDocument | TraversedModels;
|
|
327
|
+
export type TraversedEntry = TraversedDescription | TraversedOperation | TraversedAsyncApiOperation | TraversedAsyncApiChannel | TraversedAsyncApiMessage | TraversedSchema | TraversedTag | TraversedWebhook | TraversedExample | TraversedDocument | TraversedModels;
|
|
237
328
|
/**
|
|
238
329
|
* Type helper for when we are storing the parent entry in the entry itself.
|
|
239
330
|
* The parent is recursively defined to also include its own parent, except for
|
|
@@ -244,11 +335,11 @@ export type WithParent<Entry extends TraversedEntry> = Entry & {
|
|
|
244
335
|
};
|
|
245
336
|
export type DocumentIdProps = {
|
|
246
337
|
name: string;
|
|
247
|
-
info: InfoObject;
|
|
338
|
+
info: InfoObject | AsyncApiInfoObject;
|
|
248
339
|
type: 'document';
|
|
249
340
|
};
|
|
250
341
|
type DescriptionIdProps = {
|
|
251
|
-
info: InfoObject;
|
|
342
|
+
info: InfoObject | AsyncApiInfoObject;
|
|
252
343
|
type: 'text';
|
|
253
344
|
slug?: string;
|
|
254
345
|
depth?: number;
|
|
@@ -297,7 +388,25 @@ type ExampleProps = {
|
|
|
297
388
|
name: string;
|
|
298
389
|
type: 'example';
|
|
299
390
|
};
|
|
300
|
-
|
|
391
|
+
type AsyncApiOperationProps = {
|
|
392
|
+
parentId: string;
|
|
393
|
+
operationName: string;
|
|
394
|
+
type: 'asyncapi-operation';
|
|
395
|
+
parentTag?: ParentTag;
|
|
396
|
+
};
|
|
397
|
+
type AsyncApiChannelProps = {
|
|
398
|
+
parentId: string;
|
|
399
|
+
channelName: string;
|
|
400
|
+
type: 'asyncapi-channel';
|
|
401
|
+
parentTag?: ParentTag;
|
|
402
|
+
};
|
|
403
|
+
type AsyncApiMessageProps = {
|
|
404
|
+
parentId: string;
|
|
405
|
+
messageName: string;
|
|
406
|
+
channelName: string;
|
|
407
|
+
type: 'asyncapi-message';
|
|
408
|
+
};
|
|
409
|
+
export type IdGeneratorProps = DocumentIdProps | DescriptionIdProps | TagProps | OperationProps | AsyncApiOperationProps | AsyncApiChannelProps | AsyncApiMessageProps | WebhookProps | ModelProps | ExampleProps;
|
|
301
410
|
export type IdGenerator = (props: IdGeneratorProps) => string;
|
|
302
411
|
export {};
|
|
303
412
|
//# sourceMappingURL=navigation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/schemas/navigation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACjF,OAAO,EAAE,KAAK,QAAQ,EAAQ,MAAM,iBAAiB,CAAA;
|
|
1
|
+
{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/schemas/navigation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACjF,OAAO,EAAE,KAAK,QAAQ,EAAQ,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAGpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAE1D,eAAO,MAAM,8BAA8B;;;EAGzC,CAAA;AAEF,KAAK,UAAU,GAAG;IAChB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAA;IACV,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,eAAO,MAAM,iCAAiC;;;;;;;;IAQ7C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG;IAC3C,IAAI,EAAE,UAAU,CAAA;IAChB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,eAAO,MAAM,oCAAoC;;;;;;IAMhD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;IAM5C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAC1C,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;YAK0C,QAAQ,CAAC,UAAU,CAAC;;;;IAK5G,CAAA;AACD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,0CAA0C;;;;;;;;;;IAUtD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,UAAU,GAAG;IACpD,IAAI,EAAE,oBAAoB,CAAA;IAC1B,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAA;IACnB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAA;IACtB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,wCAAwC;;;;;;;;IAQpD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG;IAClD,IAAI,EAAE,kBAAkB,CAAA;IACxB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,wCAAwC;;;;;;;IAOpD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG;IAClD,IAAI,EAAE,kBAAkB,CAAA;IACxB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,gDAAgD;IAChD,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;IAO3C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG;IACzC,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,gCAAgC;;;;;;YAK4C,QAAQ,CAAC,UAAU,CAAC;;;IAI5G,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG;IAC1C,IAAI,EAAE,SAAS,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,eAAO,MAAM,4BAA4B;;;;;;;;;;;IAWxC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG;IACtC,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED,eAAO,MAAM,+BAA+B;;;;;;;IAO3C,CAAA;AACD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG;IACzC,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,8BAA8B;;;;;;;;;;;;YA9K8C,QAAQ,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAgHpB,QAAQ,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;MA0E3G,CAAA;AAEF,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,0BAA0B,GAC1B,wBAAwB,GACxB,wBAAwB,GACxB,eAAe,GACf,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,CAAA;AAEnB;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,KAAK,SAAS,cAAc,IAAI,KAAK,GAAG;IAC7D,MAAM,EAAE,UAAU,CAAC,cAAc,CAAC,GAAG,iBAAiB,CAAA;CACvD,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,UAAU,GAAG,kBAAkB,CAAA;IACrC,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,UAAU,GAAG,kBAAkB,CAAA;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,SAAS,CAAA;IACd,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,KAAK,QAAQ,GAAG;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,SAAS,CAAA;IACd,IAAI,EAAE,KAAK,CAAA;IACX;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,eAAe,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;IACf,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,KAAK,UAAU,GAAG;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,oBAAoB,CAAA;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,kBAAkB,CAAA;IACxB,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,kBAAkB,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,kBAAkB,GAClB,QAAQ,GACR,cAAc,GACd,sBAAsB,GACtB,oBAAoB,GACpB,oBAAoB,GACpB,YAAY,GACZ,UAAU,GACV,YAAY,CAAA;AAEhB,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,gBAAgB,KAAK,MAAM,CAAA"}
|
|
@@ -28,6 +28,25 @@ export const TraversedOperationSchemaDefinition = compose(NavigationBaseSchemaDe
|
|
|
28
28
|
isDeprecated: Type.Optional(Type.Boolean()),
|
|
29
29
|
children: Type.Optional(Type.Array(TraversedEntryObjectRef)),
|
|
30
30
|
}));
|
|
31
|
+
export const TraversedAsyncApiOperationSchemaDefinition = compose(NavigationBaseSchemaDefinition, Type.Object({
|
|
32
|
+
type: Type.Literal('asyncapi-operation'),
|
|
33
|
+
operationName: Type.String(),
|
|
34
|
+
action: Type.Union([Type.Literal('send'), Type.Literal('receive')]),
|
|
35
|
+
channelName: Type.String(),
|
|
36
|
+
channelAddress: Type.String(),
|
|
37
|
+
children: Type.Optional(Type.Array(TraversedEntryObjectRef)),
|
|
38
|
+
}));
|
|
39
|
+
export const TraversedAsyncApiChannelSchemaDefinition = compose(NavigationBaseSchemaDefinition, Type.Object({
|
|
40
|
+
type: Type.Literal('asyncapi-channel'),
|
|
41
|
+
channelName: Type.String(),
|
|
42
|
+
channelAddress: Type.String(),
|
|
43
|
+
children: Type.Optional(Type.Array(TraversedEntryObjectRef)),
|
|
44
|
+
}));
|
|
45
|
+
export const TraversedAsyncApiMessageSchemaDefinition = compose(NavigationBaseSchemaDefinition, Type.Object({
|
|
46
|
+
type: Type.Literal('asyncapi-message'),
|
|
47
|
+
messageName: Type.String(),
|
|
48
|
+
channelName: Type.String(),
|
|
49
|
+
}));
|
|
31
50
|
export const TraversedSchemaSchemaDefinition = compose(NavigationBaseSchemaDefinition, Type.Object({
|
|
32
51
|
type: Type.Literal('model'),
|
|
33
52
|
ref: Type.String(),
|
|
@@ -57,6 +76,9 @@ export const TraversedModelsSchemaDefinition = compose(NavigationBaseSchemaDefin
|
|
|
57
76
|
export const TraversedEntrySchemaDefinition = Type.Union([
|
|
58
77
|
TraversedDescriptionSchemaDefinition,
|
|
59
78
|
TraversedOperationSchemaDefinition,
|
|
79
|
+
TraversedAsyncApiOperationSchemaDefinition,
|
|
80
|
+
TraversedAsyncApiChannelSchemaDefinition,
|
|
81
|
+
TraversedAsyncApiMessageSchemaDefinition,
|
|
60
82
|
TraversedSchemaSchemaDefinition,
|
|
61
83
|
TraversedTagSchemaDefinition,
|
|
62
84
|
TraversedWebhookSchemaDefinition,
|