@uniformdev/project-map 19.195.0 → 19.195.1-alpha.3

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +667 -335
  2. package/dist/index.d.ts +667 -335
  3. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -1,42 +1,73 @@
1
1
  import { ApiClient } from '@uniformdev/context/api';
2
2
  import { RouteGetResponse } from '@uniformdev/canvas';
3
3
 
4
- /**
5
- * This file was auto-generated by openapi-typescript.
6
- * Do not make direct changes to the file.
7
- */
8
4
  interface paths$1 {
9
5
  "/api/v1/project-map": {
10
- /** Called to retrieve a list of project maps related to a project or a specific project map by id */
6
+ parameters: {
7
+ query?: never;
8
+ header?: never;
9
+ path?: never;
10
+ cookie?: never;
11
+ };
12
+ /** @description Called to retrieve a list of project maps related to a project or a specific project map by id */
11
13
  get: {
12
14
  parameters: {
13
15
  query: {
14
- /** The project to fetch project map for */
16
+ /** @description The project to fetch project map for */
15
17
  projectId: string;
16
- /** The id of the project map to fetch */
18
+ /** @description The id of the project map to fetch */
17
19
  projectMapId?: string;
18
20
  };
21
+ header?: never;
22
+ path?: never;
23
+ cookie?: never;
19
24
  };
25
+ requestBody?: never;
20
26
  responses: {
21
- /** OK */
27
+ /** @description OK */
22
28
  200: {
29
+ headers: {
30
+ [name: string]: unknown;
31
+ };
23
32
  content: {
24
33
  "application/json": {
25
- projectMaps: components$1["schemas"]["ProjectMapDefinition"][];
34
+ projectMaps: components$2["schemas"]["ProjectMapDefinition"][];
26
35
  };
27
36
  };
28
37
  };
29
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
30
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
31
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
32
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
33
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
38
+ 400: components$2["responses"]["BadRequestError"];
39
+ 401: components$2["responses"]["UnauthorizedError"];
40
+ 403: components$2["responses"]["ForbiddenError"];
41
+ 429: components$2["responses"]["RateLimitError"];
42
+ 500: components$2["responses"]["InternalServerError"];
34
43
  };
35
44
  };
36
45
  put: {
46
+ parameters: {
47
+ query?: never;
48
+ header?: never;
49
+ path?: never;
50
+ cookie?: never;
51
+ };
52
+ requestBody: {
53
+ content: {
54
+ "application/json": {
55
+ /** @description Project map object to insert */
56
+ projectMap: components$2["schemas"]["ProjectMapDefinition"];
57
+ /**
58
+ * Format: uuid
59
+ * @description Project id to insert the projectMap into
60
+ */
61
+ projectId: string;
62
+ };
63
+ };
64
+ };
37
65
  responses: {
38
- /** OK */
66
+ /** @description OK */
39
67
  200: {
68
+ headers: {
69
+ [name: string]: unknown;
70
+ };
40
71
  content: {
41
72
  "application/json": {
42
73
  /**
@@ -47,38 +78,28 @@ interface paths$1 {
47
78
  };
48
79
  };
49
80
  };
50
- /** OK */
51
- 204: never;
52
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
53
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
54
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
55
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
56
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
57
- };
58
- requestBody: {
59
- content: {
60
- "application/json": {
61
- /** @description Project map object to insert */
62
- projectMap: components$1["schemas"]["ProjectMapDefinition"];
63
- /**
64
- * Format: uuid
65
- * @description Project id to insert the projectMap into
66
- */
67
- projectId: string;
81
+ /** @description OK */
82
+ 204: {
83
+ headers: {
84
+ [name: string]: unknown;
68
85
  };
86
+ content?: never;
69
87
  };
88
+ 400: components$2["responses"]["BadRequestError"];
89
+ 401: components$2["responses"]["UnauthorizedError"];
90
+ 403: components$2["responses"]["ForbiddenError"];
91
+ 429: components$2["responses"]["RateLimitError"];
92
+ 500: components$2["responses"]["InternalServerError"];
70
93
  };
71
94
  };
72
- /** Called to delete a projectMap */
95
+ post?: never;
96
+ /** @description Called to delete a projectMap */
73
97
  delete: {
74
- responses: {
75
- /** OK */
76
- 204: never;
77
- 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
78
- 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
79
- 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
80
- 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
81
- 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
98
+ parameters: {
99
+ query?: never;
100
+ header?: never;
101
+ path?: never;
102
+ cookie?: never;
82
103
  };
83
104
  requestBody: {
84
105
  content: {
@@ -96,17 +117,46 @@ interface paths$1 {
96
117
  };
97
118
  };
98
119
  };
120
+ responses: {
121
+ /** @description OK */
122
+ 204: {
123
+ headers: {
124
+ [name: string]: unknown;
125
+ };
126
+ content?: never;
127
+ };
128
+ 400: components$2["responses"]["BadRequestError"];
129
+ 401: components$2["responses"]["UnauthorizedError"];
130
+ 403: components$2["responses"]["ForbiddenError"];
131
+ 429: components$2["responses"]["RateLimitError"];
132
+ 500: components$2["responses"]["InternalServerError"];
133
+ };
99
134
  };
100
- /** Handles preflight requests. This endpoint allows CORS */
135
+ /** @description Handles preflight requests. This endpoint allows CORS */
101
136
  options: {
137
+ parameters: {
138
+ query?: never;
139
+ header?: never;
140
+ path?: never;
141
+ cookie?: never;
142
+ };
143
+ requestBody?: never;
102
144
  responses: {
103
- /** OK */
104
- 204: never;
145
+ /** @description OK */
146
+ 204: {
147
+ headers: {
148
+ [name: string]: unknown;
149
+ };
150
+ content?: never;
151
+ };
105
152
  };
106
153
  };
154
+ head?: never;
155
+ patch?: never;
156
+ trace?: never;
107
157
  };
108
158
  }
109
- interface components$1 {
159
+ interface components$2 {
110
160
  schemas: {
111
161
  ProjectMapDefinition: {
112
162
  /** @description The id of the projectMap node */
@@ -119,228 +169,61 @@ interface components$1 {
119
169
  baseUrl?: string;
120
170
  default?: boolean;
121
171
  };
172
+ Error: {
173
+ /** @description Error message(s) that occurred while processing the request */
174
+ errorMessage?: string[] | string;
175
+ };
122
176
  };
123
- }
124
- interface external$1 {
125
- "swagger.yml": {
126
- paths: {};
127
- components: {
128
- schemas: {
129
- Error: {
130
- /** @description Error message(s) that occurred while processing the request */
131
- errorMessage?: string[] | string;
132
- };
177
+ responses: {
178
+ /** @description Request input validation failed */
179
+ BadRequestError: {
180
+ headers: {
181
+ [name: string]: unknown;
133
182
  };
134
- responses: {
135
- /** Request input validation failed */
136
- BadRequestError: {
137
- content: {
138
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
139
- };
140
- };
141
- /** API key or token was not valid */
142
- UnauthorizedError: {
143
- content: {
144
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
145
- };
146
- };
147
- /** Permission was denied */
148
- ForbiddenError: {
149
- content: {
150
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
151
- };
152
- };
153
- /** Resource not found */
154
- NotFoundError: {
155
- content: {
156
- "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
157
- };
158
- };
159
- /** Too many requests in allowed time period */
160
- RateLimitError: unknown;
161
- /** Execution error occurred */
162
- InternalServerError: unknown;
183
+ content: {
184
+ "application/json": components$2["schemas"]["Error"];
163
185
  };
164
186
  };
165
- operations: {};
166
- };
167
- }
168
-
169
- /**
170
- * This file was auto-generated by openapi-typescript.
171
- * Do not make direct changes to the file.
172
- */
173
- interface paths {
174
- "/api/v1/project-map-nodes": {
175
- /** Called to get a list of nodes belonging to a specific path or Id */
176
- get: {
177
- parameters: {
178
- query: {
179
- /** The project map id that the desired nodes belong */
180
- projectMapId?: string;
181
- /** The project id that contains the project map tree that this node belongs to */
182
- projectId: string;
183
- /**
184
- * The ID of a release to fetch the composition data for.
185
- *
186
- * - When unspecified, composition data is fetched from base.
187
- * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
188
- *
189
- * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
190
- */
191
- releaseId?: string;
192
- /** The id of the node to retrieve, cannot have both this parameter and `path` */
193
- id?: string;
194
- /** The path of the root node to retrieve, cannot have both this parameter and `id` */
195
- path?: string;
196
- /** Composition id to find associated project map node for */
197
- compositionId?: string;
198
- /** Limit the number or records returned by a number */
199
- limit?: number;
200
- /** Number of records to skip before returning nodes */
201
- offset?: number;
202
- /** Depth of the tree to fetch. This only applies when fetching by path */
203
- depth?: number;
204
- /** State of compositions to fetch. 0 = draft, 64 = published */
205
- state?: number;
206
- /** should the data be returned as a json tree object (or a flat array) */
207
- tree?: boolean;
208
- /** text search filter */
209
- search?: string;
210
- /**
211
- * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
212
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
213
- */
214
- includeAncestors?: boolean;
215
- /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
216
- expanded?: boolean;
217
- /** include basic composition information. ID, type, state, name, and definition id */
218
- withCompositionData?: boolean;
219
- /**
220
- * @deprecated Returns the UI status string of the composition.
221
- * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
222
- */
223
- withCompositionUIStatus?: boolean;
224
- /** Include basic redirect information */
225
- withRedirectData?: boolean;
226
- };
187
+ /** @description API key or token was not valid */
188
+ UnauthorizedError: {
189
+ headers: {
190
+ [name: string]: unknown;
227
191
  };
228
- responses: {
229
- /** OK */
230
- 200: {
231
- content: {
232
- "application/json": {
233
- nodes?: components["schemas"]["ProjectMapNodeDefinition"][];
234
- tree?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
235
- };
236
- };
237
- };
238
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
239
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
240
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
241
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
242
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
192
+ content: {
193
+ "application/json": components$2["schemas"]["Error"];
243
194
  };
244
195
  };
245
- /** Called to insert or update a node or nodes */
246
- put: {
247
- responses: {
248
- /** OK */
249
- 204: never;
250
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
251
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
252
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
253
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
254
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
196
+ /** @description Permission was denied */
197
+ ForbiddenError: {
198
+ headers: {
199
+ [name: string]: unknown;
255
200
  };
256
- requestBody: {
257
- content: {
258
- "application/json": {
259
- /** @description An array of projectMap node objects to be updated or inserted */
260
- nodes: {
261
- node: components["schemas"]["ProjectMapNodeUpdate"];
262
- /** @description The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
263
- previousSibling?: string;
264
- /** @description The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
265
- nextSibling?: string;
266
- }[];
267
- /**
268
- * Format: uuid
269
- * @description The project id of the project that the projectMap belongs to
270
- */
271
- projectId: string;
272
- /**
273
- * Format: uuid
274
- * @description The projectMap id that the changing or inserting nodes belong to
275
- */
276
- projectMapId?: string;
277
- };
278
- };
201
+ content: {
202
+ "application/json": components$2["schemas"]["Error"];
279
203
  };
280
204
  };
281
- /** Called to delete a particular projectMap node by id or path */
282
- delete: {
283
- responses: {
284
- /** OK */
285
- 204: never;
286
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
287
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
288
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
289
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
290
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
291
- };
292
- requestBody: {
293
- content: {
294
- "application/json": {
295
- /**
296
- * Format: uuid
297
- * @description Id of the projectMap node to delete
298
- */
299
- nodeId?: string;
300
- /** @description Path to the projectMap node to delete */
301
- path: string;
302
- /**
303
- * Format: uuid
304
- * @description Project map id that the node to delete belongs to
305
- */
306
- projectMapId?: string;
307
- /**
308
- * Format: uuid
309
- * @description Project id that the project map belongs to
310
- */
311
- projectId: string;
312
- } | {
313
- /**
314
- * Format: uuid
315
- * @description Id of the projectMap node to delete
316
- */
317
- nodeId: string;
318
- /** @description Path to the projectMap node to delete */
319
- path?: string;
320
- /**
321
- * Format: uuid
322
- * @description Project map id that the node to delete belongs to
323
- */
324
- projectMapId?: string;
325
- /**
326
- * Format: uuid
327
- * @description Project id that the project map belongs to
328
- */
329
- projectId: string;
330
- };
331
- };
205
+ /** @description Too many requests in allowed time period */
206
+ RateLimitError: {
207
+ headers: {
208
+ [name: string]: unknown;
332
209
  };
210
+ content?: never;
333
211
  };
334
- /** Handles preflight requests. This endpoint allows CORS */
335
- options: {
336
- responses: {
337
- /** OK */
338
- 204: never;
212
+ /** @description Execution error occurred */
213
+ InternalServerError: {
214
+ headers: {
215
+ [name: string]: unknown;
339
216
  };
217
+ content?: never;
340
218
  };
341
219
  };
220
+ parameters: never;
221
+ requestBodies: never;
222
+ headers: never;
223
+ pathItems: never;
342
224
  }
343
- interface components {
225
+
226
+ interface components$1 {
344
227
  schemas: {
345
228
  ProjectMapNodeDefinition: {
346
229
  /**
@@ -352,7 +235,7 @@ interface components {
352
235
  path: string;
353
236
  /** @description Ordering of the node, higher numbers go after lower numbers */
354
237
  order?: number;
355
- data?: components["schemas"]["ProjectMapNodeData"];
238
+ data?: components$1["schemas"]["ProjectMapNodeData"];
356
239
  /** @description The name of the projectMap entry */
357
240
  name: string;
358
241
  /**
@@ -373,11 +256,11 @@ interface components {
373
256
  pathSegment?: string;
374
257
  /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
375
258
  isLeaf?: boolean;
376
- compositionData?: components["schemas"]["ProjectMapNodeCompositionData"];
377
- sourceRedirects?: components["schemas"]["ProjectMapSourceRedirectData"];
378
- targetRedirects?: components["schemas"]["ProjectMapTargetRedirectData"];
259
+ compositionData?: components$1["schemas"]["ProjectMapNodeCompositionData"];
260
+ sourceRedirects?: components$1["schemas"]["ProjectMapSourceRedirectData"];
261
+ targetRedirects?: components$1["schemas"]["ProjectMapTargetRedirectData"];
379
262
  locales?: {
380
- [key: string]: components["schemas"]["ProjectMapNodeLocale"];
263
+ [key: string]: components$1["schemas"]["ProjectMapNodeLocale"];
381
264
  };
382
265
  };
383
266
  ProjectMapNodeLocale: {
@@ -387,15 +270,14 @@ interface components {
387
270
  path?: string;
388
271
  /** @description Last segment of the url in this locale */
389
272
  pathSegment: string;
390
- /**
391
- * @description When false, the node explicitly defines a locale-specific path segment.
273
+ /** @description When false, the node explicitly defines a locale-specific path segment.
392
274
  *
393
- * When true, an ancestor defines a locale-specific path segment,
394
- * which makes its descendants resolvable using that segment.
395
- * This node does not define a locale-specific path segment.
275
+ * When true, an ancestor defines a locale-specific path segment,
276
+ * which makes its descendants resolvable using that segment.
277
+ * This node does not define a locale-specific path segment.
396
278
  *
397
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
398
- */
279
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
280
+ * */
399
281
  inherited?: boolean;
400
282
  };
401
283
  ProjectMapSourceRedirectData: {
@@ -412,10 +294,9 @@ interface components {
412
294
  */
413
295
  id?: string;
414
296
  }[];
415
- /**
416
- * @description Basic information about the linked composition from the context of a project map node.
417
- * If the linked composition has editions, the editions are included in the `editions` property.
418
- */
297
+ /** @description Basic information about the linked composition from the context of a project map node.
298
+ * If the linked composition has editions, the editions are included in the `editions` property.
299
+ * */
419
300
  ProjectMapNodeCompositionData: {
420
301
  /** @description Type of the linked composition (id of its definition) */
421
302
  type: string;
@@ -427,7 +308,8 @@ interface components {
427
308
  /**
428
309
  * Format: uuid
429
310
  * @description The edition UUID underneath the linked composition
430
- * This is only present if the composition has not been published, but an edition has
311
+ * This is only present if the composition has not been published, but an edition has
312
+ *
431
313
  */
432
314
  editionId?: string;
433
315
  /** @description Slug pattern of the linked composition or edition */
@@ -447,10 +329,9 @@ interface components {
447
329
  icon?: string;
448
330
  /** @description Friendly name of this Composition's Definition */
449
331
  typeName?: string;
450
- /**
451
- * @description List of locales that the composition _or any of its editions_ is available in.
452
- * If empty, available in all locales.
453
- */
332
+ /** @description List of locales that the composition _or any of its editions_ is available in.
333
+ * If empty, available in all locales.
334
+ * */
454
335
  locales: string[];
455
336
  /** @description Priority of the composition relative to any editions */
456
337
  editionPriority?: number;
@@ -459,9 +340,10 @@ interface components {
459
340
  /**
460
341
  * @deprecated
461
342
  * @description List of editions available for this composition. The composition is included in the list, it is the edition
462
- * where the editionID equals the node's compositionID.
343
+ * where the editionID equals the node's compositionID.
344
+ *
463
345
  */
464
- editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
346
+ editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
465
347
  };
466
348
  /**
467
349
  * @deprecated
@@ -519,7 +401,7 @@ interface components {
519
401
  path: string;
520
402
  /** @description Ordering of the node, higher numbers go after lower numbers */
521
403
  order?: number;
522
- data?: components["schemas"]["ProjectMapNodeData"];
404
+ data?: components$1["schemas"]["ProjectMapNodeData"];
523
405
  /** @description The name of the projectMap entry */
524
406
  name: string;
525
407
  /**
@@ -535,7 +417,7 @@ interface components {
535
417
  /** @description Description of the projectMap node */
536
418
  description?: string;
537
419
  locales?: {
538
- [key: string]: components["schemas"]["ProjectMapNodeLocaleUpdate"];
420
+ [key: string]: components$1["schemas"]["ProjectMapNodeLocaleUpdate"];
539
421
  };
540
422
  };
541
423
  ProjectMapNodeLocaleUpdate: {
@@ -548,12 +430,11 @@ interface components {
548
430
  /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
549
431
  isSearchHit?: boolean;
550
432
  /** @description Query strings that are allowed to be passed to the node */
551
- queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
552
- /**
553
- * @description For dynamic nodes, this is the preview value for the dynamic value.
554
- * The preview value is used when editing a connected composition, and is the default
555
- * dynamic node value unless the author has explicitly chosen a different value
556
- */
433
+ queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
434
+ /** @description For dynamic nodes, this is the preview value for the dynamic value.
435
+ * The preview value is used when editing a connected composition, and is the default
436
+ * dynamic node value unless the author has explicitly chosen a different value
437
+ * */
557
438
  previewValue?: string;
558
439
  };
559
440
  ProjectMapNodeAllowedQueryString: {
@@ -565,65 +446,516 @@ interface components {
565
446
  helpText?: string;
566
447
  };
567
448
  };
449
+ responses: never;
450
+ parameters: never;
451
+ requestBodies: never;
452
+ headers: never;
453
+ pathItems: never;
568
454
  }
569
- interface external {
570
- "swagger.yml": {
571
- paths: {};
572
- components: {
573
- schemas: {
574
- Error: {
575
- /** @description Error message(s) that occurred while processing the request */
576
- errorMessage?: string[] | string;
455
+
456
+ interface paths {
457
+ "/api/v1/project-map-nodes": {
458
+ parameters: {
459
+ query?: never;
460
+ header?: never;
461
+ path?: never;
462
+ cookie?: never;
463
+ };
464
+ /** @description Called to get a list of nodes belonging to a specific path or Id */
465
+ get: {
466
+ parameters: {
467
+ query: {
468
+ /** @description The project map id that the desired nodes belong */
469
+ projectMapId?: string;
470
+ /** @description The project id that contains the project map tree that this node belongs to */
471
+ projectId: string;
472
+ /** @description The ID of a release to fetch the composition data for.
473
+ *
474
+ * - When unspecified, composition data is fetched from base.
475
+ * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
476
+ *
477
+ * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will not be defined
478
+ * */
479
+ releaseId?: string;
480
+ /** @description The id of the node to retrieve, cannot have both this parameter and `path` */
481
+ id?: string;
482
+ /** @description The path of the root node to retrieve, cannot have both this parameter and `id` */
483
+ path?: string;
484
+ /** @description Composition id to find associated project map node for */
485
+ compositionId?: string;
486
+ /** @description Limit the number or records returned by a number */
487
+ limit?: number;
488
+ /** @description Number of records to skip before returning nodes */
489
+ offset?: number;
490
+ /** @description Depth of the tree to fetch. This only applies when fetching by path */
491
+ depth?: number;
492
+ /** @description State of compositions to fetch. 0 = draft, 64 = published */
493
+ state?: number;
494
+ /** @description should the data be returned as a json tree object (or a flat array) */
495
+ tree?: boolean;
496
+ /** @description text search filter */
497
+ search?: string;
498
+ /** @description Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
499
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
500
+ * */
501
+ includeAncestors?: boolean;
502
+ /** @description include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
503
+ expanded?: boolean;
504
+ /** @description include basic composition information. ID, type, state, name, and definition id */
505
+ withCompositionData?: boolean;
506
+ /**
507
+ * @deprecated
508
+ * @description Returns the UI status string of the composition.
509
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
510
+ *
511
+ */
512
+ withCompositionUIStatus?: boolean;
513
+ /** @description Include basic redirect information */
514
+ withRedirectData?: boolean;
577
515
  };
516
+ header?: never;
517
+ path?: never;
518
+ cookie?: never;
578
519
  };
520
+ requestBody?: never;
579
521
  responses: {
580
- /** Request input validation failed */
581
- BadRequestError: {
582
- content: {
583
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
584
- };
585
- };
586
- /** API key or token was not valid */
587
- UnauthorizedError: {
588
- content: {
589
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
590
- };
591
- };
592
- /** Permission was denied */
593
- ForbiddenError: {
594
- content: {
595
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
522
+ /** @description OK */
523
+ 200: {
524
+ headers: {
525
+ [name: string]: unknown;
596
526
  };
597
- };
598
- /** Resource not found */
599
- NotFoundError: {
600
527
  content: {
601
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
528
+ "application/json": {
529
+ nodes?: components["schemas"]["ProjectMapNodeDefinition"][];
530
+ tree?: components["schemas"]["ProjectMapTreeNodeDefinition"];
531
+ };
602
532
  };
603
533
  };
604
- /** Too many requests in allowed time period */
605
- RateLimitError: unknown;
606
- /** Execution error occurred */
607
- InternalServerError: unknown;
534
+ 400: components["responses"]["BadRequestError"];
535
+ 401: components["responses"]["UnauthorizedError"];
536
+ 403: components["responses"]["ForbiddenError"];
537
+ 429: components["responses"]["RateLimitError"];
538
+ 500: components["responses"]["InternalServerError"];
608
539
  };
609
540
  };
610
- operations: {};
611
- };
612
- "v1-project-map-tree.swagger.yml": {
613
- paths: {};
614
- components: {
615
- schemas: {
616
- ProjectMapTreeNodeDefinition: components["schemas"]["ProjectMapNodeDefinition"] & {
617
- /** @description Children of the node */
618
- children?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
619
- } & {
620
- name: unknown;
621
- };
541
+ /** @description Called to insert or update a node or nodes */
542
+ put: {
543
+ parameters: {
544
+ query?: never;
545
+ header?: never;
546
+ path?: never;
547
+ cookie?: never;
622
548
  };
623
- };
624
- operations: {};
625
- };
626
- }
549
+ requestBody: {
550
+ content: {
551
+ "application/json": {
552
+ /** @description An array of projectMap node objects to be updated or inserted */
553
+ nodes: {
554
+ node: components["schemas"]["ProjectMapNodeUpdate"];
555
+ /** @description The path of the node directly prior to the location where the current node is desired to go or undefined if there isn't one */
556
+ previousSibling?: string;
557
+ /** @description The path of the node directly after the location where the current node is desired to go or undefined if there isn't one */
558
+ nextSibling?: string;
559
+ }[];
560
+ /**
561
+ * Format: uuid
562
+ * @description The project id of the project that the projectMap belongs to
563
+ */
564
+ projectId: string;
565
+ /**
566
+ * Format: uuid
567
+ * @description The projectMap id that the changing or inserting nodes belong to
568
+ */
569
+ projectMapId?: string;
570
+ };
571
+ };
572
+ };
573
+ responses: {
574
+ /** @description OK */
575
+ 204: {
576
+ headers: {
577
+ [name: string]: unknown;
578
+ };
579
+ content?: never;
580
+ };
581
+ 400: components["responses"]["BadRequestError"];
582
+ 401: components["responses"]["UnauthorizedError"];
583
+ 403: components["responses"]["ForbiddenError"];
584
+ 429: components["responses"]["RateLimitError"];
585
+ 500: components["responses"]["InternalServerError"];
586
+ };
587
+ };
588
+ post?: never;
589
+ /** @description Called to delete a particular projectMap node by id or path */
590
+ delete: {
591
+ parameters: {
592
+ query?: never;
593
+ header?: never;
594
+ path?: never;
595
+ cookie?: never;
596
+ };
597
+ requestBody: {
598
+ content: {
599
+ "application/json": {
600
+ /**
601
+ * Format: uuid
602
+ * @description Id of the projectMap node to delete
603
+ */
604
+ nodeId?: string;
605
+ /** @description Path to the projectMap node to delete */
606
+ path: string;
607
+ /**
608
+ * Format: uuid
609
+ * @description Project map id that the node to delete belongs to
610
+ */
611
+ projectMapId?: string;
612
+ /**
613
+ * Format: uuid
614
+ * @description Project id that the project map belongs to
615
+ */
616
+ projectId: string;
617
+ } | {
618
+ /**
619
+ * Format: uuid
620
+ * @description Id of the projectMap node to delete
621
+ */
622
+ nodeId: string;
623
+ /** @description Path to the projectMap node to delete */
624
+ path?: string;
625
+ /**
626
+ * Format: uuid
627
+ * @description Project map id that the node to delete belongs to
628
+ */
629
+ projectMapId?: string;
630
+ /**
631
+ * Format: uuid
632
+ * @description Project id that the project map belongs to
633
+ */
634
+ projectId: string;
635
+ };
636
+ };
637
+ };
638
+ responses: {
639
+ /** @description OK */
640
+ 204: {
641
+ headers: {
642
+ [name: string]: unknown;
643
+ };
644
+ content?: never;
645
+ };
646
+ 400: components["responses"]["BadRequestError"];
647
+ 401: components["responses"]["UnauthorizedError"];
648
+ 403: components["responses"]["ForbiddenError"];
649
+ 429: components["responses"]["RateLimitError"];
650
+ 500: components["responses"]["InternalServerError"];
651
+ };
652
+ };
653
+ /** @description Handles preflight requests. This endpoint allows CORS */
654
+ options: {
655
+ parameters: {
656
+ query?: never;
657
+ header?: never;
658
+ path?: never;
659
+ cookie?: never;
660
+ };
661
+ requestBody?: never;
662
+ responses: {
663
+ /** @description OK */
664
+ 204: {
665
+ headers: {
666
+ [name: string]: unknown;
667
+ };
668
+ content?: never;
669
+ };
670
+ };
671
+ };
672
+ head?: never;
673
+ patch?: never;
674
+ trace?: never;
675
+ };
676
+ }
677
+ interface components {
678
+ schemas: {
679
+ ProjectMapNodeAllowedQueryString: {
680
+ /** @description The name of the query string parameter */
681
+ name: string;
682
+ /** @description The default value of the query string if it is not provided by an incoming route path */
683
+ value?: string;
684
+ /** @description Help text for authors who might be setting up a preview value for this query string */
685
+ helpText?: string;
686
+ };
687
+ ProjectMapNodeData: {
688
+ /** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
689
+ isSearchHit?: boolean;
690
+ /** @description Query strings that are allowed to be passed to the node */
691
+ queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
692
+ /** @description For dynamic nodes, this is the preview value for the dynamic value.
693
+ * The preview value is used when editing a connected composition, and is the default
694
+ * dynamic node value unless the author has explicitly chosen a different value
695
+ * */
696
+ previewValue?: string;
697
+ };
698
+ /**
699
+ * @deprecated
700
+ * @description Basic information about a composition edition from the context of a project map node
701
+ */
702
+ ProjectMapNodeCompositionEditionData: {
703
+ /**
704
+ * Format: uuid
705
+ * @description The UUID of the linked composition
706
+ */
707
+ id: string;
708
+ /** @description Type of the edition instance (public_id of its definition) */
709
+ type: string;
710
+ /**
711
+ * Format: uuid
712
+ * @description The edition UUID underneath the linked composition
713
+ */
714
+ editionId?: string;
715
+ /** @description Slug pattern of this edition */
716
+ slug?: string | null;
717
+ /** @description Friendly name of the linked composition */
718
+ name: string;
719
+ /** @description Friendly name of the edition */
720
+ editionName?: string;
721
+ /** @description Priority of the edition */
722
+ editionPriority?: number;
723
+ /**
724
+ * @deprecated
725
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
726
+ * @enum {string}
727
+ */
728
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
729
+ /**
730
+ * @description Icon name or URL for the composition edition (e.g. 'screen' or 'https://s3/my-component.jpg')
731
+ * @default screen
732
+ */
733
+ icon?: string;
734
+ /** @description Friendly name of this edition's definition */
735
+ typeName?: string;
736
+ /** @description List of locales that the edition is available in. If empty, available in all locales */
737
+ locales: string[];
738
+ /**
739
+ * Format: date-time
740
+ * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
741
+ */
742
+ modified?: string;
743
+ };
744
+ /** @description Basic information about the linked composition from the context of a project map node.
745
+ * If the linked composition has editions, the editions are included in the `editions` property.
746
+ * */
747
+ ProjectMapNodeCompositionData: {
748
+ /** @description Type of the linked composition (id of its definition) */
749
+ type: string;
750
+ /**
751
+ * Format: uuid
752
+ * @description The UUID of the linked composition
753
+ */
754
+ id: string;
755
+ /**
756
+ * Format: uuid
757
+ * @description The edition UUID underneath the linked composition
758
+ * This is only present if the composition has not been published, but an edition has
759
+ *
760
+ */
761
+ editionId?: string;
762
+ /** @description Slug pattern of the linked composition or edition */
763
+ slug?: string | null;
764
+ /** @description Friendly name of this composition or edition */
765
+ name: string;
766
+ /**
767
+ * @deprecated
768
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
769
+ * @enum {string}
770
+ */
771
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
772
+ /**
773
+ * @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
774
+ * @default screen
775
+ */
776
+ icon?: string;
777
+ /** @description Friendly name of this Composition's Definition */
778
+ typeName?: string;
779
+ /** @description List of locales that the composition _or any of its editions_ is available in.
780
+ * If empty, available in all locales.
781
+ * */
782
+ locales: string[];
783
+ /** @description Priority of the composition relative to any editions */
784
+ editionPriority?: number;
785
+ /** @description Friendly name of the edition */
786
+ editionName?: string;
787
+ /**
788
+ * @deprecated
789
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
790
+ * where the editionID equals the node's compositionID.
791
+ *
792
+ */
793
+ editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
794
+ };
795
+ ProjectMapSourceRedirectData: {
796
+ /**
797
+ * Format: uuid
798
+ * @description The public UUID of the source redirect
799
+ */
800
+ id?: string;
801
+ }[];
802
+ ProjectMapTargetRedirectData: {
803
+ /**
804
+ * Format: uuid
805
+ * @description The public UUID of the target redirect
806
+ */
807
+ id?: string;
808
+ }[];
809
+ ProjectMapNodeLocale: {
810
+ /** @description Name of node in the locale */
811
+ name?: string;
812
+ /** @description Full path to the current node in this locale, only included if requested with the expanded flag */
813
+ path?: string;
814
+ /** @description Last segment of the url in this locale */
815
+ pathSegment: string;
816
+ /** @description When false, the node explicitly defines a locale-specific path segment.
817
+ *
818
+ * When true, an ancestor defines a locale-specific path segment,
819
+ * which makes its descendants resolvable using that segment.
820
+ * This node does not define a locale-specific path segment.
821
+ *
822
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
823
+ * */
824
+ inherited?: boolean;
825
+ };
826
+ ProjectMapNodeDefinition: {
827
+ /**
828
+ * Format: uuid
829
+ * @description The id of the projectMap entry
830
+ */
831
+ id: string;
832
+ /** @description Path representing the path to the current node */
833
+ path: string;
834
+ /** @description Ordering of the node, higher numbers go after lower numbers */
835
+ order?: number;
836
+ data?: components["schemas"]["ProjectMapNodeData"];
837
+ /** @description The name of the projectMap entry */
838
+ name: string;
839
+ /**
840
+ * @description The type of the projectMap entry
841
+ * @enum {string}
842
+ */
843
+ type: "composition" | "placeholder";
844
+ /**
845
+ * Format: uuid
846
+ * @description The composition id related to the projectMap entry
847
+ */
848
+ compositionId?: string;
849
+ /** @description Description of the projectMap node */
850
+ description?: string;
851
+ /** @description Parent path of the current node, only included if requested with the expanded flag */
852
+ parentPath?: string;
853
+ /** @description Last segment of the url */
854
+ pathSegment?: string;
855
+ /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
856
+ isLeaf?: boolean;
857
+ compositionData?: components["schemas"]["ProjectMapNodeCompositionData"];
858
+ sourceRedirects?: components["schemas"]["ProjectMapSourceRedirectData"];
859
+ targetRedirects?: components["schemas"]["ProjectMapTargetRedirectData"];
860
+ locales?: {
861
+ [key: string]: components["schemas"]["ProjectMapNodeLocale"];
862
+ };
863
+ };
864
+ ProjectMapTreeNodeDefinition: {
865
+ /** @description Children of the node */
866
+ children?: components["schemas"]["ProjectMapTreeNodeDefinition"][];
867
+ } & WithRequired<components["schemas"]["ProjectMapNodeDefinition"], "name">;
868
+ Error: {
869
+ /** @description Error message(s) that occurred while processing the request */
870
+ errorMessage?: string[] | string;
871
+ };
872
+ ProjectMapNodeLocaleUpdate: {
873
+ /** @description Name of node in the locale */
874
+ name?: string;
875
+ /** @description Locale specific path segment for this node (not a full path) */
876
+ pathSegment: string;
877
+ };
878
+ ProjectMapNodeUpdate: {
879
+ /**
880
+ * Format: uuid
881
+ * @description The id of the projectMap entry
882
+ */
883
+ id?: string;
884
+ /** @description Path representing the path to the current node */
885
+ path: string;
886
+ /** @description Ordering of the node, higher numbers go after lower numbers */
887
+ order?: number;
888
+ data?: components["schemas"]["ProjectMapNodeData"];
889
+ /** @description The name of the projectMap entry */
890
+ name: string;
891
+ /**
892
+ * @description The type of the projectMap entry
893
+ * @enum {string}
894
+ */
895
+ type: "composition" | "placeholder";
896
+ /**
897
+ * Format: uuid
898
+ * @description The composition id related to the projectMap entry
899
+ */
900
+ compositionId?: string;
901
+ /** @description Description of the projectMap node */
902
+ description?: string;
903
+ locales?: {
904
+ [key: string]: components["schemas"]["ProjectMapNodeLocaleUpdate"];
905
+ };
906
+ };
907
+ };
908
+ responses: {
909
+ /** @description Request input validation failed */
910
+ BadRequestError: {
911
+ headers: {
912
+ [name: string]: unknown;
913
+ };
914
+ content: {
915
+ "application/json": components["schemas"]["Error"];
916
+ };
917
+ };
918
+ /** @description API key or token was not valid */
919
+ UnauthorizedError: {
920
+ headers: {
921
+ [name: string]: unknown;
922
+ };
923
+ content: {
924
+ "application/json": components["schemas"]["Error"];
925
+ };
926
+ };
927
+ /** @description Permission was denied */
928
+ ForbiddenError: {
929
+ headers: {
930
+ [name: string]: unknown;
931
+ };
932
+ content: {
933
+ "application/json": components["schemas"]["Error"];
934
+ };
935
+ };
936
+ /** @description Too many requests in allowed time period */
937
+ RateLimitError: {
938
+ headers: {
939
+ [name: string]: unknown;
940
+ };
941
+ content?: never;
942
+ };
943
+ /** @description Execution error occurred */
944
+ InternalServerError: {
945
+ headers: {
946
+ [name: string]: unknown;
947
+ };
948
+ content?: never;
949
+ };
950
+ };
951
+ parameters: never;
952
+ requestBodies: never;
953
+ headers: never;
954
+ pathItems: never;
955
+ }
956
+ type WithRequired<T, K extends keyof T> = T & {
957
+ [P in K]-?: T[P];
958
+ };
627
959
 
628
960
  type ProjectMapNodeUpsertRequest = paths['/api/v1/project-map-nodes']['put']['requestBody']['content']['application/json'];
629
961
  type ProjectMapNodeUpsertRequestNode = ProjectMapNodeUpsertRequest['nodes'][0]['node'];
@@ -651,8 +983,8 @@ type ProjectMapDefinitions = {
651
983
  projectMaps: ProjectMapDefinitionWithId[];
652
984
  projectMapNodes: ProjectMapNodeWithProjectMapReference[];
653
985
  };
654
- type ProjectMapNodeData = components['schemas']['ProjectMapNodeData'];
655
- type ProjectMapNodeAllowedQueryString = components['schemas']['ProjectMapNodeAllowedQueryString'];
986
+ type ProjectMapNodeData = components$1['schemas']['ProjectMapNodeData'];
987
+ type ProjectMapNodeAllowedQueryString = components$1['schemas']['ProjectMapNodeAllowedQueryString'];
656
988
 
657
989
  declare const ROOT_NODE_PATH = "/";
658
990
  type ProjectMapClientOptions = {
@@ -684,13 +1016,13 @@ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
684
1016
  * Get available project map defintions
685
1017
  */
686
1018
  getProjectMapDefinitions: () => Promise<{
687
- projectMaps: components$1["schemas"]["ProjectMapDefinition"][];
1019
+ projectMaps: components$2["schemas"]["ProjectMapDefinition"][];
688
1020
  }>;
689
1021
  /**
690
1022
  * Get specific project map definition
691
1023
  */
692
1024
  getProjectMapDefinition: (options: WithoutProjectId<ProjectMapGetRequest>) => Promise<{
693
- projectMaps: components$1["schemas"]["ProjectMapDefinition"][];
1025
+ projectMaps: components$2["schemas"]["ProjectMapDefinition"][];
694
1026
  }>;
695
1027
  /**
696
1028
  * Update or insert a project map definition