@uniformdev/assets 20.51.0 → 20.53.1-alpha.7

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
@@ -971,9 +971,15 @@ interface paths {
971
971
  limit?: components["parameters"]["limit"];
972
972
  /** @description Number of records to skip */
973
973
  offset?: components["parameters"]["offset"];
974
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
974
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
975
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
975
976
  * */
976
977
  orderBy?: components["parameters"]["orderBy"];
978
+ /**
979
+ * @deprecated
980
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
981
+ */
982
+ facetBy?: components["parameters"]["facetBy"];
977
983
  /** @description The project the asset/assets are on */
978
984
  projectId: components["parameters"]["projectId"];
979
985
  /** @description The asset type ID to filter by */
@@ -993,6 +999,18 @@ interface paths {
993
999
  * 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
994
1000
  * */
995
1001
  releaseId?: components["parameters"]["releaseId"];
1002
+ /** @description When true, includes full label entities in the response for UI rendering.
1003
+ * The assignedLabels array includes the label and its parent group (if any).
1004
+ * This parameter is not supported with uniform.global.
1005
+ * */
1006
+ withAssignedLabels?: components["parameters"]["withAssignedLabels"];
1007
+ /**
1008
+ * @deprecated
1009
+ * @description Returns additional author and creator metadata for the asset.
1010
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1011
+ *
1012
+ */
1013
+ withUIStatus?: components["parameters"]["withUIStatus"];
996
1014
  };
997
1015
  header?: never;
998
1016
  path?: never;
@@ -1155,6 +1173,12 @@ interface components {
1155
1173
  _name: string;
1156
1174
  /** @description Name of the author of the most recent change */
1157
1175
  _author?: string;
1176
+ /** @description Identity subject of the author of the most recent change */
1177
+ _authorSubject?: string;
1178
+ /** @description Name of the original creator */
1179
+ _creator?: string;
1180
+ /** @description Identity subject of the original creator */
1181
+ _creatorSubject?: string;
1158
1182
  fields?: {
1159
1183
  title?: {
1160
1184
  value: string;
@@ -1211,6 +1235,8 @@ interface components {
1211
1235
  };
1212
1236
  };
1213
1237
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1238
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1239
+ labels?: string[];
1214
1240
  };
1215
1241
  /** @description Defines the shape of the asset input */
1216
1242
  AssetInput: {
@@ -1250,6 +1276,8 @@ interface components {
1250
1276
  };
1251
1277
  };
1252
1278
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1279
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1280
+ labels?: string[];
1253
1281
  };
1254
1282
  AssetApiResponse: {
1255
1283
  /**
@@ -1273,11 +1301,46 @@ interface components {
1273
1301
  */
1274
1302
  releaseId?: string;
1275
1303
  asset: components["schemas"]["Asset"];
1304
+ /** @description Full label entities for UI rendering (only present when withAssignedLabels=true). Read-only. */
1305
+ assignedLabels?: {
1306
+ [key: string]: {
1307
+ /** Format: uuid */
1308
+ projectId: string;
1309
+ label: {
1310
+ /** @description Public ID of the label (cannot be changed after creation) */
1311
+ publicId: string;
1312
+ /** @description Human readable name of the label */
1313
+ displayName: string;
1314
+ /** @description Whether this label is a group label (cannot be changed after creation) */
1315
+ isGroup: boolean;
1316
+ /** @description Public ID of the parent group label */
1317
+ parent?: string;
1318
+ /** @description Human readable color identifier */
1319
+ color: string;
1320
+ /** @description Short description of what the label is about */
1321
+ description?: string;
1322
+ /** @description Scope of the label (currently unused) */
1323
+ scope: string[];
1324
+ };
1325
+ /** Format: date-time */
1326
+ created: string;
1327
+ /** Format: date-time */
1328
+ modified: string;
1329
+ createdBy?: string;
1330
+ modifiedBy?: string;
1331
+ };
1332
+ };
1276
1333
  };
1277
1334
  AssetListResponse: {
1278
1335
  assets: components["schemas"]["AssetApiResponse"][];
1279
1336
  /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
1280
1337
  totalCount?: number;
1338
+ /** @description Per-field counts for distinct values */
1339
+ facets?: {
1340
+ [key: string]: {
1341
+ [key: string]: number;
1342
+ };
1343
+ };
1281
1344
  };
1282
1345
  /** @description Defines a connection to a dynamic token on a data resource
1283
1346
  * */
@@ -1482,9 +1545,15 @@ interface components {
1482
1545
  * This is a list query parameter, and cannot be used with any primary query parameters
1483
1546
  * */
1484
1547
  keyword: string;
1485
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
1548
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
1549
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
1486
1550
  * */
1487
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
1551
+ orderBy: string[];
1552
+ /**
1553
+ * @deprecated
1554
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
1555
+ */
1556
+ facetBy: string;
1488
1557
  /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
1489
1558
  * */
1490
1559
  createdBy: string;
@@ -1503,6 +1572,18 @@ interface components {
1503
1572
  * 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
1504
1573
  * */
1505
1574
  releaseId: string;
1575
+ /** @description When true, includes full label entities in the response for UI rendering.
1576
+ * The assignedLabels array includes the label and its parent group (if any).
1577
+ * This parameter is not supported with uniform.global.
1578
+ * */
1579
+ withAssignedLabels: boolean;
1580
+ /**
1581
+ * @deprecated
1582
+ * @description Returns additional author and creator metadata for the asset.
1583
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1584
+ *
1585
+ */
1586
+ withUIStatus: boolean;
1506
1587
  };
1507
1588
  requestBodies: never;
1508
1589
  headers: never;
@@ -1601,8 +1682,12 @@ declare class AssetClient extends ApiClient {
1601
1682
  constructor(options: ClientOptions & {
1602
1683
  projectId: NonNullable<ClientOptions['projectId']>;
1603
1684
  });
1604
- get(options: WithoutProjectId<AssetGetRequestSingle>): Promise<AssetGetResponseSingle>;
1605
- get(options: WithoutProjectId<AssetGetRequestList>): Promise<AssetGetResponseList>;
1685
+ get(options: WithoutProjectId<AssetGetRequestSingle> & {
1686
+ filters?: never;
1687
+ }): Promise<AssetGetResponseSingle>;
1688
+ get(options: WithoutProjectId<AssetGetRequestList> & {
1689
+ filters?: Record<string, unknown>;
1690
+ }): Promise<AssetGetResponseList>;
1606
1691
  upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
1607
1692
  delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
1608
1693
  }
package/dist/index.d.ts CHANGED
@@ -971,9 +971,15 @@ interface paths {
971
971
  limit?: components["parameters"]["limit"];
972
972
  /** @description Number of records to skip */
973
973
  offset?: components["parameters"]["offset"];
974
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
974
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
975
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
975
976
  * */
976
977
  orderBy?: components["parameters"]["orderBy"];
978
+ /**
979
+ * @deprecated
980
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
981
+ */
982
+ facetBy?: components["parameters"]["facetBy"];
977
983
  /** @description The project the asset/assets are on */
978
984
  projectId: components["parameters"]["projectId"];
979
985
  /** @description The asset type ID to filter by */
@@ -993,6 +999,18 @@ interface paths {
993
999
  * 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
994
1000
  * */
995
1001
  releaseId?: components["parameters"]["releaseId"];
1002
+ /** @description When true, includes full label entities in the response for UI rendering.
1003
+ * The assignedLabels array includes the label and its parent group (if any).
1004
+ * This parameter is not supported with uniform.global.
1005
+ * */
1006
+ withAssignedLabels?: components["parameters"]["withAssignedLabels"];
1007
+ /**
1008
+ * @deprecated
1009
+ * @description Returns additional author and creator metadata for the asset.
1010
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1011
+ *
1012
+ */
1013
+ withUIStatus?: components["parameters"]["withUIStatus"];
996
1014
  };
997
1015
  header?: never;
998
1016
  path?: never;
@@ -1155,6 +1173,12 @@ interface components {
1155
1173
  _name: string;
1156
1174
  /** @description Name of the author of the most recent change */
1157
1175
  _author?: string;
1176
+ /** @description Identity subject of the author of the most recent change */
1177
+ _authorSubject?: string;
1178
+ /** @description Name of the original creator */
1179
+ _creator?: string;
1180
+ /** @description Identity subject of the original creator */
1181
+ _creatorSubject?: string;
1158
1182
  fields?: {
1159
1183
  title?: {
1160
1184
  value: string;
@@ -1211,6 +1235,8 @@ interface components {
1211
1235
  };
1212
1236
  };
1213
1237
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1238
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1239
+ labels?: string[];
1214
1240
  };
1215
1241
  /** @description Defines the shape of the asset input */
1216
1242
  AssetInput: {
@@ -1250,6 +1276,8 @@ interface components {
1250
1276
  };
1251
1277
  };
1252
1278
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1279
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1280
+ labels?: string[];
1253
1281
  };
1254
1282
  AssetApiResponse: {
1255
1283
  /**
@@ -1273,11 +1301,46 @@ interface components {
1273
1301
  */
1274
1302
  releaseId?: string;
1275
1303
  asset: components["schemas"]["Asset"];
1304
+ /** @description Full label entities for UI rendering (only present when withAssignedLabels=true). Read-only. */
1305
+ assignedLabels?: {
1306
+ [key: string]: {
1307
+ /** Format: uuid */
1308
+ projectId: string;
1309
+ label: {
1310
+ /** @description Public ID of the label (cannot be changed after creation) */
1311
+ publicId: string;
1312
+ /** @description Human readable name of the label */
1313
+ displayName: string;
1314
+ /** @description Whether this label is a group label (cannot be changed after creation) */
1315
+ isGroup: boolean;
1316
+ /** @description Public ID of the parent group label */
1317
+ parent?: string;
1318
+ /** @description Human readable color identifier */
1319
+ color: string;
1320
+ /** @description Short description of what the label is about */
1321
+ description?: string;
1322
+ /** @description Scope of the label (currently unused) */
1323
+ scope: string[];
1324
+ };
1325
+ /** Format: date-time */
1326
+ created: string;
1327
+ /** Format: date-time */
1328
+ modified: string;
1329
+ createdBy?: string;
1330
+ modifiedBy?: string;
1331
+ };
1332
+ };
1276
1333
  };
1277
1334
  AssetListResponse: {
1278
1335
  assets: components["schemas"]["AssetApiResponse"][];
1279
1336
  /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
1280
1337
  totalCount?: number;
1338
+ /** @description Per-field counts for distinct values */
1339
+ facets?: {
1340
+ [key: string]: {
1341
+ [key: string]: number;
1342
+ };
1343
+ };
1281
1344
  };
1282
1345
  /** @description Defines a connection to a dynamic token on a data resource
1283
1346
  * */
@@ -1482,9 +1545,15 @@ interface components {
1482
1545
  * This is a list query parameter, and cannot be used with any primary query parameters
1483
1546
  * */
1484
1547
  keyword: string;
1485
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
1548
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
1549
+ * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
1486
1550
  * */
1487
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
1551
+ orderBy: string[];
1552
+ /**
1553
+ * @deprecated
1554
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
1555
+ */
1556
+ facetBy: string;
1488
1557
  /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
1489
1558
  * */
1490
1559
  createdBy: string;
@@ -1503,6 +1572,18 @@ interface components {
1503
1572
  * 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
1504
1573
  * */
1505
1574
  releaseId: string;
1575
+ /** @description When true, includes full label entities in the response for UI rendering.
1576
+ * The assignedLabels array includes the label and its parent group (if any).
1577
+ * This parameter is not supported with uniform.global.
1578
+ * */
1579
+ withAssignedLabels: boolean;
1580
+ /**
1581
+ * @deprecated
1582
+ * @description Returns additional author and creator metadata for the asset.
1583
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1584
+ *
1585
+ */
1586
+ withUIStatus: boolean;
1506
1587
  };
1507
1588
  requestBodies: never;
1508
1589
  headers: never;
@@ -1601,8 +1682,12 @@ declare class AssetClient extends ApiClient {
1601
1682
  constructor(options: ClientOptions & {
1602
1683
  projectId: NonNullable<ClientOptions['projectId']>;
1603
1684
  });
1604
- get(options: WithoutProjectId<AssetGetRequestSingle>): Promise<AssetGetResponseSingle>;
1605
- get(options: WithoutProjectId<AssetGetRequestList>): Promise<AssetGetResponseList>;
1685
+ get(options: WithoutProjectId<AssetGetRequestSingle> & {
1686
+ filters?: never;
1687
+ }): Promise<AssetGetResponseSingle>;
1688
+ get(options: WithoutProjectId<AssetGetRequestList> & {
1689
+ filters?: Record<string, unknown>;
1690
+ }): Promise<AssetGetResponseList>;
1606
1691
  upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
1607
1692
  delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
1608
1693
  }
package/dist/index.esm.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // src/AssetClient.ts
2
- import { ApiClient } from "@uniformdev/context/api";
2
+ import { ApiClient, rewriteFiltersForApi } from "@uniformdev/context/api";
3
3
  var ASSET_BASE_PATH = "/api/v1/assets";
4
4
  var AssetClient = class extends ApiClient {
5
5
  constructor(options) {
@@ -7,9 +7,12 @@ var AssetClient = class extends ApiClient {
7
7
  }
8
8
  async get(options) {
9
9
  const { projectId } = this.options;
10
+ const { filters, ...params } = options;
11
+ const rewrittenFilters = rewriteFiltersForApi(filters);
10
12
  const fetchUri = this.createUrl(ASSET_BASE_PATH, {
11
- ...options,
12
- projectId
13
+ ...params,
14
+ projectId,
15
+ ...rewrittenFilters
13
16
  });
14
17
  return this.apiClient(fetchUri);
15
18
  }
@@ -142,6 +145,7 @@ function convertAssetToPutAsset(asset) {
142
145
  _dataResources: asset.asset._dataResources,
143
146
  _name: asset.asset._name,
144
147
  type: asset.asset.type,
148
+ labels: asset.asset.labels,
145
149
  fields: {
146
150
  title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
147
151
  description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
package/dist/index.js CHANGED
@@ -37,9 +37,12 @@ var AssetClient = class extends import_api.ApiClient {
37
37
  }
38
38
  async get(options) {
39
39
  const { projectId } = this.options;
40
+ const { filters, ...params } = options;
41
+ const rewrittenFilters = (0, import_api.rewriteFiltersForApi)(filters);
40
42
  const fetchUri = this.createUrl(ASSET_BASE_PATH, {
41
- ...options,
42
- projectId
43
+ ...params,
44
+ projectId,
45
+ ...rewrittenFilters
43
46
  });
44
47
  return this.apiClient(fetchUri);
45
48
  }
@@ -172,6 +175,7 @@ function convertAssetToPutAsset(asset) {
172
175
  _dataResources: asset.asset._dataResources,
173
176
  _name: asset.asset._name,
174
177
  type: asset.asset.type,
178
+ labels: asset.asset.labels,
175
179
  fields: {
176
180
  title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
177
181
  description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
package/dist/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  // src/AssetClient.ts
2
- import { ApiClient } from "@uniformdev/context/api";
2
+ import { ApiClient, rewriteFiltersForApi } from "@uniformdev/context/api";
3
3
  var ASSET_BASE_PATH = "/api/v1/assets";
4
4
  var AssetClient = class extends ApiClient {
5
5
  constructor(options) {
@@ -7,9 +7,12 @@ var AssetClient = class extends ApiClient {
7
7
  }
8
8
  async get(options) {
9
9
  const { projectId } = this.options;
10
+ const { filters, ...params } = options;
11
+ const rewrittenFilters = rewriteFiltersForApi(filters);
10
12
  const fetchUri = this.createUrl(ASSET_BASE_PATH, {
11
- ...options,
12
- projectId
13
+ ...params,
14
+ projectId,
15
+ ...rewrittenFilters
13
16
  });
14
17
  return this.apiClient(fetchUri);
15
18
  }
@@ -142,6 +145,7 @@ function convertAssetToPutAsset(asset) {
142
145
  _dataResources: asset.asset._dataResources,
143
146
  _name: asset.asset._name,
144
147
  type: asset.asset.type,
148
+ labels: asset.asset.labels,
145
149
  fields: {
146
150
  title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
147
151
  description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "20.51.0",
3
+ "version": "20.53.1-alpha.7+1c3bd56284",
4
4
  "description": "Uniform Assets",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -36,10 +36,10 @@
36
36
  "access": "public"
37
37
  },
38
38
  "dependencies": {
39
- "@uniformdev/context": "20.51.0"
39
+ "@uniformdev/context": "20.53.1-alpha.7+1c3bd56284"
40
40
  },
41
41
  "devDependencies": {
42
42
  "ts-xor": "^1.3.0"
43
43
  },
44
- "gitHead": "4e1041ff207d9098efcdca31686c5d58615315b3"
44
+ "gitHead": "1c3bd56284db96f16318a18e62b3b6e83cb09f9b"
45
45
  }