@uniformdev/mesh-sdk 20.72.2-alpha.3 → 20.72.3-alpha.14
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/index.d.mts +381 -21
- package/dist/index.d.ts +381 -21
- package/dist/index.esm.js +94 -52
- package/dist/index.js +97 -52
- package/dist/index.mjs +94 -52
- package/dist/server/index.d.mts +386 -0
- package/dist/server/index.mjs +354 -0
- package/package.json +34 -12
package/dist/index.d.mts
CHANGED
|
@@ -5,6 +5,212 @@ import { ProjectMapNode } from '@uniformdev/project-map';
|
|
|
5
5
|
import { AssetDefinitionType } from '@uniformdev/assets';
|
|
6
6
|
import { Emitter } from 'mitt';
|
|
7
7
|
|
|
8
|
+
interface paths$2 {
|
|
9
|
+
"/api/v1/integration-credentials": {
|
|
10
|
+
parameters: {
|
|
11
|
+
query?: never;
|
|
12
|
+
header?: never;
|
|
13
|
+
path?: never;
|
|
14
|
+
cookie?: never;
|
|
15
|
+
};
|
|
16
|
+
get?: never;
|
|
17
|
+
put?: never;
|
|
18
|
+
/** @description Mints or rotates the credential for an integration definition. Atomic: a successful response invalidates any previously-issued secret of the same kind. The plaintext secret is returned in the response body and cannot be retrieved later. */
|
|
19
|
+
post: {
|
|
20
|
+
parameters: {
|
|
21
|
+
query?: never;
|
|
22
|
+
header?: never;
|
|
23
|
+
path?: never;
|
|
24
|
+
cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
requestBody: {
|
|
27
|
+
content: {
|
|
28
|
+
"application/json": {
|
|
29
|
+
/**
|
|
30
|
+
* Format: uuid
|
|
31
|
+
* @description The team ID that owns the integration
|
|
32
|
+
*/
|
|
33
|
+
teamId: string;
|
|
34
|
+
/**
|
|
35
|
+
* Format: uuid
|
|
36
|
+
* @description The integration definition ID to mint or revoke credentials for
|
|
37
|
+
*/
|
|
38
|
+
integrationDefinitionId: string;
|
|
39
|
+
/**
|
|
40
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
41
|
+
* @enum {string}
|
|
42
|
+
*/
|
|
43
|
+
kind: "app_secret";
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
responses: {
|
|
48
|
+
/** @description Credential minted or rotated. */
|
|
49
|
+
200: {
|
|
50
|
+
headers: {
|
|
51
|
+
[name: string]: unknown;
|
|
52
|
+
};
|
|
53
|
+
content: {
|
|
54
|
+
"application/json": {
|
|
55
|
+
/**
|
|
56
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
57
|
+
* @enum {string}
|
|
58
|
+
*/
|
|
59
|
+
kind: "app_secret";
|
|
60
|
+
/** Format: uuid */
|
|
61
|
+
integrationDefinitionId: string;
|
|
62
|
+
/** @description Plaintext app secret. Only returned on this response; cannot be retrieved later. */
|
|
63
|
+
appSecret: string;
|
|
64
|
+
/** @description ISO timestamp when the secret became effective. */
|
|
65
|
+
createdAt: string;
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
|
+
};
|
|
69
|
+
400: components$2["responses"]["BadRequestError"];
|
|
70
|
+
401: components$2["responses"]["UnauthorizedError"];
|
|
71
|
+
403: components$2["responses"]["ForbiddenError"];
|
|
72
|
+
/** @description Integration definition not found in this team */
|
|
73
|
+
404: {
|
|
74
|
+
headers: {
|
|
75
|
+
[name: string]: unknown;
|
|
76
|
+
};
|
|
77
|
+
content?: never;
|
|
78
|
+
};
|
|
79
|
+
429: components$2["responses"]["RateLimitError"];
|
|
80
|
+
500: components$2["responses"]["InternalServerError"];
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
/** @description Revokes the credential for an integration definition. Future grants and refreshes will fail until a new credential is minted. In-flight delegation tokens remain valid until natural expiry. */
|
|
84
|
+
delete: {
|
|
85
|
+
parameters: {
|
|
86
|
+
query?: never;
|
|
87
|
+
header?: never;
|
|
88
|
+
path?: never;
|
|
89
|
+
cookie?: never;
|
|
90
|
+
};
|
|
91
|
+
requestBody: {
|
|
92
|
+
content: {
|
|
93
|
+
"application/json": {
|
|
94
|
+
/**
|
|
95
|
+
* Format: uuid
|
|
96
|
+
* @description The team ID that owns the integration
|
|
97
|
+
*/
|
|
98
|
+
teamId: string;
|
|
99
|
+
/**
|
|
100
|
+
* Format: uuid
|
|
101
|
+
* @description The integration definition ID to mint or revoke credentials for
|
|
102
|
+
*/
|
|
103
|
+
integrationDefinitionId: string;
|
|
104
|
+
/**
|
|
105
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
106
|
+
* @enum {string}
|
|
107
|
+
*/
|
|
108
|
+
kind: "app_secret";
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
responses: {
|
|
113
|
+
/** @description Credential revoked */
|
|
114
|
+
204: {
|
|
115
|
+
headers: {
|
|
116
|
+
[name: string]: unknown;
|
|
117
|
+
};
|
|
118
|
+
content?: never;
|
|
119
|
+
};
|
|
120
|
+
400: components$2["responses"]["BadRequestError"];
|
|
121
|
+
401: components$2["responses"]["UnauthorizedError"];
|
|
122
|
+
403: components$2["responses"]["ForbiddenError"];
|
|
123
|
+
/** @description Integration definition not found in this team, or no credential of the given kind is configured */
|
|
124
|
+
404: {
|
|
125
|
+
headers: {
|
|
126
|
+
[name: string]: unknown;
|
|
127
|
+
};
|
|
128
|
+
content?: never;
|
|
129
|
+
};
|
|
130
|
+
429: components$2["responses"]["RateLimitError"];
|
|
131
|
+
500: components$2["responses"]["InternalServerError"];
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
135
|
+
options: {
|
|
136
|
+
parameters: {
|
|
137
|
+
query?: never;
|
|
138
|
+
header?: never;
|
|
139
|
+
path?: never;
|
|
140
|
+
cookie?: never;
|
|
141
|
+
};
|
|
142
|
+
requestBody?: never;
|
|
143
|
+
responses: {
|
|
144
|
+
/** @description ok */
|
|
145
|
+
204: {
|
|
146
|
+
headers: {
|
|
147
|
+
[name: string]: unknown;
|
|
148
|
+
};
|
|
149
|
+
content?: never;
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
head?: never;
|
|
154
|
+
patch?: never;
|
|
155
|
+
trace?: never;
|
|
156
|
+
};
|
|
157
|
+
}
|
|
158
|
+
interface components$2 {
|
|
159
|
+
schemas: {
|
|
160
|
+
Error: {
|
|
161
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
162
|
+
errorMessage?: string[] | string;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
responses: {
|
|
166
|
+
/** @description Request input validation failed */
|
|
167
|
+
BadRequestError: {
|
|
168
|
+
headers: {
|
|
169
|
+
[name: string]: unknown;
|
|
170
|
+
};
|
|
171
|
+
content: {
|
|
172
|
+
"application/json": components$2["schemas"]["Error"];
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
/** @description API key or token was not valid */
|
|
176
|
+
UnauthorizedError: {
|
|
177
|
+
headers: {
|
|
178
|
+
[name: string]: unknown;
|
|
179
|
+
};
|
|
180
|
+
content: {
|
|
181
|
+
"application/json": components$2["schemas"]["Error"];
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
/** @description Permission was denied */
|
|
185
|
+
ForbiddenError: {
|
|
186
|
+
headers: {
|
|
187
|
+
[name: string]: unknown;
|
|
188
|
+
};
|
|
189
|
+
content: {
|
|
190
|
+
"application/json": components$2["schemas"]["Error"];
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
/** @description Too many requests in allowed time period */
|
|
194
|
+
RateLimitError: {
|
|
195
|
+
headers: {
|
|
196
|
+
[name: string]: unknown;
|
|
197
|
+
};
|
|
198
|
+
content?: never;
|
|
199
|
+
};
|
|
200
|
+
/** @description Execution error occurred */
|
|
201
|
+
InternalServerError: {
|
|
202
|
+
headers: {
|
|
203
|
+
[name: string]: unknown;
|
|
204
|
+
};
|
|
205
|
+
content?: never;
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
parameters: never;
|
|
209
|
+
requestBodies: never;
|
|
210
|
+
headers: never;
|
|
211
|
+
pathItems: never;
|
|
212
|
+
}
|
|
213
|
+
|
|
8
214
|
interface paths$1 {
|
|
9
215
|
"/api/v1/integration-definitions": {
|
|
10
216
|
parameters: {
|
|
@@ -46,6 +252,10 @@ interface paths$1 {
|
|
|
46
252
|
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
47
253
|
public?: boolean;
|
|
48
254
|
scopes?: string[];
|
|
255
|
+
identityDelegation?: boolean;
|
|
256
|
+
/** Format: uuid */
|
|
257
|
+
integrationId?: string;
|
|
258
|
+
hasAppSecret?: boolean;
|
|
49
259
|
baseLocationUrl?: string;
|
|
50
260
|
locations: {
|
|
51
261
|
install?: {
|
|
@@ -121,6 +331,10 @@ interface paths$1 {
|
|
|
121
331
|
name: string;
|
|
122
332
|
url: string;
|
|
123
333
|
iconUrl?: string;
|
|
334
|
+
access?: {
|
|
335
|
+
/** @enum {boolean} */
|
|
336
|
+
teamAdminRequired?: true;
|
|
337
|
+
};
|
|
124
338
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
125
339
|
}[];
|
|
126
340
|
personalization?: {
|
|
@@ -268,18 +482,30 @@ interface paths$1 {
|
|
|
268
482
|
name: string;
|
|
269
483
|
url: string;
|
|
270
484
|
iconUrl?: string;
|
|
485
|
+
access?: {
|
|
486
|
+
/** @enum {boolean} */
|
|
487
|
+
teamAdminRequired?: true;
|
|
488
|
+
};
|
|
271
489
|
}[];
|
|
272
490
|
projectTools?: {
|
|
273
491
|
id: string;
|
|
274
492
|
name: string;
|
|
275
493
|
url: string;
|
|
276
494
|
iconUrl?: string;
|
|
495
|
+
access?: {
|
|
496
|
+
/** @enum {boolean} */
|
|
497
|
+
teamAdminRequired?: true;
|
|
498
|
+
};
|
|
277
499
|
}[];
|
|
278
500
|
dashboardTools?: {
|
|
279
501
|
id: string;
|
|
280
502
|
name: string;
|
|
281
503
|
url: string;
|
|
282
504
|
iconUrl?: string;
|
|
505
|
+
access?: {
|
|
506
|
+
/** @enum {boolean} */
|
|
507
|
+
teamAdminRequired?: true;
|
|
508
|
+
};
|
|
283
509
|
}[];
|
|
284
510
|
};
|
|
285
511
|
unstable_prompts?: {
|
|
@@ -310,7 +536,7 @@ interface paths$1 {
|
|
|
310
536
|
500: components$1["responses"]["InternalServerError"];
|
|
311
537
|
};
|
|
312
538
|
};
|
|
313
|
-
/** @description Creates or updates a Mesh app definition on a team */
|
|
539
|
+
/** @description Creates or updates a Mesh app definition on a team. */
|
|
314
540
|
put: {
|
|
315
541
|
parameters: {
|
|
316
542
|
query?: never;
|
|
@@ -331,6 +557,7 @@ interface paths$1 {
|
|
|
331
557
|
/** @enum {string} */
|
|
332
558
|
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
333
559
|
scopes?: string[];
|
|
560
|
+
identityDelegation?: boolean;
|
|
334
561
|
baseLocationUrl?: string;
|
|
335
562
|
locations: {
|
|
336
563
|
install?: {
|
|
@@ -406,6 +633,10 @@ interface paths$1 {
|
|
|
406
633
|
name: string;
|
|
407
634
|
url: string;
|
|
408
635
|
iconUrl?: string;
|
|
636
|
+
access?: {
|
|
637
|
+
/** @enum {boolean} */
|
|
638
|
+
teamAdminRequired?: true;
|
|
639
|
+
};
|
|
409
640
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
410
641
|
}[];
|
|
411
642
|
personalization?: {
|
|
@@ -553,18 +784,30 @@ interface paths$1 {
|
|
|
553
784
|
name: string;
|
|
554
785
|
url: string;
|
|
555
786
|
iconUrl?: string;
|
|
787
|
+
access?: {
|
|
788
|
+
/** @enum {boolean} */
|
|
789
|
+
teamAdminRequired?: true;
|
|
790
|
+
};
|
|
556
791
|
}[];
|
|
557
792
|
projectTools?: {
|
|
558
793
|
id: string;
|
|
559
794
|
name: string;
|
|
560
795
|
url: string;
|
|
561
796
|
iconUrl?: string;
|
|
797
|
+
access?: {
|
|
798
|
+
/** @enum {boolean} */
|
|
799
|
+
teamAdminRequired?: true;
|
|
800
|
+
};
|
|
562
801
|
}[];
|
|
563
802
|
dashboardTools?: {
|
|
564
803
|
id: string;
|
|
565
804
|
name: string;
|
|
566
805
|
url: string;
|
|
567
806
|
iconUrl?: string;
|
|
807
|
+
access?: {
|
|
808
|
+
/** @enum {boolean} */
|
|
809
|
+
teamAdminRequired?: true;
|
|
810
|
+
};
|
|
568
811
|
}[];
|
|
569
812
|
};
|
|
570
813
|
unstable_prompts?: {
|
|
@@ -604,6 +847,13 @@ interface paths$1 {
|
|
|
604
847
|
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
605
848
|
public?: boolean;
|
|
606
849
|
scopes?: string[];
|
|
850
|
+
identityDelegation?: boolean;
|
|
851
|
+
/**
|
|
852
|
+
* Format: uuid
|
|
853
|
+
* @description Stable id for this integration definition. Required for identity delegation token exchange.
|
|
854
|
+
*/
|
|
855
|
+
integrationId: string;
|
|
856
|
+
hasAppSecret?: boolean;
|
|
607
857
|
baseLocationUrl?: string;
|
|
608
858
|
locations: {
|
|
609
859
|
install?: {
|
|
@@ -679,6 +929,10 @@ interface paths$1 {
|
|
|
679
929
|
name: string;
|
|
680
930
|
url: string;
|
|
681
931
|
iconUrl?: string;
|
|
932
|
+
access?: {
|
|
933
|
+
/** @enum {boolean} */
|
|
934
|
+
teamAdminRequired?: true;
|
|
935
|
+
};
|
|
682
936
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
683
937
|
}[];
|
|
684
938
|
personalization?: {
|
|
@@ -826,18 +1080,30 @@ interface paths$1 {
|
|
|
826
1080
|
name: string;
|
|
827
1081
|
url: string;
|
|
828
1082
|
iconUrl?: string;
|
|
1083
|
+
access?: {
|
|
1084
|
+
/** @enum {boolean} */
|
|
1085
|
+
teamAdminRequired?: true;
|
|
1086
|
+
};
|
|
829
1087
|
}[];
|
|
830
1088
|
projectTools?: {
|
|
831
1089
|
id: string;
|
|
832
1090
|
name: string;
|
|
833
1091
|
url: string;
|
|
834
1092
|
iconUrl?: string;
|
|
1093
|
+
access?: {
|
|
1094
|
+
/** @enum {boolean} */
|
|
1095
|
+
teamAdminRequired?: true;
|
|
1096
|
+
};
|
|
835
1097
|
}[];
|
|
836
1098
|
dashboardTools?: {
|
|
837
1099
|
id: string;
|
|
838
1100
|
name: string;
|
|
839
1101
|
url: string;
|
|
840
1102
|
iconUrl?: string;
|
|
1103
|
+
access?: {
|
|
1104
|
+
/** @enum {boolean} */
|
|
1105
|
+
teamAdminRequired?: true;
|
|
1106
|
+
};
|
|
841
1107
|
}[];
|
|
842
1108
|
};
|
|
843
1109
|
unstable_prompts?: {
|
|
@@ -1200,6 +1466,7 @@ interface components {
|
|
|
1200
1466
|
|
|
1201
1467
|
type IntegrationDefinitionsApi = paths$1['/api/v1/integration-definitions'];
|
|
1202
1468
|
type IntegrationInstallationsApi = paths['/api/v1/integration-installations'];
|
|
1469
|
+
type IntegrationCredentialsApi = paths$2['/api/v1/integration-credentials'];
|
|
1203
1470
|
/** Query parameter options for GET /api/v1/integration-definitions */
|
|
1204
1471
|
type IntegrationDefinitionGetParameters = IntegrationDefinitionsApi['get']['parameters']['query'];
|
|
1205
1472
|
/** The GET response from /api/v1/integration-definitions */
|
|
@@ -1210,6 +1477,12 @@ type IntegrationDefinitionPutParameters = IntegrationDefinitionsApi['put']['requ
|
|
|
1210
1477
|
type IntegrationDefinitionPutResponse = IntegrationDefinitionsApi['put']['responses']['200']['content']['application/json'];
|
|
1211
1478
|
/** The DELETE body for /api/v1/integration-definitions */
|
|
1212
1479
|
type IntegrationDefinitionDeleteParameters = IntegrationDefinitionsApi['delete']['requestBody']['content']['application/json'];
|
|
1480
|
+
/** The POST body for /api/v1/integration-credentials (rotate or mint) */
|
|
1481
|
+
type IntegrationCredentialRotateParameters = IntegrationCredentialsApi['post']['requestBody']['content']['application/json'];
|
|
1482
|
+
/** The POST response for /api/v1/integration-credentials (returns the plaintext secret once) */
|
|
1483
|
+
type IntegrationCredentialRotateResponse = IntegrationCredentialsApi['post']['responses']['200']['content']['application/json'];
|
|
1484
|
+
/** The DELETE body for /api/v1/integration-credentials (revoke) */
|
|
1485
|
+
type IntegrationCredentialRevokeParameters = IntegrationCredentialsApi['delete']['requestBody']['content']['application/json'];
|
|
1213
1486
|
/** Query parameter options for GET /api/v1/integration-installations */
|
|
1214
1487
|
type IntegrationInstallationGetParameters = IntegrationInstallationsApi['get']['parameters']['query'];
|
|
1215
1488
|
/** The GET response from /api/v1/integration-installations */
|
|
@@ -1222,13 +1495,13 @@ type IntegrationInstallationDeleteParameters = IntegrationInstallationsApi['dele
|
|
|
1222
1495
|
type DefClientOptions = Omit<ClientOptions, 'apiKey' | 'projectId'> & {
|
|
1223
1496
|
teamId: string;
|
|
1224
1497
|
};
|
|
1225
|
-
/** API Client to manage the registration of custom Mesh applications */
|
|
1498
|
+
/** API Client to manage the registration of custom Mesh applications and their identity-delegation credentials. */
|
|
1226
1499
|
declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
1227
1500
|
#private;
|
|
1228
1501
|
constructor(options: DefClientOptions);
|
|
1229
1502
|
/** Fetches all mesh apps for a team (and optionally also those shared across teams) */
|
|
1230
1503
|
get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
|
|
1231
|
-
/** Creates or updates a mesh app definition on a team */
|
|
1504
|
+
/** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link rotateCredential}. */
|
|
1232
1505
|
upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
|
|
1233
1506
|
type: string;
|
|
1234
1507
|
displayName: string;
|
|
@@ -1237,6 +1510,9 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1237
1510
|
category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
|
|
1238
1511
|
public?: boolean;
|
|
1239
1512
|
scopes?: string[];
|
|
1513
|
+
identityDelegation?: boolean;
|
|
1514
|
+
integrationId: string;
|
|
1515
|
+
hasAppSecret?: boolean;
|
|
1240
1516
|
baseLocationUrl?: string;
|
|
1241
1517
|
locations: {
|
|
1242
1518
|
install?: {
|
|
@@ -1305,6 +1581,9 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1305
1581
|
name: string;
|
|
1306
1582
|
url: string;
|
|
1307
1583
|
iconUrl?: string;
|
|
1584
|
+
access?: {
|
|
1585
|
+
teamAdminRequired?: true;
|
|
1586
|
+
};
|
|
1308
1587
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
1309
1588
|
}[];
|
|
1310
1589
|
personalization?: {
|
|
@@ -1442,18 +1721,27 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1442
1721
|
name: string;
|
|
1443
1722
|
url: string;
|
|
1444
1723
|
iconUrl?: string;
|
|
1724
|
+
access?: {
|
|
1725
|
+
teamAdminRequired?: true;
|
|
1726
|
+
};
|
|
1445
1727
|
}[];
|
|
1446
1728
|
projectTools?: {
|
|
1447
1729
|
id: string;
|
|
1448
1730
|
name: string;
|
|
1449
1731
|
url: string;
|
|
1450
1732
|
iconUrl?: string;
|
|
1733
|
+
access?: {
|
|
1734
|
+
teamAdminRequired?: true;
|
|
1735
|
+
};
|
|
1451
1736
|
}[];
|
|
1452
1737
|
dashboardTools?: {
|
|
1453
1738
|
id: string;
|
|
1454
1739
|
name: string;
|
|
1455
1740
|
url: string;
|
|
1456
1741
|
iconUrl?: string;
|
|
1742
|
+
access?: {
|
|
1743
|
+
teamAdminRequired?: true;
|
|
1744
|
+
};
|
|
1457
1745
|
}[];
|
|
1458
1746
|
};
|
|
1459
1747
|
unstable_prompts?: {
|
|
@@ -1476,6 +1764,19 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1476
1764
|
}>;
|
|
1477
1765
|
/** Deletes a mesh app from a team */
|
|
1478
1766
|
remove(body: Omit<IntegrationDefinitionDeleteParameters, 'teamId'>): Promise<void>;
|
|
1767
|
+
/**
|
|
1768
|
+
* Mints or rotates an identity-delegation credential for an integration definition. The plaintext
|
|
1769
|
+
* `appSecret` is returned exactly once and is not retrievable afterwards — Uniform stores only
|
|
1770
|
+
* the hash. A successful response invalidates any previously-issued secret of the same kind.
|
|
1771
|
+
* Caller must be a team admin.
|
|
1772
|
+
*/
|
|
1773
|
+
rotateCredential(body: Omit<IntegrationCredentialRotateParameters, 'teamId'>): Promise<IntegrationCredentialRotateResponse>;
|
|
1774
|
+
/**
|
|
1775
|
+
* Revokes an identity-delegation credential. Future delegation grants and refreshes will fail
|
|
1776
|
+
* until a new credential is minted; in-flight delegation tokens remain valid until natural
|
|
1777
|
+
* expiry (up to ~15 minutes). Caller must be a team admin.
|
|
1778
|
+
*/
|
|
1779
|
+
revokeCredential(body: Omit<IntegrationCredentialRevokeParameters, 'teamId'>): Promise<void>;
|
|
1479
1780
|
}
|
|
1480
1781
|
|
|
1481
1782
|
/** API Client to manage the registration of custom Mesh applications */
|
|
@@ -1494,6 +1795,26 @@ declare class IntegrationInstallationClient extends ApiClient {
|
|
|
1494
1795
|
remove(body: ExceptProject<IntegrationInstallationDeleteParameters>): Promise<void>;
|
|
1495
1796
|
}
|
|
1496
1797
|
|
|
1798
|
+
/**
|
|
1799
|
+
* Default custom-header name partners attach on every state-changing call
|
|
1800
|
+
* to the BFF. Any fixed, non-CORS-safelisted header name works — the value
|
|
1801
|
+
* is irrelevant to the security argument; only its presence matters.
|
|
1802
|
+
*
|
|
1803
|
+
* The browser will not attach a non-safelisted header on a cross-origin
|
|
1804
|
+
* request without a CORS preflight, so any request that arrives with the
|
|
1805
|
+
* header must have originated from same-origin JavaScript.
|
|
1806
|
+
*
|
|
1807
|
+
* The constant is exported so the BFF and the consumer's browser fetch
|
|
1808
|
+
* helper share one source of truth.
|
|
1809
|
+
*/
|
|
1810
|
+
declare const CSRF_HEADER_NAME = "x-mesh-csrf";
|
|
1811
|
+
/**
|
|
1812
|
+
* Default expected value for the custom CSRF header. Constant; the security
|
|
1813
|
+
* argument is presence-of-header, not value-secrecy. Kept as `'1'` so the
|
|
1814
|
+
* value is trivial to recognise in logs and developer tooling.
|
|
1815
|
+
*/
|
|
1816
|
+
declare const CSRF_HEADER_VALUE = "1";
|
|
1817
|
+
|
|
1497
1818
|
/** @deprecated experimental */
|
|
1498
1819
|
type FunctionCallResponse = {
|
|
1499
1820
|
message: string;
|
|
@@ -1847,7 +2168,41 @@ type UniformUser = {
|
|
|
1847
2168
|
isAdmin: boolean;
|
|
1848
2169
|
};
|
|
1849
2170
|
|
|
1850
|
-
|
|
2171
|
+
/**
|
|
2172
|
+
* Methods the parent frame exposes to the Mesh SDK over the iframe bridge (`connectToParent().parent`).
|
|
2173
|
+
* The dashboard implements the same shape when wiring `setupIframeListeners` / mesh location hosts.
|
|
2174
|
+
*/
|
|
2175
|
+
interface MeshParentConnection {
|
|
2176
|
+
resize: ({ height }: {
|
|
2177
|
+
height: CSSHeight;
|
|
2178
|
+
}) => Promise<void>;
|
|
2179
|
+
setValue: (value: SetValueMessage) => Promise<void>;
|
|
2180
|
+
openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, 'value' | 'dialogId'> | undefined>;
|
|
2181
|
+
closeDialog: (message: CloseDialogMessage) => Promise<void>;
|
|
2182
|
+
getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
|
|
2183
|
+
navigate: (message: NavigateMessage) => Promise<void>;
|
|
2184
|
+
reloadLocation: () => Promise<void>;
|
|
2185
|
+
editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
|
|
2186
|
+
/**
|
|
2187
|
+
* Returns a short-lived session token for identity delegation, or `undefined` when delegation
|
|
2188
|
+
* is not enabled for this integration.
|
|
2189
|
+
*
|
|
2190
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
2191
|
+
*/
|
|
2192
|
+
getSessionToken: () => Promise<string | undefined>;
|
|
2193
|
+
/**
|
|
2194
|
+
* Provides imperative access to the composition/entry editor state.
|
|
2195
|
+
* This API provides imperative access to the composition/entry editor state.
|
|
2196
|
+
*/
|
|
2197
|
+
editorState: EditorStateApi;
|
|
2198
|
+
}
|
|
2199
|
+
type ConnectToParentResult = {
|
|
2200
|
+
initData: MeshContextData;
|
|
2201
|
+
parent: MeshParentConnection;
|
|
2202
|
+
};
|
|
2203
|
+
/** Shape of the handler object the mesh parent iframe must provide (includes `initialize` for the host side). */
|
|
2204
|
+
type MeshSDKEventInterface = MeshParentConnection & {
|
|
2205
|
+
/** Invoked by the child on startup; not part of `connectToParent().parent` but required on the host. */
|
|
1851
2206
|
initialize: () => Promise<MeshContextData>;
|
|
1852
2207
|
};
|
|
1853
2208
|
/**
|
|
@@ -1858,22 +2213,7 @@ declare function connectToParent({ dialogResponseHandlers, onMetadataUpdated, on
|
|
|
1858
2213
|
dialogResponseHandlers: DialogResponseHandlers;
|
|
1859
2214
|
onMetadataUpdated: (metadata: unknown) => void;
|
|
1860
2215
|
onValueExternallyUpdated: (value: unknown) => void;
|
|
1861
|
-
}): Promise<
|
|
1862
|
-
initData: MeshContextData;
|
|
1863
|
-
parent: {
|
|
1864
|
-
resize: ({ height }: {
|
|
1865
|
-
height: CSSHeight;
|
|
1866
|
-
}) => Promise<void>;
|
|
1867
|
-
setValue: (value: SetValueMessage) => Promise<void>;
|
|
1868
|
-
openDialog: (message: OpenDialogMessage) => Promise<Pick<DialogResponseData, "value" | "dialogId"> | undefined>;
|
|
1869
|
-
closeDialog: (message: CloseDialogMessage) => Promise<void>;
|
|
1870
|
-
getDataResource: <TExpectedResult>(message: GetDataResourceMessage) => Promise<TExpectedResult>;
|
|
1871
|
-
navigate: (message: NavigateMessage) => Promise<void>;
|
|
1872
|
-
reloadLocation: () => Promise<void>;
|
|
1873
|
-
editConnectedData: (message: EditConnectedDataMessage) => Promise<EditConnectedDataResponse>;
|
|
1874
|
-
editorState: EditorStateApi;
|
|
1875
|
-
};
|
|
1876
|
-
}>;
|
|
2216
|
+
}): Promise<ConnectToParentResult>;
|
|
1877
2217
|
|
|
1878
2218
|
type SetLocationFunction<TSetValue> = (value: TSetValue, options?: SetValueOptions) => Promise<void> | void;
|
|
1879
2219
|
/** Core shared generic for a mesh location context */
|
|
@@ -2045,6 +2385,16 @@ type MeshLocationUserPermissions =
|
|
|
2045
2385
|
| 'ENTRIES_MANAGE_SCHEMA'
|
|
2046
2386
|
/** Uniform Canvas:AI Prompts:Manage|Create, update, and delete AI prompts */
|
|
2047
2387
|
| 'PROMPTS_MANAGE_SCHEMA'
|
|
2388
|
+
/** Uniform Canvas:Labels:Create */
|
|
2389
|
+
| 'LABELS_CREATE'
|
|
2390
|
+
/** Uniform Canvas:Labels:Update */
|
|
2391
|
+
| 'LABELS_UPDATE'
|
|
2392
|
+
/** Uniform Canvas:Labels:Delete */
|
|
2393
|
+
| 'LABELS_DELETE'
|
|
2394
|
+
/** Uniform Automations:Manage|Create, update, delete, and toggle automations. */
|
|
2395
|
+
| 'AUTOMATIONS_MANAGE'
|
|
2396
|
+
/** Uniform Canvas:Workflows:Manage|Create, update, and delete workflow definitions. */
|
|
2397
|
+
| 'WORKFLOWS_MANAGE'
|
|
2048
2398
|
/** UTM Mapper:Read|Read UTM mapper configuration */
|
|
2049
2399
|
| 'UTM_MAPPER_READ'
|
|
2050
2400
|
/** UTM Mapper:Read|Create, update and delete UTM mapper configuration */
|
|
@@ -2542,6 +2892,16 @@ interface UniformMeshSDK {
|
|
|
2542
2892
|
}>['setValue']>[0]> | undefined>;
|
|
2543
2893
|
/** Explicitly close a location dialog. Called when rendering current location in the dialog. */
|
|
2544
2894
|
closeCurrentLocationDialog(): Promise<void>;
|
|
2895
|
+
/**
|
|
2896
|
+
* Requests a fresh short-lived session token for identity delegation.
|
|
2897
|
+
* Returns `undefined` when the integration does not have `identityDelegation` enabled.
|
|
2898
|
+
* Call this on demand — the token has a very short TTL (~10 s) and should be
|
|
2899
|
+
* consumed immediately by your backend to exchange for a delegation token
|
|
2900
|
+
* via `POST /api/v1/token` with `grantType=delegation_token` or DelegationTokenClient.
|
|
2901
|
+
*
|
|
2902
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
2903
|
+
*/
|
|
2904
|
+
getSessionToken(): Promise<string | undefined>;
|
|
2545
2905
|
}
|
|
2546
2906
|
declare global {
|
|
2547
2907
|
interface Window {
|
|
@@ -2562,4 +2922,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2562
2922
|
*/
|
|
2563
2923
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2564
2924
|
|
|
2565
|
-
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CanvasEditorContextMetadata, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DashboardToolLocation, type DashboardToolLocationMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataResourceSelectorLocation, type DataResourceSelectorLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DeleteNodeOptions, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EditorComponentInstance, type EditorComponentParameter, type EditorExportOptions, type EditorNode, type EditorNodeChildren, type EditorNodeParentInfo, type EditorRootMetadata, type EditorRootNodeMetadata, type EditorStateApi, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, type GetEditorStateLocation, type GetEditorStateLocationMaybe, type InsertNodeOptions, type InsertPatternOptions, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshRouter, type MeshSDKEventInterface, type MoveNodeOptions, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetPropertyLocalizabilityCommonParams, type SetPropertyLocalizabilityParams, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type UpdateNodePropertyOptions, type UpdateRootNodeOptions, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|
|
2925
|
+
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, CSRF_HEADER_NAME, CSRF_HEADER_VALUE, type CSSHeight, type CanvasEditorContextMetadata, type CanvasEditorEntityType, type CanvasEditorToolsData, type CanvasEditorToolsLocation, type CanvasEditorToolsLocationMetadata, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type ConnectToParentResult, type DashboardToolLocation, type DashboardToolLocationMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataResourceSelectorLocation, type DataResourceSelectorLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DeleteNodeOptions, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type EditorComponentInstance, type EditorComponentParameter, type EditorExportOptions, type EditorNode, type EditorNodeChildren, type EditorNodeParentInfo, type EditorRootMetadata, type EditorRootNodeMetadata, type EditorStateApi, type EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, type GetEditorStateLocation, type GetEditorStateLocationMaybe, type InsertNodeOptions, type InsertPatternOptions, type IntegrationCredentialRevokeParameters, type IntegrationCredentialRotateParameters, type IntegrationCredentialRotateResponse, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshParentConnection, type MeshRouter, type MeshSDKEventInterface, type MoveNodeOptions, type NavigateMessage, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PersonalizationCriteriaLocation, type PersonalizationCriteriaLocationMetadata, type ProjectToolLocation, type ProjectToolLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetPropertyLocalizabilityCommonParams, type SetPropertyLocalizabilityParams, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type UpdateNodePropertyOptions, type UpdateRootNodeOptions, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|