@rstreamlabs/tunnels 1.0.6 → 1.0.8

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.
@@ -0,0 +1,288 @@
1
+ type OpenApiRule = {
2
+ readonly resource: string | readonly string[];
3
+ readonly action: string | readonly string[];
4
+ };
5
+ type OpenApiPermission = {
6
+ readonly name: string;
7
+ readonly description: string;
8
+ readonly rules: readonly OpenApiRule[];
9
+ };
10
+ declare const engineOpenApiDocument: {
11
+ openapi: string;
12
+ info: {
13
+ title: string;
14
+ version: string;
15
+ description: string;
16
+ };
17
+ servers: {
18
+ url: string;
19
+ description: string;
20
+ variables: {
21
+ engine: {
22
+ default: string;
23
+ description: string;
24
+ };
25
+ };
26
+ }[];
27
+ security: {
28
+ bearerAuth: never[];
29
+ }[];
30
+ components: {
31
+ securitySchemes: {
32
+ bearerAuth: {
33
+ type: string;
34
+ scheme: string;
35
+ bearerFormat: string;
36
+ description: string;
37
+ };
38
+ };
39
+ parameters: {
40
+ ListClientsParams: {
41
+ name: string;
42
+ in: string;
43
+ required: boolean;
44
+ description: string;
45
+ content: {
46
+ "application/json": {
47
+ examples?: Record<string, {
48
+ readonly value: unknown;
49
+ }> | undefined;
50
+ schema: {
51
+ $ref: string;
52
+ };
53
+ };
54
+ };
55
+ };
56
+ ListTunnelsParams: {
57
+ name: string;
58
+ in: string;
59
+ required: boolean;
60
+ description: string;
61
+ content: {
62
+ "application/json": {
63
+ examples?: Record<string, {
64
+ readonly value: unknown;
65
+ }> | undefined;
66
+ schema: {
67
+ $ref: string;
68
+ };
69
+ };
70
+ };
71
+ };
72
+ WatchParams: {
73
+ name: string;
74
+ in: string;
75
+ required: boolean;
76
+ description: string;
77
+ content: {
78
+ "application/json": {
79
+ examples?: Record<string, {
80
+ readonly value: unknown;
81
+ }> | undefined;
82
+ schema: {
83
+ $ref: string;
84
+ };
85
+ };
86
+ };
87
+ };
88
+ };
89
+ responses: {
90
+ BadRequest: {
91
+ description: string;
92
+ };
93
+ Unauthorized: {
94
+ description: string;
95
+ };
96
+ Forbidden: {
97
+ description: string;
98
+ };
99
+ };
100
+ schemas: {
101
+ Client: unknown;
102
+ Event: unknown;
103
+ ListClientsParams: unknown;
104
+ ListTunnelsParams: unknown;
105
+ TunnelListItem: unknown;
106
+ WatchParams: unknown;
107
+ };
108
+ };
109
+ "x-rstream-agent-authentication": {
110
+ oauth_authorization_server_metadata: string;
111
+ oauth_protected_resource_metadata: string;
112
+ scope_selection: string;
113
+ };
114
+ "x-rstream-permissions": Record<string, OpenApiPermission>;
115
+ "x-rstream-use-case-permissions": {
116
+ "inspect-engine-state": string[];
117
+ "expose-service-from-cli": string[];
118
+ "connect-private-tunnel": string[];
119
+ "operate-webtty": string[];
120
+ };
121
+ paths: {
122
+ "/api/openapi.json": {
123
+ get: {
124
+ tags: string[];
125
+ summary: string;
126
+ operationId: string;
127
+ security: never[];
128
+ responses: {
129
+ "200": {
130
+ description: string;
131
+ content: {
132
+ "application/vnd.oai.openapi+json;version=3.1": {
133
+ schema: {
134
+ type: string;
135
+ };
136
+ };
137
+ };
138
+ };
139
+ };
140
+ };
141
+ };
142
+ "/api/clients": {
143
+ get: {
144
+ tags: string[];
145
+ summary: string;
146
+ operationId: string;
147
+ parameters: {
148
+ $ref: string;
149
+ }[];
150
+ security: {
151
+ bearerAuth: never[];
152
+ }[];
153
+ responses: {
154
+ "200": {
155
+ description: string;
156
+ content: {
157
+ "application/json": {
158
+ schema: {
159
+ type: string;
160
+ items: {
161
+ $ref: string;
162
+ };
163
+ };
164
+ };
165
+ };
166
+ };
167
+ "400": {
168
+ $ref: string;
169
+ };
170
+ "401": {
171
+ $ref: string;
172
+ };
173
+ "403": {
174
+ $ref: string;
175
+ };
176
+ };
177
+ "x-rstream-required-rules": readonly OpenApiRule[];
178
+ };
179
+ };
180
+ "/api/tunnels": {
181
+ get: {
182
+ tags: string[];
183
+ summary: string;
184
+ operationId: string;
185
+ parameters: {
186
+ $ref: string;
187
+ }[];
188
+ security: {
189
+ bearerAuth: never[];
190
+ }[];
191
+ responses: {
192
+ "200": {
193
+ description: string;
194
+ content: {
195
+ "application/json": {
196
+ schema: {
197
+ type: string;
198
+ items: {
199
+ $ref: string;
200
+ };
201
+ };
202
+ };
203
+ };
204
+ };
205
+ "400": {
206
+ $ref: string;
207
+ };
208
+ "401": {
209
+ $ref: string;
210
+ };
211
+ "403": {
212
+ $ref: string;
213
+ };
214
+ };
215
+ "x-rstream-required-rules": readonly OpenApiRule[];
216
+ "x-rstream-token-metadata-scope": string;
217
+ };
218
+ };
219
+ "/api/sse": {
220
+ get: {
221
+ tags: string[];
222
+ summary: string;
223
+ operationId: string;
224
+ parameters: {
225
+ $ref: string;
226
+ }[];
227
+ security: {
228
+ bearerAuth: never[];
229
+ }[];
230
+ responses: {
231
+ "200": {
232
+ description: string;
233
+ content: {
234
+ "text/event-stream": {
235
+ schema: {
236
+ type: string;
237
+ };
238
+ };
239
+ };
240
+ };
241
+ "400": {
242
+ $ref: string;
243
+ };
244
+ "401": {
245
+ $ref: string;
246
+ };
247
+ "403": {
248
+ $ref: string;
249
+ };
250
+ };
251
+ "x-rstream-event-schema": string;
252
+ "x-rstream-required-rules": readonly OpenApiRule[];
253
+ };
254
+ };
255
+ "/api/websocket": {
256
+ get: {
257
+ tags: string[];
258
+ summary: string;
259
+ operationId: string;
260
+ parameters: {
261
+ $ref: string;
262
+ }[];
263
+ security: {
264
+ bearerAuth: never[];
265
+ }[];
266
+ responses: {
267
+ "101": {
268
+ description: string;
269
+ };
270
+ "400": {
271
+ $ref: string;
272
+ };
273
+ "401": {
274
+ $ref: string;
275
+ };
276
+ "403": {
277
+ $ref: string;
278
+ };
279
+ };
280
+ "x-rstream-event-schema": string;
281
+ "x-rstream-required-rules": readonly OpenApiRule[];
282
+ };
283
+ };
284
+ };
285
+ };
286
+ declare const engineOpenApiJson: string;
287
+
288
+ export { engineOpenApiDocument, engineOpenApiJson };
@@ -0,0 +1,288 @@
1
+ type OpenApiRule = {
2
+ readonly resource: string | readonly string[];
3
+ readonly action: string | readonly string[];
4
+ };
5
+ type OpenApiPermission = {
6
+ readonly name: string;
7
+ readonly description: string;
8
+ readonly rules: readonly OpenApiRule[];
9
+ };
10
+ declare const engineOpenApiDocument: {
11
+ openapi: string;
12
+ info: {
13
+ title: string;
14
+ version: string;
15
+ description: string;
16
+ };
17
+ servers: {
18
+ url: string;
19
+ description: string;
20
+ variables: {
21
+ engine: {
22
+ default: string;
23
+ description: string;
24
+ };
25
+ };
26
+ }[];
27
+ security: {
28
+ bearerAuth: never[];
29
+ }[];
30
+ components: {
31
+ securitySchemes: {
32
+ bearerAuth: {
33
+ type: string;
34
+ scheme: string;
35
+ bearerFormat: string;
36
+ description: string;
37
+ };
38
+ };
39
+ parameters: {
40
+ ListClientsParams: {
41
+ name: string;
42
+ in: string;
43
+ required: boolean;
44
+ description: string;
45
+ content: {
46
+ "application/json": {
47
+ examples?: Record<string, {
48
+ readonly value: unknown;
49
+ }> | undefined;
50
+ schema: {
51
+ $ref: string;
52
+ };
53
+ };
54
+ };
55
+ };
56
+ ListTunnelsParams: {
57
+ name: string;
58
+ in: string;
59
+ required: boolean;
60
+ description: string;
61
+ content: {
62
+ "application/json": {
63
+ examples?: Record<string, {
64
+ readonly value: unknown;
65
+ }> | undefined;
66
+ schema: {
67
+ $ref: string;
68
+ };
69
+ };
70
+ };
71
+ };
72
+ WatchParams: {
73
+ name: string;
74
+ in: string;
75
+ required: boolean;
76
+ description: string;
77
+ content: {
78
+ "application/json": {
79
+ examples?: Record<string, {
80
+ readonly value: unknown;
81
+ }> | undefined;
82
+ schema: {
83
+ $ref: string;
84
+ };
85
+ };
86
+ };
87
+ };
88
+ };
89
+ responses: {
90
+ BadRequest: {
91
+ description: string;
92
+ };
93
+ Unauthorized: {
94
+ description: string;
95
+ };
96
+ Forbidden: {
97
+ description: string;
98
+ };
99
+ };
100
+ schemas: {
101
+ Client: unknown;
102
+ Event: unknown;
103
+ ListClientsParams: unknown;
104
+ ListTunnelsParams: unknown;
105
+ TunnelListItem: unknown;
106
+ WatchParams: unknown;
107
+ };
108
+ };
109
+ "x-rstream-agent-authentication": {
110
+ oauth_authorization_server_metadata: string;
111
+ oauth_protected_resource_metadata: string;
112
+ scope_selection: string;
113
+ };
114
+ "x-rstream-permissions": Record<string, OpenApiPermission>;
115
+ "x-rstream-use-case-permissions": {
116
+ "inspect-engine-state": string[];
117
+ "expose-service-from-cli": string[];
118
+ "connect-private-tunnel": string[];
119
+ "operate-webtty": string[];
120
+ };
121
+ paths: {
122
+ "/api/openapi.json": {
123
+ get: {
124
+ tags: string[];
125
+ summary: string;
126
+ operationId: string;
127
+ security: never[];
128
+ responses: {
129
+ "200": {
130
+ description: string;
131
+ content: {
132
+ "application/vnd.oai.openapi+json;version=3.1": {
133
+ schema: {
134
+ type: string;
135
+ };
136
+ };
137
+ };
138
+ };
139
+ };
140
+ };
141
+ };
142
+ "/api/clients": {
143
+ get: {
144
+ tags: string[];
145
+ summary: string;
146
+ operationId: string;
147
+ parameters: {
148
+ $ref: string;
149
+ }[];
150
+ security: {
151
+ bearerAuth: never[];
152
+ }[];
153
+ responses: {
154
+ "200": {
155
+ description: string;
156
+ content: {
157
+ "application/json": {
158
+ schema: {
159
+ type: string;
160
+ items: {
161
+ $ref: string;
162
+ };
163
+ };
164
+ };
165
+ };
166
+ };
167
+ "400": {
168
+ $ref: string;
169
+ };
170
+ "401": {
171
+ $ref: string;
172
+ };
173
+ "403": {
174
+ $ref: string;
175
+ };
176
+ };
177
+ "x-rstream-required-rules": readonly OpenApiRule[];
178
+ };
179
+ };
180
+ "/api/tunnels": {
181
+ get: {
182
+ tags: string[];
183
+ summary: string;
184
+ operationId: string;
185
+ parameters: {
186
+ $ref: string;
187
+ }[];
188
+ security: {
189
+ bearerAuth: never[];
190
+ }[];
191
+ responses: {
192
+ "200": {
193
+ description: string;
194
+ content: {
195
+ "application/json": {
196
+ schema: {
197
+ type: string;
198
+ items: {
199
+ $ref: string;
200
+ };
201
+ };
202
+ };
203
+ };
204
+ };
205
+ "400": {
206
+ $ref: string;
207
+ };
208
+ "401": {
209
+ $ref: string;
210
+ };
211
+ "403": {
212
+ $ref: string;
213
+ };
214
+ };
215
+ "x-rstream-required-rules": readonly OpenApiRule[];
216
+ "x-rstream-token-metadata-scope": string;
217
+ };
218
+ };
219
+ "/api/sse": {
220
+ get: {
221
+ tags: string[];
222
+ summary: string;
223
+ operationId: string;
224
+ parameters: {
225
+ $ref: string;
226
+ }[];
227
+ security: {
228
+ bearerAuth: never[];
229
+ }[];
230
+ responses: {
231
+ "200": {
232
+ description: string;
233
+ content: {
234
+ "text/event-stream": {
235
+ schema: {
236
+ type: string;
237
+ };
238
+ };
239
+ };
240
+ };
241
+ "400": {
242
+ $ref: string;
243
+ };
244
+ "401": {
245
+ $ref: string;
246
+ };
247
+ "403": {
248
+ $ref: string;
249
+ };
250
+ };
251
+ "x-rstream-event-schema": string;
252
+ "x-rstream-required-rules": readonly OpenApiRule[];
253
+ };
254
+ };
255
+ "/api/websocket": {
256
+ get: {
257
+ tags: string[];
258
+ summary: string;
259
+ operationId: string;
260
+ parameters: {
261
+ $ref: string;
262
+ }[];
263
+ security: {
264
+ bearerAuth: never[];
265
+ }[];
266
+ responses: {
267
+ "101": {
268
+ description: string;
269
+ };
270
+ "400": {
271
+ $ref: string;
272
+ };
273
+ "401": {
274
+ $ref: string;
275
+ };
276
+ "403": {
277
+ $ref: string;
278
+ };
279
+ };
280
+ "x-rstream-event-schema": string;
281
+ "x-rstream-required-rules": readonly OpenApiRule[];
282
+ };
283
+ };
284
+ };
285
+ };
286
+ declare const engineOpenApiJson: string;
287
+
288
+ export { engineOpenApiDocument, engineOpenApiJson };