@uniformdev/assets 19.61.1 → 19.62.1-alpha.127

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 CHANGED
@@ -37,6 +37,15 @@ interface paths {
37
37
  * Has no effect when not fetching a list. This does impact performance when enabled.
38
38
  */
39
39
  withTotalCount?: components["parameters"]["withTotalCount"];
40
+ /**
41
+ * The ID of a release to fetch the content for.
42
+ *
43
+ * - When unspecified, all release content is excluded from the result(s).
44
+ * - 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.
45
+ *
46
+ * 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 be undefined.
47
+ */
48
+ releaseId?: components["parameters"]["releaseId"];
40
49
  };
41
50
  };
42
51
  responses: {
@@ -81,7 +90,13 @@ interface paths {
81
90
  * @description The project ID to upsert the asset to
82
91
  */
83
92
  projectId: string;
84
- asset: components["schemas"]["AssetInput"];
93
+ /**
94
+ * Format: uuid
95
+ * @description The release ID to upsert the asset to. If unspecified the asset belongs to the base.
96
+ */
97
+ releaseId?: string;
98
+ asset?: components["schemas"]["AssetInput"];
99
+ assets?: components["schemas"]["AssetInput"][];
85
100
  };
86
101
  };
87
102
  };
@@ -110,6 +125,12 @@ interface paths {
110
125
  * @description The ID of the project the asset to delete belongs to
111
126
  */
112
127
  projectId: string;
128
+ /**
129
+ * Format: uuid
130
+ * @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
131
+ * Note: deleting an asset from a release will not delete the asset from the base.
132
+ */
133
+ releaseId?: string;
113
134
  };
114
135
  };
115
136
  };
@@ -138,50 +159,52 @@ interface components {
138
159
  _name?: string;
139
160
  /** @description Name of the author of the most recent change. */
140
161
  _author?: string;
141
- title?: {
142
- value: string;
143
- /** @constant */
144
- type: "text";
145
- };
146
- description?: {
147
- value: string;
148
- /** @constant */
149
- type: "text";
150
- };
151
- file?: {
152
- /** Format: uuid */
153
- value: string;
154
- /** @constant */
155
- type: "file";
156
- };
157
- mediaType?: {
158
- value: string;
159
- /** @constant */
160
- type: "text";
161
- };
162
- url?: {
163
- value: string;
164
- /** @constant */
165
- type: "text";
166
- };
167
- size?: {
168
- value: number;
169
- /** @constant */
170
- type: "number";
171
- };
172
- width?: {
173
- value: number;
174
- /** @constant */
175
- type: "number";
176
- };
177
- height?: {
178
- value: number;
179
- /** @constant */
180
- type: "number";
181
- };
182
- /** @description Asset field values. */
183
- custom?: {
184
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
162
+ fields?: {
163
+ title?: {
164
+ value: string;
165
+ /** @constant */
166
+ type: "text";
167
+ };
168
+ description?: {
169
+ value: string;
170
+ /** @constant */
171
+ type: "text";
172
+ };
173
+ file?: {
174
+ /** Format: uuid */
175
+ value: string;
176
+ /** @constant */
177
+ type: "file";
178
+ };
179
+ mediaType?: {
180
+ value: string;
181
+ /** @constant */
182
+ type: "text";
183
+ };
184
+ url?: {
185
+ value: string;
186
+ /** @constant */
187
+ type: "text";
188
+ };
189
+ size?: {
190
+ value: number;
191
+ /** @constant */
192
+ type: "number";
193
+ };
194
+ width?: {
195
+ value: number;
196
+ /** @constant */
197
+ type: "number";
198
+ };
199
+ height?: {
200
+ value: number;
201
+ /** @constant */
202
+ type: "number";
203
+ };
204
+ /** @description Asset field values. */
205
+ custom?: {
206
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
207
+ };
185
208
  };
186
209
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
187
210
  };
@@ -196,21 +219,23 @@ interface components {
196
219
  _id?: string;
197
220
  /** @description The internal name of the asset. */
198
221
  _name?: string;
199
- title?: {
200
- value: string;
201
- /** @constant */
202
- type: "text";
203
- };
204
- description?: {
205
- value: string;
206
- /** @constant */
207
- type: "text";
208
- };
209
- file?: {
210
- /** Format: uuid */
211
- value: string;
212
- /** @constant */
213
- type: "file";
222
+ fields?: {
223
+ title?: {
224
+ value: string;
225
+ /** @constant */
226
+ type: "text";
227
+ };
228
+ description?: {
229
+ value: string;
230
+ /** @constant */
231
+ type: "text";
232
+ };
233
+ file?: {
234
+ /** Format: uuid */
235
+ value: string;
236
+ /** @constant */
237
+ type: "file";
238
+ };
214
239
  };
215
240
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
216
241
  };
@@ -230,6 +255,11 @@ interface components {
230
255
  * @description Modified date string for this definition
231
256
  */
232
257
  modified: string;
258
+ /**
259
+ * Format: uuid
260
+ * @description The release this asset belongs to. If not set, the asset belongs to the base.
261
+ */
262
+ releaseId?: string;
233
263
  asset: components["schemas"]["Asset"];
234
264
  };
235
265
  AssetListResponse: {
@@ -267,6 +297,15 @@ interface components {
267
297
  * Has no effect when not fetching a list. This does impact performance when enabled.
268
298
  */
269
299
  withTotalCount: boolean;
300
+ /**
301
+ * @description The ID of a release to fetch the content for.
302
+ *
303
+ * - When unspecified, all release content is excluded from the result(s).
304
+ * - 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.
305
+ *
306
+ * 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 be undefined.
307
+ */
308
+ releaseId: string;
270
309
  };
271
310
  }
272
311
  interface external {
@@ -327,6 +366,11 @@ interface external {
327
366
  helpText?: string;
328
367
  /** @description Type name of the parameter (provided by a Uniform integration) */
329
368
  type: string;
369
+ /**
370
+ * @description If true, this property can have locale-specific values. If false or not defined,
371
+ * this property will have a single value that is shared for all locales.
372
+ */
373
+ localizable?: boolean;
330
374
  /** @description The configuration object for the type (type-specific) */
331
375
  typeConfig?: unknown;
332
376
  };
@@ -424,6 +468,12 @@ interface external {
424
468
  * @default null
425
469
  */
426
470
  titleParameter?: string | null;
471
+ /**
472
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
473
+ *
474
+ * @default null
475
+ */
476
+ thumbnailParameter?: string | null;
427
477
  /**
428
478
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
429
479
  * @default false
@@ -476,6 +526,12 @@ interface external {
476
526
  * The field type must support being used as an entry name for this to work.
477
527
  */
478
528
  entryName?: string | null;
529
+ /**
530
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
531
+ *
532
+ * @default null
533
+ */
534
+ thumbnailField?: string | null;
479
535
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
480
536
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
481
537
  /**
@@ -499,15 +555,29 @@ interface external {
499
555
  * @enum {string}
500
556
  */
501
557
  type?: "contentType" | "block";
558
+ /**
559
+ * @description if this content type uses team permissions or custom permissions
560
+ * @default true
561
+ */
562
+ useTeamPermissions?: boolean;
563
+ /** @description Custom role permissions for this content type */
564
+ permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
502
565
  };
503
566
  /** @description Defines an editable parameter on a component. */
504
567
  ComponentParameter: {
505
568
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
506
- value: unknown;
569
+ value?: unknown;
507
570
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
508
571
  type: string;
509
572
  /** @deprecated */
510
573
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
574
+ /**
575
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
576
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
577
+ */
578
+ locales?: {
579
+ [key: string]: unknown;
580
+ };
511
581
  };
512
582
  /** @description Defines a connection to a dynamic token on a data resource. */
513
583
  DataElementConnectionDefinition: {
@@ -518,6 +588,35 @@ interface external {
518
588
  * @enum {string}
519
589
  */
520
590
  syntax: "jptr";
591
+ /**
592
+ * @description The action to take if the dynamic token cannot be resolved
593
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
594
+ * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
595
+ * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
596
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
597
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
598
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
599
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
600
+ * it is treated as an 'a' failure because removing the root means we must remove all.
601
+ * - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses.
602
+ *
603
+ * @enum {string}
604
+ */
605
+ failureAction?: "t" | "p" | "c" | "a";
606
+ /**
607
+ * @description How to report when the dynamic token cannot be resolved
608
+ * - e: ERROR: Report an error message (this will prevent publishing)
609
+ * - w: WARNING: Report a warning message [default]
610
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
611
+ *
612
+ * @enum {string}
613
+ */
614
+ failureLogLevel?: "e" | "w" | "i";
615
+ /**
616
+ * @description The default value to use if the dynamic token cannot be resolved.
617
+ * This is only used if the failureAction is the default (undefined, or explicitly token).
618
+ */
619
+ failureDefault?: string;
521
620
  };
522
621
  /** @description Defines the shape of a component instance served by the composition API. */
523
622
  ComponentInstance: {
@@ -550,15 +649,7 @@ interface external {
550
649
  _patternDataResources?: {
551
650
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
552
651
  };
553
- /**
554
- * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
555
- * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
556
- * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
557
- * Means nothing for PUTs; it will be ignored.
558
- *
559
- * @enum {string}
560
- */
561
- _patternError?: "NOTFOUND" | "CYCLIC";
652
+ _patternError?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PatternError"];
562
653
  /**
563
654
  * @description Defines patch overrides to component IDs that live in the composition.
564
655
  * This can be used to override parameters that are defined on patterns,
@@ -582,6 +673,8 @@ interface external {
582
673
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
583
674
  */
584
675
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
676
+ /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
677
+ _locales?: string[];
585
678
  };
586
679
  /** @description Defines the shape of the root component in a composition */
587
680
  RootComponentInstance: {
@@ -605,7 +698,17 @@ interface external {
605
698
  _slug?: string | null;
606
699
  /** @description Friendly name of this component. */
607
700
  _name: string;
701
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
702
+ _pattern?: string;
703
+ /**
704
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
705
+ * Means nothing for PUTs; it will be ignored.
706
+ */
707
+ _patternDataResources?: {
708
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
709
+ };
608
710
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
711
+ _patternError?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PatternError"];
609
712
  /**
610
713
  * @description Defines patch overrides to component IDs that live in the composition.
611
714
  * This can be used to override parameters that are defined on patterns,
@@ -629,6 +732,8 @@ interface external {
629
732
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
630
733
  */
631
734
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
735
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
736
+ _locales?: string[];
632
737
  };
633
738
  /**
634
739
  * @description Defines how to override a specific component.
@@ -640,6 +745,9 @@ interface external {
640
745
  parameters?: {
641
746
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
642
747
  };
748
+ slots?: {
749
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
750
+ };
643
751
  variant?: string;
644
752
  };
645
753
  /**
@@ -656,6 +764,12 @@ interface external {
656
764
  };
657
765
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
658
766
  variants?: boolean;
767
+ /**
768
+ * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
769
+ * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
770
+ * If not set, the default is false.
771
+ */
772
+ hideLockedParameters?: boolean;
659
773
  };
660
774
  /**
661
775
  * @description Whether a parameter is overridable
@@ -677,7 +791,7 @@ interface external {
677
791
  id: string;
678
792
  /** @description Display name of the data source */
679
793
  displayName: string;
680
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
794
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
681
795
  connectorType: string;
682
796
  /** @description Base resource URL of the data source. No trailing slash. */
683
797
  baseUrl: string;
@@ -695,7 +809,18 @@ interface external {
695
809
  variables?: {
696
810
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
697
811
  };
698
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
812
+ /**
813
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
814
+ * If a locale is not mapped, it will be passed through to the data source as-is.
815
+ */
816
+ localeMapping?: {
817
+ [key: string]: string;
818
+ };
819
+ /** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets. */
820
+ customPublic?: {
821
+ [key: string]: unknown;
822
+ };
823
+ /** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors. */
699
824
  custom?: {
700
825
  [key: string]: unknown;
701
826
  };
@@ -717,15 +842,8 @@ interface external {
717
842
  allowedOnComponents?: string[];
718
843
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
719
844
  path: string;
720
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
845
+ /** @description Time-to-live (in seconds) for the resource data cache. */
721
846
  ttl?: number;
722
- /** @description Long term data resource cache configuration. */
723
- longTermCache?: {
724
- /** @description A flag to turn the long term cache on. */
725
- enabled: boolean;
726
- /** @description Time-to-live (in hours) for the long term resource data cache. */
727
- ttlInHours?: number;
728
- };
729
847
  /** @description A key for the resource data cache purging. */
730
848
  purgeKey?: string;
731
849
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -805,6 +923,37 @@ interface external {
805
923
  DataResourceVariables: {
806
924
  [key: string]: string;
807
925
  };
926
+ /**
927
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
928
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
929
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
930
+ * Means nothing for PUTs; it will be ignored.
931
+ *
932
+ * @enum {string}
933
+ */
934
+ PatternError: "NOTFOUND" | "CYCLIC";
935
+ HistoryApiResponse: {
936
+ /**
937
+ * @description If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
938
+ * If this is undefined then no more results are available.
939
+ */
940
+ cursor?: string;
941
+ /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
942
+ truncated?: boolean;
943
+ /** @description Version history entries. */
944
+ results?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
945
+ };
946
+ HistoryEntry: {
947
+ /** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
948
+ versionId: string;
949
+ /** @description The timestamp when the version was created in epoch milliseconds. */
950
+ timestamp: number;
951
+ /** @description The name (full name) of the user who created the version. */
952
+ authorName: string;
953
+ authorIsApiKey: boolean;
954
+ /** @description The state of the entity when the history entry was made. */
955
+ state: number;
956
+ };
808
957
  /** @description Category for tagging canvas entities */
809
958
  Category: {
810
959
  /**
@@ -827,13 +976,398 @@ interface external {
827
976
  * @description Unique identifier for the project map node
828
977
  */
829
978
  id: string;
830
- /** @description Path of the project map node */
979
+ /**
980
+ * @description Fallback path of the project map node.
981
+ * Note that the node may have matched via a locale-specific path which is in the `locales` object.
982
+ */
831
983
  path: string;
832
984
  /**
833
985
  * Format: uuid
834
986
  * @description Unique identifier for the project map that this node belongs to.
835
987
  */
836
988
  projectMapId: string;
989
+ data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
990
+ /**
991
+ * @description Locale-specific paths of the project map node.
992
+ * Keys are locale codes.
993
+ */
994
+ locales?: {
995
+ [key: string]: {
996
+ /** @description Locale-specific path of the project map node. */
997
+ path: string;
998
+ /** @description Whether the path is inherited from a parent node which defined a path segment in this locale. */
999
+ inherited: boolean;
1000
+ };
1001
+ };
1002
+ };
1003
+ /** @description AI Prompt definition. */
1004
+ Prompt: {
1005
+ /**
1006
+ * Format: uuid
1007
+ * @description Unique identifier for the prompt
1008
+ */
1009
+ id: string;
1010
+ /** @description Unique identifier for the integration that this prompt belongs to. */
1011
+ integrationType: string;
1012
+ /** @description Name for the prompt */
1013
+ name?: string | null;
1014
+ /** @description Text for the prompt */
1015
+ text?: string | null;
1016
+ /** @description Data for the prompt */
1017
+ data?: {
1018
+ [key: string]: unknown;
1019
+ } | null;
1020
+ /** @description Turn off/on prompt */
1021
+ enabled?: boolean | null;
1022
+ /** @description Integration default prompt */
1023
+ builtIn?: boolean | null;
1024
+ /** @description Supported parameter types */
1025
+ parameterTypes?: string[] | null;
1026
+ };
1027
+ };
1028
+ };
1029
+ operations: {};
1030
+ };
1031
+ "v1-project-map-nodes.swagger.yml": {
1032
+ paths: {
1033
+ "/api/v1/project-map-nodes": {
1034
+ /** Called to get a list of nodes belonging to a specific path or Id */
1035
+ get: {
1036
+ parameters: {
1037
+ query: {
1038
+ /** The project map id that the desired nodes belong */
1039
+ projectMapId?: string;
1040
+ /** The project id that contains the project map tree that this node belongs to */
1041
+ projectId: string;
1042
+ /**
1043
+ * The ID of a release to fetch the composition data for.
1044
+ *
1045
+ * - When unspecified, composition data is fetched from base.
1046
+ * - 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.
1047
+ *
1048
+ * 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.
1049
+ */
1050
+ releaseId?: string;
1051
+ /** The id of the node to retrieve, cannot have both this parameter and Path */
1052
+ id?: string;
1053
+ /** The path of the root node to retrieve, cannot have both this parameter and Id */
1054
+ path?: string;
1055
+ /** Composition id to find associated sitemap nodes for */
1056
+ compositionId?: string;
1057
+ /** Limit the number or records returned by a number */
1058
+ limit?: number;
1059
+ /** Number of records to skip before returning nodes */
1060
+ offset?: number;
1061
+ /** Depth of the tree to fetch. Only applies when fetching by path. */
1062
+ depth?: number;
1063
+ /** State of compositions to fetch. 0 = draft, 64 = published. */
1064
+ state?: number;
1065
+ /** should the data be returned as a json tree object (or a flat array) */
1066
+ tree?: boolean;
1067
+ /** text search filter */
1068
+ search?: string;
1069
+ /**
1070
+ * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
1071
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
1072
+ */
1073
+ includeAncestors?: boolean;
1074
+ /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
1075
+ expanded?: boolean;
1076
+ /** include basic composition information. ID, type, state, name, and definition id. */
1077
+ withCompositionData?: boolean;
1078
+ /**
1079
+ * @deprecated Returns the UI status string of the composition.
1080
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
1081
+ */
1082
+ withCompositionUIStatus?: boolean;
1083
+ /** Include basic redirect information. */
1084
+ withRedirectData?: boolean;
1085
+ };
1086
+ };
1087
+ responses: {
1088
+ /** OK */
1089
+ 200: {
1090
+ content: {
1091
+ "application/json": {
1092
+ nodes?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
1093
+ tree?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
1094
+ };
1095
+ };
1096
+ };
1097
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1098
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1099
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1100
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1101
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1102
+ };
1103
+ };
1104
+ /** Called to insert or update a node or nodes */
1105
+ put: {
1106
+ responses: {
1107
+ /** OK */
1108
+ 204: never;
1109
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1110
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1111
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1112
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1113
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1114
+ };
1115
+ requestBody: {
1116
+ content: {
1117
+ "application/json": {
1118
+ /** @description An array of projectMap node objects to be updated or inserted */
1119
+ nodes: {
1120
+ node: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
1121
+ /** @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 */
1122
+ previousSibling?: string;
1123
+ /** @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 */
1124
+ nextSibling?: string;
1125
+ }[];
1126
+ /**
1127
+ * Format: uuid
1128
+ * @description The project id of the project that the projectMap belongs to
1129
+ */
1130
+ projectId: string;
1131
+ /**
1132
+ * Format: uuid
1133
+ * @description The projectMap id that the changing or inserting nodes belong to
1134
+ */
1135
+ projectMapId?: string;
1136
+ };
1137
+ };
1138
+ };
1139
+ };
1140
+ /** Called to delete a particular projectMap node by id or path */
1141
+ delete: {
1142
+ responses: {
1143
+ /** OK */
1144
+ 204: never;
1145
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1146
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1147
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1148
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1149
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1150
+ };
1151
+ requestBody: {
1152
+ content: {
1153
+ "application/json": {
1154
+ /**
1155
+ * Format: uuid
1156
+ * @description Id of the projectMap node to delete
1157
+ */
1158
+ nodeId?: string;
1159
+ /** @description Path to the projectMap node to delete */
1160
+ path: string;
1161
+ /**
1162
+ * Format: uuid
1163
+ * @description Project map id that the node to delete belongs to
1164
+ */
1165
+ projectMapId?: string;
1166
+ /**
1167
+ * Format: uuid
1168
+ * @description Project id that the project map belongs to
1169
+ */
1170
+ projectId: string;
1171
+ } | {
1172
+ /**
1173
+ * Format: uuid
1174
+ * @description Id of the projectMap node to delete
1175
+ */
1176
+ nodeId: string;
1177
+ /** @description Path to the projectMap node to delete */
1178
+ path?: string;
1179
+ /**
1180
+ * Format: uuid
1181
+ * @description Project map id that the node to delete belongs to
1182
+ */
1183
+ projectMapId?: string;
1184
+ /**
1185
+ * Format: uuid
1186
+ * @description Project id that the project map belongs to
1187
+ */
1188
+ projectId: string;
1189
+ };
1190
+ };
1191
+ };
1192
+ };
1193
+ /** Handles preflight requests. This endpoint allows CORS. */
1194
+ options: {
1195
+ responses: {
1196
+ /** OK */
1197
+ 204: never;
1198
+ };
1199
+ };
1200
+ };
1201
+ };
1202
+ components: {
1203
+ schemas: {
1204
+ ProjectMapNodeDefinition: {
1205
+ /**
1206
+ * Format: uuid
1207
+ * @description The id of the projectMap entry
1208
+ */
1209
+ id: string;
1210
+ /** @description Path representing the path to the current node */
1211
+ path: string;
1212
+ /** @description Ordering of the node, higher numbers go after lower numbers. */
1213
+ order?: number;
1214
+ data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1215
+ /** @description The name of the projectMap entry */
1216
+ name: string;
1217
+ /**
1218
+ * @description The type of the projectMap entry
1219
+ * @enum {string}
1220
+ */
1221
+ type: "composition" | "placeholder";
1222
+ /**
1223
+ * Format: uuid
1224
+ * @description The composition id related to the projectMap entry
1225
+ */
1226
+ compositionId?: string;
1227
+ /** @description Description of the projectMap node */
1228
+ description?: string;
1229
+ /** @description Parent path of the current node, only included if requested with the expanded flag */
1230
+ parentPath?: string;
1231
+ /** @description Last segment of the url */
1232
+ pathSegment?: string;
1233
+ /** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
1234
+ isLeaf?: boolean;
1235
+ compositionData?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
1236
+ sourceRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
1237
+ targetRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
1238
+ locales?: {
1239
+ [key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
1240
+ };
1241
+ };
1242
+ ProjectMapNodeLocale: {
1243
+ /** @description Name of node in the locale */
1244
+ name?: string;
1245
+ /** @description Full path to the current node in this locale, only included if requested with the expanded flag */
1246
+ path?: string;
1247
+ /** @description Last segment of the url in this locale */
1248
+ pathSegment: string;
1249
+ /**
1250
+ * @description When false, the node explicitly defines a locale specific path segment.
1251
+ *
1252
+ * When true, an ancestor defines a locale specific path segment,
1253
+ * which makes its descendants resolvable using that segment.
1254
+ * This node does not define a locale specific path segment.
1255
+ *
1256
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
1257
+ */
1258
+ inherited?: boolean;
1259
+ };
1260
+ ProjectMapSourceRedirectData: {
1261
+ /**
1262
+ * Format: uuid
1263
+ * @description The public UUID of the source redirect
1264
+ */
1265
+ id?: string;
1266
+ }[];
1267
+ ProjectMapTargetRedirectData: {
1268
+ /**
1269
+ * Format: uuid
1270
+ * @description The public UUID of the target redirect
1271
+ */
1272
+ id?: string;
1273
+ }[];
1274
+ /** @description Basic information about a composition from the context of a project map node. */
1275
+ ProjectMapNodeCompositionData: {
1276
+ /** @description Type of the composition instance (public_id of its definition) */
1277
+ type: string;
1278
+ /**
1279
+ * Format: uuid
1280
+ * @description The public UUID of the composition.
1281
+ */
1282
+ id: string;
1283
+ /** @description Slug pattern of this composition. */
1284
+ slug?: string | null;
1285
+ /** @description Friendly name of this composition. */
1286
+ name: string;
1287
+ /**
1288
+ * @deprecated
1289
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
1290
+ * @enum {string}
1291
+ */
1292
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
1293
+ /**
1294
+ * @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
1295
+ * @default screen
1296
+ */
1297
+ icon?: string;
1298
+ /** @description Friendly name of this Composition's Definition */
1299
+ typeName?: string;
1300
+ /** @description List of locales that the composition is available in. If empty, available in all locales. */
1301
+ locales: string[];
1302
+ };
1303
+ ProjectMapNodeUpdate: {
1304
+ /**
1305
+ * Format: uuid
1306
+ * @description The id of the projectMap entry
1307
+ */
1308
+ id?: string;
1309
+ /** @description Path representing the path to the current node */
1310
+ path: string;
1311
+ /** @description Ordering of the node, higher numbers go after lower numbers. */
1312
+ order?: number;
1313
+ data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
1314
+ /** @description The name of the projectMap entry */
1315
+ name: string;
1316
+ /**
1317
+ * @description The type of the projectMap entry
1318
+ * @enum {string}
1319
+ */
1320
+ type: "composition" | "placeholder";
1321
+ /**
1322
+ * Format: uuid
1323
+ * @description The composition id related to the projectMap entry
1324
+ */
1325
+ compositionId?: string;
1326
+ /** @description Description of the projectMap node */
1327
+ description?: string;
1328
+ locales?: {
1329
+ [key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
1330
+ };
1331
+ };
1332
+ ProjectMapNodeLocaleUpdate: {
1333
+ /** @description Name of node in the locale */
1334
+ name?: string;
1335
+ /** @description Locale specific path segment for this node (not a full path) */
1336
+ pathSegment: string;
1337
+ };
1338
+ ProjectMapNodeData: {
1339
+ /** @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 */
1340
+ isSearchHit?: boolean;
1341
+ /** @description Query strings that are allowed to be passed to the node */
1342
+ queryStrings?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
1343
+ /**
1344
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
1345
+ * The preview value is used when editing a connected composition, and is the default
1346
+ * dynamic node value unless the author has explicitly chosen a different value.
1347
+ */
1348
+ previewValue?: string;
1349
+ };
1350
+ ProjectMapNodeAllowedQueryString: {
1351
+ /** @description The name of the query string parameter */
1352
+ name: string;
1353
+ /** @description The default value of the query string if it is not provided by an incoming route path */
1354
+ value?: string;
1355
+ /** @description Help text for authors who might be setting up a preview value for this query string */
1356
+ helpText?: string;
1357
+ };
1358
+ };
1359
+ };
1360
+ operations: {};
1361
+ };
1362
+ "v1-project-map-tree.swagger.yml": {
1363
+ paths: {};
1364
+ components: {
1365
+ schemas: {
1366
+ ProjectMapTreeNodeDefinition: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
1367
+ /** @description Children of the node */
1368
+ children?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
1369
+ } & {
1370
+ name: unknown;
837
1371
  };
838
1372
  };
839
1373
  };
@@ -871,4 +1405,10 @@ declare class UncachedAssetClient extends AssetClient {
871
1405
  }, 'bypassCache'>);
872
1406
  }
873
1407
 
874
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient };
1408
+ /**
1409
+ * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
1410
+ * Removes things like author, stats, etc.
1411
+ */
1412
+ declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
1413
+
1414
+ export { type Asset, AssetClient, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };