@tessl/cli 0.28.0 → 0.50.2

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/cli.d.ts DELETED
@@ -1,4330 +0,0 @@
1
- import * as _sinclair_typebox from '@sinclair/typebox';
2
- import { Static, TSchema } from '@sinclair/typebox';
3
- import { Logger } from '@tileworks/logger';
4
- import { Redis } from 'ioredis';
5
- import { LangfuseParent } from 'langfuse';
6
- import { ClientOptions } from 'openai';
7
- import { ZodSchema, AnyZodObject, ZodObject, z, Schema, ZodType } from 'zod';
8
- import { Client } from 'openapi-fetch';
9
- import { Options } from 'p-map';
10
- import { HTMLElement } from 'node-html-parser';
11
- import * as nice_grpc from 'nice-grpc';
12
- import * as nice_grpc_client_middleware_retry from 'nice-grpc-client-middleware-retry';
13
- import * as nice_grpc_lib_service_definitions_ts_proto_js from 'nice-grpc/lib/service-definitions/ts-proto.js';
14
- import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
15
-
16
- declare const ProjectConfigSchema: _sinclair_typebox.TObject<{
17
- name: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
18
- }>;
19
- type ProjectConfig = Readonly<Static<typeof ProjectConfigSchema>>;
20
-
21
- declare const netSchema: _sinclair_typebox.TObject<{
22
- POSTHOG_API_KEY: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
23
- GRPC_BIND_ADDR: _sinclair_typebox.TString;
24
- HTTP_BIND_PORT: _sinclair_typebox.TString;
25
- WS_BIND_PORT: _sinclair_typebox.TString;
26
- GRPC_SHUTDOWN_DELAY_MS: _sinclair_typebox.TString;
27
- SHUTDOWN_DEADLINE_SECS: _sinclair_typebox.TString;
28
- VALKEY_HOST_LLM: _sinclair_typebox.TString;
29
- VALKEY_LLM_PASSWORD: _sinclair_typebox.TString;
30
- VALKEY_LLM_NO_TLS: _sinclair_typebox.TOptional<_sinclair_typebox.TLiteral<"yes">>;
31
- VALKEY_HOST_BULLMQ: _sinclair_typebox.TString;
32
- VALKEY_BULLMQ_PASSWORD: _sinclair_typebox.TString;
33
- VALKEY_BULLMQ_NO_TLS: _sinclair_typebox.TOptional<_sinclair_typebox.TLiteral<"yes">>;
34
- QUEUE_NAME_SUFFIX: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
35
- OPENAI_API_KEY: _sinclair_typebox.TString;
36
- LANGFUSE_PUBLIC_KEY: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
37
- LANGFUSE_SECRET_KEY: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
38
- ENABLE_LESS_SAFE_STEPS: _sinclair_typebox.TOptional<_sinclair_typebox.TLiteral<"yes">>;
39
- EXPOSE_UNSANITIZED_DEBUG_INFO: _sinclair_typebox.TOptional<_sinclair_typebox.TLiteral<"yes">>;
40
- NOT_GIT_ADDR: _sinclair_typebox.TString;
41
- STEPPER_ADDR: _sinclair_typebox.TString;
42
- CHAT_ADDR: _sinclair_typebox.TString;
43
- TILE_VERSIONS_ADDR: _sinclair_typebox.TString;
44
- TESSL_NPM_REGISTRY_URL: _sinclair_typebox.TString;
45
- LOG_LEVEL: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"debug">, _sinclair_typebox.TLiteral<"info">, _sinclair_typebox.TLiteral<"warn">, _sinclair_typebox.TLiteral<"error">, _sinclair_typebox.TLiteral<"fatal">]>;
46
- NODE_ENV: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"development">, _sinclair_typebox.TLiteral<"test">, _sinclair_typebox.TLiteral<"production">]>;
47
- GIT_COMMIT_ID: _sinclair_typebox.TString;
48
- TESSL_BASE_API_URL: _sinclair_typebox.TString;
49
- TESSL_LOG_LEVEL: _sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"trace">, _sinclair_typebox.TLiteral<"debug">, _sinclair_typebox.TLiteral<"info">, _sinclair_typebox.TLiteral<"warn">, _sinclair_typebox.TLiteral<"error">, _sinclair_typebox.TLiteral<"fatal">, _sinclair_typebox.TLiteral<"silent">]>;
50
- TESSL_LOG_FILE: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
51
- WORKOS_CLIENT_ID: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
52
- TESSL_TOKEN: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
53
- TESSL_LLM_API_KEY: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
54
- TESSL_LLM_BASE_URL: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
55
- TESSL_DISABLE_LLM_CACHE: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"true">, _sinclair_typebox.TLiteral<"false">]>>;
56
- ENABLE_RECOMMEND_SPECS: _sinclair_typebox.TOptional<_sinclair_typebox.TLiteral<"true">>;
57
- }>;
58
- type NetEnv = Static<typeof netSchema>;
59
-
60
- /**
61
- * This file was auto-generated by openapi-typescript.
62
- * Do not make direct changes to the file.
63
- */
64
- interface paths {
65
- '/': {
66
- parameters: {
67
- query?: never;
68
- header?: never;
69
- path?: never;
70
- cookie?: never;
71
- };
72
- get: {
73
- parameters: {
74
- query?: never;
75
- header?: never;
76
- path?: never;
77
- cookie?: never;
78
- };
79
- requestBody?: never;
80
- responses: {
81
- /** @description Default Response */
82
- 200: {
83
- headers: {
84
- [name: string]: unknown;
85
- };
86
- content?: never;
87
- };
88
- };
89
- };
90
- put?: never;
91
- post?: never;
92
- delete?: never;
93
- options?: never;
94
- head?: never;
95
- patch?: never;
96
- trace?: never;
97
- };
98
- '/v1/': {
99
- parameters: {
100
- query?: never;
101
- header?: never;
102
- path?: never;
103
- cookie?: never;
104
- };
105
- get: {
106
- parameters: {
107
- query?: never;
108
- header?: never;
109
- path?: never;
110
- cookie?: never;
111
- };
112
- requestBody?: never;
113
- responses: {
114
- /** @description Default Response */
115
- 200: {
116
- headers: {
117
- [name: string]: unknown;
118
- };
119
- content?: never;
120
- };
121
- };
122
- };
123
- put?: never;
124
- post?: never;
125
- delete?: never;
126
- options?: never;
127
- head?: never;
128
- patch?: never;
129
- trace?: never;
130
- };
131
- '/v1/tiles/{workspaceName}/{tileName}': {
132
- parameters: {
133
- query?: never;
134
- header?: never;
135
- path?: never;
136
- cookie?: never;
137
- };
138
- get: {
139
- parameters: {
140
- query?: never;
141
- header?: never;
142
- path: {
143
- workspaceName: string;
144
- tileName: string;
145
- };
146
- cookie?: never;
147
- };
148
- requestBody?: never;
149
- responses: {
150
- /** @description Default Response */
151
- 200: {
152
- headers: {
153
- [name: string]: unknown;
154
- };
155
- content: {
156
- 'application/json': {
157
- data: {
158
- /** Format: uuid */
159
- id: string;
160
- /** @enum {string} */
161
- type: 'tile';
162
- attributes: {
163
- name: string;
164
- fullName: string;
165
- featured: boolean;
166
- /** Format: date-time */
167
- createdAt: string;
168
- /** Format: date-time */
169
- updatedAt: string;
170
- latestVersion: string | null;
171
- };
172
- relationships: {
173
- workspace: {
174
- data: {
175
- /** Format: uuid */
176
- id: string;
177
- /** @enum {string} */
178
- type: 'workspace';
179
- };
180
- links: {
181
- /** Format: uri */
182
- self: string;
183
- };
184
- };
185
- };
186
- meta: {
187
- allowedActions: string[];
188
- };
189
- links: {
190
- /** Format: uri */
191
- self: string;
192
- };
193
- };
194
- };
195
- };
196
- };
197
- /** @description Not Found */
198
- 404: {
199
- headers: {
200
- [name: string]: unknown;
201
- };
202
- content: {
203
- 'application/json': {
204
- jsonapi: {
205
- profile: string[];
206
- /** @enum {string} */
207
- version: '1.1';
208
- };
209
- errors: {
210
- title: string;
211
- status: string;
212
- detail: string;
213
- }[];
214
- };
215
- };
216
- };
217
- /** @description Internal Server Error */
218
- 500: {
219
- headers: {
220
- [name: string]: unknown;
221
- };
222
- content: {
223
- 'application/json': {
224
- jsonapi: {
225
- profile: string[];
226
- /** @enum {string} */
227
- version: '1.1';
228
- };
229
- errors: {
230
- title: string;
231
- status: string;
232
- detail: string;
233
- }[];
234
- };
235
- };
236
- };
237
- };
238
- };
239
- put?: never;
240
- post?: never;
241
- delete?: never;
242
- options?: never;
243
- head?: never;
244
- patch?: never;
245
- trace?: never;
246
- };
247
- '/v1/tiles': {
248
- parameters: {
249
- query?: never;
250
- header?: never;
251
- path?: never;
252
- cookie?: never;
253
- };
254
- get: {
255
- parameters: {
256
- query?: {
257
- sort?: ('updatedAt' | '-updatedAt' | 'similarity' | '-similarity' | 'id' | '-id') | ('updatedAt' | '-updatedAt' | 'similarity' | '-similarity' | 'id' | '-id')[];
258
- 'page[size]'?: number;
259
- 'page[after]'?: string;
260
- 'page[before]'?: string;
261
- include?: 'versions';
262
- 'filter[name]'?: string;
263
- 'filter[name][eq]'?: string;
264
- 'filter[name][gte]'?: string;
265
- 'filter[name][gt]'?: string;
266
- 'filter[name][lt]'?: string;
267
- 'filter[name][lte]'?: string;
268
- 'filter[name][ne]'?: string;
269
- 'filter[name][like]'?: string;
270
- 'filter[fullName]'?: string;
271
- 'filter[fullName][eq]'?: string;
272
- 'filter[fullName][gte]'?: string;
273
- 'filter[fullName][gt]'?: string;
274
- 'filter[fullName][lt]'?: string;
275
- 'filter[fullName][lte]'?: string;
276
- 'filter[fullName][ne]'?: string;
277
- 'filter[fullName][like]'?: string;
278
- 'filter[describes]'?: string;
279
- 'filter[describes][eq]'?: string;
280
- 'filter[describes][gte]'?: string;
281
- 'filter[describes][gt]'?: string;
282
- 'filter[describes][lt]'?: string;
283
- 'filter[describes][lte]'?: string;
284
- 'filter[describes][ne]'?: string;
285
- 'filter[describes][like]'?: string;
286
- 'filter[workspaceId]'?: string;
287
- 'filter[workspaceId][eq]'?: string;
288
- 'filter[workspaceId][gte]'?: string;
289
- 'filter[workspaceId][gt]'?: string;
290
- 'filter[workspaceId][lt]'?: string;
291
- 'filter[workspaceId][lte]'?: string;
292
- 'filter[workspaceId][ne]'?: string;
293
- 'filter[workspaceId][like]'?: string;
294
- 'filter[featured]'?: boolean;
295
- 'filter[featured][eq]'?: boolean;
296
- 'filter[featured][gte]'?: boolean;
297
- 'filter[featured][gt]'?: boolean;
298
- 'filter[featured][lt]'?: boolean;
299
- 'filter[featured][lte]'?: boolean;
300
- 'filter[featured][ne]'?: boolean;
301
- 'filter[featured][like]'?: boolean;
302
- };
303
- header?: never;
304
- path?: never;
305
- cookie?: never;
306
- };
307
- requestBody?: never;
308
- responses: {
309
- /** @description Default Response */
310
- 200: {
311
- headers: {
312
- [name: string]: unknown;
313
- };
314
- content: {
315
- 'application/json': {
316
- jsonapi: {
317
- profile: string[];
318
- /** @enum {string} */
319
- version: '1.1';
320
- };
321
- links: {
322
- /** Format: uri */
323
- self: string;
324
- next: string | null;
325
- prev: string | null;
326
- };
327
- meta: {
328
- count: number;
329
- };
330
- included?: unknown;
331
- relationships?: Record<string, never>;
332
- data: {
333
- /** Format: uuid */
334
- id: string;
335
- /** @enum {string} */
336
- type: 'tile';
337
- attributes: {
338
- name: string;
339
- describes: string | null;
340
- featured: boolean;
341
- fullName: string;
342
- createdAt: string;
343
- updatedAt: string;
344
- versions?: {
345
- describes: string;
346
- version: string;
347
- summary: string;
348
- major: number;
349
- minor: number;
350
- patch: number;
351
- archived: boolean;
352
- createdAt: string;
353
- docs: string;
354
- }[];
355
- };
356
- relationships: {
357
- workspace: {
358
- data: {
359
- /** Format: uuid */
360
- id: string;
361
- /** @enum {string} */
362
- type: 'workspace';
363
- };
364
- links: {
365
- /** Format: uri */
366
- self: string;
367
- };
368
- };
369
- };
370
- meta: {
371
- allowedActions: string[];
372
- };
373
- }[];
374
- };
375
- };
376
- };
377
- /** @description Not Found */
378
- 404: {
379
- headers: {
380
- [name: string]: unknown;
381
- };
382
- content: {
383
- 'application/json': {
384
- jsonapi: {
385
- profile: string[];
386
- /** @enum {string} */
387
- version: '1.1';
388
- };
389
- errors: {
390
- title: string;
391
- status: string;
392
- detail: string;
393
- }[];
394
- };
395
- };
396
- };
397
- /** @description Internal Server Error */
398
- 500: {
399
- headers: {
400
- [name: string]: unknown;
401
- };
402
- content: {
403
- 'application/json': {
404
- jsonapi: {
405
- profile: string[];
406
- /** @enum {string} */
407
- version: '1.1';
408
- };
409
- errors: {
410
- title: string;
411
- status: string;
412
- detail: string;
413
- }[];
414
- };
415
- };
416
- };
417
- };
418
- };
419
- put?: never;
420
- post: {
421
- parameters: {
422
- query?: never;
423
- header: {
424
- 'content-type': 'application/x-tar';
425
- };
426
- path?: never;
427
- cookie?: never;
428
- };
429
- requestBody?: never;
430
- responses: {
431
- /** @description Default Response */
432
- 201: {
433
- headers: {
434
- [name: string]: unknown;
435
- };
436
- content: {
437
- 'application/json': {
438
- data: {
439
- /** Format: uuid */
440
- id: string;
441
- /** @enum {string} */
442
- type: 'tile';
443
- attributes: {
444
- /** @enum {string} */
445
- type: 'knowledge';
446
- featured: boolean;
447
- /** Format: uuid */
448
- workspaceId: string;
449
- name: string;
450
- version: string;
451
- fullName: string;
452
- describes: string;
453
- /** Format: date-time */
454
- createdAt: string;
455
- /** Format: date-time */
456
- updatedAt: string;
457
- };
458
- };
459
- };
460
- };
461
- };
462
- /** @description Unauthorized */
463
- 401: {
464
- headers: {
465
- [name: string]: unknown;
466
- };
467
- content: {
468
- 'application/json': {
469
- jsonapi: {
470
- profile: string[];
471
- /** @enum {string} */
472
- version: '1.1';
473
- };
474
- errors: {
475
- title: string;
476
- status: string;
477
- detail: string;
478
- }[];
479
- };
480
- };
481
- };
482
- /** @description Forbidden */
483
- 403: {
484
- headers: {
485
- [name: string]: unknown;
486
- };
487
- content: {
488
- 'application/json': {
489
- jsonapi: {
490
- profile: string[];
491
- /** @enum {string} */
492
- version: '1.1';
493
- };
494
- errors: {
495
- title: string;
496
- status: string;
497
- detail: string;
498
- }[];
499
- };
500
- };
501
- };
502
- /** @description Not Found */
503
- 404: {
504
- headers: {
505
- [name: string]: unknown;
506
- };
507
- content: {
508
- 'application/json': {
509
- jsonapi: {
510
- profile: string[];
511
- /** @enum {string} */
512
- version: '1.1';
513
- };
514
- errors: {
515
- title: string;
516
- status: string;
517
- detail: string;
518
- }[];
519
- };
520
- };
521
- };
522
- /** @description Internal Server Error */
523
- 500: {
524
- headers: {
525
- [name: string]: unknown;
526
- };
527
- content: {
528
- 'application/json': {
529
- jsonapi: {
530
- profile: string[];
531
- /** @enum {string} */
532
- version: '1.1';
533
- };
534
- errors: {
535
- title: string;
536
- status: string;
537
- detail: string;
538
- }[];
539
- };
540
- };
541
- };
542
- };
543
- };
544
- delete?: never;
545
- options?: never;
546
- head?: never;
547
- patch?: never;
548
- trace?: never;
549
- };
550
- '/v1/tiles/{workspaceName}/{tileName}/versions/{version}': {
551
- parameters: {
552
- query?: never;
553
- header?: never;
554
- path?: never;
555
- cookie?: never;
556
- };
557
- get: {
558
- parameters: {
559
- query?: never;
560
- header?: never;
561
- path: {
562
- workspaceName: string;
563
- tileName: string;
564
- version: string;
565
- };
566
- cookie?: never;
567
- };
568
- requestBody?: never;
569
- responses: {
570
- /** @description Default Response */
571
- 200: {
572
- headers: {
573
- [name: string]: unknown;
574
- };
575
- content: {
576
- 'application/json': {
577
- jsonapi: {
578
- profile: string[];
579
- /** @enum {string} */
580
- version: '1.1';
581
- };
582
- data: {
583
- /** Format: uuid */
584
- id: string;
585
- /** @enum {string} */
586
- type: 'tile-version';
587
- attributes: {
588
- version: string;
589
- major: number;
590
- minor: number;
591
- patch: number;
592
- describes: string | null;
593
- docs: string;
594
- summary: string;
595
- archived: boolean;
596
- archivedAt: string | null;
597
- archivedBy: string | null;
598
- archivedReason: string | null;
599
- /** Format: date-time */
600
- createdAt: string;
601
- /** Format: date-time */
602
- updatedAt: string;
603
- };
604
- relationships: {
605
- tile: {
606
- data: {
607
- /** Format: uuid */
608
- id: string;
609
- /** @enum {string} */
610
- type: 'tile';
611
- };
612
- links: {
613
- /** Format: uri */
614
- self: string;
615
- };
616
- };
617
- };
618
- meta?: Record<string, never>;
619
- };
620
- included?: unknown;
621
- links: {
622
- /** Format: uri */
623
- self: string;
624
- /** Format: uri */
625
- related?: string;
626
- };
627
- meta?: Record<string, never>;
628
- };
629
- };
630
- };
631
- /** @description Not Found */
632
- 404: {
633
- headers: {
634
- [name: string]: unknown;
635
- };
636
- content: {
637
- 'application/json': {
638
- jsonapi: {
639
- profile: string[];
640
- /** @enum {string} */
641
- version: '1.1';
642
- };
643
- errors: {
644
- title: string;
645
- status: string;
646
- detail: string;
647
- }[];
648
- };
649
- };
650
- };
651
- /** @description Internal Server Error */
652
- 500: {
653
- headers: {
654
- [name: string]: unknown;
655
- };
656
- content: {
657
- 'application/json': {
658
- jsonapi: {
659
- profile: string[];
660
- /** @enum {string} */
661
- version: '1.1';
662
- };
663
- errors: {
664
- title: string;
665
- status: string;
666
- detail: string;
667
- }[];
668
- };
669
- };
670
- };
671
- };
672
- };
673
- put?: never;
674
- post: {
675
- parameters: {
676
- query?: never;
677
- header?: never;
678
- path: {
679
- workspaceName: string;
680
- tileName: string;
681
- version: string;
682
- };
683
- cookie?: never;
684
- };
685
- requestBody?: {
686
- content: {
687
- 'application/json': {
688
- archived?: boolean;
689
- archivedReason?: string;
690
- };
691
- };
692
- };
693
- responses: {
694
- /** @description Default Response */
695
- 200: {
696
- headers: {
697
- [name: string]: unknown;
698
- };
699
- content: {
700
- 'application/json': {
701
- jsonapi: {
702
- profile: string[];
703
- /** @enum {string} */
704
- version: '1.1';
705
- };
706
- data: {
707
- /** Format: uuid */
708
- id: string;
709
- /** @enum {string} */
710
- type: 'tile-version';
711
- attributes: {
712
- version: string;
713
- major: number;
714
- minor: number;
715
- patch: number;
716
- describes: string | null;
717
- docs: string;
718
- archived: boolean;
719
- archivedAt: string | null;
720
- archivedBy: string | null;
721
- archivedReason: string | null;
722
- summary: string;
723
- /** Format: date-time */
724
- createdAt: string;
725
- /** Format: date-time */
726
- updatedAt: string;
727
- };
728
- relationships?: Record<string, never>;
729
- meta?: Record<string, never>;
730
- };
731
- included?: unknown;
732
- links: {
733
- /** Format: uri */
734
- self: string;
735
- /** Format: uri */
736
- related?: string;
737
- };
738
- meta?: Record<string, never>;
739
- };
740
- };
741
- };
742
- /** @description Unauthorized */
743
- 401: {
744
- headers: {
745
- [name: string]: unknown;
746
- };
747
- content: {
748
- 'application/json': {
749
- jsonapi: {
750
- profile: string[];
751
- /** @enum {string} */
752
- version: '1.1';
753
- };
754
- errors: {
755
- title: string;
756
- status: string;
757
- detail: string;
758
- }[];
759
- };
760
- };
761
- };
762
- /** @description Forbidden */
763
- 403: {
764
- headers: {
765
- [name: string]: unknown;
766
- };
767
- content: {
768
- 'application/json': {
769
- jsonapi: {
770
- profile: string[];
771
- /** @enum {string} */
772
- version: '1.1';
773
- };
774
- errors: {
775
- title: string;
776
- status: string;
777
- detail: string;
778
- }[];
779
- };
780
- };
781
- };
782
- /** @description Not Found */
783
- 404: {
784
- headers: {
785
- [name: string]: unknown;
786
- };
787
- content: {
788
- 'application/json': {
789
- jsonapi: {
790
- profile: string[];
791
- /** @enum {string} */
792
- version: '1.1';
793
- };
794
- errors: {
795
- title: string;
796
- status: string;
797
- detail: string;
798
- }[];
799
- };
800
- };
801
- };
802
- /** @description Internal Server Error */
803
- 500: {
804
- headers: {
805
- [name: string]: unknown;
806
- };
807
- content: {
808
- 'application/json': {
809
- jsonapi: {
810
- profile: string[];
811
- /** @enum {string} */
812
- version: '1.1';
813
- };
814
- errors: {
815
- title: string;
816
- status: string;
817
- detail: string;
818
- }[];
819
- };
820
- };
821
- };
822
- };
823
- };
824
- delete: {
825
- parameters: {
826
- query?: never;
827
- header?: never;
828
- path: {
829
- workspaceName: string;
830
- tileName: string;
831
- version: string;
832
- };
833
- cookie?: never;
834
- };
835
- requestBody?: never;
836
- responses: {
837
- /** @description Default Response */
838
- 204: {
839
- headers: {
840
- [name: string]: unknown;
841
- };
842
- content: {
843
- 'application/json': Record<string, never>;
844
- };
845
- };
846
- /** @description Unauthorized */
847
- 401: {
848
- headers: {
849
- [name: string]: unknown;
850
- };
851
- content: {
852
- 'application/json': {
853
- jsonapi: {
854
- profile: string[];
855
- /** @enum {string} */
856
- version: '1.1';
857
- };
858
- errors: {
859
- title: string;
860
- status: string;
861
- detail: string;
862
- }[];
863
- };
864
- };
865
- };
866
- /** @description Forbidden */
867
- 403: {
868
- headers: {
869
- [name: string]: unknown;
870
- };
871
- content: {
872
- 'application/json': {
873
- jsonapi: {
874
- profile: string[];
875
- /** @enum {string} */
876
- version: '1.1';
877
- };
878
- errors: {
879
- title: string;
880
- status: string;
881
- detail: string;
882
- }[];
883
- };
884
- };
885
- };
886
- /** @description Not Found */
887
- 404: {
888
- headers: {
889
- [name: string]: unknown;
890
- };
891
- content: {
892
- 'application/json': {
893
- jsonapi: {
894
- profile: string[];
895
- /** @enum {string} */
896
- version: '1.1';
897
- };
898
- errors: {
899
- title: string;
900
- status: string;
901
- detail: string;
902
- }[];
903
- };
904
- };
905
- };
906
- /** @description Internal Server Error */
907
- 500: {
908
- headers: {
909
- [name: string]: unknown;
910
- };
911
- content: {
912
- 'application/json': {
913
- jsonapi: {
914
- profile: string[];
915
- /** @enum {string} */
916
- version: '1.1';
917
- };
918
- errors: {
919
- title: string;
920
- status: string;
921
- detail: string;
922
- }[];
923
- };
924
- };
925
- };
926
- };
927
- };
928
- options?: never;
929
- head?: never;
930
- patch?: never;
931
- trace?: never;
932
- };
933
- '/v1/tiles/{workspaceName}/{tileName}/versions': {
934
- parameters: {
935
- query?: never;
936
- header?: never;
937
- path?: never;
938
- cookie?: never;
939
- };
940
- get: {
941
- parameters: {
942
- query?: {
943
- sort?: ('version' | '-version') | ('version' | '-version')[];
944
- 'page[size]'?: number;
945
- 'page[after]'?: string;
946
- 'page[before]'?: string;
947
- include?: string;
948
- 'filter[describes]'?: string;
949
- 'filter[describes][eq]'?: string;
950
- 'filter[describes][gte]'?: string;
951
- 'filter[describes][gt]'?: string;
952
- 'filter[describes][lt]'?: string;
953
- 'filter[describes][lte]'?: string;
954
- 'filter[describes][ne]'?: string;
955
- 'filter[describes][like]'?: string;
956
- 'filter[major]'?: string;
957
- 'filter[major][eq]'?: string;
958
- 'filter[major][gte]'?: string;
959
- 'filter[major][gt]'?: string;
960
- 'filter[major][lt]'?: string;
961
- 'filter[major][lte]'?: string;
962
- 'filter[major][ne]'?: string;
963
- 'filter[major][like]'?: string;
964
- 'filter[minor]'?: string;
965
- 'filter[minor][eq]'?: string;
966
- 'filter[minor][gte]'?: string;
967
- 'filter[minor][gt]'?: string;
968
- 'filter[minor][lt]'?: string;
969
- 'filter[minor][lte]'?: string;
970
- 'filter[minor][ne]'?: string;
971
- 'filter[minor][like]'?: string;
972
- 'filter[patch]'?: string;
973
- 'filter[patch][eq]'?: string;
974
- 'filter[patch][gte]'?: string;
975
- 'filter[patch][gt]'?: string;
976
- 'filter[patch][lt]'?: string;
977
- 'filter[patch][lte]'?: string;
978
- 'filter[patch][ne]'?: string;
979
- 'filter[patch][like]'?: string;
980
- };
981
- header?: never;
982
- path: {
983
- workspaceName: string;
984
- tileName: string;
985
- };
986
- cookie?: never;
987
- };
988
- requestBody?: never;
989
- responses: {
990
- /** @description Default Response */
991
- 200: {
992
- headers: {
993
- [name: string]: unknown;
994
- };
995
- content: {
996
- 'application/json': {
997
- data: {
998
- /** Format: uuid */
999
- id: string;
1000
- /** @enum {string} */
1001
- type: 'tile-version';
1002
- attributes: {
1003
- version: string;
1004
- major: number;
1005
- minor: number;
1006
- patch: number;
1007
- describes: string | null;
1008
- archived: boolean;
1009
- archivedAt: string | null;
1010
- archivedBy: string | null;
1011
- archivedReason: string | null;
1012
- docs: string;
1013
- summary: string;
1014
- /** Format: date-time */
1015
- createdAt: string;
1016
- /** Format: date-time */
1017
- updatedAt: string;
1018
- };
1019
- relationships: {
1020
- tile: {
1021
- data: {
1022
- /** Format: uuid */
1023
- id: string;
1024
- /** @enum {string} */
1025
- type: 'tile';
1026
- };
1027
- links: {
1028
- /** Format: uri */
1029
- self: string;
1030
- };
1031
- };
1032
- };
1033
- links: {
1034
- /** Format: uri */
1035
- self: string;
1036
- };
1037
- }[];
1038
- };
1039
- };
1040
- };
1041
- /** @description Not Found */
1042
- 404: {
1043
- headers: {
1044
- [name: string]: unknown;
1045
- };
1046
- content: {
1047
- 'application/json': {
1048
- jsonapi: {
1049
- profile: string[];
1050
- /** @enum {string} */
1051
- version: '1.1';
1052
- };
1053
- errors: {
1054
- title: string;
1055
- status: string;
1056
- detail: string;
1057
- }[];
1058
- };
1059
- };
1060
- };
1061
- /** @description Internal Server Error */
1062
- 500: {
1063
- headers: {
1064
- [name: string]: unknown;
1065
- };
1066
- content: {
1067
- 'application/json': {
1068
- jsonapi: {
1069
- profile: string[];
1070
- /** @enum {string} */
1071
- version: '1.1';
1072
- };
1073
- errors: {
1074
- title: string;
1075
- status: string;
1076
- detail: string;
1077
- }[];
1078
- };
1079
- };
1080
- };
1081
- };
1082
- };
1083
- put?: never;
1084
- post?: never;
1085
- delete?: never;
1086
- options?: never;
1087
- head?: never;
1088
- patch?: never;
1089
- trace?: never;
1090
- };
1091
- '/v1/tiles/{workspaceName}/{tileName}/versions/{version}/files/{filePath}': {
1092
- parameters: {
1093
- query?: never;
1094
- header?: never;
1095
- path?: never;
1096
- cookie?: never;
1097
- };
1098
- get: {
1099
- parameters: {
1100
- query?: never;
1101
- header?: never;
1102
- path: {
1103
- workspaceName: string;
1104
- tileName: string;
1105
- version: string;
1106
- filePath: string;
1107
- };
1108
- cookie?: never;
1109
- };
1110
- requestBody?: never;
1111
- responses: {
1112
- /** @description Default Response */
1113
- 200: {
1114
- headers: {
1115
- [name: string]: unknown;
1116
- };
1117
- content: {
1118
- 'application/zip': unknown;
1119
- };
1120
- };
1121
- /** @description Not Found */
1122
- 404: {
1123
- headers: {
1124
- [name: string]: unknown;
1125
- };
1126
- content: {
1127
- 'application/json': {
1128
- jsonapi: {
1129
- profile: string[];
1130
- /** @enum {string} */
1131
- version: '1.1';
1132
- };
1133
- errors: {
1134
- title: string;
1135
- status: string;
1136
- detail: string;
1137
- }[];
1138
- };
1139
- };
1140
- };
1141
- /** @description Internal Server Error */
1142
- 500: {
1143
- headers: {
1144
- [name: string]: unknown;
1145
- };
1146
- content: {
1147
- 'application/json': {
1148
- jsonapi: {
1149
- profile: string[];
1150
- /** @enum {string} */
1151
- version: '1.1';
1152
- };
1153
- errors: {
1154
- title: string;
1155
- status: string;
1156
- detail: string;
1157
- }[];
1158
- };
1159
- };
1160
- };
1161
- };
1162
- };
1163
- put?: never;
1164
- post?: never;
1165
- delete?: never;
1166
- options?: never;
1167
- head?: never;
1168
- patch?: never;
1169
- trace?: never;
1170
- };
1171
- '/v1/tiles/{workspaceName}/{tileName}/versions/{version}/files': {
1172
- parameters: {
1173
- query?: never;
1174
- header?: never;
1175
- path?: never;
1176
- cookie?: never;
1177
- };
1178
- get: {
1179
- parameters: {
1180
- query?: never;
1181
- header: {
1182
- accept: 'application/gzip' | 'application/json';
1183
- };
1184
- path: {
1185
- workspaceName: string;
1186
- tileName: string;
1187
- version: string;
1188
- };
1189
- cookie?: never;
1190
- };
1191
- requestBody?: never;
1192
- responses: {
1193
- /** @description Default Response */
1194
- 200: {
1195
- headers: {
1196
- [name: string]: unknown;
1197
- };
1198
- content: {
1199
- 'application/json': {
1200
- data: {
1201
- id: string;
1202
- /** @enum {string} */
1203
- type: 'file';
1204
- attributes: {
1205
- path: string;
1206
- };
1207
- }[];
1208
- };
1209
- 'application/gzip': unknown;
1210
- };
1211
- };
1212
- /** @description Not Found */
1213
- 404: {
1214
- headers: {
1215
- [name: string]: unknown;
1216
- };
1217
- content: {
1218
- 'application/json': {
1219
- jsonapi: {
1220
- profile: string[];
1221
- /** @enum {string} */
1222
- version: '1.1';
1223
- };
1224
- errors: {
1225
- title: string;
1226
- status: string;
1227
- detail: string;
1228
- }[];
1229
- };
1230
- };
1231
- };
1232
- /** @description Internal Server Error */
1233
- 500: {
1234
- headers: {
1235
- [name: string]: unknown;
1236
- };
1237
- content: {
1238
- 'application/json': {
1239
- jsonapi: {
1240
- profile: string[];
1241
- /** @enum {string} */
1242
- version: '1.1';
1243
- };
1244
- errors: {
1245
- title: string;
1246
- status: string;
1247
- detail: string;
1248
- }[];
1249
- };
1250
- };
1251
- };
1252
- };
1253
- };
1254
- put?: never;
1255
- post?: never;
1256
- delete?: never;
1257
- options?: never;
1258
- head?: never;
1259
- patch?: never;
1260
- trace?: never;
1261
- };
1262
- '/v1/stepper-jobs/{stepperJobId}': {
1263
- parameters: {
1264
- query?: never;
1265
- header?: never;
1266
- path?: never;
1267
- cookie?: never;
1268
- };
1269
- get: {
1270
- parameters: {
1271
- query?: never;
1272
- header?: never;
1273
- path: {
1274
- stepperJobId: string;
1275
- };
1276
- cookie?: never;
1277
- };
1278
- requestBody?: never;
1279
- responses: {
1280
- /** @description Default Response */
1281
- 202: {
1282
- headers: {
1283
- [name: string]: unknown;
1284
- };
1285
- content: {
1286
- 'application/json': {
1287
- jsonapi: {
1288
- profile: string[];
1289
- /** @enum {string} */
1290
- version: '1.1';
1291
- };
1292
- data: {
1293
- /** Format: uuid */
1294
- id: string;
1295
- /** @enum {string} */
1296
- type: 'stepper-job';
1297
- attributes: {
1298
- status: 'pending' | 'running' | 'complete' | 'crash';
1299
- error?: unknown;
1300
- };
1301
- relationships?: Record<string, never>;
1302
- meta?: Record<string, never>;
1303
- };
1304
- included?: unknown;
1305
- links: {
1306
- /** Format: uri */
1307
- self: string;
1308
- /** Format: uri */
1309
- related?: string;
1310
- };
1311
- meta?: Record<string, never>;
1312
- };
1313
- };
1314
- };
1315
- /** @description Unauthorized */
1316
- 401: {
1317
- headers: {
1318
- [name: string]: unknown;
1319
- };
1320
- content: {
1321
- 'application/json': {
1322
- jsonapi: {
1323
- profile: string[];
1324
- /** @enum {string} */
1325
- version: '1.1';
1326
- };
1327
- errors: {
1328
- title: string;
1329
- status: string;
1330
- detail: string;
1331
- }[];
1332
- };
1333
- };
1334
- };
1335
- /** @description Forbidden */
1336
- 403: {
1337
- headers: {
1338
- [name: string]: unknown;
1339
- };
1340
- content: {
1341
- 'application/json': {
1342
- jsonapi: {
1343
- profile: string[];
1344
- /** @enum {string} */
1345
- version: '1.1';
1346
- };
1347
- errors: {
1348
- title: string;
1349
- status: string;
1350
- detail: string;
1351
- }[];
1352
- };
1353
- };
1354
- };
1355
- /** @description Not Found */
1356
- 404: {
1357
- headers: {
1358
- [name: string]: unknown;
1359
- };
1360
- content: {
1361
- 'application/json': {
1362
- jsonapi: {
1363
- profile: string[];
1364
- /** @enum {string} */
1365
- version: '1.1';
1366
- };
1367
- errors: {
1368
- title: string;
1369
- status: string;
1370
- detail: string;
1371
- }[];
1372
- };
1373
- };
1374
- };
1375
- /** @description Internal Server Error */
1376
- 500: {
1377
- headers: {
1378
- [name: string]: unknown;
1379
- };
1380
- content: {
1381
- 'application/json': {
1382
- jsonapi: {
1383
- profile: string[];
1384
- /** @enum {string} */
1385
- version: '1.1';
1386
- };
1387
- errors: {
1388
- title: string;
1389
- status: string;
1390
- detail: string;
1391
- }[];
1392
- };
1393
- };
1394
- };
1395
- };
1396
- };
1397
- put?: never;
1398
- post?: never;
1399
- delete?: never;
1400
- options?: never;
1401
- head?: never;
1402
- patch?: never;
1403
- trace?: never;
1404
- };
1405
- '/v1/users': {
1406
- parameters: {
1407
- query?: never;
1408
- header?: never;
1409
- path?: never;
1410
- cookie?: never;
1411
- };
1412
- get: {
1413
- parameters: {
1414
- query?: {
1415
- sort?: ('username' | '-username' | 'createdAt' | '-createdAt') | ('username' | '-username' | 'createdAt' | '-createdAt')[];
1416
- 'page[size]'?: number;
1417
- 'page[after]'?: string;
1418
- 'page[before]'?: string;
1419
- include?: string;
1420
- 'filter[username]'?: string;
1421
- 'filter[username][eq]'?: string;
1422
- 'filter[username][gte]'?: string;
1423
- 'filter[username][gt]'?: string;
1424
- 'filter[username][lt]'?: string;
1425
- 'filter[username][lte]'?: string;
1426
- 'filter[username][ne]'?: string;
1427
- 'filter[username][like]'?: string;
1428
- };
1429
- header?: never;
1430
- path?: never;
1431
- cookie?: never;
1432
- };
1433
- requestBody?: never;
1434
- responses: {
1435
- /** @description Default Response */
1436
- 200: {
1437
- headers: {
1438
- [name: string]: unknown;
1439
- };
1440
- content: {
1441
- 'application/json': {
1442
- jsonapi: {
1443
- profile: string[];
1444
- /** @enum {string} */
1445
- version: '1.1';
1446
- };
1447
- links: {
1448
- /** Format: uri */
1449
- self: string;
1450
- next: string | null;
1451
- prev: string | null;
1452
- };
1453
- meta: {
1454
- count: number;
1455
- };
1456
- included?: unknown;
1457
- relationships?: Record<string, never>;
1458
- data: {
1459
- /** Format: uuid */
1460
- id: string;
1461
- /** @enum {string} */
1462
- type: 'user';
1463
- attributes: {
1464
- username: string;
1465
- /** Format: date-time */
1466
- createdAt: string;
1467
- };
1468
- relationships?: Record<string, never>;
1469
- meta?: Record<string, never>;
1470
- }[];
1471
- };
1472
- };
1473
- };
1474
- /** @description Unauthorized */
1475
- 401: {
1476
- headers: {
1477
- [name: string]: unknown;
1478
- };
1479
- content: {
1480
- 'application/json': {
1481
- jsonapi: {
1482
- profile: string[];
1483
- /** @enum {string} */
1484
- version: '1.1';
1485
- };
1486
- errors: {
1487
- title: string;
1488
- status: string;
1489
- detail: string;
1490
- }[];
1491
- };
1492
- };
1493
- };
1494
- /** @description Forbidden */
1495
- 403: {
1496
- headers: {
1497
- [name: string]: unknown;
1498
- };
1499
- content: {
1500
- 'application/json': {
1501
- jsonapi: {
1502
- profile: string[];
1503
- /** @enum {string} */
1504
- version: '1.1';
1505
- };
1506
- errors: {
1507
- title: string;
1508
- status: string;
1509
- detail: string;
1510
- }[];
1511
- };
1512
- };
1513
- };
1514
- /** @description Not Found */
1515
- 404: {
1516
- headers: {
1517
- [name: string]: unknown;
1518
- };
1519
- content: {
1520
- 'application/json': {
1521
- jsonapi: {
1522
- profile: string[];
1523
- /** @enum {string} */
1524
- version: '1.1';
1525
- };
1526
- errors: {
1527
- title: string;
1528
- status: string;
1529
- detail: string;
1530
- }[];
1531
- };
1532
- };
1533
- };
1534
- /** @description Internal Server Error */
1535
- 500: {
1536
- headers: {
1537
- [name: string]: unknown;
1538
- };
1539
- content: {
1540
- 'application/json': {
1541
- jsonapi: {
1542
- profile: string[];
1543
- /** @enum {string} */
1544
- version: '1.1';
1545
- };
1546
- errors: {
1547
- title: string;
1548
- status: string;
1549
- detail: string;
1550
- }[];
1551
- };
1552
- };
1553
- };
1554
- };
1555
- };
1556
- put?: never;
1557
- post: {
1558
- parameters: {
1559
- query?: never;
1560
- header?: never;
1561
- path?: never;
1562
- cookie?: never;
1563
- };
1564
- requestBody?: never;
1565
- responses: {
1566
- /** @description Default Response */
1567
- 200: {
1568
- headers: {
1569
- [name: string]: unknown;
1570
- };
1571
- content: {
1572
- 'application/json': {
1573
- jsonapi: {
1574
- profile: string[];
1575
- /** @enum {string} */
1576
- version: '1.1';
1577
- };
1578
- data: {
1579
- /** Format: uuid */
1580
- id: string;
1581
- /** @enum {string} */
1582
- type: 'user';
1583
- attributes?: Record<string, never>;
1584
- relationships?: Record<string, never>;
1585
- meta?: Record<string, never>;
1586
- };
1587
- included?: unknown;
1588
- links: {
1589
- /** Format: uri */
1590
- self: string;
1591
- /** Format: uri */
1592
- related?: string;
1593
- };
1594
- meta?: Record<string, never>;
1595
- };
1596
- };
1597
- };
1598
- /** @description Default Response */
1599
- 201: {
1600
- headers: {
1601
- [name: string]: unknown;
1602
- };
1603
- content: {
1604
- 'application/json': {
1605
- jsonapi: {
1606
- profile: string[];
1607
- /** @enum {string} */
1608
- version: '1.1';
1609
- };
1610
- data: {
1611
- /** Format: uuid */
1612
- id: string;
1613
- /** @enum {string} */
1614
- type: 'user';
1615
- attributes?: Record<string, never>;
1616
- relationships?: Record<string, never>;
1617
- meta?: Record<string, never>;
1618
- };
1619
- included?: unknown;
1620
- links: {
1621
- /** Format: uri */
1622
- self: string;
1623
- /** Format: uri */
1624
- related?: string;
1625
- };
1626
- meta?: Record<string, never>;
1627
- };
1628
- };
1629
- };
1630
- /** @description Not Found */
1631
- 404: {
1632
- headers: {
1633
- [name: string]: unknown;
1634
- };
1635
- content: {
1636
- 'application/json': {
1637
- jsonapi: {
1638
- profile: string[];
1639
- /** @enum {string} */
1640
- version: '1.1';
1641
- };
1642
- errors: {
1643
- title: string;
1644
- status: string;
1645
- detail: string;
1646
- }[];
1647
- };
1648
- };
1649
- };
1650
- /** @description Internal Server Error */
1651
- 500: {
1652
- headers: {
1653
- [name: string]: unknown;
1654
- };
1655
- content: {
1656
- 'application/json': {
1657
- jsonapi: {
1658
- profile: string[];
1659
- /** @enum {string} */
1660
- version: '1.1';
1661
- };
1662
- errors: {
1663
- title: string;
1664
- status: string;
1665
- detail: string;
1666
- }[];
1667
- };
1668
- };
1669
- };
1670
- };
1671
- };
1672
- delete?: never;
1673
- options?: never;
1674
- head?: never;
1675
- patch?: never;
1676
- trace?: never;
1677
- };
1678
- '/v1/users/{userId}': {
1679
- parameters: {
1680
- query?: never;
1681
- header?: never;
1682
- path?: never;
1683
- cookie?: never;
1684
- };
1685
- get: {
1686
- parameters: {
1687
- query?: never;
1688
- header?: never;
1689
- path: {
1690
- userId: string;
1691
- };
1692
- cookie?: never;
1693
- };
1694
- requestBody?: never;
1695
- responses: {
1696
- /** @description Default Response */
1697
- 200: {
1698
- headers: {
1699
- [name: string]: unknown;
1700
- };
1701
- content: {
1702
- 'application/json': {
1703
- jsonapi: {
1704
- profile: string[];
1705
- /** @enum {string} */
1706
- version: '1.1';
1707
- };
1708
- data: {
1709
- /** Format: uuid */
1710
- id: string;
1711
- /** @enum {string} */
1712
- type: 'user';
1713
- attributes: {
1714
- username: string;
1715
- firstName: string;
1716
- lastName: string;
1717
- profilePictureUrl: string;
1718
- /** Format: date-time */
1719
- createdAt: string;
1720
- };
1721
- relationships?: Record<string, never>;
1722
- meta?: Record<string, never>;
1723
- };
1724
- included?: unknown;
1725
- links: {
1726
- /** Format: uri */
1727
- self: string;
1728
- /** Format: uri */
1729
- related?: string;
1730
- };
1731
- meta?: Record<string, never>;
1732
- };
1733
- };
1734
- };
1735
- /** @description Unauthorized */
1736
- 401: {
1737
- headers: {
1738
- [name: string]: unknown;
1739
- };
1740
- content: {
1741
- 'application/json': {
1742
- jsonapi: {
1743
- profile: string[];
1744
- /** @enum {string} */
1745
- version: '1.1';
1746
- };
1747
- errors: {
1748
- title: string;
1749
- status: string;
1750
- detail: string;
1751
- }[];
1752
- };
1753
- };
1754
- };
1755
- /** @description Forbidden */
1756
- 403: {
1757
- headers: {
1758
- [name: string]: unknown;
1759
- };
1760
- content: {
1761
- 'application/json': {
1762
- jsonapi: {
1763
- profile: string[];
1764
- /** @enum {string} */
1765
- version: '1.1';
1766
- };
1767
- errors: {
1768
- title: string;
1769
- status: string;
1770
- detail: string;
1771
- }[];
1772
- };
1773
- };
1774
- };
1775
- /** @description Not Found */
1776
- 404: {
1777
- headers: {
1778
- [name: string]: unknown;
1779
- };
1780
- content: {
1781
- 'application/json': {
1782
- jsonapi: {
1783
- profile: string[];
1784
- /** @enum {string} */
1785
- version: '1.1';
1786
- };
1787
- errors: {
1788
- title: string;
1789
- status: string;
1790
- detail: string;
1791
- }[];
1792
- };
1793
- };
1794
- };
1795
- /** @description Internal Server Error */
1796
- 500: {
1797
- headers: {
1798
- [name: string]: unknown;
1799
- };
1800
- content: {
1801
- 'application/json': {
1802
- jsonapi: {
1803
- profile: string[];
1804
- /** @enum {string} */
1805
- version: '1.1';
1806
- };
1807
- errors: {
1808
- title: string;
1809
- status: string;
1810
- detail: string;
1811
- }[];
1812
- };
1813
- };
1814
- };
1815
- };
1816
- };
1817
- put?: never;
1818
- post: {
1819
- parameters: {
1820
- query?: never;
1821
- header?: never;
1822
- path: {
1823
- userId: string;
1824
- };
1825
- cookie?: never;
1826
- };
1827
- requestBody?: {
1828
- content: {
1829
- 'application/json': {
1830
- /** Format: email */
1831
- email?: string;
1832
- };
1833
- };
1834
- };
1835
- responses: {
1836
- /** @description Default Response */
1837
- 200: {
1838
- headers: {
1839
- [name: string]: unknown;
1840
- };
1841
- content: {
1842
- 'application/json': {
1843
- jsonapi: {
1844
- profile: string[];
1845
- /** @enum {string} */
1846
- version: '1.1';
1847
- };
1848
- data: {
1849
- /** Format: uuid */
1850
- id: string;
1851
- /** @enum {string} */
1852
- type: 'user';
1853
- attributes: {
1854
- username: string;
1855
- firstName: string;
1856
- lastName: string;
1857
- /** Format: email */
1858
- email: string;
1859
- emailVerified: boolean;
1860
- profilePictureUrl: string;
1861
- /** Format: date-time */
1862
- createdAt: string;
1863
- /** Format: date-time */
1864
- updatedAt: string;
1865
- };
1866
- relationships?: Record<string, never>;
1867
- meta?: Record<string, never>;
1868
- };
1869
- included?: unknown;
1870
- links: {
1871
- /** Format: uri */
1872
- self: string;
1873
- /** Format: uri */
1874
- related?: string;
1875
- };
1876
- meta?: Record<string, never>;
1877
- };
1878
- };
1879
- };
1880
- /** @description Unauthorized */
1881
- 401: {
1882
- headers: {
1883
- [name: string]: unknown;
1884
- };
1885
- content: {
1886
- 'application/json': {
1887
- jsonapi: {
1888
- profile: string[];
1889
- /** @enum {string} */
1890
- version: '1.1';
1891
- };
1892
- errors: {
1893
- title: string;
1894
- status: string;
1895
- detail: string;
1896
- }[];
1897
- };
1898
- };
1899
- };
1900
- /** @description Forbidden */
1901
- 403: {
1902
- headers: {
1903
- [name: string]: unknown;
1904
- };
1905
- content: {
1906
- 'application/json': {
1907
- jsonapi: {
1908
- profile: string[];
1909
- /** @enum {string} */
1910
- version: '1.1';
1911
- };
1912
- errors: {
1913
- title: string;
1914
- status: string;
1915
- detail: string;
1916
- }[];
1917
- };
1918
- };
1919
- };
1920
- /** @description Not Found */
1921
- 404: {
1922
- headers: {
1923
- [name: string]: unknown;
1924
- };
1925
- content: {
1926
- 'application/json': {
1927
- jsonapi: {
1928
- profile: string[];
1929
- /** @enum {string} */
1930
- version: '1.1';
1931
- };
1932
- errors: {
1933
- title: string;
1934
- status: string;
1935
- detail: string;
1936
- }[];
1937
- };
1938
- };
1939
- };
1940
- /** @description Internal Server Error */
1941
- 500: {
1942
- headers: {
1943
- [name: string]: unknown;
1944
- };
1945
- content: {
1946
- 'application/json': {
1947
- jsonapi: {
1948
- profile: string[];
1949
- /** @enum {string} */
1950
- version: '1.1';
1951
- };
1952
- errors: {
1953
- title: string;
1954
- status: string;
1955
- detail: string;
1956
- }[];
1957
- };
1958
- };
1959
- };
1960
- };
1961
- };
1962
- delete?: never;
1963
- options?: never;
1964
- head?: never;
1965
- patch?: never;
1966
- trace?: never;
1967
- };
1968
- '/v1/users/keys': {
1969
- parameters: {
1970
- query?: never;
1971
- header?: never;
1972
- path?: never;
1973
- cookie?: never;
1974
- };
1975
- get?: never;
1976
- put?: never;
1977
- post: {
1978
- parameters: {
1979
- query?: never;
1980
- header?: never;
1981
- path?: never;
1982
- cookie?: never;
1983
- };
1984
- requestBody: {
1985
- content: {
1986
- 'application/json': {
1987
- /** Format: date-time */
1988
- expiryDate: string;
1989
- };
1990
- };
1991
- };
1992
- responses: {
1993
- /** @description Default Response */
1994
- 201: {
1995
- headers: {
1996
- [name: string]: unknown;
1997
- };
1998
- content: {
1999
- 'application/json': {
2000
- jsonapi: {
2001
- profile: string[];
2002
- /** @enum {string} */
2003
- version: '1.1';
2004
- };
2005
- data: {
2006
- /** Format: uuid */
2007
- id: string;
2008
- /** @enum {string} */
2009
- type: 'api-key';
2010
- attributes: {
2011
- apiKey: string;
2012
- /** Format: date-time */
2013
- expiryDate: string;
2014
- /** Format: date-time */
2015
- createdAt: string;
2016
- };
2017
- relationships?: Record<string, never>;
2018
- meta?: Record<string, never>;
2019
- };
2020
- included?: unknown;
2021
- links: {
2022
- /** Format: uri */
2023
- self: string;
2024
- /** Format: uri */
2025
- related?: string;
2026
- };
2027
- meta?: Record<string, never>;
2028
- };
2029
- };
2030
- };
2031
- /** @description Unauthorized */
2032
- 401: {
2033
- headers: {
2034
- [name: string]: unknown;
2035
- };
2036
- content: {
2037
- 'application/json': {
2038
- jsonapi: {
2039
- profile: string[];
2040
- /** @enum {string} */
2041
- version: '1.1';
2042
- };
2043
- errors: {
2044
- title: string;
2045
- status: string;
2046
- detail: string;
2047
- }[];
2048
- };
2049
- };
2050
- };
2051
- /** @description Forbidden */
2052
- 403: {
2053
- headers: {
2054
- [name: string]: unknown;
2055
- };
2056
- content: {
2057
- 'application/json': {
2058
- jsonapi: {
2059
- profile: string[];
2060
- /** @enum {string} */
2061
- version: '1.1';
2062
- };
2063
- errors: {
2064
- title: string;
2065
- status: string;
2066
- detail: string;
2067
- }[];
2068
- };
2069
- };
2070
- };
2071
- /** @description Not Found */
2072
- 404: {
2073
- headers: {
2074
- [name: string]: unknown;
2075
- };
2076
- content: {
2077
- 'application/json': {
2078
- jsonapi: {
2079
- profile: string[];
2080
- /** @enum {string} */
2081
- version: '1.1';
2082
- };
2083
- errors: {
2084
- title: string;
2085
- status: string;
2086
- detail: string;
2087
- }[];
2088
- };
2089
- };
2090
- };
2091
- /** @description Internal Server Error */
2092
- 500: {
2093
- headers: {
2094
- [name: string]: unknown;
2095
- };
2096
- content: {
2097
- 'application/json': {
2098
- jsonapi: {
2099
- profile: string[];
2100
- /** @enum {string} */
2101
- version: '1.1';
2102
- };
2103
- errors: {
2104
- title: string;
2105
- status: string;
2106
- detail: string;
2107
- }[];
2108
- };
2109
- };
2110
- };
2111
- };
2112
- };
2113
- delete?: never;
2114
- options?: never;
2115
- head?: never;
2116
- patch?: never;
2117
- trace?: never;
2118
- };
2119
- '/v1/users/me': {
2120
- parameters: {
2121
- query?: never;
2122
- header?: never;
2123
- path?: never;
2124
- cookie?: never;
2125
- };
2126
- get: {
2127
- parameters: {
2128
- query?: never;
2129
- header?: never;
2130
- path?: never;
2131
- cookie?: never;
2132
- };
2133
- requestBody?: never;
2134
- responses: {
2135
- /** @description Default Response */
2136
- 200: {
2137
- headers: {
2138
- [name: string]: unknown;
2139
- };
2140
- content: {
2141
- 'application/json': {
2142
- jsonapi: {
2143
- profile: string[];
2144
- /** @enum {string} */
2145
- version: '1.1';
2146
- };
2147
- data: {
2148
- /** Format: uuid */
2149
- id: string;
2150
- /** @enum {string} */
2151
- type: 'user';
2152
- attributes: {
2153
- username: string;
2154
- firstName: string | null;
2155
- lastName: string | null;
2156
- /** Format: email */
2157
- email: string;
2158
- emailVerified: boolean;
2159
- profilePictureUrl: string | null;
2160
- /** Format: date-time */
2161
- createdAt: string;
2162
- /** Format: date-time */
2163
- updatedAt: string;
2164
- };
2165
- relationships?: Record<string, never>;
2166
- meta?: Record<string, never>;
2167
- };
2168
- included?: unknown;
2169
- links: {
2170
- /** Format: uri */
2171
- self: string;
2172
- /** Format: uri */
2173
- related?: string;
2174
- };
2175
- meta?: Record<string, never>;
2176
- };
2177
- };
2178
- };
2179
- /** @description Unauthorized */
2180
- 401: {
2181
- headers: {
2182
- [name: string]: unknown;
2183
- };
2184
- content: {
2185
- 'application/json': {
2186
- jsonapi: {
2187
- profile: string[];
2188
- /** @enum {string} */
2189
- version: '1.1';
2190
- };
2191
- errors: {
2192
- title: string;
2193
- status: string;
2194
- detail: string;
2195
- }[];
2196
- };
2197
- };
2198
- };
2199
- /** @description Forbidden */
2200
- 403: {
2201
- headers: {
2202
- [name: string]: unknown;
2203
- };
2204
- content: {
2205
- 'application/json': {
2206
- jsonapi: {
2207
- profile: string[];
2208
- /** @enum {string} */
2209
- version: '1.1';
2210
- };
2211
- errors: {
2212
- title: string;
2213
- status: string;
2214
- detail: string;
2215
- }[];
2216
- };
2217
- };
2218
- };
2219
- /** @description Not Found */
2220
- 404: {
2221
- headers: {
2222
- [name: string]: unknown;
2223
- };
2224
- content: {
2225
- 'application/json': {
2226
- jsonapi: {
2227
- profile: string[];
2228
- /** @enum {string} */
2229
- version: '1.1';
2230
- };
2231
- errors: {
2232
- title: string;
2233
- status: string;
2234
- detail: string;
2235
- }[];
2236
- };
2237
- };
2238
- };
2239
- /** @description Internal Server Error */
2240
- 500: {
2241
- headers: {
2242
- [name: string]: unknown;
2243
- };
2244
- content: {
2245
- 'application/json': {
2246
- jsonapi: {
2247
- profile: string[];
2248
- /** @enum {string} */
2249
- version: '1.1';
2250
- };
2251
- errors: {
2252
- title: string;
2253
- status: string;
2254
- detail: string;
2255
- }[];
2256
- };
2257
- };
2258
- };
2259
- };
2260
- };
2261
- put?: never;
2262
- post?: never;
2263
- delete?: never;
2264
- options?: never;
2265
- head?: never;
2266
- patch?: never;
2267
- trace?: never;
2268
- };
2269
- '/v1/workspaces/{workspaceId}': {
2270
- parameters: {
2271
- query?: never;
2272
- header?: never;
2273
- path?: never;
2274
- cookie?: never;
2275
- };
2276
- get: {
2277
- parameters: {
2278
- query?: never;
2279
- header?: never;
2280
- path: {
2281
- workspaceId: string;
2282
- };
2283
- cookie?: never;
2284
- };
2285
- requestBody?: never;
2286
- responses: {
2287
- /** @description Default Response */
2288
- 200: {
2289
- headers: {
2290
- [name: string]: unknown;
2291
- };
2292
- content: {
2293
- 'application/json': {
2294
- jsonapi: {
2295
- profile: string[];
2296
- /** @enum {string} */
2297
- version: '1.1';
2298
- };
2299
- data: {
2300
- /** Format: uuid */
2301
- id: string;
2302
- /** @enum {string} */
2303
- type: 'workspace';
2304
- attributes: {
2305
- name: string;
2306
- };
2307
- relationships?: Record<string, never>;
2308
- meta?: Record<string, never>;
2309
- };
2310
- included?: unknown;
2311
- links: {
2312
- /** Format: uri */
2313
- self: string;
2314
- /** Format: uri */
2315
- related?: string;
2316
- };
2317
- meta?: Record<string, never>;
2318
- };
2319
- };
2320
- };
2321
- /** @description Unauthorized */
2322
- 401: {
2323
- headers: {
2324
- [name: string]: unknown;
2325
- };
2326
- content: {
2327
- 'application/json': {
2328
- jsonapi: {
2329
- profile: string[];
2330
- /** @enum {string} */
2331
- version: '1.1';
2332
- };
2333
- errors: {
2334
- title: string;
2335
- status: string;
2336
- detail: string;
2337
- }[];
2338
- };
2339
- };
2340
- };
2341
- /** @description Forbidden */
2342
- 403: {
2343
- headers: {
2344
- [name: string]: unknown;
2345
- };
2346
- content: {
2347
- 'application/json': {
2348
- jsonapi: {
2349
- profile: string[];
2350
- /** @enum {string} */
2351
- version: '1.1';
2352
- };
2353
- errors: {
2354
- title: string;
2355
- status: string;
2356
- detail: string;
2357
- }[];
2358
- };
2359
- };
2360
- };
2361
- /** @description Not Found */
2362
- 404: {
2363
- headers: {
2364
- [name: string]: unknown;
2365
- };
2366
- content: {
2367
- 'application/json': {
2368
- jsonapi: {
2369
- profile: string[];
2370
- /** @enum {string} */
2371
- version: '1.1';
2372
- };
2373
- errors: {
2374
- title: string;
2375
- status: string;
2376
- detail: string;
2377
- }[];
2378
- };
2379
- };
2380
- };
2381
- /** @description Internal Server Error */
2382
- 500: {
2383
- headers: {
2384
- [name: string]: unknown;
2385
- };
2386
- content: {
2387
- 'application/json': {
2388
- jsonapi: {
2389
- profile: string[];
2390
- /** @enum {string} */
2391
- version: '1.1';
2392
- };
2393
- errors: {
2394
- title: string;
2395
- status: string;
2396
- detail: string;
2397
- }[];
2398
- };
2399
- };
2400
- };
2401
- };
2402
- };
2403
- put?: never;
2404
- post: {
2405
- parameters: {
2406
- query?: never;
2407
- header?: never;
2408
- path: {
2409
- workspaceId: string;
2410
- };
2411
- cookie?: never;
2412
- };
2413
- requestBody?: {
2414
- content: {
2415
- 'application/json': Record<string, never>;
2416
- };
2417
- };
2418
- responses: {
2419
- /** @description Default Response */
2420
- 200: {
2421
- headers: {
2422
- [name: string]: unknown;
2423
- };
2424
- content: {
2425
- 'application/json': {
2426
- jsonapi: {
2427
- profile: string[];
2428
- /** @enum {string} */
2429
- version: '1.1';
2430
- };
2431
- data: {
2432
- /** Format: uuid */
2433
- id: string;
2434
- /** @enum {string} */
2435
- type: 'workspace';
2436
- attributes: {
2437
- name: string;
2438
- /** Format: date-time */
2439
- createdAt: string;
2440
- /** Format: date-time */
2441
- updatedAt: string;
2442
- };
2443
- relationships?: Record<string, never>;
2444
- meta?: Record<string, never>;
2445
- };
2446
- included?: unknown;
2447
- links: {
2448
- /** Format: uri */
2449
- self: string;
2450
- /** Format: uri */
2451
- related?: string;
2452
- };
2453
- meta?: Record<string, never>;
2454
- };
2455
- };
2456
- };
2457
- /** @description Unauthorized */
2458
- 401: {
2459
- headers: {
2460
- [name: string]: unknown;
2461
- };
2462
- content: {
2463
- 'application/json': {
2464
- jsonapi: {
2465
- profile: string[];
2466
- /** @enum {string} */
2467
- version: '1.1';
2468
- };
2469
- errors: {
2470
- title: string;
2471
- status: string;
2472
- detail: string;
2473
- }[];
2474
- };
2475
- };
2476
- };
2477
- /** @description Forbidden */
2478
- 403: {
2479
- headers: {
2480
- [name: string]: unknown;
2481
- };
2482
- content: {
2483
- 'application/json': {
2484
- jsonapi: {
2485
- profile: string[];
2486
- /** @enum {string} */
2487
- version: '1.1';
2488
- };
2489
- errors: {
2490
- title: string;
2491
- status: string;
2492
- detail: string;
2493
- }[];
2494
- };
2495
- };
2496
- };
2497
- /** @description Not Found */
2498
- 404: {
2499
- headers: {
2500
- [name: string]: unknown;
2501
- };
2502
- content: {
2503
- 'application/json': {
2504
- jsonapi: {
2505
- profile: string[];
2506
- /** @enum {string} */
2507
- version: '1.1';
2508
- };
2509
- errors: {
2510
- title: string;
2511
- status: string;
2512
- detail: string;
2513
- }[];
2514
- };
2515
- };
2516
- };
2517
- /** @description Internal Server Error */
2518
- 500: {
2519
- headers: {
2520
- [name: string]: unknown;
2521
- };
2522
- content: {
2523
- 'application/json': {
2524
- jsonapi: {
2525
- profile: string[];
2526
- /** @enum {string} */
2527
- version: '1.1';
2528
- };
2529
- errors: {
2530
- title: string;
2531
- status: string;
2532
- detail: string;
2533
- }[];
2534
- };
2535
- };
2536
- };
2537
- };
2538
- };
2539
- delete: {
2540
- parameters: {
2541
- query?: never;
2542
- header?: never;
2543
- path: {
2544
- workspaceId: string;
2545
- };
2546
- cookie?: never;
2547
- };
2548
- requestBody?: never;
2549
- responses: {
2550
- /** @description Default Response */
2551
- 204: {
2552
- headers: {
2553
- [name: string]: unknown;
2554
- };
2555
- content: {
2556
- 'application/json': Record<string, never>;
2557
- };
2558
- };
2559
- /** @description Unauthorized */
2560
- 401: {
2561
- headers: {
2562
- [name: string]: unknown;
2563
- };
2564
- content: {
2565
- 'application/json': {
2566
- jsonapi: {
2567
- profile: string[];
2568
- /** @enum {string} */
2569
- version: '1.1';
2570
- };
2571
- errors: {
2572
- title: string;
2573
- status: string;
2574
- detail: string;
2575
- }[];
2576
- };
2577
- };
2578
- };
2579
- /** @description Forbidden */
2580
- 403: {
2581
- headers: {
2582
- [name: string]: unknown;
2583
- };
2584
- content: {
2585
- 'application/json': {
2586
- jsonapi: {
2587
- profile: string[];
2588
- /** @enum {string} */
2589
- version: '1.1';
2590
- };
2591
- errors: {
2592
- title: string;
2593
- status: string;
2594
- detail: string;
2595
- }[];
2596
- };
2597
- };
2598
- };
2599
- /** @description Not Found */
2600
- 404: {
2601
- headers: {
2602
- [name: string]: unknown;
2603
- };
2604
- content: {
2605
- 'application/json': {
2606
- jsonapi: {
2607
- profile: string[];
2608
- /** @enum {string} */
2609
- version: '1.1';
2610
- };
2611
- errors: {
2612
- title: string;
2613
- status: string;
2614
- detail: string;
2615
- }[];
2616
- };
2617
- };
2618
- };
2619
- /** @description Internal Server Error */
2620
- 500: {
2621
- headers: {
2622
- [name: string]: unknown;
2623
- };
2624
- content: {
2625
- 'application/json': {
2626
- jsonapi: {
2627
- profile: string[];
2628
- /** @enum {string} */
2629
- version: '1.1';
2630
- };
2631
- errors: {
2632
- title: string;
2633
- status: string;
2634
- detail: string;
2635
- }[];
2636
- };
2637
- };
2638
- };
2639
- };
2640
- };
2641
- options?: never;
2642
- head?: never;
2643
- patch?: never;
2644
- trace?: never;
2645
- };
2646
- '/v1/workspaces': {
2647
- parameters: {
2648
- query?: never;
2649
- header?: never;
2650
- path?: never;
2651
- cookie?: never;
2652
- };
2653
- get: {
2654
- parameters: {
2655
- query?: {
2656
- sort?: ('name' | '-name' | 'updatedAt' | '-updatedAt') | ('name' | '-name' | 'updatedAt' | '-updatedAt')[];
2657
- 'page[size]'?: number;
2658
- 'page[after]'?: string;
2659
- 'page[before]'?: string;
2660
- include?: string;
2661
- 'filter[name]'?: string;
2662
- 'filter[name][eq]'?: string;
2663
- 'filter[name][gte]'?: string;
2664
- 'filter[name][gt]'?: string;
2665
- 'filter[name][lt]'?: string;
2666
- 'filter[name][lte]'?: string;
2667
- 'filter[name][ne]'?: string;
2668
- 'filter[name][like]'?: string;
2669
- };
2670
- header?: never;
2671
- path?: never;
2672
- cookie?: never;
2673
- };
2674
- requestBody?: never;
2675
- responses: {
2676
- /** @description Default Response */
2677
- 200: {
2678
- headers: {
2679
- [name: string]: unknown;
2680
- };
2681
- content: {
2682
- 'application/json': {
2683
- jsonapi: {
2684
- profile: string[];
2685
- /** @enum {string} */
2686
- version: '1.1';
2687
- };
2688
- links: {
2689
- /** Format: uri */
2690
- self: string;
2691
- next: string | null;
2692
- prev: string | null;
2693
- };
2694
- meta: {
2695
- count: number;
2696
- };
2697
- included?: unknown;
2698
- relationships?: Record<string, never>;
2699
- data: {
2700
- /** Format: uuid */
2701
- id: string;
2702
- /** @enum {string} */
2703
- type: 'workspace';
2704
- attributes: {
2705
- name: string;
2706
- createdAt: string;
2707
- updatedAt: string;
2708
- };
2709
- relationships?: Record<string, never>;
2710
- meta: {
2711
- allowedActions: string[];
2712
- };
2713
- }[];
2714
- };
2715
- };
2716
- };
2717
- /** @description Unauthorized */
2718
- 401: {
2719
- headers: {
2720
- [name: string]: unknown;
2721
- };
2722
- content: {
2723
- 'application/json': {
2724
- jsonapi: {
2725
- profile: string[];
2726
- /** @enum {string} */
2727
- version: '1.1';
2728
- };
2729
- errors: {
2730
- title: string;
2731
- status: string;
2732
- detail: string;
2733
- }[];
2734
- };
2735
- };
2736
- };
2737
- /** @description Forbidden */
2738
- 403: {
2739
- headers: {
2740
- [name: string]: unknown;
2741
- };
2742
- content: {
2743
- 'application/json': {
2744
- jsonapi: {
2745
- profile: string[];
2746
- /** @enum {string} */
2747
- version: '1.1';
2748
- };
2749
- errors: {
2750
- title: string;
2751
- status: string;
2752
- detail: string;
2753
- }[];
2754
- };
2755
- };
2756
- };
2757
- /** @description Not Found */
2758
- 404: {
2759
- headers: {
2760
- [name: string]: unknown;
2761
- };
2762
- content: {
2763
- 'application/json': {
2764
- jsonapi: {
2765
- profile: string[];
2766
- /** @enum {string} */
2767
- version: '1.1';
2768
- };
2769
- errors: {
2770
- title: string;
2771
- status: string;
2772
- detail: string;
2773
- }[];
2774
- };
2775
- };
2776
- };
2777
- /** @description Internal Server Error */
2778
- 500: {
2779
- headers: {
2780
- [name: string]: unknown;
2781
- };
2782
- content: {
2783
- 'application/json': {
2784
- jsonapi: {
2785
- profile: string[];
2786
- /** @enum {string} */
2787
- version: '1.1';
2788
- };
2789
- errors: {
2790
- title: string;
2791
- status: string;
2792
- detail: string;
2793
- }[];
2794
- };
2795
- };
2796
- };
2797
- };
2798
- };
2799
- put?: never;
2800
- post: {
2801
- parameters: {
2802
- query?: never;
2803
- header?: never;
2804
- path?: never;
2805
- cookie?: never;
2806
- };
2807
- requestBody: {
2808
- content: {
2809
- 'application/json': {
2810
- name: string;
2811
- };
2812
- };
2813
- };
2814
- responses: {
2815
- /** @description Default Response */
2816
- 201: {
2817
- headers: {
2818
- [name: string]: unknown;
2819
- };
2820
- content: {
2821
- 'application/json': {
2822
- jsonapi: {
2823
- profile: string[];
2824
- /** @enum {string} */
2825
- version: '1.1';
2826
- };
2827
- data: {
2828
- /** Format: uuid */
2829
- id: string;
2830
- /** @enum {string} */
2831
- type: 'workspace';
2832
- attributes: {
2833
- name: string;
2834
- };
2835
- relationships?: Record<string, never>;
2836
- meta?: Record<string, never>;
2837
- };
2838
- included?: unknown;
2839
- links: {
2840
- /** Format: uri */
2841
- self: string;
2842
- /** Format: uri */
2843
- related?: string;
2844
- };
2845
- meta?: Record<string, never>;
2846
- };
2847
- };
2848
- };
2849
- /** @description Unauthorized */
2850
- 401: {
2851
- headers: {
2852
- [name: string]: unknown;
2853
- };
2854
- content: {
2855
- 'application/json': {
2856
- jsonapi: {
2857
- profile: string[];
2858
- /** @enum {string} */
2859
- version: '1.1';
2860
- };
2861
- errors: {
2862
- title: string;
2863
- status: string;
2864
- detail: string;
2865
- }[];
2866
- };
2867
- };
2868
- };
2869
- /** @description Forbidden */
2870
- 403: {
2871
- headers: {
2872
- [name: string]: unknown;
2873
- };
2874
- content: {
2875
- 'application/json': {
2876
- jsonapi: {
2877
- profile: string[];
2878
- /** @enum {string} */
2879
- version: '1.1';
2880
- };
2881
- errors: {
2882
- title: string;
2883
- status: string;
2884
- detail: string;
2885
- }[];
2886
- };
2887
- };
2888
- };
2889
- /** @description Not Found */
2890
- 404: {
2891
- headers: {
2892
- [name: string]: unknown;
2893
- };
2894
- content: {
2895
- 'application/json': {
2896
- jsonapi: {
2897
- profile: string[];
2898
- /** @enum {string} */
2899
- version: '1.1';
2900
- };
2901
- errors: {
2902
- title: string;
2903
- status: string;
2904
- detail: string;
2905
- }[];
2906
- };
2907
- };
2908
- };
2909
- /** @description Internal Server Error */
2910
- 500: {
2911
- headers: {
2912
- [name: string]: unknown;
2913
- };
2914
- content: {
2915
- 'application/json': {
2916
- jsonapi: {
2917
- profile: string[];
2918
- /** @enum {string} */
2919
- version: '1.1';
2920
- };
2921
- errors: {
2922
- title: string;
2923
- status: string;
2924
- detail: string;
2925
- }[];
2926
- };
2927
- };
2928
- };
2929
- };
2930
- };
2931
- delete?: never;
2932
- options?: never;
2933
- head?: never;
2934
- patch?: never;
2935
- trace?: never;
2936
- };
2937
- '/v1/workspaces/{workspaceId}/members': {
2938
- parameters: {
2939
- query?: never;
2940
- header?: never;
2941
- path?: never;
2942
- cookie?: never;
2943
- };
2944
- get: {
2945
- parameters: {
2946
- query?: {
2947
- sort?: ('username' | '-username') | ('username' | '-username')[];
2948
- 'page[size]'?: number;
2949
- 'page[after]'?: string;
2950
- 'page[before]'?: string;
2951
- include?: string;
2952
- };
2953
- header?: never;
2954
- path: {
2955
- workspaceId: string;
2956
- };
2957
- cookie?: never;
2958
- };
2959
- requestBody?: never;
2960
- responses: {
2961
- /** @description Default Response */
2962
- 200: {
2963
- headers: {
2964
- [name: string]: unknown;
2965
- };
2966
- content: {
2967
- 'application/json': {
2968
- jsonapi: {
2969
- profile: string[];
2970
- /** @enum {string} */
2971
- version: '1.1';
2972
- };
2973
- links: {
2974
- /** Format: uri */
2975
- self: string;
2976
- next: string | null;
2977
- prev: string | null;
2978
- };
2979
- meta: {
2980
- count: number;
2981
- };
2982
- included?: unknown;
2983
- relationships?: Record<string, never>;
2984
- data: {
2985
- /** Format: uuid */
2986
- id: string;
2987
- /** @enum {string} */
2988
- type: 'user';
2989
- attributes: {
2990
- username: string;
2991
- firstName: string;
2992
- lastName: string;
2993
- profilePictureUrl: string | null;
2994
- role: 'owner' | 'member' | 'viewer';
2995
- };
2996
- relationships?: Record<string, never>;
2997
- meta?: Record<string, never>;
2998
- }[];
2999
- };
3000
- };
3001
- };
3002
- /** @description Unauthorized */
3003
- 401: {
3004
- headers: {
3005
- [name: string]: unknown;
3006
- };
3007
- content: {
3008
- 'application/json': {
3009
- jsonapi: {
3010
- profile: string[];
3011
- /** @enum {string} */
3012
- version: '1.1';
3013
- };
3014
- errors: {
3015
- title: string;
3016
- status: string;
3017
- detail: string;
3018
- }[];
3019
- };
3020
- };
3021
- };
3022
- /** @description Forbidden */
3023
- 403: {
3024
- headers: {
3025
- [name: string]: unknown;
3026
- };
3027
- content: {
3028
- 'application/json': {
3029
- jsonapi: {
3030
- profile: string[];
3031
- /** @enum {string} */
3032
- version: '1.1';
3033
- };
3034
- errors: {
3035
- title: string;
3036
- status: string;
3037
- detail: string;
3038
- }[];
3039
- };
3040
- };
3041
- };
3042
- /** @description Not Found */
3043
- 404: {
3044
- headers: {
3045
- [name: string]: unknown;
3046
- };
3047
- content: {
3048
- 'application/json': {
3049
- jsonapi: {
3050
- profile: string[];
3051
- /** @enum {string} */
3052
- version: '1.1';
3053
- };
3054
- errors: {
3055
- title: string;
3056
- status: string;
3057
- detail: string;
3058
- }[];
3059
- };
3060
- };
3061
- };
3062
- /** @description Internal Server Error */
3063
- 500: {
3064
- headers: {
3065
- [name: string]: unknown;
3066
- };
3067
- content: {
3068
- 'application/json': {
3069
- jsonapi: {
3070
- profile: string[];
3071
- /** @enum {string} */
3072
- version: '1.1';
3073
- };
3074
- errors: {
3075
- title: string;
3076
- status: string;
3077
- detail: string;
3078
- }[];
3079
- };
3080
- };
3081
- };
3082
- };
3083
- };
3084
- put?: never;
3085
- post: {
3086
- parameters: {
3087
- query?: never;
3088
- header?: never;
3089
- path: {
3090
- workspaceId: string;
3091
- };
3092
- cookie?: never;
3093
- };
3094
- requestBody: {
3095
- content: {
3096
- 'application/json': {
3097
- memberId?: string;
3098
- memberEmail?: string;
3099
- role: 'owner' | 'member' | 'viewer';
3100
- };
3101
- };
3102
- };
3103
- responses: {
3104
- /** @description Default Response */
3105
- 201: {
3106
- headers: {
3107
- [name: string]: unknown;
3108
- };
3109
- content: {
3110
- 'application/json': {
3111
- jsonapi: {
3112
- profile: string[];
3113
- /** @enum {string} */
3114
- version: '1.1';
3115
- };
3116
- data: {
3117
- /** Format: uuid */
3118
- id: string;
3119
- /** @enum {string} */
3120
- type: 'user';
3121
- attributes?: Record<string, never>;
3122
- relationships?: Record<string, never>;
3123
- meta?: Record<string, never>;
3124
- };
3125
- included?: unknown;
3126
- links: {
3127
- /** Format: uri */
3128
- self: string;
3129
- /** Format: uri */
3130
- related?: string;
3131
- };
3132
- meta?: Record<string, never>;
3133
- };
3134
- };
3135
- };
3136
- /** @description Unauthorized */
3137
- 401: {
3138
- headers: {
3139
- [name: string]: unknown;
3140
- };
3141
- content: {
3142
- 'application/json': {
3143
- jsonapi: {
3144
- profile: string[];
3145
- /** @enum {string} */
3146
- version: '1.1';
3147
- };
3148
- errors: {
3149
- title: string;
3150
- status: string;
3151
- detail: string;
3152
- }[];
3153
- };
3154
- };
3155
- };
3156
- /** @description Forbidden */
3157
- 403: {
3158
- headers: {
3159
- [name: string]: unknown;
3160
- };
3161
- content: {
3162
- 'application/json': {
3163
- jsonapi: {
3164
- profile: string[];
3165
- /** @enum {string} */
3166
- version: '1.1';
3167
- };
3168
- errors: {
3169
- title: string;
3170
- status: string;
3171
- detail: string;
3172
- }[];
3173
- };
3174
- };
3175
- };
3176
- /** @description Not Found */
3177
- 404: {
3178
- headers: {
3179
- [name: string]: unknown;
3180
- };
3181
- content: {
3182
- 'application/json': {
3183
- jsonapi: {
3184
- profile: string[];
3185
- /** @enum {string} */
3186
- version: '1.1';
3187
- };
3188
- errors: {
3189
- title: string;
3190
- status: string;
3191
- detail: string;
3192
- }[];
3193
- };
3194
- };
3195
- };
3196
- /** @description Internal Server Error */
3197
- 500: {
3198
- headers: {
3199
- [name: string]: unknown;
3200
- };
3201
- content: {
3202
- 'application/json': {
3203
- jsonapi: {
3204
- profile: string[];
3205
- /** @enum {string} */
3206
- version: '1.1';
3207
- };
3208
- errors: {
3209
- title: string;
3210
- status: string;
3211
- detail: string;
3212
- }[];
3213
- };
3214
- };
3215
- };
3216
- };
3217
- };
3218
- delete?: never;
3219
- options?: never;
3220
- head?: never;
3221
- patch?: never;
3222
- trace?: never;
3223
- };
3224
- '/v1/workspaces/{workspaceId}/members/{userId}': {
3225
- parameters: {
3226
- query?: never;
3227
- header?: never;
3228
- path?: never;
3229
- cookie?: never;
3230
- };
3231
- get?: never;
3232
- put?: never;
3233
- post?: never;
3234
- delete: {
3235
- parameters: {
3236
- query?: never;
3237
- header?: never;
3238
- path: {
3239
- workspaceId: string;
3240
- userId: string;
3241
- };
3242
- cookie?: never;
3243
- };
3244
- requestBody?: never;
3245
- responses: {
3246
- /** @description Default Response */
3247
- 204: {
3248
- headers: {
3249
- [name: string]: unknown;
3250
- };
3251
- content: {
3252
- 'application/json': Record<string, never>;
3253
- };
3254
- };
3255
- /** @description Unauthorized */
3256
- 401: {
3257
- headers: {
3258
- [name: string]: unknown;
3259
- };
3260
- content: {
3261
- 'application/json': {
3262
- jsonapi: {
3263
- profile: string[];
3264
- /** @enum {string} */
3265
- version: '1.1';
3266
- };
3267
- errors: {
3268
- title: string;
3269
- status: string;
3270
- detail: string;
3271
- }[];
3272
- };
3273
- };
3274
- };
3275
- /** @description Forbidden */
3276
- 403: {
3277
- headers: {
3278
- [name: string]: unknown;
3279
- };
3280
- content: {
3281
- 'application/json': {
3282
- jsonapi: {
3283
- profile: string[];
3284
- /** @enum {string} */
3285
- version: '1.1';
3286
- };
3287
- errors: {
3288
- title: string;
3289
- status: string;
3290
- detail: string;
3291
- }[];
3292
- };
3293
- };
3294
- };
3295
- /** @description Not Found */
3296
- 404: {
3297
- headers: {
3298
- [name: string]: unknown;
3299
- };
3300
- content: {
3301
- 'application/json': {
3302
- jsonapi: {
3303
- profile: string[];
3304
- /** @enum {string} */
3305
- version: '1.1';
3306
- };
3307
- errors: {
3308
- title: string;
3309
- status: string;
3310
- detail: string;
3311
- }[];
3312
- };
3313
- };
3314
- };
3315
- /** @description Internal Server Error */
3316
- 500: {
3317
- headers: {
3318
- [name: string]: unknown;
3319
- };
3320
- content: {
3321
- 'application/json': {
3322
- jsonapi: {
3323
- profile: string[];
3324
- /** @enum {string} */
3325
- version: '1.1';
3326
- };
3327
- errors: {
3328
- title: string;
3329
- status: string;
3330
- detail: string;
3331
- }[];
3332
- };
3333
- };
3334
- };
3335
- };
3336
- };
3337
- options?: never;
3338
- head?: never;
3339
- patch?: never;
3340
- trace?: never;
3341
- };
3342
- '/experimental/cli-env': {
3343
- parameters: {
3344
- query?: never;
3345
- header?: never;
3346
- path?: never;
3347
- cookie?: never;
3348
- };
3349
- get: {
3350
- parameters: {
3351
- query?: never;
3352
- header?: never;
3353
- path?: never;
3354
- cookie?: never;
3355
- };
3356
- requestBody?: never;
3357
- responses: {
3358
- /** @description Default Response */
3359
- 200: {
3360
- headers: {
3361
- [name: string]: unknown;
3362
- };
3363
- content: {
3364
- 'application/json': {
3365
- jsonapi: {
3366
- profile: string[];
3367
- /** @enum {string} */
3368
- version: '1.1';
3369
- };
3370
- data: {
3371
- id: string;
3372
- /** @enum {string} */
3373
- type: 'cli-env';
3374
- attributes: {
3375
- envVars: {
3376
- [key: string]: string;
3377
- };
3378
- };
3379
- relationships?: Record<string, never>;
3380
- meta?: Record<string, never>;
3381
- };
3382
- included?: unknown;
3383
- links: {
3384
- /** Format: uri */
3385
- self: string;
3386
- /** Format: uri */
3387
- related?: string;
3388
- };
3389
- meta?: Record<string, never>;
3390
- };
3391
- };
3392
- };
3393
- /** @description Unauthorized */
3394
- 401: {
3395
- headers: {
3396
- [name: string]: unknown;
3397
- };
3398
- content: {
3399
- 'application/json': {
3400
- jsonapi: {
3401
- profile: string[];
3402
- /** @enum {string} */
3403
- version: '1.1';
3404
- };
3405
- errors: {
3406
- title: string;
3407
- status: string;
3408
- detail: string;
3409
- }[];
3410
- };
3411
- };
3412
- };
3413
- /** @description Forbidden */
3414
- 403: {
3415
- headers: {
3416
- [name: string]: unknown;
3417
- };
3418
- content: {
3419
- 'application/json': {
3420
- jsonapi: {
3421
- profile: string[];
3422
- /** @enum {string} */
3423
- version: '1.1';
3424
- };
3425
- errors: {
3426
- title: string;
3427
- status: string;
3428
- detail: string;
3429
- }[];
3430
- };
3431
- };
3432
- };
3433
- /** @description Not Found */
3434
- 404: {
3435
- headers: {
3436
- [name: string]: unknown;
3437
- };
3438
- content: {
3439
- 'application/json': {
3440
- jsonapi: {
3441
- profile: string[];
3442
- /** @enum {string} */
3443
- version: '1.1';
3444
- };
3445
- errors: {
3446
- title: string;
3447
- status: string;
3448
- detail: string;
3449
- }[];
3450
- };
3451
- };
3452
- };
3453
- /** @description Internal Server Error */
3454
- 500: {
3455
- headers: {
3456
- [name: string]: unknown;
3457
- };
3458
- content: {
3459
- 'application/json': {
3460
- jsonapi: {
3461
- profile: string[];
3462
- /** @enum {string} */
3463
- version: '1.1';
3464
- };
3465
- errors: {
3466
- title: string;
3467
- status: string;
3468
- detail: string;
3469
- }[];
3470
- };
3471
- };
3472
- };
3473
- };
3474
- };
3475
- put?: never;
3476
- post?: never;
3477
- delete?: never;
3478
- options?: never;
3479
- head?: never;
3480
- patch?: never;
3481
- trace?: never;
3482
- };
3483
- '/experimental/hosted-exec-logs/{id}': {
3484
- parameters: {
3485
- query?: never;
3486
- header?: never;
3487
- path?: never;
3488
- cookie?: never;
3489
- };
3490
- get: {
3491
- parameters: {
3492
- query?: {
3493
- since?: string;
3494
- limit?: number;
3495
- };
3496
- header?: never;
3497
- path: {
3498
- id: string;
3499
- };
3500
- cookie?: never;
3501
- };
3502
- requestBody?: never;
3503
- responses: {
3504
- /** @description Default Response */
3505
- 200: {
3506
- headers: {
3507
- [name: string]: unknown;
3508
- };
3509
- content?: never;
3510
- };
3511
- };
3512
- };
3513
- put?: never;
3514
- post: {
3515
- parameters: {
3516
- query?: never;
3517
- header?: never;
3518
- path: {
3519
- id: string;
3520
- };
3521
- cookie?: never;
3522
- };
3523
- requestBody?: {
3524
- content: {
3525
- 'application/json': string;
3526
- };
3527
- };
3528
- responses: {
3529
- /** @description Default Response */
3530
- 200: {
3531
- headers: {
3532
- [name: string]: unknown;
3533
- };
3534
- content?: never;
3535
- };
3536
- };
3537
- };
3538
- delete?: never;
3539
- options?: never;
3540
- head?: never;
3541
- patch?: never;
3542
- trace?: never;
3543
- };
3544
- '/openapi': {
3545
- parameters: {
3546
- query?: never;
3547
- header?: never;
3548
- path?: never;
3549
- cookie?: never;
3550
- };
3551
- get: {
3552
- parameters: {
3553
- query?: never;
3554
- header?: never;
3555
- path?: never;
3556
- cookie?: never;
3557
- };
3558
- requestBody?: never;
3559
- responses: {
3560
- /** @description Default Response */
3561
- 200: {
3562
- headers: {
3563
- [name: string]: unknown;
3564
- };
3565
- content?: never;
3566
- };
3567
- };
3568
- };
3569
- put?: never;
3570
- post?: never;
3571
- delete?: never;
3572
- options?: never;
3573
- head?: never;
3574
- patch?: never;
3575
- trace?: never;
3576
- };
3577
- }
3578
-
3579
- type TesslClient = Client<paths> & {
3580
- setAccessToken: (accessToken: string | undefined) => void;
3581
- };
3582
-
3583
- type TaskDetails = {
3584
- task: string;
3585
- context: string;
3586
- tool?: string;
3587
- completed: boolean;
3588
- };
3589
-
3590
- declare const SUCCESS = 0;
3591
- declare const FAILURE = 1;
3592
-
3593
- type MessageType = 'message' | 'list' | 'alert' | 'summary' | 'plan' | 'heading' | 'action' | 'progressBar';
3594
- interface Message {
3595
- id: string;
3596
- toolRunId: string;
3597
- toolName: string;
3598
- timestamp: Date;
3599
- type: MessageType;
3600
- parentToolRunId?: string;
3601
- ctx?: Record<string, unknown>;
3602
- }
3603
- interface DefaultMessage extends Message {
3604
- type: 'message';
3605
- content: string;
3606
- }
3607
- interface ListMessage extends Message {
3608
- type: 'list';
3609
- content: {
3610
- title?: string;
3611
- items: string[];
3612
- bullet?: string;
3613
- };
3614
- }
3615
- interface AlertMessage extends Message {
3616
- type: 'alert';
3617
- content: {
3618
- severity: 'info' | 'warning' | 'error' | 'success';
3619
- message: string;
3620
- };
3621
- }
3622
- interface SummaryMessage extends Message {
3623
- type: 'summary';
3624
- content: string[];
3625
- }
3626
- interface PlanMessage extends Message {
3627
- type: 'plan';
3628
- content: {
3629
- title: string | undefined;
3630
- filePath: string;
3631
- tasks: Array<TaskDetails>;
3632
- };
3633
- }
3634
- interface HeadingMessage extends Message {
3635
- type: 'heading';
3636
- content: string;
3637
- }
3638
- interface ActionMessage extends Message {
3639
- type: 'action';
3640
- content: {
3641
- result: 'success' | 'failure' | 'running';
3642
- message: string;
3643
- };
3644
- }
3645
- interface ProgressBarMessage extends Message {
3646
- type: 'progressBar';
3647
- content: {
3648
- message: string;
3649
- progress?: number;
3650
- total?: number;
3651
- };
3652
- }
3653
- type ReportMessage = DefaultMessage | ListMessage | AlertMessage | SummaryMessage | PlanMessage | HeadingMessage | ActionMessage | ProgressBarMessage;
3654
- interface ReportContext {
3655
- toolRunId: string;
3656
- toolName: string;
3657
- parentToolRunId?: string;
3658
- }
3659
- interface Activity {
3660
- id: string;
3661
- toolRunId: string;
3662
- parentId?: string;
3663
- message: string;
3664
- progress: number;
3665
- total?: number;
3666
- start: Date;
3667
- end?: Date;
3668
- }
3669
- type ReportEventConsumer = (ev: ReportEvent) => Promise<void>;
3670
- interface Reporter {
3671
- addEventConsumer(fn: ReportEventConsumer, toolUuid?: string): void;
3672
- resetEventConsumers(): void;
3673
- message(message: string): void;
3674
- /**
3675
- * Consider using `figures` if overriding the bullet.
3676
- */
3677
- list(title: string | undefined, items: string[], bullet?: string): void;
3678
- plan(title: string | undefined, filePath: string, tasks: PlanMessage['content']['tasks']): void;
3679
- alert(severity: AlertMessage['content']['severity'], message: string): void;
3680
- summary(items: string[]): void;
3681
- heading(task: string): void;
3682
- action(result: 'success' | 'failure' | 'running', message: string): void;
3683
- progressBar(message: string, options?: {
3684
- progress?: number;
3685
- total?: number;
3686
- }): void;
3687
- failure(message: string, context?: Record<string, unknown>): typeof FAILURE;
3688
- success(summaryItems?: string[]): typeof SUCCESS;
3689
- wait<T>(message: string, callbackOrPromise: ((update: (message: string) => void) => Promise<T>) | Promise<T>): Promise<T>;
3690
- cMap<I, O>(items: I[], mapper: (item: I, updateActivity: (message: string) => void) => Promise<O>, options?: Options & {
3691
- message?: string;
3692
- publishResults?: boolean;
3693
- }): Promise<O[]>;
3694
- withContext(context: ReportContext): Reporter;
3695
- withReportHandler(consumer: ReportEventConsumer, newContext?: ReportContext, uuid?: string): Reporter;
3696
- hideOverview(): void;
3697
- }
3698
-
3699
- /**
3700
- * ⚠️ Hand-rolled Tile candidate.
3701
- *
3702
- * Friends don't let friends write their own html-to-markdown converters.
3703
- *
3704
- * Having problems with this? Check out markdownFromSpecDom in spec-dom.ts
3705
- */
3706
- declare function htmlDomToMarkdown(dom: HTMLElement): string;
3707
-
3708
- type SpecDom = HTMLElement;
3709
- interface SpecTestDefinition {
3710
- path: string;
3711
- sourceLines?: string;
3712
- locked: boolean;
3713
- }
3714
- declare function specFromMarkdown(md: string): SpecDom;
3715
- declare function getApi(specDom: SpecDom): string[];
3716
- /**
3717
- * Like getImplementationPaths but does not throw if issues/no links are found.
3718
- */
3719
- declare function findImplementationPaths(specDom: SpecDom): {
3720
- describe: string[];
3721
- generate: string[];
3722
- };
3723
- /**
3724
- * Finds test links within the spec.
3725
- */
3726
- declare function findTests(specDom: SpecDom): SpecTestDefinition[];
3727
- declare function findTest(specDom: SpecDom, testPath: string): SpecTestDefinition;
3728
-
3729
- interface SubmitTilePackageVersionRequest {
3730
- purl: string;
3731
- summaryText: string;
3732
- lookupText: string;
3733
- descriptionMarkdown: string;
3734
- filesJson: string;
3735
- readmeText?: string | undefined;
3736
- publishedAt?: Date | undefined;
3737
- }
3738
- declare const SubmitTilePackageVersionRequest: MessageFns$1<SubmitTilePackageVersionRequest>;
3739
- interface SubmitTilePackageVersionResponse {
3740
- }
3741
- declare const SubmitTilePackageVersionResponse: MessageFns$1<SubmitTilePackageVersionResponse>;
3742
- type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | undefined;
3743
- type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {
3744
- $case: string;
3745
- } ? {
3746
- [K in keyof Omit<T, "$case">]?: DeepPartial$1<T[K]>;
3747
- } & {
3748
- $case: T["$case"];
3749
- } : T extends {} ? {
3750
- [K in keyof T]?: DeepPartial$1<T[K]>;
3751
- } : Partial<T>;
3752
- interface MessageFns$1<T> {
3753
- encode(message: T, writer?: BinaryWriter): BinaryWriter;
3754
- decode(input: BinaryReader | Uint8Array, length?: number): T;
3755
- fromJSON(object: any): T;
3756
- toJSON(message: T): unknown;
3757
- create(base?: DeepPartial$1<T>): T;
3758
- fromPartial(object: DeepPartial$1<T>): T;
3759
- }
3760
-
3761
- type TilePackagesClient = Awaited<ReturnType<typeof createTilePackagesClient>>;
3762
- declare function createTilePackagesClient(logger: Logger, env: Pick<NetEnv, 'TILE_VERSIONS_ADDR'>): nice_grpc.RawClient<nice_grpc_lib_service_definitions_ts_proto_js.FromTsProtoServiceDefinition<{
3763
- readonly name: "TilePackageService";
3764
- readonly fullName: "tessl.tile_packages.v1.TilePackageService";
3765
- readonly methods: {
3766
- readonly submitTilePackageVersion: {
3767
- readonly name: "SubmitTilePackageVersion";
3768
- readonly requestType: MessageFns$1<SubmitTilePackageVersionRequest>;
3769
- readonly requestStream: false;
3770
- readonly responseType: MessageFns$1<SubmitTilePackageVersionResponse>;
3771
- readonly responseStream: false;
3772
- readonly options: {
3773
- readonly idempotencyLevel: "IDEMPOTENT";
3774
- };
3775
- };
3776
- };
3777
- }>, nice_grpc_client_middleware_retry.RetryOptions> & {
3778
- close: () => void;
3779
- };
3780
-
3781
- type LookupToolFn = (name: string) => Promise<ToolDefinition | undefined>;
3782
- declare function makeLookupTool(opts?: {
3783
- customToolDirs?: string[];
3784
- }): Promise<LookupToolFn>;
3785
-
3786
- interface ExecRequest {
3787
- /** Command to execute (shell interpolated) - mutually exclusive with argv */
3788
- cmd?: string;
3789
- /** Arguments to execute (array of args) - mutually exclusive with cmd */
3790
- argv?: string[];
3791
- /** Working directory to execute in */
3792
- cwd: string;
3793
- /** Timeout in seconds (default: 10) */
3794
- timeoutSecs?: number;
3795
- /** Inactivity Timeout in seconds (default: 10) - times out the process if it doesn't output anything for x seconds */
3796
- inactivityTimeoutSecs?: number;
3797
- /** List of files to fetch after execution */
3798
- fetchFiles?: string[];
3799
- /** Whether to merge stdout/stderr (default: false) */
3800
- mergeStdStreams?: boolean;
3801
- /** Environment variables to set (defaults to safe env) */
3802
- env?: Record<string, string>;
3803
- /** AbortSignal to cancel execution */
3804
- signal?: AbortSignal;
3805
- }
3806
- interface ExecResponse {
3807
- /** Exit code */
3808
- code?: number;
3809
- /** Exit signal */
3810
- signal?: string;
3811
- /** Standard output */
3812
- stdout: string;
3813
- /** Standard error */
3814
- stderr: string;
3815
- /** Files fetched after execution */
3816
- fetchedFiles: Record<string, string>;
3817
- /** Error if spawn failed */
3818
- error?: unknown;
3819
- /** Way that the process has timed out, either 'process':overall timeout,
3820
- * or 'inactivity', i.e. the process has not written anything to stdout or stderr in x seconds
3821
- * */
3822
- timeoutType?: 'process' | 'inactivity';
3823
- }
3824
-
3825
- interface CreateCommitRequest {
3826
- repoId: string;
3827
- id: string;
3828
- parentIds: string[];
3829
- message: string;
3830
- bodyJson: string;
3831
- updateBranch?: string | undefined;
3832
- withLeasedId?: string | undefined;
3833
- }
3834
- declare const CreateCommitRequest: MessageFns<CreateCommitRequest>;
3835
- interface CreateCommitResponse {
3836
- }
3837
- declare const CreateCommitResponse: MessageFns<CreateCommitResponse>;
3838
- interface GetCommitRequest {
3839
- repoId: string;
3840
- id: string;
3841
- }
3842
- declare const GetCommitRequest: MessageFns<GetCommitRequest>;
3843
- interface GetCommitResponse {
3844
- parentIds: string[];
3845
- message: string;
3846
- bodyJson: string;
3847
- submittedAt: Date | undefined;
3848
- }
3849
- declare const GetCommitResponse: MessageFns<GetCommitResponse>;
3850
- interface GetCommitHistoryRequest {
3851
- repoId: string;
3852
- id: string;
3853
- limit: number;
3854
- }
3855
- declare const GetCommitHistoryRequest: MessageFns<GetCommitHistoryRequest>;
3856
- interface CommitHistoryEntry {
3857
- id: string;
3858
- parentIds: string[];
3859
- message: string;
3860
- createdAt: Date | undefined;
3861
- author: string;
3862
- committer: string;
3863
- }
3864
- declare const CommitHistoryEntry: MessageFns<CommitHistoryEntry>;
3865
- interface GetCommitHistoryResponse {
3866
- commits: CommitHistoryEntry[];
3867
- hasMore: boolean;
3868
- }
3869
- declare const GetCommitHistoryResponse: MessageFns<GetCommitHistoryResponse>;
3870
- interface GetChildrenRequest {
3871
- repoId: string;
3872
- id: string;
3873
- }
3874
- declare const GetChildrenRequest: MessageFns<GetChildrenRequest>;
3875
- interface GetChildrenResponse {
3876
- childIds: string[];
3877
- }
3878
- declare const GetChildrenResponse: MessageFns<GetChildrenResponse>;
3879
- interface GetBranchRequest {
3880
- repoId: string;
3881
- name: string;
3882
- }
3883
- declare const GetBranchRequest: MessageFns<GetBranchRequest>;
3884
- interface GetBranchResponse {
3885
- id: string;
3886
- }
3887
- declare const GetBranchResponse: MessageFns<GetBranchResponse>;
3888
- interface UpdateBranchRequest {
3889
- repoId: string;
3890
- name: string;
3891
- commitId: string;
3892
- }
3893
- declare const UpdateBranchRequest: MessageFns<UpdateBranchRequest>;
3894
- interface UpdateBranchResponse {
3895
- }
3896
- declare const UpdateBranchResponse: MessageFns<UpdateBranchResponse>;
3897
- /** I'm going to regret not making this paged / filtered. */
3898
- interface GetBranchesRequest {
3899
- repoId: string;
3900
- }
3901
- declare const GetBranchesRequest: MessageFns<GetBranchesRequest>;
3902
- interface GetBranchesResponse {
3903
- name: string[];
3904
- }
3905
- declare const GetBranchesResponse: MessageFns<GetBranchesResponse>;
3906
- interface CreateBranchRequest {
3907
- repoId: string;
3908
- name: string;
3909
- commitId: string;
3910
- }
3911
- declare const CreateBranchRequest: MessageFns<CreateBranchRequest>;
3912
- interface CreateBranchResponse {
3913
- }
3914
- declare const CreateBranchResponse: MessageFns<CreateBranchResponse>;
3915
- interface DeleteBranchRequest {
3916
- repoId: string;
3917
- name: string;
3918
- }
3919
- declare const DeleteBranchRequest: MessageFns<DeleteBranchRequest>;
3920
- interface DeleteBranchResponse {
3921
- }
3922
- declare const DeleteBranchResponse: MessageFns<DeleteBranchResponse>;
3923
- type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
3924
- type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
3925
- $case: string;
3926
- } ? {
3927
- [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
3928
- } & {
3929
- $case: T["$case"];
3930
- } : T extends {} ? {
3931
- [K in keyof T]?: DeepPartial<T[K]>;
3932
- } : Partial<T>;
3933
- interface MessageFns<T> {
3934
- encode(message: T, writer?: BinaryWriter): BinaryWriter;
3935
- decode(input: BinaryReader | Uint8Array, length?: number): T;
3936
- fromJSON(object: any): T;
3937
- toJSON(message: T): unknown;
3938
- create(base?: DeepPartial<T>): T;
3939
- fromPartial(object: DeepPartial<T>): T;
3940
- }
3941
-
3942
- type NgClient = Awaited<ReturnType<typeof createNgClient>>;
3943
- declare function createNgClient(logger: Logger, env: Pick<NetEnv, 'NOT_GIT_ADDR'>): nice_grpc.RawClient<nice_grpc_lib_service_definitions_ts_proto_js.FromTsProtoServiceDefinition<{
3944
- readonly name: "VcsService";
3945
- readonly fullName: "tessl.notgit.v1.VcsService";
3946
- readonly methods: {
3947
- readonly createCommit: {
3948
- readonly name: "CreateCommit";
3949
- readonly requestType: MessageFns<CreateCommitRequest>;
3950
- readonly requestStream: false;
3951
- readonly responseType: MessageFns<CreateCommitResponse>;
3952
- readonly responseStream: false;
3953
- readonly options: {
3954
- readonly idempotencyLevel: "IDEMPOTENT";
3955
- };
3956
- };
3957
- readonly createBranch: {
3958
- readonly name: "CreateBranch";
3959
- readonly requestType: MessageFns<CreateBranchRequest>;
3960
- readonly requestStream: false;
3961
- readonly responseType: MessageFns<CreateBranchResponse>;
3962
- readonly responseStream: false;
3963
- readonly options: {
3964
- readonly idempotencyLevel: "IDEMPOTENT";
3965
- };
3966
- };
3967
- readonly updateBranch: {
3968
- readonly name: "UpdateBranch";
3969
- readonly requestType: MessageFns<UpdateBranchRequest>;
3970
- readonly requestStream: false;
3971
- readonly responseType: MessageFns<UpdateBranchResponse>;
3972
- readonly responseStream: false;
3973
- readonly options: {
3974
- readonly idempotencyLevel: "IDEMPOTENT";
3975
- };
3976
- };
3977
- readonly deleteBranch: {
3978
- readonly name: "DeleteBranch";
3979
- readonly requestType: MessageFns<DeleteBranchRequest>;
3980
- readonly requestStream: false;
3981
- readonly responseType: MessageFns<DeleteBranchResponse>;
3982
- readonly responseStream: false;
3983
- readonly options: {
3984
- readonly idempotencyLevel: "IDEMPOTENT";
3985
- };
3986
- };
3987
- readonly getCommit: {
3988
- readonly name: "GetCommit";
3989
- readonly requestType: MessageFns<GetCommitRequest>;
3990
- readonly requestStream: false;
3991
- readonly responseType: MessageFns<GetCommitResponse>;
3992
- readonly responseStream: false;
3993
- readonly options: {
3994
- readonly idempotencyLevel: "NO_SIDE_EFFECTS";
3995
- };
3996
- };
3997
- readonly getChildren: {
3998
- readonly name: "GetChildren";
3999
- readonly requestType: MessageFns<GetChildrenRequest>;
4000
- readonly requestStream: false;
4001
- readonly responseType: MessageFns<GetChildrenResponse>;
4002
- readonly responseStream: false;
4003
- readonly options: {
4004
- readonly idempotencyLevel: "NO_SIDE_EFFECTS";
4005
- };
4006
- };
4007
- readonly getBranch: {
4008
- readonly name: "GetBranch";
4009
- readonly requestType: MessageFns<GetBranchRequest>;
4010
- readonly requestStream: false;
4011
- readonly responseType: MessageFns<GetBranchResponse>;
4012
- readonly responseStream: false;
4013
- readonly options: {
4014
- readonly idempotencyLevel: "NO_SIDE_EFFECTS";
4015
- };
4016
- };
4017
- readonly getBranches: {
4018
- readonly name: "GetBranches";
4019
- readonly requestType: MessageFns<GetBranchesRequest>;
4020
- readonly requestStream: false;
4021
- readonly responseType: MessageFns<GetBranchesResponse>;
4022
- readonly responseStream: false;
4023
- readonly options: {
4024
- readonly idempotencyLevel: "NO_SIDE_EFFECTS";
4025
- };
4026
- };
4027
- readonly getCommitHistory: {
4028
- readonly name: "GetCommitHistory";
4029
- readonly requestType: MessageFns<GetCommitHistoryRequest>;
4030
- readonly requestStream: false;
4031
- readonly responseType: MessageFns<GetCommitHistoryResponse>;
4032
- readonly responseStream: false;
4033
- readonly options: {
4034
- readonly idempotencyLevel: "NO_SIDE_EFFECTS";
4035
- };
4036
- };
4037
- };
4038
- }>, nice_grpc_client_middleware_retry.RetryOptions> & {
4039
- close: () => void;
4040
- };
4041
-
4042
- type Awaitable<T> = T | PromiseLike<T>;
4043
-
4044
- declare const FeatureFlagsAlwaysReturnTrue: unique symbol;
4045
- type FeatureFlagValue = string | boolean;
4046
- type FeatureFlagStore = Record<string, FeatureFlagValue> | typeof FeatureFlagsAlwaysReturnTrue;
4047
-
4048
- type RelativePath$1 = string;
4049
- type Fsd = EnhancedFileApi;
4050
- interface PrimitiveFileApi {
4051
- exists: (path: RelativePath$1) => Promise<boolean>;
4052
- isDir: (path: RelativePath$1) => Promise<boolean>;
4053
- readText: (path: RelativePath$1) => Promise<string | undefined>;
4054
- writeText: (path: RelativePath$1, content: string) => Promise<void>;
4055
- glob: (pattern: string, options?: Record<string, unknown>) => Promise<string[]>;
4056
- destroy: (path: RelativePath$1) => Promise<void>;
4057
- }
4058
- interface EnhancedFileApi extends PrimitiveFileApi {
4059
- listFiles: (opts?: {
4060
- enableGitignoreFilter?: boolean;
4061
- }) => Promise<string[]>;
4062
- }
4063
-
4064
- type RelativePath = string;
4065
- type PackageAlias = string;
4066
- type RelativePathOrPackageAlias = RelativePath | PackageAlias;
4067
- interface ImportResolver {
4068
- resolve(name: RelativePathOrPackageAlias): Promise<ResolvedImport | undefined>;
4069
- }
4070
- interface ResolvedImport {
4071
- /** something that might be useful to humans; not necessarily machine-readable */
4072
- displayName: string;
4073
- /** check if we think the package is in a good state on this computer right now */
4074
- isInstalled(): Promise<boolean>;
4075
- /** low-level access to the package's data */
4076
- openFsd(): Promise<Fsd>;
4077
- }
4078
-
4079
- declare const ModelParamSchema: _sinclair_typebox.TObject<{
4080
- modelName: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
4081
- modelClient: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"anthropic">, _sinclair_typebox.TLiteral<"bedrock">, _sinclair_typebox.TLiteral<"cerebras">, _sinclair_typebox.TLiteral<"deepseek">, _sinclair_typebox.TLiteral<"google-no-stream">, _sinclair_typebox.TLiteral<"llama">, _sinclair_typebox.TLiteral<"openai">, _sinclair_typebox.TLiteral<"openai-no-stream">]>>;
4082
- modelParams: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TUnknown>>;
4083
- modelTemperature: _sinclair_typebox.TOptional<_sinclair_typebox.TNumber>;
4084
- modelReasoningEffort: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
4085
- skipStreaming: _sinclair_typebox.TOptional<_sinclair_typebox.TBoolean>;
4086
- }>;
4087
- type ModelParams = Static<typeof ModelParamSchema>;
4088
- declare const Defaults: _sinclair_typebox.TObject<{
4089
- modelName: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
4090
- modelClient: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TLiteral<"anthropic">, _sinclair_typebox.TLiteral<"bedrock">, _sinclair_typebox.TLiteral<"cerebras">, _sinclair_typebox.TLiteral<"deepseek">, _sinclair_typebox.TLiteral<"google-no-stream">, _sinclair_typebox.TLiteral<"llama">, _sinclair_typebox.TLiteral<"openai">, _sinclair_typebox.TLiteral<"openai-no-stream">]>>;
4091
- modelParams: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TUnknown>>;
4092
- modelTemperature: _sinclair_typebox.TOptional<_sinclair_typebox.TNumber>;
4093
- modelReasoningEffort: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
4094
- skipStreaming: _sinclair_typebox.TOptional<_sinclair_typebox.TBoolean>;
4095
- }>;
4096
- type ReqDefaults = Static<typeof Defaults>;
4097
-
4098
- /** an abstraction over streaming, that doesn't know anything about specific client libraries */
4099
-
4100
- interface RespondObject<T> {
4101
- name: string;
4102
- schema: ZodSchema<T>;
4103
- }
4104
-
4105
- declare class ResponseValidationError extends Error {
4106
- attempts: number;
4107
- constructor(message: string, attempts: number);
4108
- }
4109
-
4110
- interface TokenCounter {
4111
- start(): Promise<void>;
4112
- countTokens(total: number): Promise<void>;
4113
- done(): Promise<void>;
4114
- generationName?: string;
4115
- }
4116
- interface Typer extends TokenCounter {
4117
- chunk(chunk: string, totalTokens?: number): Promise<void>;
4118
- }
4119
- interface ExpectationParams {
4120
- validator: (content: string) => boolean;
4121
- promptOnFailure: string;
4122
- attempts: number;
4123
- strategy: 'retry' | 'feedback';
4124
- validationErrorBuilder: (message: string, attempts: number) => ResponseValidationError | Error;
4125
- }
4126
- interface Script {
4127
- text: (tryStripMarkdown?: boolean, typer?: Typer) => Promise<string>;
4128
- object: <T>(format: RespondObject<T>, typer?: Typer) => Promise<T>;
4129
- multiGen: <K extends string>(keys: K[]) => Promise<Record<K, string | null | undefined>>;
4130
- multiGenTyper: <K extends string>(docs: Record<K, Typer | 'not-streamed'>) => Promise<Record<K, string | null | undefined>>;
4131
- user(content: string): this;
4132
- assistant(content: string): this;
4133
- prediction(content: string): this;
4134
- expect(params?: ExpectationParams): this;
4135
- overwriteLastReplyTo(content: string): this;
4136
- }
4137
-
4138
- interface RunToolArgs {
4139
- rc: RequestContext;
4140
- fsd?: Fsd;
4141
- }
4142
- declare const runToolOrCrash: (...args: Parameters<typeof runTool>) => Promise<void>;
4143
- declare function runTool<T extends AnyZodObject>(toolToRun: ToolToRun<T>, args: RunToolArgs): Promise<ExitCode>;
4144
-
4145
- interface RequestContext {
4146
- uuid: string;
4147
- parent?: string;
4148
- emitMgmt: (ev: ManagementEvent) => Promise<void>;
4149
- exec: (request: ExecRequest) => Promise<ExecResponse>;
4150
- abortSignal: AbortSignal;
4151
- llmFactory: RequestLlmContext;
4152
- lfTrace: LangfuseParent;
4153
- ngClient?: NgClient;
4154
- tilePackagesClient?: TilePackagesClient;
4155
- lookupTool: (name: string) => Awaitable<ToolDefinition | undefined>;
4156
- resolveImport: ImportResolver;
4157
- tesslClient: TesslClient;
4158
- userFeatureFlags: FeatureFlagStore;
4159
- logger: Logger;
4160
- projectConfig: Readonly<ProjectConfig>;
4161
- projectDir: string;
4162
- reporter: Reporter;
4163
- reqLevelParams: ReqDefaults;
4164
- shutdown: () => Promise<void>;
4165
- }
4166
- interface HiEvent {
4167
- id: 'hi';
4168
- traceUrl: string;
4169
- }
4170
- interface StartToolEvent {
4171
- id: 'startTool';
4172
- name: string;
4173
- stepType: ToolDefinition['type'];
4174
- uuid: string;
4175
- parent?: string;
4176
- params?: Record<string, unknown>;
4177
- }
4178
- interface EndToolEvent {
4179
- id: 'endTool';
4180
- name: string;
4181
- exitCode: ExitCode;
4182
- stepType: ToolDefinition['type'];
4183
- uuid: string;
4184
- parent?: string;
4185
- }
4186
- interface TypingStartEvent {
4187
- id: 'typingStart';
4188
- uuid: string;
4189
- }
4190
- interface TypingChunkEvent {
4191
- id: 'typingChunk';
4192
- uuid: string;
4193
- chunk: string;
4194
- totalTokens?: number;
4195
- }
4196
- interface TypingCountTokensEvent {
4197
- id: 'typingCountTokens';
4198
- uuid: string;
4199
- totalTokens: number;
4200
- }
4201
- interface TypingDoneEvent {
4202
- id: 'typingDone';
4203
- uuid: string;
4204
- }
4205
- interface HeartbeatEvent {
4206
- id: 'heartbeat';
4207
- }
4208
- interface CrashEvent {
4209
- id: 'crash';
4210
- err: unknown;
4211
- uuid: string;
4212
- parent?: string;
4213
- }
4214
- interface SetOutputEvent {
4215
- id: 'setOutput';
4216
- value: Record<string, unknown>;
4217
- }
4218
- interface ByeEvent {
4219
- id: 'bye';
4220
- traceUrl: string;
4221
- }
4222
- interface ReportEvent {
4223
- id: 'report';
4224
- uuid: string;
4225
- data: {
4226
- type: 'message';
4227
- message: ReportMessage;
4228
- } | {
4229
- type: 'activityStarted' | 'activityUpdated';
4230
- activity: Activity;
4231
- } | {
4232
- type: 'hideOverview';
4233
- };
4234
- }
4235
- type ManagementEvent = HiEvent | StartToolEvent | EndToolEvent | HeartbeatEvent | CrashEvent | SetOutputEvent | ByeEvent | TypingStartEvent | TypingChunkEvent | TypingCountTokensEvent | TypingDoneEvent | ReportEvent;
4236
- interface RequestLlmContext {
4237
- keys?: {
4238
- openAi?: string;
4239
- fireworks?: string;
4240
- cerebras?: string;
4241
- };
4242
- forTesting?: {
4243
- openAiFetch?: ClientOptions['fetch'];
4244
- };
4245
- cacheWith?: {
4246
- redis?: Redis;
4247
- fs?: string;
4248
- };
4249
- apiEndpoint?: {
4250
- fireworks?: string;
4251
- openAi?: string;
4252
- cerebras?: string;
4253
- };
4254
- userHash?: string;
4255
- shareUsageData: boolean;
4256
- }
4257
- interface ToolToRun<T extends AnyZodObject = AnyZodObject> {
4258
- tool: ToolDefinition<T>;
4259
- params: ReqDefaults & z.input<T>;
4260
- }
4261
- type Params<T extends ZodType | TSchema> = (T extends TSchema ? Static<T> : T extends ZodType ? z.infer<T> : never) & ReqDefaults;
4262
- type ExitCode = 0 | 1;
4263
- interface AllToolArgs<T extends ZodType | TSchema> {
4264
- rc: RequestContext;
4265
- utils: ToolUtils;
4266
- params: Params<T>;
4267
- }
4268
- interface FsdToolArgs<T extends Schema> extends AllToolArgs<T> {
4269
- utils: FsdToolUtils;
4270
- fsd: Fsd;
4271
- }
4272
- type CustomToolArgs<T extends Schema> = FsdToolArgs<T>;
4273
- type FsdToolUtils = ToolUtils;
4274
- interface ToolUtils {
4275
- abortSignal: AbortSignal;
4276
- script: (systemPrompt: string, opts?: ModelParams) => Script;
4277
- exec: (request: ExecRequest) => Promise<ExecResponse>;
4278
- langfuseEvent: (obj: Parameters<LangfuseParent['event']>[0]) => void;
4279
- userHasFlag: (flag: string) => FeatureFlagValue | undefined;
4280
- ngClient?: NgClient;
4281
- /**
4282
- * @experimental
4283
- * Experimental tools may be removed or changed at any time; use with
4284
- * caution
4285
- */
4286
- experimental: {
4287
- lookupTool: Awaited<ReturnType<typeof makeLookupTool>>;
4288
- runTool: typeof runTool;
4289
- runToolOrCrash: typeof runToolOrCrash;
4290
- specDom: {
4291
- fromMarkdown: typeof specFromMarkdown;
4292
- getApi: typeof getApi;
4293
- findTests: typeof findTests;
4294
- findTest: typeof findTest;
4295
- toMarkdown: typeof htmlDomToMarkdown;
4296
- findImplementations: typeof findImplementationPaths;
4297
- };
4298
- };
4299
- }
4300
- interface BaseToolDefinition {
4301
- name: string;
4302
- /** Description of what the tool does, shown at the start of invocation */
4303
- description: string;
4304
- /** Optional help text shown in the help UI */
4305
- help?: string;
4306
- /** Whether this shows in docs, help, etc */
4307
- visibility: 'public' | 'private';
4308
- denyRunIn?: ('cli' | 'cloud')[];
4309
- /** Which param key maps to a positional in CLI commands */
4310
- positionalParam?: string;
4311
- }
4312
- type FsdTool<T extends Schema> = (args: FsdToolArgs<T>) => Promise<ExitCode>;
4313
- /**
4314
- * A CustomTool can be defined in a .workflow.ts file in the designated directory
4315
- * (/workflows by default).
4316
- *
4317
- * The workflow function should be the default export of the module.
4318
- */
4319
- type CustomTool<WorkflowParams extends ZodObject<z.ZodRawShape>> = Partial<{
4320
- description: string;
4321
- }> & ((args: CustomToolArgs<WorkflowParams>) => Promise<ExitCode>);
4322
- interface FsdToolDefinition<T extends AnyZodObject> extends BaseToolDefinition {
4323
- type: 'fsd';
4324
- impl: FsdTool<T>;
4325
- paramsSchema: T;
4326
- isCustom?: boolean;
4327
- }
4328
- type ToolDefinition<T extends AnyZodObject = AnyZodObject> = FsdToolDefinition<T>;
4329
-
4330
- export type { CustomTool, CustomToolArgs, Fsd, RequestContext, ToolUtils };