@rstreamlabs/tunnels 1.0.6 → 1.0.7

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