@uniformdev/assets 19.134.3-alpha.10 → 19.134.3-alpha.28
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 +362 -1
- package/dist/index.d.ts +362 -1
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -947,13 +947,29 @@ interface external {
|
|
|
947
947
|
* @description Unique identifier for the project map node
|
|
948
948
|
*/
|
|
949
949
|
id: string;
|
|
950
|
-
/**
|
|
950
|
+
/**
|
|
951
|
+
* @description Fallback path of the project map node.
|
|
952
|
+
* Note that the node may have matched via a locale-specific path which is in the `locales` object.
|
|
953
|
+
*/
|
|
951
954
|
path: string;
|
|
952
955
|
/**
|
|
953
956
|
* Format: uuid
|
|
954
957
|
* @description Unique identifier for the project map that this node belongs to.
|
|
955
958
|
*/
|
|
956
959
|
projectMapId: string;
|
|
960
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
961
|
+
/**
|
|
962
|
+
* @description Locale-specific paths of the project map node.
|
|
963
|
+
* Keys are locale codes.
|
|
964
|
+
*/
|
|
965
|
+
locales?: {
|
|
966
|
+
[key: string]: {
|
|
967
|
+
/** @description Locale-specific path of the project map node. */
|
|
968
|
+
path: string;
|
|
969
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale. */
|
|
970
|
+
inherited: boolean;
|
|
971
|
+
};
|
|
972
|
+
};
|
|
957
973
|
};
|
|
958
974
|
/** @description AI Prompt definition. */
|
|
959
975
|
Prompt: {
|
|
@@ -983,6 +999,351 @@ interface external {
|
|
|
983
999
|
};
|
|
984
1000
|
operations: {};
|
|
985
1001
|
};
|
|
1002
|
+
"v1-project-map-nodes.swagger.yml": {
|
|
1003
|
+
paths: {
|
|
1004
|
+
"/api/v1/project-map-nodes": {
|
|
1005
|
+
/** Called to get a list of nodes belonging to a specific path or Id */
|
|
1006
|
+
get: {
|
|
1007
|
+
parameters: {
|
|
1008
|
+
query: {
|
|
1009
|
+
/** The project map id that the desired nodes belong */
|
|
1010
|
+
projectMapId?: string;
|
|
1011
|
+
/** The project id that contains the project map tree that this node belongs to */
|
|
1012
|
+
projectId: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* The ID of a release to fetch the composition data for.
|
|
1015
|
+
*
|
|
1016
|
+
* - When unspecified, composition data is fetched from base.
|
|
1017
|
+
* - 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.
|
|
1018
|
+
*
|
|
1019
|
+
* 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.
|
|
1020
|
+
*/
|
|
1021
|
+
releaseId?: string;
|
|
1022
|
+
/** The id of the node to retrieve, cannot have both this parameter and Path */
|
|
1023
|
+
id?: string;
|
|
1024
|
+
/** The path of the root node to retrieve, cannot have both this parameter and Id */
|
|
1025
|
+
path?: string;
|
|
1026
|
+
/** Composition id to find associated sitemap nodes for */
|
|
1027
|
+
compositionId?: string;
|
|
1028
|
+
/** Limit the number or records returned by a number */
|
|
1029
|
+
limit?: number;
|
|
1030
|
+
/** Number of records to skip before returning nodes */
|
|
1031
|
+
offset?: number;
|
|
1032
|
+
/** Depth of the tree to fetch. Only applies when fetching by path. */
|
|
1033
|
+
depth?: number;
|
|
1034
|
+
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
|
1035
|
+
state?: number;
|
|
1036
|
+
/** should the data be returned as a json tree object (or a flat array) */
|
|
1037
|
+
tree?: boolean;
|
|
1038
|
+
/** text search filter */
|
|
1039
|
+
search?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
|
|
1042
|
+
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
|
|
1043
|
+
*/
|
|
1044
|
+
includeAncestors?: boolean;
|
|
1045
|
+
/** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
|
|
1046
|
+
expanded?: boolean;
|
|
1047
|
+
/** include basic composition information. ID, type, state, name, and definition id. */
|
|
1048
|
+
withCompositionData?: boolean;
|
|
1049
|
+
/**
|
|
1050
|
+
* @deprecated Returns the UI status string of the composition.
|
|
1051
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
|
1052
|
+
*/
|
|
1053
|
+
withCompositionUIStatus?: boolean;
|
|
1054
|
+
/** Include basic redirect information. */
|
|
1055
|
+
withRedirectData?: boolean;
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
responses: {
|
|
1059
|
+
/** OK */
|
|
1060
|
+
200: {
|
|
1061
|
+
content: {
|
|
1062
|
+
"application/json": {
|
|
1063
|
+
nodes?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
|
|
1064
|
+
tree?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1069
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1070
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1071
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1072
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1073
|
+
};
|
|
1074
|
+
};
|
|
1075
|
+
/** Called to insert or update a node or nodes */
|
|
1076
|
+
put: {
|
|
1077
|
+
responses: {
|
|
1078
|
+
/** OK */
|
|
1079
|
+
204: never;
|
|
1080
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1081
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1082
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1083
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1084
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1085
|
+
};
|
|
1086
|
+
requestBody: {
|
|
1087
|
+
content: {
|
|
1088
|
+
"application/json": {
|
|
1089
|
+
/** @description An array of projectMap node objects to be updated or inserted */
|
|
1090
|
+
nodes: {
|
|
1091
|
+
node: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
|
|
1092
|
+
/** @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 */
|
|
1093
|
+
previousSibling?: string;
|
|
1094
|
+
/** @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 */
|
|
1095
|
+
nextSibling?: string;
|
|
1096
|
+
}[];
|
|
1097
|
+
/**
|
|
1098
|
+
* Format: uuid
|
|
1099
|
+
* @description The project id of the project that the projectMap belongs to
|
|
1100
|
+
*/
|
|
1101
|
+
projectId: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Format: uuid
|
|
1104
|
+
* @description The projectMap id that the changing or inserting nodes belong to
|
|
1105
|
+
*/
|
|
1106
|
+
projectMapId?: string;
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
/** Called to delete a particular projectMap node by id or path */
|
|
1112
|
+
delete: {
|
|
1113
|
+
responses: {
|
|
1114
|
+
/** OK */
|
|
1115
|
+
204: never;
|
|
1116
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1117
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1118
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1119
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1120
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1121
|
+
};
|
|
1122
|
+
requestBody: {
|
|
1123
|
+
content: {
|
|
1124
|
+
"application/json": {
|
|
1125
|
+
/**
|
|
1126
|
+
* Format: uuid
|
|
1127
|
+
* @description Id of the projectMap node to delete
|
|
1128
|
+
*/
|
|
1129
|
+
nodeId?: string;
|
|
1130
|
+
/** @description Path to the projectMap node to delete */
|
|
1131
|
+
path: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Format: uuid
|
|
1134
|
+
* @description Project map id that the node to delete belongs to
|
|
1135
|
+
*/
|
|
1136
|
+
projectMapId?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Format: uuid
|
|
1139
|
+
* @description Project id that the project map belongs to
|
|
1140
|
+
*/
|
|
1141
|
+
projectId: string;
|
|
1142
|
+
} | {
|
|
1143
|
+
/**
|
|
1144
|
+
* Format: uuid
|
|
1145
|
+
* @description Id of the projectMap node to delete
|
|
1146
|
+
*/
|
|
1147
|
+
nodeId: string;
|
|
1148
|
+
/** @description Path to the projectMap node to delete */
|
|
1149
|
+
path?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Format: uuid
|
|
1152
|
+
* @description Project map id that the node to delete belongs to
|
|
1153
|
+
*/
|
|
1154
|
+
projectMapId?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* Format: uuid
|
|
1157
|
+
* @description Project id that the project map belongs to
|
|
1158
|
+
*/
|
|
1159
|
+
projectId: string;
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
1165
|
+
options: {
|
|
1166
|
+
responses: {
|
|
1167
|
+
/** OK */
|
|
1168
|
+
204: never;
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
components: {
|
|
1174
|
+
schemas: {
|
|
1175
|
+
ProjectMapNodeDefinition: {
|
|
1176
|
+
/**
|
|
1177
|
+
* Format: uuid
|
|
1178
|
+
* @description The id of the projectMap entry
|
|
1179
|
+
*/
|
|
1180
|
+
id: string;
|
|
1181
|
+
/** @description Path representing the path to the current node */
|
|
1182
|
+
path: string;
|
|
1183
|
+
/** @description Ordering of the node, higher numbers go after lower numbers. */
|
|
1184
|
+
order?: number;
|
|
1185
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1186
|
+
/** @description The name of the projectMap entry */
|
|
1187
|
+
name: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* @description The type of the projectMap entry
|
|
1190
|
+
* @enum {string}
|
|
1191
|
+
*/
|
|
1192
|
+
type: "composition" | "placeholder";
|
|
1193
|
+
/**
|
|
1194
|
+
* Format: uuid
|
|
1195
|
+
* @description The composition id related to the projectMap entry
|
|
1196
|
+
*/
|
|
1197
|
+
compositionId?: string;
|
|
1198
|
+
/** @description Description of the projectMap node */
|
|
1199
|
+
description?: string;
|
|
1200
|
+
/** @description Parent path of the current node, only included if requested with the expanded flag */
|
|
1201
|
+
parentPath?: string;
|
|
1202
|
+
/** @description Last segment of the url */
|
|
1203
|
+
pathSegment?: string;
|
|
1204
|
+
/** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
|
|
1205
|
+
isLeaf?: boolean;
|
|
1206
|
+
compositionData?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
|
|
1207
|
+
sourceRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
|
|
1208
|
+
targetRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
|
|
1209
|
+
locales?: {
|
|
1210
|
+
[key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
|
|
1211
|
+
};
|
|
1212
|
+
};
|
|
1213
|
+
ProjectMapNodeLocale: {
|
|
1214
|
+
/** @description Name of node in the locale */
|
|
1215
|
+
name?: string;
|
|
1216
|
+
/** @description Full path to the current node in this locale, only included if requested with the expanded flag */
|
|
1217
|
+
path?: string;
|
|
1218
|
+
/** @description Last segment of the url in this locale */
|
|
1219
|
+
pathSegment: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* @description When false, the node explicitly defines a locale specific path segment.
|
|
1222
|
+
*
|
|
1223
|
+
* When true, an ancestor defines a locale specific path segment,
|
|
1224
|
+
* which makes its descendants resolvable using that segment.
|
|
1225
|
+
* This node does not define a locale specific path segment.
|
|
1226
|
+
*
|
|
1227
|
+
* Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
|
|
1228
|
+
*/
|
|
1229
|
+
inherited?: boolean;
|
|
1230
|
+
};
|
|
1231
|
+
ProjectMapSourceRedirectData: {
|
|
1232
|
+
/**
|
|
1233
|
+
* Format: uuid
|
|
1234
|
+
* @description The public UUID of the source redirect
|
|
1235
|
+
*/
|
|
1236
|
+
id?: string;
|
|
1237
|
+
}[];
|
|
1238
|
+
ProjectMapTargetRedirectData: {
|
|
1239
|
+
/**
|
|
1240
|
+
* Format: uuid
|
|
1241
|
+
* @description The public UUID of the target redirect
|
|
1242
|
+
*/
|
|
1243
|
+
id?: string;
|
|
1244
|
+
}[];
|
|
1245
|
+
/** @description Basic information about a composition from the context of a project map node. */
|
|
1246
|
+
ProjectMapNodeCompositionData: {
|
|
1247
|
+
/** @description Type of the composition instance (public_id of its definition) */
|
|
1248
|
+
type: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* Format: uuid
|
|
1251
|
+
* @description The public UUID of the composition.
|
|
1252
|
+
*/
|
|
1253
|
+
id: string;
|
|
1254
|
+
/** @description Slug pattern of this composition. */
|
|
1255
|
+
slug?: string | null;
|
|
1256
|
+
/** @description Friendly name of this composition. */
|
|
1257
|
+
name: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* @deprecated
|
|
1260
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
|
|
1261
|
+
* @enum {string}
|
|
1262
|
+
*/
|
|
1263
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
1264
|
+
/**
|
|
1265
|
+
* @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
1266
|
+
* @default screen
|
|
1267
|
+
*/
|
|
1268
|
+
icon?: string;
|
|
1269
|
+
/** @description Friendly name of this Composition's Definition */
|
|
1270
|
+
typeName?: string;
|
|
1271
|
+
/** @description List of locales that the composition is available in. If empty, available in all locales. */
|
|
1272
|
+
locales: string[];
|
|
1273
|
+
};
|
|
1274
|
+
ProjectMapNodeUpdate: {
|
|
1275
|
+
/**
|
|
1276
|
+
* Format: uuid
|
|
1277
|
+
* @description The id of the projectMap entry
|
|
1278
|
+
*/
|
|
1279
|
+
id?: string;
|
|
1280
|
+
/** @description Path representing the path to the current node */
|
|
1281
|
+
path: string;
|
|
1282
|
+
/** @description Ordering of the node, higher numbers go after lower numbers. */
|
|
1283
|
+
order?: number;
|
|
1284
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1285
|
+
/** @description The name of the projectMap entry */
|
|
1286
|
+
name: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* @description The type of the projectMap entry
|
|
1289
|
+
* @enum {string}
|
|
1290
|
+
*/
|
|
1291
|
+
type: "composition" | "placeholder";
|
|
1292
|
+
/**
|
|
1293
|
+
* Format: uuid
|
|
1294
|
+
* @description The composition id related to the projectMap entry
|
|
1295
|
+
*/
|
|
1296
|
+
compositionId?: string;
|
|
1297
|
+
/** @description Description of the projectMap node */
|
|
1298
|
+
description?: string;
|
|
1299
|
+
locales?: {
|
|
1300
|
+
[key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
ProjectMapNodeLocaleUpdate: {
|
|
1304
|
+
/** @description Name of node in the locale */
|
|
1305
|
+
name?: string;
|
|
1306
|
+
/** @description Locale specific path segment for this node (not a full path) */
|
|
1307
|
+
pathSegment: string;
|
|
1308
|
+
};
|
|
1309
|
+
ProjectMapNodeData: {
|
|
1310
|
+
/** @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 */
|
|
1311
|
+
isSearchHit?: boolean;
|
|
1312
|
+
/** @description Query strings that are allowed to be passed to the node */
|
|
1313
|
+
queryStrings?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1314
|
+
/**
|
|
1315
|
+
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1316
|
+
* The preview value is used when editing a connected composition, and is the default
|
|
1317
|
+
* dynamic node value unless the author has explicitly chosen a different value.
|
|
1318
|
+
*/
|
|
1319
|
+
previewValue?: string;
|
|
1320
|
+
};
|
|
1321
|
+
ProjectMapNodeAllowedQueryString: {
|
|
1322
|
+
/** @description The name of the query string parameter */
|
|
1323
|
+
name: string;
|
|
1324
|
+
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1325
|
+
value: string;
|
|
1326
|
+
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1327
|
+
helpText?: string;
|
|
1328
|
+
};
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
operations: {};
|
|
1332
|
+
};
|
|
1333
|
+
"v1-project-map-tree.swagger.yml": {
|
|
1334
|
+
paths: {};
|
|
1335
|
+
components: {
|
|
1336
|
+
schemas: {
|
|
1337
|
+
ProjectMapTreeNodeDefinition: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
|
|
1338
|
+
/** @description Children of the node */
|
|
1339
|
+
children?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
|
|
1340
|
+
} & {
|
|
1341
|
+
name: unknown;
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
};
|
|
1345
|
+
operations: {};
|
|
1346
|
+
};
|
|
986
1347
|
}
|
|
987
1348
|
|
|
988
1349
|
type AssetUpsertRequest = paths['/api/v1/assets']['put']['requestBody']['content']['application/json'];
|
package/dist/index.d.ts
CHANGED
|
@@ -947,13 +947,29 @@ interface external {
|
|
|
947
947
|
* @description Unique identifier for the project map node
|
|
948
948
|
*/
|
|
949
949
|
id: string;
|
|
950
|
-
/**
|
|
950
|
+
/**
|
|
951
|
+
* @description Fallback path of the project map node.
|
|
952
|
+
* Note that the node may have matched via a locale-specific path which is in the `locales` object.
|
|
953
|
+
*/
|
|
951
954
|
path: string;
|
|
952
955
|
/**
|
|
953
956
|
* Format: uuid
|
|
954
957
|
* @description Unique identifier for the project map that this node belongs to.
|
|
955
958
|
*/
|
|
956
959
|
projectMapId: string;
|
|
960
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
961
|
+
/**
|
|
962
|
+
* @description Locale-specific paths of the project map node.
|
|
963
|
+
* Keys are locale codes.
|
|
964
|
+
*/
|
|
965
|
+
locales?: {
|
|
966
|
+
[key: string]: {
|
|
967
|
+
/** @description Locale-specific path of the project map node. */
|
|
968
|
+
path: string;
|
|
969
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale. */
|
|
970
|
+
inherited: boolean;
|
|
971
|
+
};
|
|
972
|
+
};
|
|
957
973
|
};
|
|
958
974
|
/** @description AI Prompt definition. */
|
|
959
975
|
Prompt: {
|
|
@@ -983,6 +999,351 @@ interface external {
|
|
|
983
999
|
};
|
|
984
1000
|
operations: {};
|
|
985
1001
|
};
|
|
1002
|
+
"v1-project-map-nodes.swagger.yml": {
|
|
1003
|
+
paths: {
|
|
1004
|
+
"/api/v1/project-map-nodes": {
|
|
1005
|
+
/** Called to get a list of nodes belonging to a specific path or Id */
|
|
1006
|
+
get: {
|
|
1007
|
+
parameters: {
|
|
1008
|
+
query: {
|
|
1009
|
+
/** The project map id that the desired nodes belong */
|
|
1010
|
+
projectMapId?: string;
|
|
1011
|
+
/** The project id that contains the project map tree that this node belongs to */
|
|
1012
|
+
projectId: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* The ID of a release to fetch the composition data for.
|
|
1015
|
+
*
|
|
1016
|
+
* - When unspecified, composition data is fetched from base.
|
|
1017
|
+
* - 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.
|
|
1018
|
+
*
|
|
1019
|
+
* 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.
|
|
1020
|
+
*/
|
|
1021
|
+
releaseId?: string;
|
|
1022
|
+
/** The id of the node to retrieve, cannot have both this parameter and Path */
|
|
1023
|
+
id?: string;
|
|
1024
|
+
/** The path of the root node to retrieve, cannot have both this parameter and Id */
|
|
1025
|
+
path?: string;
|
|
1026
|
+
/** Composition id to find associated sitemap nodes for */
|
|
1027
|
+
compositionId?: string;
|
|
1028
|
+
/** Limit the number or records returned by a number */
|
|
1029
|
+
limit?: number;
|
|
1030
|
+
/** Number of records to skip before returning nodes */
|
|
1031
|
+
offset?: number;
|
|
1032
|
+
/** Depth of the tree to fetch. Only applies when fetching by path. */
|
|
1033
|
+
depth?: number;
|
|
1034
|
+
/** State of compositions to fetch. 0 = draft, 64 = published. */
|
|
1035
|
+
state?: number;
|
|
1036
|
+
/** should the data be returned as a json tree object (or a flat array) */
|
|
1037
|
+
tree?: boolean;
|
|
1038
|
+
/** text search filter */
|
|
1039
|
+
search?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
|
|
1042
|
+
* Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
|
|
1043
|
+
*/
|
|
1044
|
+
includeAncestors?: boolean;
|
|
1045
|
+
/** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
|
|
1046
|
+
expanded?: boolean;
|
|
1047
|
+
/** include basic composition information. ID, type, state, name, and definition id. */
|
|
1048
|
+
withCompositionData?: boolean;
|
|
1049
|
+
/**
|
|
1050
|
+
* @deprecated Returns the UI status string of the composition.
|
|
1051
|
+
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
|
1052
|
+
*/
|
|
1053
|
+
withCompositionUIStatus?: boolean;
|
|
1054
|
+
/** Include basic redirect information. */
|
|
1055
|
+
withRedirectData?: boolean;
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
responses: {
|
|
1059
|
+
/** OK */
|
|
1060
|
+
200: {
|
|
1061
|
+
content: {
|
|
1062
|
+
"application/json": {
|
|
1063
|
+
nodes?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"][];
|
|
1064
|
+
tree?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"];
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1069
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1070
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1071
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1072
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1073
|
+
};
|
|
1074
|
+
};
|
|
1075
|
+
/** Called to insert or update a node or nodes */
|
|
1076
|
+
put: {
|
|
1077
|
+
responses: {
|
|
1078
|
+
/** OK */
|
|
1079
|
+
204: never;
|
|
1080
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1081
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1082
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1083
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1084
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1085
|
+
};
|
|
1086
|
+
requestBody: {
|
|
1087
|
+
content: {
|
|
1088
|
+
"application/json": {
|
|
1089
|
+
/** @description An array of projectMap node objects to be updated or inserted */
|
|
1090
|
+
nodes: {
|
|
1091
|
+
node: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeUpdate"];
|
|
1092
|
+
/** @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 */
|
|
1093
|
+
previousSibling?: string;
|
|
1094
|
+
/** @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 */
|
|
1095
|
+
nextSibling?: string;
|
|
1096
|
+
}[];
|
|
1097
|
+
/**
|
|
1098
|
+
* Format: uuid
|
|
1099
|
+
* @description The project id of the project that the projectMap belongs to
|
|
1100
|
+
*/
|
|
1101
|
+
projectId: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Format: uuid
|
|
1104
|
+
* @description The projectMap id that the changing or inserting nodes belong to
|
|
1105
|
+
*/
|
|
1106
|
+
projectMapId?: string;
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
/** Called to delete a particular projectMap node by id or path */
|
|
1112
|
+
delete: {
|
|
1113
|
+
responses: {
|
|
1114
|
+
/** OK */
|
|
1115
|
+
204: never;
|
|
1116
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
1117
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
1118
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
1119
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
1120
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
1121
|
+
};
|
|
1122
|
+
requestBody: {
|
|
1123
|
+
content: {
|
|
1124
|
+
"application/json": {
|
|
1125
|
+
/**
|
|
1126
|
+
* Format: uuid
|
|
1127
|
+
* @description Id of the projectMap node to delete
|
|
1128
|
+
*/
|
|
1129
|
+
nodeId?: string;
|
|
1130
|
+
/** @description Path to the projectMap node to delete */
|
|
1131
|
+
path: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Format: uuid
|
|
1134
|
+
* @description Project map id that the node to delete belongs to
|
|
1135
|
+
*/
|
|
1136
|
+
projectMapId?: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Format: uuid
|
|
1139
|
+
* @description Project id that the project map belongs to
|
|
1140
|
+
*/
|
|
1141
|
+
projectId: string;
|
|
1142
|
+
} | {
|
|
1143
|
+
/**
|
|
1144
|
+
* Format: uuid
|
|
1145
|
+
* @description Id of the projectMap node to delete
|
|
1146
|
+
*/
|
|
1147
|
+
nodeId: string;
|
|
1148
|
+
/** @description Path to the projectMap node to delete */
|
|
1149
|
+
path?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Format: uuid
|
|
1152
|
+
* @description Project map id that the node to delete belongs to
|
|
1153
|
+
*/
|
|
1154
|
+
projectMapId?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* Format: uuid
|
|
1157
|
+
* @description Project id that the project map belongs to
|
|
1158
|
+
*/
|
|
1159
|
+
projectId: string;
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
1165
|
+
options: {
|
|
1166
|
+
responses: {
|
|
1167
|
+
/** OK */
|
|
1168
|
+
204: never;
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
components: {
|
|
1174
|
+
schemas: {
|
|
1175
|
+
ProjectMapNodeDefinition: {
|
|
1176
|
+
/**
|
|
1177
|
+
* Format: uuid
|
|
1178
|
+
* @description The id of the projectMap entry
|
|
1179
|
+
*/
|
|
1180
|
+
id: string;
|
|
1181
|
+
/** @description Path representing the path to the current node */
|
|
1182
|
+
path: string;
|
|
1183
|
+
/** @description Ordering of the node, higher numbers go after lower numbers. */
|
|
1184
|
+
order?: number;
|
|
1185
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1186
|
+
/** @description The name of the projectMap entry */
|
|
1187
|
+
name: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* @description The type of the projectMap entry
|
|
1190
|
+
* @enum {string}
|
|
1191
|
+
*/
|
|
1192
|
+
type: "composition" | "placeholder";
|
|
1193
|
+
/**
|
|
1194
|
+
* Format: uuid
|
|
1195
|
+
* @description The composition id related to the projectMap entry
|
|
1196
|
+
*/
|
|
1197
|
+
compositionId?: string;
|
|
1198
|
+
/** @description Description of the projectMap node */
|
|
1199
|
+
description?: string;
|
|
1200
|
+
/** @description Parent path of the current node, only included if requested with the expanded flag */
|
|
1201
|
+
parentPath?: string;
|
|
1202
|
+
/** @description Last segment of the url */
|
|
1203
|
+
pathSegment?: string;
|
|
1204
|
+
/** @description returns true if the node is a leaf node, meaning having no children, only included if requested with the expanded flag */
|
|
1205
|
+
isLeaf?: boolean;
|
|
1206
|
+
compositionData?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeCompositionData"];
|
|
1207
|
+
sourceRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapSourceRedirectData"];
|
|
1208
|
+
targetRedirects?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapTargetRedirectData"];
|
|
1209
|
+
locales?: {
|
|
1210
|
+
[key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocale"];
|
|
1211
|
+
};
|
|
1212
|
+
};
|
|
1213
|
+
ProjectMapNodeLocale: {
|
|
1214
|
+
/** @description Name of node in the locale */
|
|
1215
|
+
name?: string;
|
|
1216
|
+
/** @description Full path to the current node in this locale, only included if requested with the expanded flag */
|
|
1217
|
+
path?: string;
|
|
1218
|
+
/** @description Last segment of the url in this locale */
|
|
1219
|
+
pathSegment: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* @description When false, the node explicitly defines a locale specific path segment.
|
|
1222
|
+
*
|
|
1223
|
+
* When true, an ancestor defines a locale specific path segment,
|
|
1224
|
+
* which makes its descendants resolvable using that segment.
|
|
1225
|
+
* This node does not define a locale specific path segment.
|
|
1226
|
+
*
|
|
1227
|
+
* Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
|
|
1228
|
+
*/
|
|
1229
|
+
inherited?: boolean;
|
|
1230
|
+
};
|
|
1231
|
+
ProjectMapSourceRedirectData: {
|
|
1232
|
+
/**
|
|
1233
|
+
* Format: uuid
|
|
1234
|
+
* @description The public UUID of the source redirect
|
|
1235
|
+
*/
|
|
1236
|
+
id?: string;
|
|
1237
|
+
}[];
|
|
1238
|
+
ProjectMapTargetRedirectData: {
|
|
1239
|
+
/**
|
|
1240
|
+
* Format: uuid
|
|
1241
|
+
* @description The public UUID of the target redirect
|
|
1242
|
+
*/
|
|
1243
|
+
id?: string;
|
|
1244
|
+
}[];
|
|
1245
|
+
/** @description Basic information about a composition from the context of a project map node. */
|
|
1246
|
+
ProjectMapNodeCompositionData: {
|
|
1247
|
+
/** @description Type of the composition instance (public_id of its definition) */
|
|
1248
|
+
type: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* Format: uuid
|
|
1251
|
+
* @description The public UUID of the composition.
|
|
1252
|
+
*/
|
|
1253
|
+
id: string;
|
|
1254
|
+
/** @description Slug pattern of this composition. */
|
|
1255
|
+
slug?: string | null;
|
|
1256
|
+
/** @description Friendly name of this composition. */
|
|
1257
|
+
name: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* @deprecated
|
|
1260
|
+
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
|
|
1261
|
+
* @enum {string}
|
|
1262
|
+
*/
|
|
1263
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
|
1264
|
+
/**
|
|
1265
|
+
* @description Icon name or URL for the composition definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
1266
|
+
* @default screen
|
|
1267
|
+
*/
|
|
1268
|
+
icon?: string;
|
|
1269
|
+
/** @description Friendly name of this Composition's Definition */
|
|
1270
|
+
typeName?: string;
|
|
1271
|
+
/** @description List of locales that the composition is available in. If empty, available in all locales. */
|
|
1272
|
+
locales: string[];
|
|
1273
|
+
};
|
|
1274
|
+
ProjectMapNodeUpdate: {
|
|
1275
|
+
/**
|
|
1276
|
+
* Format: uuid
|
|
1277
|
+
* @description The id of the projectMap entry
|
|
1278
|
+
*/
|
|
1279
|
+
id?: string;
|
|
1280
|
+
/** @description Path representing the path to the current node */
|
|
1281
|
+
path: string;
|
|
1282
|
+
/** @description Ordering of the node, higher numbers go after lower numbers. */
|
|
1283
|
+
order?: number;
|
|
1284
|
+
data?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeData"];
|
|
1285
|
+
/** @description The name of the projectMap entry */
|
|
1286
|
+
name: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* @description The type of the projectMap entry
|
|
1289
|
+
* @enum {string}
|
|
1290
|
+
*/
|
|
1291
|
+
type: "composition" | "placeholder";
|
|
1292
|
+
/**
|
|
1293
|
+
* Format: uuid
|
|
1294
|
+
* @description The composition id related to the projectMap entry
|
|
1295
|
+
*/
|
|
1296
|
+
compositionId?: string;
|
|
1297
|
+
/** @description Description of the projectMap node */
|
|
1298
|
+
description?: string;
|
|
1299
|
+
locales?: {
|
|
1300
|
+
[key: string]: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeLocaleUpdate"];
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
ProjectMapNodeLocaleUpdate: {
|
|
1304
|
+
/** @description Name of node in the locale */
|
|
1305
|
+
name?: string;
|
|
1306
|
+
/** @description Locale specific path segment for this node (not a full path) */
|
|
1307
|
+
pathSegment: string;
|
|
1308
|
+
};
|
|
1309
|
+
ProjectMapNodeData: {
|
|
1310
|
+
/** @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 */
|
|
1311
|
+
isSearchHit?: boolean;
|
|
1312
|
+
/** @description Query strings that are allowed to be passed to the node */
|
|
1313
|
+
queryStrings?: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1314
|
+
/**
|
|
1315
|
+
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1316
|
+
* The preview value is used when editing a connected composition, and is the default
|
|
1317
|
+
* dynamic node value unless the author has explicitly chosen a different value.
|
|
1318
|
+
*/
|
|
1319
|
+
previewValue?: string;
|
|
1320
|
+
};
|
|
1321
|
+
ProjectMapNodeAllowedQueryString: {
|
|
1322
|
+
/** @description The name of the query string parameter */
|
|
1323
|
+
name: string;
|
|
1324
|
+
/** @description The default value of the query string if it is not provided by an incoming route path */
|
|
1325
|
+
value: string;
|
|
1326
|
+
/** @description Help text for authors who might be setting up a preview value for this query string */
|
|
1327
|
+
helpText?: string;
|
|
1328
|
+
};
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
operations: {};
|
|
1332
|
+
};
|
|
1333
|
+
"v1-project-map-tree.swagger.yml": {
|
|
1334
|
+
paths: {};
|
|
1335
|
+
components: {
|
|
1336
|
+
schemas: {
|
|
1337
|
+
ProjectMapTreeNodeDefinition: external["v1-project-map-nodes.swagger.yml"]["components"]["schemas"]["ProjectMapNodeDefinition"] & {
|
|
1338
|
+
/** @description Children of the node */
|
|
1339
|
+
children?: external["v1-project-map-tree.swagger.yml"]["components"]["schemas"]["ProjectMapTreeNodeDefinition"][];
|
|
1340
|
+
} & {
|
|
1341
|
+
name: unknown;
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
};
|
|
1345
|
+
operations: {};
|
|
1346
|
+
};
|
|
986
1347
|
}
|
|
987
1348
|
|
|
988
1349
|
type AssetUpsertRequest = paths['/api/v1/assets']['put']['requestBody']['content']['application/json'];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/assets",
|
|
3
|
-
"version": "19.134.3-alpha.
|
|
3
|
+
"version": "19.134.3-alpha.28+506233b832",
|
|
4
4
|
"description": "Uniform Assets",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"access": "public"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@uniformdev/context": "19.134.3-alpha.
|
|
39
|
+
"@uniformdev/context": "19.134.3-alpha.28+506233b832"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "506233b8324cbb3d7d6a0ef97b8d5e01b36bfb08"
|
|
42
42
|
}
|