@uniformdev/assets 19.79.1-alpha.11 → 19.79.1-alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/LICENSE.txt +1 -1
  2. package/dist/index.d.mts +98 -3
  3. package/dist/index.d.ts +98 -3
  4. package/package.json +3 -3
package/LICENSE.txt CHANGED
@@ -1,2 +1,2 @@
1
- © 2023 Uniform Systems, Inc. All Rights Reserved.
1
+ © 2024 Uniform Systems, Inc. All Rights Reserved.
2
2
  See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula
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,6 +90,11 @@ interface paths {
81
90
  * @description The project ID to upsert the asset to
82
91
  */
83
92
  projectId: string;
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;
84
98
  asset?: components["schemas"]["AssetInput"];
85
99
  assets?: components["schemas"]["AssetInput"][];
86
100
  };
@@ -111,6 +125,12 @@ interface paths {
111
125
  * @description The ID of the project the asset to delete belongs to
112
126
  */
113
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;
114
134
  };
115
135
  };
116
136
  };
@@ -235,6 +255,11 @@ interface components {
235
255
  * @description Modified date string for this definition
236
256
  */
237
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;
238
263
  asset: components["schemas"]["Asset"];
239
264
  };
240
265
  AssetListResponse: {
@@ -272,6 +297,15 @@ interface components {
272
297
  * Has no effect when not fetching a list. This does impact performance when enabled.
273
298
  */
274
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;
275
309
  };
276
310
  }
277
311
  interface external {
@@ -332,6 +366,11 @@ interface external {
332
366
  helpText?: string;
333
367
  /** @description Type name of the parameter (provided by a Uniform integration) */
334
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;
335
374
  /** @description The configuration object for the type (type-specific) */
336
375
  typeConfig?: unknown;
337
376
  };
@@ -429,6 +468,12 @@ interface external {
429
468
  * @default null
430
469
  */
431
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;
432
477
  /**
433
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.
434
479
  * @default false
@@ -481,6 +526,12 @@ interface external {
481
526
  * The field type must support being used as an entry name for this to work.
482
527
  */
483
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;
484
535
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
485
536
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
486
537
  /**
@@ -504,15 +555,29 @@ interface external {
504
555
  * @enum {string}
505
556
  */
506
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"][];
507
565
  };
508
566
  /** @description Defines an editable parameter on a component. */
509
567
  ComponentParameter: {
510
568
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
511
- value: unknown;
569
+ value?: unknown;
512
570
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
513
571
  type: string;
514
572
  /** @deprecated */
515
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
+ };
516
581
  };
517
582
  /** @description Defines a connection to a dynamic token on a data resource. */
518
583
  DataElementConnectionDefinition: {
@@ -587,6 +652,8 @@ interface external {
587
652
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
588
653
  */
589
654
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
655
+ /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
656
+ _locales?: string[];
590
657
  };
591
658
  /** @description Defines the shape of the root component in a composition */
592
659
  RootComponentInstance: {
@@ -610,6 +677,15 @@ interface external {
610
677
  _slug?: string | null;
611
678
  /** @description Friendly name of this component. */
612
679
  _name: string;
680
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
681
+ _pattern?: string;
682
+ /**
683
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
684
+ * Means nothing for PUTs; it will be ignored.
685
+ */
686
+ _patternDataResources?: {
687
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
688
+ };
613
689
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
614
690
  /**
615
691
  * @description Defines patch overrides to component IDs that live in the composition.
@@ -634,6 +710,8 @@ interface external {
634
710
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
635
711
  */
636
712
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
713
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
714
+ _locales?: string[];
637
715
  };
638
716
  /**
639
717
  * @description Defines how to override a specific component.
@@ -661,6 +739,12 @@ interface external {
661
739
  };
662
740
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
663
741
  variants?: boolean;
742
+ /**
743
+ * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
744
+ * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
745
+ * If not set, the default is false.
746
+ */
747
+ hideLockedParameters?: boolean;
664
748
  };
665
749
  /**
666
750
  * @description Whether a parameter is overridable
@@ -700,7 +784,18 @@ interface external {
700
784
  variables?: {
701
785
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
702
786
  };
703
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
787
+ /**
788
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
789
+ * If a locale is not mapped, it will be passed through to the data source as-is.
790
+ */
791
+ localeMapping?: {
792
+ [key: string]: string;
793
+ };
794
+ /** @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. */
795
+ customPublic?: {
796
+ [key: string]: unknown;
797
+ };
798
+ /** @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. */
704
799
  custom?: {
705
800
  [key: string]: unknown;
706
801
  };
@@ -921,4 +1016,4 @@ declare class UncachedAssetClient extends AssetClient {
921
1016
  */
922
1017
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
923
1018
 
924
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
1019
+ export { type Asset, AssetClient, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
package/dist/index.d.ts 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,6 +90,11 @@ interface paths {
81
90
  * @description The project ID to upsert the asset to
82
91
  */
83
92
  projectId: string;
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;
84
98
  asset?: components["schemas"]["AssetInput"];
85
99
  assets?: components["schemas"]["AssetInput"][];
86
100
  };
@@ -111,6 +125,12 @@ interface paths {
111
125
  * @description The ID of the project the asset to delete belongs to
112
126
  */
113
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;
114
134
  };
115
135
  };
116
136
  };
@@ -235,6 +255,11 @@ interface components {
235
255
  * @description Modified date string for this definition
236
256
  */
237
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;
238
263
  asset: components["schemas"]["Asset"];
239
264
  };
240
265
  AssetListResponse: {
@@ -272,6 +297,15 @@ interface components {
272
297
  * Has no effect when not fetching a list. This does impact performance when enabled.
273
298
  */
274
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;
275
309
  };
276
310
  }
277
311
  interface external {
@@ -332,6 +366,11 @@ interface external {
332
366
  helpText?: string;
333
367
  /** @description Type name of the parameter (provided by a Uniform integration) */
334
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;
335
374
  /** @description The configuration object for the type (type-specific) */
336
375
  typeConfig?: unknown;
337
376
  };
@@ -429,6 +468,12 @@ interface external {
429
468
  * @default null
430
469
  */
431
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;
432
477
  /**
433
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.
434
479
  * @default false
@@ -481,6 +526,12 @@ interface external {
481
526
  * The field type must support being used as an entry name for this to work.
482
527
  */
483
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;
484
535
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
485
536
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
486
537
  /**
@@ -504,15 +555,29 @@ interface external {
504
555
  * @enum {string}
505
556
  */
506
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"][];
507
565
  };
508
566
  /** @description Defines an editable parameter on a component. */
509
567
  ComponentParameter: {
510
568
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
511
- value: unknown;
569
+ value?: unknown;
512
570
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
513
571
  type: string;
514
572
  /** @deprecated */
515
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
+ };
516
581
  };
517
582
  /** @description Defines a connection to a dynamic token on a data resource. */
518
583
  DataElementConnectionDefinition: {
@@ -587,6 +652,8 @@ interface external {
587
652
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
588
653
  */
589
654
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
655
+ /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
656
+ _locales?: string[];
590
657
  };
591
658
  /** @description Defines the shape of the root component in a composition */
592
659
  RootComponentInstance: {
@@ -610,6 +677,15 @@ interface external {
610
677
  _slug?: string | null;
611
678
  /** @description Friendly name of this component. */
612
679
  _name: string;
680
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
681
+ _pattern?: string;
682
+ /**
683
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
684
+ * Means nothing for PUTs; it will be ignored.
685
+ */
686
+ _patternDataResources?: {
687
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
688
+ };
613
689
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
614
690
  /**
615
691
  * @description Defines patch overrides to component IDs that live in the composition.
@@ -634,6 +710,8 @@ interface external {
634
710
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
635
711
  */
636
712
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
713
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
714
+ _locales?: string[];
637
715
  };
638
716
  /**
639
717
  * @description Defines how to override a specific component.
@@ -661,6 +739,12 @@ interface external {
661
739
  };
662
740
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
663
741
  variants?: boolean;
742
+ /**
743
+ * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
744
+ * If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
745
+ * If not set, the default is false.
746
+ */
747
+ hideLockedParameters?: boolean;
664
748
  };
665
749
  /**
666
750
  * @description Whether a parameter is overridable
@@ -700,7 +784,18 @@ interface external {
700
784
  variables?: {
701
785
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
702
786
  };
703
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
787
+ /**
788
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
789
+ * If a locale is not mapped, it will be passed through to the data source as-is.
790
+ */
791
+ localeMapping?: {
792
+ [key: string]: string;
793
+ };
794
+ /** @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. */
795
+ customPublic?: {
796
+ [key: string]: unknown;
797
+ };
798
+ /** @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. */
704
799
  custom?: {
705
800
  [key: string]: unknown;
706
801
  };
@@ -921,4 +1016,4 @@ declare class UncachedAssetClient extends AssetClient {
921
1016
  */
922
1017
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
923
1018
 
924
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
1019
+ export { type Asset, AssetClient, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.79.1-alpha.11+4547ef846",
3
+ "version": "19.79.1-alpha.18+12234b9350",
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.79.1-alpha.11+4547ef846"
39
+ "@uniformdev/context": "19.79.1-alpha.18+12234b9350"
40
40
  },
41
- "gitHead": "4547ef8469f21f7f2341bcd87203372c4646bc08"
41
+ "gitHead": "12234b9350cfa4209bc7e242701d2dc535ece19e"
42
42
  }