@mintlify/common 1.0.331 → 1.0.333
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/asyncapi/getAsyncApiChannelMetadata.js +7 -5
- package/dist/asyncapi/index.d.ts +5 -0
- package/dist/asyncapi/index.js +5 -0
- package/dist/asyncapi/parser/extractSchemaProperties.d.ts +2 -0
- package/dist/asyncapi/parser/extractSchemaProperties.js +67 -0
- package/dist/asyncapi/parser/getBindingsData.d.ts +2 -0
- package/dist/asyncapi/parser/getBindingsData.js +12 -0
- package/dist/asyncapi/parser/getChannelData.d.ts +7 -0
- package/dist/asyncapi/parser/getChannelData.js +57 -0
- package/dist/asyncapi/parser/getExamplesData.d.ts +6 -0
- package/dist/asyncapi/parser/getExamplesData.js +68 -0
- package/dist/asyncapi/parser/getExtensionsData.d.ts +2 -0
- package/dist/asyncapi/parser/getExtensionsData.js +8 -0
- package/dist/asyncapi/parser/getMessagesData.d.ts +8 -0
- package/dist/asyncapi/parser/getMessagesData.js +77 -0
- package/dist/asyncapi/parser/getOperationsData.d.ts +2 -0
- package/dist/asyncapi/parser/getOperationsData.js +24 -0
- package/dist/asyncapi/parser/getParametersData.d.ts +2 -0
- package/dist/asyncapi/parser/getParametersData.js +20 -0
- package/dist/asyncapi/parser/getSecuritySchemesData.d.ts +2 -0
- package/dist/asyncapi/parser/getSecuritySchemesData.js +16 -0
- package/dist/asyncapi/parser/getServersData.d.ts +2 -0
- package/dist/asyncapi/parser/getServersData.js +22 -0
- package/dist/index.d.ts +1 -2
- package/dist/index.js +1 -2
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/types/asyncapi.d.ts +97 -2
- package/package.json +4 -4
package/dist/types/asyncapi.d.ts
CHANGED
|
@@ -1,11 +1,16 @@
|
|
|
1
|
-
import { AsyncAPIDocumentInterface, Input, ChannelInterface } from '@asyncapi/parser';
|
|
2
|
-
export type { AsyncAPIDocumentInterface };
|
|
1
|
+
import { AsyncAPIDocumentInterface, Input, ChannelInterface, ServerInterface, ChannelParameterInterface, BindingsInterface, OperationInterface, SchemaInterface, MessageInterface, OperationReplyInterface, OperationTraitsInterface, MessageTraitsInterface, ExtensionInterface, SecuritySchemeInterface, BindingInterface, AsyncAPIDocumentV3 } from '@asyncapi/parser';
|
|
2
|
+
export type { AsyncAPIDocumentInterface, ServerInterface, ChannelParameterInterface, BindingsInterface, OperationInterface, SchemaInterface, MessageInterface, OperationReplyInterface, OperationTraitsInterface, MessageTraitsInterface, ExtensionInterface, SecuritySchemeInterface, BindingInterface, AsyncAPIDocumentV3, };
|
|
3
3
|
export type AsyncAPIParserInput = Input;
|
|
4
4
|
export type AsyncAPIFile = {
|
|
5
5
|
filename: string;
|
|
6
6
|
spec: AsyncAPIDocumentInterface;
|
|
7
7
|
originalFileLocation: string;
|
|
8
8
|
};
|
|
9
|
+
export type SavedAsyncAPIFile = {
|
|
10
|
+
filename: string;
|
|
11
|
+
spec: AsyncAPIDocumentV3;
|
|
12
|
+
originalFileLocation: string;
|
|
13
|
+
};
|
|
9
14
|
export interface AsyncAPIChannel extends ChannelInterface {
|
|
10
15
|
tags(): {
|
|
11
16
|
all(): Array<{
|
|
@@ -23,3 +28,93 @@ export type ParsedAsyncApiPageMetadata = {
|
|
|
23
28
|
title?: string;
|
|
24
29
|
description?: string;
|
|
25
30
|
} | undefined;
|
|
31
|
+
export type AnyRecord = Record<string, any>;
|
|
32
|
+
export type AsyncApiParameter = {
|
|
33
|
+
id: string;
|
|
34
|
+
jsonSchema: AnyRecord | undefined;
|
|
35
|
+
type: string | undefined;
|
|
36
|
+
description: string | undefined;
|
|
37
|
+
propertiesCount: number | undefined;
|
|
38
|
+
required: boolean | undefined;
|
|
39
|
+
deprecated: boolean | undefined;
|
|
40
|
+
};
|
|
41
|
+
export type AsyncApiBinding = {
|
|
42
|
+
protocol: string;
|
|
43
|
+
version: string;
|
|
44
|
+
value: AnyRecord;
|
|
45
|
+
schemaProperties: SchemaProperty[];
|
|
46
|
+
};
|
|
47
|
+
export type AsyncApiExtension = {
|
|
48
|
+
id: string;
|
|
49
|
+
value: AnyRecord;
|
|
50
|
+
};
|
|
51
|
+
export type AsyncApiOperation = {
|
|
52
|
+
id: string | undefined;
|
|
53
|
+
title: string | undefined;
|
|
54
|
+
type: string | undefined;
|
|
55
|
+
description: string | undefined;
|
|
56
|
+
messages: AsyncApiMessage[];
|
|
57
|
+
bindings: AsyncApiBinding[];
|
|
58
|
+
extensions: AsyncApiExtension[];
|
|
59
|
+
};
|
|
60
|
+
export type AsyncApiMessage = {
|
|
61
|
+
id: string;
|
|
62
|
+
contentType: string | undefined;
|
|
63
|
+
payload: SchemaProperty[] | undefined;
|
|
64
|
+
jsonPayloadSchema: AnyRecord | undefined;
|
|
65
|
+
headers: SchemaProperty[] | undefined;
|
|
66
|
+
jsonHeadersSchema: AnyRecord | undefined;
|
|
67
|
+
title: string | undefined;
|
|
68
|
+
description: string | undefined;
|
|
69
|
+
example: string | undefined;
|
|
70
|
+
bindings: AsyncApiBinding[] | undefined;
|
|
71
|
+
extensions: AsyncApiExtension[] | undefined;
|
|
72
|
+
};
|
|
73
|
+
export type AsyncApiSecurityScheme = {
|
|
74
|
+
id: string;
|
|
75
|
+
name: string | undefined;
|
|
76
|
+
type: string;
|
|
77
|
+
description: string | undefined;
|
|
78
|
+
in: string | undefined;
|
|
79
|
+
scheme: string | undefined;
|
|
80
|
+
bearerFormat: string | undefined;
|
|
81
|
+
openIdConnectUrl: string | undefined;
|
|
82
|
+
extensions: AsyncApiExtension[];
|
|
83
|
+
};
|
|
84
|
+
export type AsyncApiVariable = {
|
|
85
|
+
id: string;
|
|
86
|
+
description: string | undefined;
|
|
87
|
+
defaultValue: string | undefined;
|
|
88
|
+
allowedValues: string[] | undefined;
|
|
89
|
+
};
|
|
90
|
+
export type Server = {
|
|
91
|
+
id: string;
|
|
92
|
+
protocol: string;
|
|
93
|
+
host: string;
|
|
94
|
+
bindings: AsyncApiBinding[];
|
|
95
|
+
variables: AsyncApiVariable[];
|
|
96
|
+
};
|
|
97
|
+
export type ChannelData = {
|
|
98
|
+
id: string;
|
|
99
|
+
title: string;
|
|
100
|
+
description: string | undefined;
|
|
101
|
+
servers: Server[];
|
|
102
|
+
address: string | null | undefined;
|
|
103
|
+
parameters: AsyncApiParameter[];
|
|
104
|
+
bindings: AsyncApiBinding[];
|
|
105
|
+
extensions: AsyncApiExtension[];
|
|
106
|
+
securitySchemes: AsyncApiSecurityScheme[];
|
|
107
|
+
operations: AsyncApiOperation[];
|
|
108
|
+
sendOperations: AsyncApiOperation[];
|
|
109
|
+
receiveOperations: AsyncApiOperation[];
|
|
110
|
+
sendMessages: AsyncApiMessage[];
|
|
111
|
+
receiveMessages: AsyncApiMessage[];
|
|
112
|
+
};
|
|
113
|
+
export type SchemaProperty = {
|
|
114
|
+
name: string;
|
|
115
|
+
type: string | undefined;
|
|
116
|
+
description?: string | undefined;
|
|
117
|
+
properties?: SchemaProperty[];
|
|
118
|
+
required?: boolean;
|
|
119
|
+
deprecated?: boolean;
|
|
120
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/common",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.333",
|
|
4
4
|
"description": "Commonly shared code within Mintlify",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -30,9 +30,9 @@
|
|
|
30
30
|
"dependencies": {
|
|
31
31
|
"@asyncapi/parser": "^3.4.0",
|
|
32
32
|
"@mintlify/mdx": "^1.0.1",
|
|
33
|
-
"@mintlify/models": "0.0.
|
|
33
|
+
"@mintlify/models": "0.0.183",
|
|
34
34
|
"@mintlify/openapi-parser": "^0.0.7",
|
|
35
|
-
"@mintlify/validation": "0.1.
|
|
35
|
+
"@mintlify/validation": "0.1.337",
|
|
36
36
|
"@sindresorhus/slugify": "^2.1.1",
|
|
37
37
|
"acorn": "^8.11.2",
|
|
38
38
|
"estree-util-to-js": "^2.0.0",
|
|
@@ -80,5 +80,5 @@
|
|
|
80
80
|
"typescript": "^5.5.3",
|
|
81
81
|
"vitest": "^2.0.4"
|
|
82
82
|
},
|
|
83
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "8367e9146026a1c3b44cf767c4e2f39b07680c5f"
|
|
84
84
|
}
|