@uniformdev/mesh-sdk 20.50.2-alpha.39 → 20.50.2-alpha.77
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 +321 -11
- package/dist/index.d.ts +321 -11
- package/dist/index.esm.js +87 -25
- package/dist/index.js +88 -25
- package/dist/index.mjs +87 -25
- package/package.json +8 -8
package/dist/index.d.mts
CHANGED
|
@@ -5,6 +5,7 @@ import { ProjectMapNode } from '@uniformdev/project-map';
|
|
|
5
5
|
import { AssetDefinitionType } from '@uniformdev/assets';
|
|
6
6
|
import { Emitter } from 'mitt';
|
|
7
7
|
|
|
8
|
+
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
8
9
|
interface DelegationTokenClientOptions {
|
|
9
10
|
/** Uniform API host (e.g. 'https://uniform.app'). */
|
|
10
11
|
apiHost: string;
|
|
@@ -13,6 +14,7 @@ interface DelegationTokenClientOptions {
|
|
|
13
14
|
/** Plaintext app secret for this integration. */
|
|
14
15
|
integrationSecret: string;
|
|
15
16
|
}
|
|
17
|
+
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
16
18
|
interface DelegationTokenResponse {
|
|
17
19
|
/** Bearer access token that can be used to call Uniform APIs on behalf of the user. */
|
|
18
20
|
accessToken: string;
|
|
@@ -23,10 +25,24 @@ interface DelegationTokenResponse {
|
|
|
23
25
|
/** Token lifetime in seconds. */
|
|
24
26
|
expiresIn: number;
|
|
25
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Stable, low-detail kinds of token-exchange failures. Callers branch on these
|
|
30
|
+
* instead of parsing arbitrary upstream message text, and integrators surface a
|
|
31
|
+
* sanitised public message rather than whatever the server happened to return.
|
|
32
|
+
*/
|
|
33
|
+
type DelegationTokenErrorKind = 'bad_request' | 'unauthenticated' | 'forbidden' | 'not_found' | 'rate_limited' | 'server_error' | 'unknown';
|
|
34
|
+
/** @deprecated This beta identity delegation API may change with breaking changes. */
|
|
35
|
+
declare class DelegationTokenError extends Error {
|
|
36
|
+
readonly status: number;
|
|
37
|
+
readonly kind: DelegationTokenErrorKind;
|
|
38
|
+
constructor(status: number, kind: DelegationTokenErrorKind, publicMessage: string);
|
|
39
|
+
}
|
|
26
40
|
/**
|
|
27
41
|
* Server-side client for the Uniform token exchange endpoint.
|
|
28
42
|
* Use this in your integration's backend to exchange a session token (obtained from the
|
|
29
43
|
* Mesh SDK iframe context) for a delegation token, or to refresh an existing delegation token.
|
|
44
|
+
*
|
|
45
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
30
46
|
*/
|
|
31
47
|
declare class DelegationTokenClient {
|
|
32
48
|
#private;
|
|
@@ -34,15 +50,230 @@ declare class DelegationTokenClient {
|
|
|
34
50
|
/**
|
|
35
51
|
* Exchanges a short-lived session token for a delegation token and refresh token.
|
|
36
52
|
* The session token is obtained by the integration's frontend via `sdk.getSessionToken()`.
|
|
53
|
+
*
|
|
54
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
37
55
|
*/
|
|
38
56
|
exchangeSessionToken(sessionToken: string): Promise<DelegationTokenResponse>;
|
|
39
57
|
/**
|
|
40
|
-
* Exchanges a refresh token for a new delegation token and refresh token.
|
|
41
|
-
*
|
|
58
|
+
* Exchanges a refresh token for a new delegation token and a new refresh token.
|
|
59
|
+
*
|
|
60
|
+
* Replay posture: refresh tokens are bearer credentials that are valid until
|
|
61
|
+
* their server-side expiry. They are NOT single-use — a captured refresh token can be
|
|
62
|
+
* replayed by an attacker that also has the integration secret until it expires.
|
|
63
|
+
* Single-use enforcement (refresh-token storage, family/jti tracking, replay revocation)
|
|
64
|
+
* is tracked in `UNI-9279`.
|
|
65
|
+
*
|
|
66
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
42
67
|
*/
|
|
43
68
|
refreshDelegationToken(refreshToken: string): Promise<DelegationTokenResponse>;
|
|
44
69
|
}
|
|
45
70
|
|
|
71
|
+
interface paths$2 {
|
|
72
|
+
"/api/v1/integration-credentials": {
|
|
73
|
+
parameters: {
|
|
74
|
+
query?: never;
|
|
75
|
+
header?: never;
|
|
76
|
+
path?: never;
|
|
77
|
+
cookie?: never;
|
|
78
|
+
};
|
|
79
|
+
get?: never;
|
|
80
|
+
put?: never;
|
|
81
|
+
/** @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 must be persisted by the caller — Uniform stores only a hash. Response is `Cache-Control: no-store`. */
|
|
82
|
+
post: {
|
|
83
|
+
parameters: {
|
|
84
|
+
query?: never;
|
|
85
|
+
header?: never;
|
|
86
|
+
path?: never;
|
|
87
|
+
cookie?: never;
|
|
88
|
+
};
|
|
89
|
+
requestBody: {
|
|
90
|
+
content: {
|
|
91
|
+
"application/json": {
|
|
92
|
+
/**
|
|
93
|
+
* Format: uuid
|
|
94
|
+
* @description The team ID that owns the integration
|
|
95
|
+
*/
|
|
96
|
+
teamId: string;
|
|
97
|
+
/**
|
|
98
|
+
* Format: uuid
|
|
99
|
+
* @description The integration definition ID to mint or revoke credentials for
|
|
100
|
+
*/
|
|
101
|
+
integrationDefinitionId: string;
|
|
102
|
+
/**
|
|
103
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
104
|
+
* @enum {string}
|
|
105
|
+
*/
|
|
106
|
+
kind: "app_secret";
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
responses: {
|
|
111
|
+
/** @description Credential minted or rotated. Plaintext secret is returned exactly once. */
|
|
112
|
+
200: {
|
|
113
|
+
headers: {
|
|
114
|
+
[name: string]: unknown;
|
|
115
|
+
};
|
|
116
|
+
content: {
|
|
117
|
+
"application/json": {
|
|
118
|
+
/**
|
|
119
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
120
|
+
* @enum {string}
|
|
121
|
+
*/
|
|
122
|
+
kind: "app_secret";
|
|
123
|
+
/** Format: uuid */
|
|
124
|
+
integrationDefinitionId: string;
|
|
125
|
+
/** @description Plaintext app secret. Only returned on this response; cannot be retrieved later. */
|
|
126
|
+
appSecret: string;
|
|
127
|
+
/** @description ISO timestamp when the secret became effective. */
|
|
128
|
+
createdAt: string;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
};
|
|
132
|
+
400: components$2["responses"]["BadRequestError"];
|
|
133
|
+
401: components$2["responses"]["UnauthorizedError"];
|
|
134
|
+
403: components$2["responses"]["ForbiddenError"];
|
|
135
|
+
/** @description Integration definition not found in this team */
|
|
136
|
+
404: {
|
|
137
|
+
headers: {
|
|
138
|
+
[name: string]: unknown;
|
|
139
|
+
};
|
|
140
|
+
content?: never;
|
|
141
|
+
};
|
|
142
|
+
429: components$2["responses"]["RateLimitError"];
|
|
143
|
+
500: components$2["responses"]["InternalServerError"];
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
/** @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. */
|
|
147
|
+
delete: {
|
|
148
|
+
parameters: {
|
|
149
|
+
query?: never;
|
|
150
|
+
header?: never;
|
|
151
|
+
path?: never;
|
|
152
|
+
cookie?: never;
|
|
153
|
+
};
|
|
154
|
+
requestBody: {
|
|
155
|
+
content: {
|
|
156
|
+
"application/json": {
|
|
157
|
+
/**
|
|
158
|
+
* Format: uuid
|
|
159
|
+
* @description The team ID that owns the integration
|
|
160
|
+
*/
|
|
161
|
+
teamId: string;
|
|
162
|
+
/**
|
|
163
|
+
* Format: uuid
|
|
164
|
+
* @description The integration definition ID to mint or revoke credentials for
|
|
165
|
+
*/
|
|
166
|
+
integrationDefinitionId: string;
|
|
167
|
+
/**
|
|
168
|
+
* @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
|
|
169
|
+
* @enum {string}
|
|
170
|
+
*/
|
|
171
|
+
kind: "app_secret";
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
responses: {
|
|
176
|
+
/** @description Credential revoked */
|
|
177
|
+
204: {
|
|
178
|
+
headers: {
|
|
179
|
+
[name: string]: unknown;
|
|
180
|
+
};
|
|
181
|
+
content?: never;
|
|
182
|
+
};
|
|
183
|
+
400: components$2["responses"]["BadRequestError"];
|
|
184
|
+
401: components$2["responses"]["UnauthorizedError"];
|
|
185
|
+
403: components$2["responses"]["ForbiddenError"];
|
|
186
|
+
/** @description Integration definition not found in this team, or no credential of the given kind is configured */
|
|
187
|
+
404: {
|
|
188
|
+
headers: {
|
|
189
|
+
[name: string]: unknown;
|
|
190
|
+
};
|
|
191
|
+
content?: never;
|
|
192
|
+
};
|
|
193
|
+
429: components$2["responses"]["RateLimitError"];
|
|
194
|
+
500: components$2["responses"]["InternalServerError"];
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
198
|
+
options: {
|
|
199
|
+
parameters: {
|
|
200
|
+
query?: never;
|
|
201
|
+
header?: never;
|
|
202
|
+
path?: never;
|
|
203
|
+
cookie?: never;
|
|
204
|
+
};
|
|
205
|
+
requestBody?: never;
|
|
206
|
+
responses: {
|
|
207
|
+
/** @description ok */
|
|
208
|
+
204: {
|
|
209
|
+
headers: {
|
|
210
|
+
[name: string]: unknown;
|
|
211
|
+
};
|
|
212
|
+
content?: never;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
head?: never;
|
|
217
|
+
patch?: never;
|
|
218
|
+
trace?: never;
|
|
219
|
+
};
|
|
220
|
+
}
|
|
221
|
+
interface components$2 {
|
|
222
|
+
schemas: {
|
|
223
|
+
Error: {
|
|
224
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
225
|
+
errorMessage?: string[] | string;
|
|
226
|
+
};
|
|
227
|
+
};
|
|
228
|
+
responses: {
|
|
229
|
+
/** @description Request input validation failed */
|
|
230
|
+
BadRequestError: {
|
|
231
|
+
headers: {
|
|
232
|
+
[name: string]: unknown;
|
|
233
|
+
};
|
|
234
|
+
content: {
|
|
235
|
+
"application/json": components$2["schemas"]["Error"];
|
|
236
|
+
};
|
|
237
|
+
};
|
|
238
|
+
/** @description API key or token was not valid */
|
|
239
|
+
UnauthorizedError: {
|
|
240
|
+
headers: {
|
|
241
|
+
[name: string]: unknown;
|
|
242
|
+
};
|
|
243
|
+
content: {
|
|
244
|
+
"application/json": components$2["schemas"]["Error"];
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
/** @description Permission was denied */
|
|
248
|
+
ForbiddenError: {
|
|
249
|
+
headers: {
|
|
250
|
+
[name: string]: unknown;
|
|
251
|
+
};
|
|
252
|
+
content: {
|
|
253
|
+
"application/json": components$2["schemas"]["Error"];
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
/** @description Too many requests in allowed time period */
|
|
257
|
+
RateLimitError: {
|
|
258
|
+
headers: {
|
|
259
|
+
[name: string]: unknown;
|
|
260
|
+
};
|
|
261
|
+
content?: never;
|
|
262
|
+
};
|
|
263
|
+
/** @description Execution error occurred */
|
|
264
|
+
InternalServerError: {
|
|
265
|
+
headers: {
|
|
266
|
+
[name: string]: unknown;
|
|
267
|
+
};
|
|
268
|
+
content?: never;
|
|
269
|
+
};
|
|
270
|
+
};
|
|
271
|
+
parameters: never;
|
|
272
|
+
requestBodies: never;
|
|
273
|
+
headers: never;
|
|
274
|
+
pathItems: never;
|
|
275
|
+
}
|
|
276
|
+
|
|
46
277
|
interface paths$1 {
|
|
47
278
|
"/api/v1/integration-definitions": {
|
|
48
279
|
parameters: {
|
|
@@ -159,6 +390,10 @@ interface paths$1 {
|
|
|
159
390
|
name: string;
|
|
160
391
|
url: string;
|
|
161
392
|
iconUrl?: string;
|
|
393
|
+
access?: {
|
|
394
|
+
/** @enum {boolean} */
|
|
395
|
+
teamAdminRequired?: true;
|
|
396
|
+
};
|
|
162
397
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
163
398
|
}[];
|
|
164
399
|
personalization?: {
|
|
@@ -295,18 +530,30 @@ interface paths$1 {
|
|
|
295
530
|
name: string;
|
|
296
531
|
url: string;
|
|
297
532
|
iconUrl?: string;
|
|
533
|
+
access?: {
|
|
534
|
+
/** @enum {boolean} */
|
|
535
|
+
teamAdminRequired?: true;
|
|
536
|
+
};
|
|
298
537
|
}[];
|
|
299
538
|
projectTools?: {
|
|
300
539
|
id: string;
|
|
301
540
|
name: string;
|
|
302
541
|
url: string;
|
|
303
542
|
iconUrl?: string;
|
|
543
|
+
access?: {
|
|
544
|
+
/** @enum {boolean} */
|
|
545
|
+
teamAdminRequired?: true;
|
|
546
|
+
};
|
|
304
547
|
}[];
|
|
305
548
|
dashboardTools?: {
|
|
306
549
|
id: string;
|
|
307
550
|
name: string;
|
|
308
551
|
url: string;
|
|
309
552
|
iconUrl?: string;
|
|
553
|
+
access?: {
|
|
554
|
+
/** @enum {boolean} */
|
|
555
|
+
teamAdminRequired?: true;
|
|
556
|
+
};
|
|
310
557
|
}[];
|
|
311
558
|
};
|
|
312
559
|
unstable_prompts?: {
|
|
@@ -338,7 +585,7 @@ interface paths$1 {
|
|
|
338
585
|
500: components$1["responses"]["InternalServerError"];
|
|
339
586
|
};
|
|
340
587
|
};
|
|
341
|
-
/** @description Creates or updates a Mesh app definition on a team */
|
|
588
|
+
/** @description Creates or updates a Mesh app definition on a team. */
|
|
342
589
|
put: {
|
|
343
590
|
parameters: {
|
|
344
591
|
query?: never;
|
|
@@ -438,6 +685,10 @@ interface paths$1 {
|
|
|
438
685
|
name: string;
|
|
439
686
|
url: string;
|
|
440
687
|
iconUrl?: string;
|
|
688
|
+
access?: {
|
|
689
|
+
/** @enum {boolean} */
|
|
690
|
+
teamAdminRequired?: true;
|
|
691
|
+
};
|
|
441
692
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
442
693
|
}[];
|
|
443
694
|
personalization?: {
|
|
@@ -574,18 +825,30 @@ interface paths$1 {
|
|
|
574
825
|
name: string;
|
|
575
826
|
url: string;
|
|
576
827
|
iconUrl?: string;
|
|
828
|
+
access?: {
|
|
829
|
+
/** @enum {boolean} */
|
|
830
|
+
teamAdminRequired?: true;
|
|
831
|
+
};
|
|
577
832
|
}[];
|
|
578
833
|
projectTools?: {
|
|
579
834
|
id: string;
|
|
580
835
|
name: string;
|
|
581
836
|
url: string;
|
|
582
837
|
iconUrl?: string;
|
|
838
|
+
access?: {
|
|
839
|
+
/** @enum {boolean} */
|
|
840
|
+
teamAdminRequired?: true;
|
|
841
|
+
};
|
|
583
842
|
}[];
|
|
584
843
|
dashboardTools?: {
|
|
585
844
|
id: string;
|
|
586
845
|
name: string;
|
|
587
846
|
url: string;
|
|
588
847
|
iconUrl?: string;
|
|
848
|
+
access?: {
|
|
849
|
+
/** @enum {boolean} */
|
|
850
|
+
teamAdminRequired?: true;
|
|
851
|
+
};
|
|
589
852
|
}[];
|
|
590
853
|
};
|
|
591
854
|
unstable_prompts?: {
|
|
@@ -607,8 +870,6 @@ interface paths$1 {
|
|
|
607
870
|
parameterTypes: string[];
|
|
608
871
|
}[];
|
|
609
872
|
};
|
|
610
|
-
/** @description When true, regenerates the app secret for identity delegation. Only valid when identity delegation is enabled. */
|
|
611
|
-
regenerateSecret?: boolean;
|
|
612
873
|
};
|
|
613
874
|
};
|
|
614
875
|
};
|
|
@@ -709,6 +970,10 @@ interface paths$1 {
|
|
|
709
970
|
name: string;
|
|
710
971
|
url: string;
|
|
711
972
|
iconUrl?: string;
|
|
973
|
+
access?: {
|
|
974
|
+
/** @enum {boolean} */
|
|
975
|
+
teamAdminRequired?: true;
|
|
976
|
+
};
|
|
712
977
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
713
978
|
}[];
|
|
714
979
|
personalization?: {
|
|
@@ -845,18 +1110,30 @@ interface paths$1 {
|
|
|
845
1110
|
name: string;
|
|
846
1111
|
url: string;
|
|
847
1112
|
iconUrl?: string;
|
|
1113
|
+
access?: {
|
|
1114
|
+
/** @enum {boolean} */
|
|
1115
|
+
teamAdminRequired?: true;
|
|
1116
|
+
};
|
|
848
1117
|
}[];
|
|
849
1118
|
projectTools?: {
|
|
850
1119
|
id: string;
|
|
851
1120
|
name: string;
|
|
852
1121
|
url: string;
|
|
853
1122
|
iconUrl?: string;
|
|
1123
|
+
access?: {
|
|
1124
|
+
/** @enum {boolean} */
|
|
1125
|
+
teamAdminRequired?: true;
|
|
1126
|
+
};
|
|
854
1127
|
}[];
|
|
855
1128
|
dashboardTools?: {
|
|
856
1129
|
id: string;
|
|
857
1130
|
name: string;
|
|
858
1131
|
url: string;
|
|
859
1132
|
iconUrl?: string;
|
|
1133
|
+
access?: {
|
|
1134
|
+
/** @enum {boolean} */
|
|
1135
|
+
teamAdminRequired?: true;
|
|
1136
|
+
};
|
|
860
1137
|
}[];
|
|
861
1138
|
};
|
|
862
1139
|
unstable_prompts?: {
|
|
@@ -877,8 +1154,6 @@ interface paths$1 {
|
|
|
877
1154
|
} | null;
|
|
878
1155
|
parameterTypes: string[];
|
|
879
1156
|
}[];
|
|
880
|
-
/** @description Plaintext app secret for identity delegation. Only returned on create or when regenerateSecret is true. */
|
|
881
|
-
appSecret?: string;
|
|
882
1157
|
};
|
|
883
1158
|
};
|
|
884
1159
|
};
|
|
@@ -1225,6 +1500,7 @@ interface components {
|
|
|
1225
1500
|
|
|
1226
1501
|
type IntegrationDefinitionsApi = paths$1['/api/v1/integration-definitions'];
|
|
1227
1502
|
type IntegrationInstallationsApi = paths['/api/v1/integration-installations'];
|
|
1503
|
+
type IntegrationCredentialsApi = paths$2['/api/v1/integration-credentials'];
|
|
1228
1504
|
/** Query parameter options for GET /api/v1/integration-definitions */
|
|
1229
1505
|
type IntegrationDefinitionGetParameters = IntegrationDefinitionsApi['get']['parameters']['query'];
|
|
1230
1506
|
/** The GET response from /api/v1/integration-definitions */
|
|
@@ -1235,6 +1511,12 @@ type IntegrationDefinitionPutParameters = IntegrationDefinitionsApi['put']['requ
|
|
|
1235
1511
|
type IntegrationDefinitionPutResponse = IntegrationDefinitionsApi['put']['responses']['200']['content']['application/json'];
|
|
1236
1512
|
/** The DELETE body for /api/v1/integration-definitions */
|
|
1237
1513
|
type IntegrationDefinitionDeleteParameters = IntegrationDefinitionsApi['delete']['requestBody']['content']['application/json'];
|
|
1514
|
+
/** The POST body for /api/v1/integration-credentials (rotate or mint) */
|
|
1515
|
+
type IntegrationCredentialRotateParameters = IntegrationCredentialsApi['post']['requestBody']['content']['application/json'];
|
|
1516
|
+
/** The POST response for /api/v1/integration-credentials (returns the plaintext secret once) */
|
|
1517
|
+
type IntegrationCredentialRotateResponse = IntegrationCredentialsApi['post']['responses']['200']['content']['application/json'];
|
|
1518
|
+
/** The DELETE body for /api/v1/integration-credentials (revoke) */
|
|
1519
|
+
type IntegrationCredentialRevokeParameters = IntegrationCredentialsApi['delete']['requestBody']['content']['application/json'];
|
|
1238
1520
|
/** Query parameter options for GET /api/v1/integration-installations */
|
|
1239
1521
|
type IntegrationInstallationGetParameters = IntegrationInstallationsApi['get']['parameters']['query'];
|
|
1240
1522
|
/** The GET response from /api/v1/integration-installations */
|
|
@@ -1247,13 +1529,13 @@ type IntegrationInstallationDeleteParameters = IntegrationInstallationsApi['dele
|
|
|
1247
1529
|
type DefClientOptions = Omit<ClientOptions, 'apiKey' | 'projectId'> & {
|
|
1248
1530
|
teamId: string;
|
|
1249
1531
|
};
|
|
1250
|
-
/** API Client to manage the registration of custom Mesh applications */
|
|
1532
|
+
/** API Client to manage the registration of custom Mesh applications and their identity-delegation credentials. */
|
|
1251
1533
|
declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
1252
1534
|
#private;
|
|
1253
1535
|
constructor(options: DefClientOptions);
|
|
1254
1536
|
/** Fetches all mesh apps for a team (and optionally also those shared across teams) */
|
|
1255
1537
|
get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
|
|
1256
|
-
/** Creates or updates a mesh app definition on a team */
|
|
1538
|
+
/** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link rotateCredential}. */
|
|
1257
1539
|
upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
|
|
1258
1540
|
type: string;
|
|
1259
1541
|
displayName: string;
|
|
@@ -1332,6 +1614,9 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1332
1614
|
name: string;
|
|
1333
1615
|
url: string;
|
|
1334
1616
|
iconUrl?: string;
|
|
1617
|
+
access?: {
|
|
1618
|
+
teamAdminRequired?: true;
|
|
1619
|
+
};
|
|
1335
1620
|
editorTypes?: ("composition" | "componentPattern" | "compositionDefaults" | "entry" | "entryPattern")[];
|
|
1336
1621
|
}[];
|
|
1337
1622
|
personalization?: {
|
|
@@ -1459,18 +1744,27 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1459
1744
|
name: string;
|
|
1460
1745
|
url: string;
|
|
1461
1746
|
iconUrl?: string;
|
|
1747
|
+
access?: {
|
|
1748
|
+
teamAdminRequired?: true;
|
|
1749
|
+
};
|
|
1462
1750
|
}[];
|
|
1463
1751
|
projectTools?: {
|
|
1464
1752
|
id: string;
|
|
1465
1753
|
name: string;
|
|
1466
1754
|
url: string;
|
|
1467
1755
|
iconUrl?: string;
|
|
1756
|
+
access?: {
|
|
1757
|
+
teamAdminRequired?: true;
|
|
1758
|
+
};
|
|
1468
1759
|
}[];
|
|
1469
1760
|
dashboardTools?: {
|
|
1470
1761
|
id: string;
|
|
1471
1762
|
name: string;
|
|
1472
1763
|
url: string;
|
|
1473
1764
|
iconUrl?: string;
|
|
1765
|
+
access?: {
|
|
1766
|
+
teamAdminRequired?: true;
|
|
1767
|
+
};
|
|
1474
1768
|
}[];
|
|
1475
1769
|
};
|
|
1476
1770
|
unstable_prompts?: {
|
|
@@ -1490,10 +1784,22 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
|
|
|
1490
1784
|
} | null;
|
|
1491
1785
|
parameterTypes: string[];
|
|
1492
1786
|
}[];
|
|
1493
|
-
appSecret?: string;
|
|
1494
1787
|
}>;
|
|
1495
1788
|
/** Deletes a mesh app from a team */
|
|
1496
1789
|
remove(body: Omit<IntegrationDefinitionDeleteParameters, 'teamId'>): Promise<void>;
|
|
1790
|
+
/**
|
|
1791
|
+
* Mints or rotates an identity-delegation credential for an integration definition. The plaintext
|
|
1792
|
+
* `appSecret` is returned exactly once and is not retrievable afterwards — Uniform stores only
|
|
1793
|
+
* the hash. A successful response invalidates any previously-issued secret of the same kind.
|
|
1794
|
+
* Caller must be a team admin.
|
|
1795
|
+
*/
|
|
1796
|
+
rotateCredential(body: Omit<IntegrationCredentialRotateParameters, 'teamId'>): Promise<IntegrationCredentialRotateResponse>;
|
|
1797
|
+
/**
|
|
1798
|
+
* Revokes an identity-delegation credential. Future delegation grants and refreshes will fail
|
|
1799
|
+
* until a new credential is minted; in-flight delegation tokens remain valid until natural
|
|
1800
|
+
* expiry (up to ~15 minutes). Caller must be a team admin.
|
|
1801
|
+
*/
|
|
1802
|
+
revokeCredential(body: Omit<IntegrationCredentialRevokeParameters, 'teamId'>): Promise<void>;
|
|
1497
1803
|
}
|
|
1498
1804
|
|
|
1499
1805
|
/** API Client to manage the registration of custom Mesh applications */
|
|
@@ -1869,6 +2175,8 @@ interface MeshParentConnection {
|
|
|
1869
2175
|
/**
|
|
1870
2176
|
* Returns a short-lived session token for identity delegation, or `undefined` when delegation
|
|
1871
2177
|
* is not enabled for this integration.
|
|
2178
|
+
*
|
|
2179
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
1872
2180
|
*/
|
|
1873
2181
|
getSessionToken: () => Promise<string | undefined>;
|
|
1874
2182
|
}
|
|
@@ -2275,6 +2583,8 @@ interface UniformMeshSDK {
|
|
|
2275
2583
|
* Call this on demand — the token has a very short TTL (~10 s) and should be
|
|
2276
2584
|
* consumed immediately by your backend to exchange for a delegation token
|
|
2277
2585
|
* via `POST /api/v1/token` with `grant_type=delegation_token` or DelegationTokenClient.
|
|
2586
|
+
*
|
|
2587
|
+
* @deprecated This beta identity delegation API may change with breaking changes.
|
|
2278
2588
|
*/
|
|
2279
2589
|
getSessionToken(): Promise<string | undefined>;
|
|
2280
2590
|
}
|
|
@@ -2297,4 +2607,4 @@ declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLo
|
|
|
2297
2607
|
*/
|
|
2298
2608
|
declare const hasRole: (role: string, user: UniformUser) => boolean;
|
|
2299
2609
|
|
|
2300
|
-
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, 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 DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, DelegationTokenClient, type DelegationTokenClientOptions, type DelegationTokenResponse, 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 EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, 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 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 SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|
|
2610
|
+
export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, 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 DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, DelegationTokenClient, type DelegationTokenClientOptions, DelegationTokenError, type DelegationTokenErrorKind, type DelegationTokenResponse, 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 EmbeddedEditorLocation, type EmbeddedEditorLocationMetadata, type EmbeddedEditorLocationSetValue, type EmbeddedEditorLocationValue, type FunctionCallResponse, type FunctionCallSystemParameter, type GetDataResourceLocation, type GetDataResourceMessage, 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 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 SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, functionCallSystemParameters, hasPermissions, hasRole, initializeUniformMeshSDK, parseFunctionCall };
|