@tailorkit/client-platform 0.1.0-beta.13 → 0.1.0-beta.16

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.
@@ -1,15 +1,50 @@
1
1
  export type ClientOptions = {
2
2
  baseUrl: "https://tailorkit.dev/api/platform" | (string & {});
3
3
  };
4
+ export type Schema0 = string | number | boolean | null | Array<Schema0> | {
5
+ [key: string]: Schema0;
6
+ };
7
+ export type AppsRuntimeSessionData = {
8
+ body: {
9
+ scopes: Array<{
10
+ name: string;
11
+ value: {
12
+ [key: string]: Schema0;
13
+ };
14
+ }>;
15
+ userId: string;
16
+ installationId: string;
17
+ };
18
+ path: {
19
+ appId: string;
20
+ };
21
+ query?: never;
22
+ url: "/apps/{appId}/runtime/session";
23
+ };
24
+ export type AppsRuntimeSessionResponses = {
25
+ /**
26
+ * OK
27
+ */
28
+ 200: {
29
+ token: string;
30
+ expiresAt: number;
31
+ };
32
+ };
33
+ export type AppsRuntimeSessionResponse = AppsRuntimeSessionResponses[keyof AppsRuntimeSessionResponses];
4
34
  export type AppsListData = {
5
- body?: never;
6
- path?: never;
7
- query: {
35
+ body: {
8
36
  page?: number;
9
37
  pageSize?: number;
10
- scopeId: string;
38
+ scopes: Array<{
39
+ name: string;
40
+ value: {
41
+ [key: string]: Schema0;
42
+ };
43
+ }>;
11
44
  };
12
- url: "/apps";
45
+ path?: never;
46
+ query?: never;
47
+ url: "/apps/list";
13
48
  };
14
49
  export type AppsListResponses = {
15
50
  /**
@@ -20,7 +55,12 @@ export type AppsListResponses = {
20
55
  id: string;
21
56
  publicId: string;
22
57
  projectId: string;
23
- scopeId: string;
58
+ scope: {
59
+ name: string;
60
+ value: {
61
+ [key: string]: Schema0;
62
+ };
63
+ };
24
64
  name: string;
25
65
  description: string | null;
26
66
  currentDeploymentId: string | null;
@@ -53,17 +93,22 @@ export type AppsListResponses = {
53
93
  };
54
94
  };
55
95
  export type AppsListResponse = AppsListResponses[keyof AppsListResponses];
56
- export type AppsCreateData = {
96
+ export type AppsGetData = {
57
97
  body: {
58
- name: string;
59
- description: string | null;
60
- scopeId: string;
98
+ scopes: Array<{
99
+ name: string;
100
+ value: {
101
+ [key: string]: Schema0;
102
+ };
103
+ }>;
104
+ };
105
+ path: {
106
+ appId: string;
61
107
  };
62
- path?: never;
63
108
  query?: never;
64
- url: "/apps";
109
+ url: "/apps/{appId}/lookup";
65
110
  };
66
- export type AppsCreateResponses = {
111
+ export type AppsGetResponses = {
67
112
  /**
68
113
  * OK
69
114
  */
@@ -71,7 +116,12 @@ export type AppsCreateResponses = {
71
116
  id: string;
72
117
  publicId: string;
73
118
  projectId: string;
74
- scopeId: string;
119
+ scope: {
120
+ name: string;
121
+ value: {
122
+ [key: string]: Schema0;
123
+ };
124
+ };
75
125
  name: string;
76
126
  description: string | null;
77
127
  currentDeploymentId: string | null;
@@ -97,37 +147,23 @@ export type AppsCreateResponses = {
97
147
  };
98
148
  };
99
149
  };
100
- export type AppsCreateResponse = AppsCreateResponses[keyof AppsCreateResponses];
101
- export type AppsDeleteData = {
102
- body?: never;
103
- path: {
104
- appId: string;
105
- };
106
- query: {
107
- scopeId: string;
108
- };
109
- url: "/apps/{appId}";
110
- };
111
- export type AppsDeleteResponses = {
112
- /**
113
- * OK
114
- */
115
- 200: {
116
- id: string;
117
- };
118
- };
119
- export type AppsDeleteResponse = AppsDeleteResponses[keyof AppsDeleteResponses];
120
- export type AppsGetData = {
121
- body?: never;
122
- path: {
123
- appId: string;
124
- };
125
- query: {
126
- scopeId: string;
150
+ export type AppsGetResponse = AppsGetResponses[keyof AppsGetResponses];
151
+ export type AppsCreateData = {
152
+ body: {
153
+ name: string;
154
+ description: string | null;
155
+ scope: {
156
+ name: string;
157
+ value: {
158
+ [key: string]: Schema0;
159
+ };
160
+ };
127
161
  };
128
- url: "/apps/{appId}";
162
+ path?: never;
163
+ query?: never;
164
+ url: "/apps";
129
165
  };
130
- export type AppsGetResponses = {
166
+ export type AppsCreateResponses = {
131
167
  /**
132
168
  * OK
133
169
  */
@@ -135,7 +171,12 @@ export type AppsGetResponses = {
135
171
  id: string;
136
172
  publicId: string;
137
173
  projectId: string;
138
- scopeId: string;
174
+ scope: {
175
+ name: string;
176
+ value: {
177
+ [key: string]: Schema0;
178
+ };
179
+ };
139
180
  name: string;
140
181
  description: string | null;
141
182
  currentDeploymentId: string | null;
@@ -161,18 +202,46 @@ export type AppsGetResponses = {
161
202
  };
162
203
  };
163
204
  };
164
- export type AppsGetResponse = AppsGetResponses[keyof AppsGetResponses];
205
+ export type AppsCreateResponse = AppsCreateResponses[keyof AppsCreateResponses];
206
+ export type AppsDeleteData = {
207
+ body: {
208
+ scope: {
209
+ name: string;
210
+ value: {
211
+ [key: string]: Schema0;
212
+ };
213
+ };
214
+ };
215
+ path: {
216
+ appId: string;
217
+ };
218
+ query?: never;
219
+ url: "/apps/{appId}";
220
+ };
221
+ export type AppsDeleteResponses = {
222
+ /**
223
+ * OK
224
+ */
225
+ 200: {
226
+ id: string;
227
+ };
228
+ };
229
+ export type AppsDeleteResponse = AppsDeleteResponses[keyof AppsDeleteResponses];
165
230
  export type AppsUpdateData = {
166
231
  body: {
167
232
  name: string;
168
233
  description: string | null;
234
+ scope: {
235
+ name: string;
236
+ value: {
237
+ [key: string]: Schema0;
238
+ };
239
+ };
169
240
  };
170
241
  path: {
171
242
  appId: string;
172
243
  };
173
- query: {
174
- scopeId: string;
175
- };
244
+ query?: never;
176
245
  url: "/apps/{appId}";
177
246
  };
178
247
  export type AppsUpdateResponses = {
@@ -183,7 +252,12 @@ export type AppsUpdateResponses = {
183
252
  id: string;
184
253
  publicId: string;
185
254
  projectId: string;
186
- scopeId: string;
255
+ scope: {
256
+ name: string;
257
+ value: {
258
+ [key: string]: Schema0;
259
+ };
260
+ };
187
261
  name: string;
188
262
  description: string | null;
189
263
  currentDeploymentId: string | null;
@@ -213,13 +287,17 @@ export type AppsUpdateResponse = AppsUpdateResponses[keyof AppsUpdateResponses];
213
287
  export type AppsDeployData = {
214
288
  body: {
215
289
  deploymentId: string;
290
+ scope: {
291
+ name: string;
292
+ value: {
293
+ [key: string]: Schema0;
294
+ };
295
+ };
216
296
  };
217
297
  path: {
218
298
  appId: string;
219
299
  };
220
- query: {
221
- scopeId: string;
222
- };
300
+ query?: never;
223
301
  url: "/apps/{appId}/deploy";
224
302
  };
225
303
  export type AppsDeployResponses = {
@@ -230,7 +308,12 @@ export type AppsDeployResponses = {
230
308
  id: string;
231
309
  publicId: string;
232
310
  projectId: string;
233
- scopeId: string;
311
+ scope: {
312
+ name: string;
313
+ value: {
314
+ [key: string]: Schema0;
315
+ };
316
+ };
234
317
  name: string;
235
318
  description: string | null;
236
319
  currentDeploymentId: string | null;
@@ -259,7 +342,12 @@ export type AppsDeployResponses = {
259
342
  export type AppsDeployResponse = AppsDeployResponses[keyof AppsDeployResponses];
260
343
  export type CliAuthApproveData = {
261
344
  body: {
262
- scopeId: string;
345
+ scope: {
346
+ name: string;
347
+ value: {
348
+ [key: string]: Schema0;
349
+ };
350
+ };
263
351
  userCode: string;
264
352
  };
265
353
  path?: never;
@@ -310,7 +398,12 @@ export type CliAuthPollResponses = {
310
398
  status: "denied";
311
399
  } | {
312
400
  deployToken: string;
313
- scopeId: string;
401
+ scope: {
402
+ name: string;
403
+ value: {
404
+ [key: string]: Schema0;
405
+ };
406
+ };
314
407
  status: "approved";
315
408
  } | {
316
409
  status: "expired";
@@ -349,20 +442,30 @@ export type CliAuthVerifyTokenResponses = {
349
442
  * OK
350
443
  */
351
444
  200: {
352
- scopeId: string;
445
+ scope: {
446
+ name: string;
447
+ value: {
448
+ [key: string]: Schema0;
449
+ };
450
+ };
353
451
  };
354
452
  };
355
453
  export type CliAuthVerifyTokenResponse = CliAuthVerifyTokenResponses[keyof CliAuthVerifyTokenResponses];
356
454
  export type DeploymentsListData = {
357
- body?: never;
358
- path?: never;
359
- query: {
455
+ body: {
360
456
  page?: number;
361
457
  pageSize?: number;
362
458
  appId: string;
363
- scopeId: string;
459
+ scopes: Array<{
460
+ name: string;
461
+ value: {
462
+ [key: string]: Schema0;
463
+ };
464
+ }>;
364
465
  };
365
- url: "/deployments";
466
+ path?: never;
467
+ query?: never;
468
+ url: "/deployments/list";
366
469
  };
367
470
  export type DeploymentsListResponses = {
368
471
  /**
@@ -390,6 +493,40 @@ export type DeploymentsListResponses = {
390
493
  };
391
494
  };
392
495
  export type DeploymentsListResponse = DeploymentsListResponses[keyof DeploymentsListResponses];
496
+ export type DeploymentsGetData = {
497
+ body: {
498
+ scopes: Array<{
499
+ name: string;
500
+ value: {
501
+ [key: string]: Schema0;
502
+ };
503
+ }>;
504
+ };
505
+ path: {
506
+ deploymentId: string;
507
+ };
508
+ query?: never;
509
+ url: "/deployments/{deploymentId}/lookup";
510
+ };
511
+ export type DeploymentsGetResponses = {
512
+ /**
513
+ * OK
514
+ */
515
+ 200: {
516
+ id: string;
517
+ publicId: string;
518
+ appId: string;
519
+ status: "uploading" | "deploying" | "verifying" | "published";
520
+ clientEntryFileId: string | null;
521
+ logoLightFileId: string | null;
522
+ logoDarkFileId: string | null;
523
+ logoLightPath: string | null;
524
+ logoDarkPath: string | null;
525
+ createdAt: string;
526
+ updatedAt: string;
527
+ };
528
+ };
529
+ export type DeploymentsGetResponse = DeploymentsGetResponses[keyof DeploymentsGetResponses];
393
530
  export type DeploymentsCreateData = {
394
531
  body: {
395
532
  appId: string;
@@ -402,6 +539,13 @@ export type DeploymentsCreateData = {
402
539
  objectKey: "client.js";
403
540
  }
404
541
  ];
542
+ server?: {
543
+ checksum: string;
544
+ contentLength: number;
545
+ contentType: "application/javascript";
546
+ encoding: "utf-8";
547
+ objectKey: "server.js";
548
+ };
405
549
  logos?: {
406
550
  dark?: {
407
551
  checksum: string;
@@ -414,7 +558,12 @@ export type DeploymentsCreateData = {
414
558
  contentType: "image/svg+xml" | "image/png" | "image/webp";
415
559
  };
416
560
  };
417
- scopeId: string;
561
+ scope: {
562
+ name: string;
563
+ value: {
564
+ [key: string]: Schema0;
565
+ };
566
+ };
418
567
  };
419
568
  path?: never;
420
569
  query?: never;
@@ -443,6 +592,24 @@ export type DeploymentsCreateResponses = {
443
592
  };
444
593
  uploadUrl: string;
445
594
  }>;
595
+ server?: {
596
+ file: {
597
+ id: string;
598
+ appDeploymentId: string;
599
+ objectKey: string;
600
+ contentType: "application/javascript" | "image/svg+xml" | "image/png" | "image/webp";
601
+ encoding: "utf-8" | null;
602
+ contentLength: number;
603
+ checksum: string | null;
604
+ status: "uploading" | "verifying" | "verified" | "failed";
605
+ createdAt: string;
606
+ updatedAt: string;
607
+ };
608
+ headers?: {
609
+ [key: string]: string;
610
+ };
611
+ uploadUrl: string;
612
+ };
446
613
  deployment: {
447
614
  id: string;
448
615
  publicId: string;
@@ -497,17 +664,23 @@ export type DeploymentsCreateResponses = {
497
664
  };
498
665
  };
499
666
  export type DeploymentsCreateResponse = DeploymentsCreateResponses[keyof DeploymentsCreateResponses];
500
- export type DeploymentsGetData = {
501
- body?: never;
667
+ export type DeploymentsPublishData = {
668
+ body: {
669
+ scope: {
670
+ name: string;
671
+ value: {
672
+ [key: string]: Schema0;
673
+ };
674
+ };
675
+ rollout?: boolean;
676
+ };
502
677
  path: {
503
678
  deploymentId: string;
504
679
  };
505
- query: {
506
- scopeId: string;
507
- };
680
+ query?: never;
508
681
  url: "/deployments/{deploymentId}";
509
682
  };
510
- export type DeploymentsGetResponses = {
683
+ export type DeploymentsPublishResponses = {
511
684
  /**
512
685
  * OK
513
686
  */
@@ -525,41 +698,36 @@ export type DeploymentsGetResponses = {
525
698
  updatedAt: string;
526
699
  };
527
700
  };
528
- export type DeploymentsGetResponse = DeploymentsGetResponses[keyof DeploymentsGetResponses];
529
- export type DeploymentsPublishData = {
701
+ export type DeploymentsPublishResponse = DeploymentsPublishResponses[keyof DeploymentsPublishResponses];
702
+ export type DeploymentsRuntimeData = {
530
703
  body: {
531
- scopeId: string;
532
- rollout?: boolean;
704
+ [key: string]: unknown;
533
705
  };
534
706
  path: {
535
- deploymentId: string;
707
+ appId: string;
536
708
  };
537
709
  query?: never;
538
- url: "/deployments/{deploymentId}";
710
+ url: "/apps/{appId}/runtime";
539
711
  };
540
- export type DeploymentsPublishResponses = {
712
+ export type DeploymentsRuntimeResponses = {
541
713
  /**
542
714
  * OK
543
715
  */
544
716
  200: {
545
- id: string;
546
- publicId: string;
717
+ projectId: string;
547
718
  appId: string;
548
- status: "uploading" | "deploying" | "verifying" | "published";
549
- clientEntryFileId: string | null;
550
- logoLightFileId: string | null;
551
- logoDarkFileId: string | null;
552
- logoLightPath: string | null;
553
- logoDarkPath: string | null;
554
- createdAt: string;
555
- updatedAt: string;
719
+ deploymentId: string;
720
+ objectKey: string;
721
+ checksum: string;
722
+ contentLength: number;
556
723
  };
557
724
  };
558
- export type DeploymentsPublishResponse = DeploymentsPublishResponses[keyof DeploymentsPublishResponses];
725
+ export type DeploymentsRuntimeResponse = DeploymentsRuntimeResponses[keyof DeploymentsRuntimeResponses];
559
726
  export type PreviewStartData = {
560
727
  body: {
561
728
  appId: string;
562
729
  deployToken: string;
730
+ replaceActive?: boolean;
563
731
  };
564
732
  path?: never;
565
733
  query?: never;
@@ -574,47 +742,134 @@ export type PreviewStartResponses = {
574
742
  sessionId: string;
575
743
  tunnelToken: string;
576
744
  tunnelUrl: string;
745
+ shareId: string;
577
746
  };
578
747
  };
579
748
  export type PreviewStartResponse = PreviewStartResponses[keyof PreviewStartResponses];
580
- export type PreviewResolveData = {
581
- body?: never;
749
+ export type PreviewStopData = {
750
+ body: {
751
+ deployToken: string;
752
+ };
582
753
  path: {
583
754
  sessionId: string;
584
755
  };
585
- query: {
586
- scopeId: string;
756
+ query?: never;
757
+ url: "/preview/{sessionId}/stop";
758
+ };
759
+ export type PreviewStopResponses = {
760
+ /**
761
+ * OK
762
+ */
763
+ 200: {
764
+ [key: string]: never;
765
+ };
766
+ };
767
+ export type PreviewStopResponse = PreviewStopResponses[keyof PreviewStopResponses];
768
+ export type PreviewInvitationData = {
769
+ body?: never;
770
+ path: {
771
+ shareId: string;
587
772
  };
588
- url: "/preview/{sessionId}";
773
+ query?: never;
774
+ url: "/preview/shares/{shareId}";
589
775
  };
590
- export type PreviewResolveResponses = {
776
+ export type PreviewInvitationResponses = {
591
777
  /**
592
778
  * OK
593
779
  */
594
780
  200: {
595
- appId: string;
596
- clientPath: string;
781
+ appName: string;
782
+ expiresAt: string;
597
783
  sessionId: string;
598
- status: "connected" | "offline";
599
784
  };
600
785
  };
601
- export type PreviewResolveResponse = PreviewResolveResponses[keyof PreviewResolveResponses];
602
- export type PreviewStopData = {
786
+ export type PreviewInvitationResponse = PreviewInvitationResponses[keyof PreviewInvitationResponses];
787
+ export type PreviewAcceptData = {
603
788
  body: {
604
- deployToken: string;
789
+ scope: {
790
+ name: string;
791
+ value: {
792
+ [key: string]: Schema0;
793
+ };
794
+ };
605
795
  };
606
796
  path: {
797
+ shareId: string;
798
+ };
799
+ query?: never;
800
+ url: "/preview/shares/{shareId}/accept";
801
+ };
802
+ export type PreviewAcceptResponses = {
803
+ /**
804
+ * OK
805
+ */
806
+ 200: {
807
+ grantId: string;
607
808
  sessionId: string;
608
809
  };
810
+ };
811
+ export type PreviewAcceptResponse = PreviewAcceptResponses[keyof PreviewAcceptResponses];
812
+ export type PreviewAcceptedData = {
813
+ body: {
814
+ grantIds: Array<string>;
815
+ scopes: Array<{
816
+ name: string;
817
+ value: {
818
+ [key: string]: Schema0;
819
+ };
820
+ }>;
821
+ };
822
+ path?: never;
609
823
  query?: never;
610
- url: "/preview/{sessionId}/stop";
824
+ url: "/preview/grants/resolve";
611
825
  };
612
- export type PreviewStopResponses = {
826
+ export type PreviewAcceptedResponses = {
613
827
  /**
614
828
  * OK
615
829
  */
616
830
  200: {
617
- [key: string]: unknown;
831
+ items: Array<{
832
+ app: {
833
+ id: string;
834
+ publicId: string;
835
+ projectId: string;
836
+ scope: {
837
+ name: string;
838
+ value: {
839
+ [key: string]: Schema0;
840
+ };
841
+ };
842
+ name: string;
843
+ description: string | null;
844
+ currentDeploymentId: string | null;
845
+ createdAt: string;
846
+ updatedAt: string;
847
+ currentDeployment: {
848
+ id: string;
849
+ publicId: string;
850
+ appId: string;
851
+ status: "uploading" | "deploying" | "verifying" | "published";
852
+ clientEntryFileId: string | null;
853
+ logoLightFileId: string | null;
854
+ logoDarkFileId: string | null;
855
+ logoLightPath: string | null;
856
+ logoDarkPath: string | null;
857
+ createdAt: string;
858
+ updatedAt: string;
859
+ } | null;
860
+ clientPath?: string;
861
+ logoPaths?: {
862
+ dark?: string;
863
+ light?: string;
864
+ };
865
+ };
866
+ preview: {
867
+ sessionId: string;
868
+ expiresAt: string;
869
+ websocketUrl: string;
870
+ token: string;
871
+ };
872
+ }>;
618
873
  };
619
874
  };
620
- export type PreviewStopResponse = PreviewStopResponses[keyof PreviewStopResponses];
875
+ export type PreviewAcceptedResponse = PreviewAcceptedResponses[keyof PreviewAcceptedResponses];
package/dist/client.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- import type { CreateClientConfig } from "./client/client";
1
+ import type { CreateClientConfig } from "./client/client/index.js";
2
2
  export declare const createClientConfig: CreateClientConfig;
package/dist/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
- export * from "./client/index";
2
- export * from "./client";
1
+ export * from "./client/index.js";
2
+ export * from "./client.js";
3
+ export * from "./preview.js";