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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +58 -3
  2. package/dist/index.d.ts +58 -3
  3. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -332,6 +332,11 @@ interface external {
332
332
  helpText?: string;
333
333
  /** @description Type name of the parameter (provided by a Uniform integration) */
334
334
  type: string;
335
+ /**
336
+ * @description If true, this property can have locale-specific values. If false or not defined,
337
+ * this property will have a single value that is shared for all locales.
338
+ */
339
+ localizable?: boolean;
335
340
  /** @description The configuration object for the type (type-specific) */
336
341
  typeConfig?: unknown;
337
342
  };
@@ -429,6 +434,12 @@ interface external {
429
434
  * @default null
430
435
  */
431
436
  titleParameter?: string | null;
437
+ /**
438
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
439
+ *
440
+ * @default null
441
+ */
442
+ thumbnailParameter?: string | null;
432
443
  /**
433
444
  * @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
445
  * @default false
@@ -481,6 +492,12 @@ interface external {
481
492
  * The field type must support being used as an entry name for this to work.
482
493
  */
483
494
  entryName?: string | null;
495
+ /**
496
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
497
+ *
498
+ * @default null
499
+ */
500
+ thumbnailField?: string | null;
484
501
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
485
502
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
486
503
  /**
@@ -504,15 +521,29 @@ interface external {
504
521
  * @enum {string}
505
522
  */
506
523
  type?: "contentType" | "block";
524
+ /**
525
+ * @description if this content type uses team permissions or custom permissions
526
+ * @default true
527
+ */
528
+ useTeamPermissions?: boolean;
529
+ /** @description Custom role permissions for this content type */
530
+ permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
507
531
  };
508
532
  /** @description Defines an editable parameter on a component. */
509
533
  ComponentParameter: {
510
534
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
511
- value: unknown;
535
+ value?: unknown;
512
536
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
513
537
  type: string;
514
538
  /** @deprecated */
515
539
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
540
+ /**
541
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
542
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
543
+ */
544
+ locales?: {
545
+ [key: string]: unknown;
546
+ };
516
547
  };
517
548
  /** @description Defines a connection to a dynamic token on a data resource. */
518
549
  DataElementConnectionDefinition: {
@@ -587,6 +618,8 @@ interface external {
587
618
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
588
619
  */
589
620
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
621
+ /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
622
+ _locales?: string[];
590
623
  };
591
624
  /** @description Defines the shape of the root component in a composition */
592
625
  RootComponentInstance: {
@@ -610,6 +643,15 @@ interface external {
610
643
  _slug?: string | null;
611
644
  /** @description Friendly name of this component. */
612
645
  _name: string;
646
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
647
+ _pattern?: string;
648
+ /**
649
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
650
+ * Means nothing for PUTs; it will be ignored.
651
+ */
652
+ _patternDataResources?: {
653
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
654
+ };
613
655
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
614
656
  /**
615
657
  * @description Defines patch overrides to component IDs that live in the composition.
@@ -634,6 +676,8 @@ interface external {
634
676
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
635
677
  */
636
678
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
679
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
680
+ _locales?: string[];
637
681
  };
638
682
  /**
639
683
  * @description Defines how to override a specific component.
@@ -700,7 +744,18 @@ interface external {
700
744
  variables?: {
701
745
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
702
746
  };
703
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
747
+ /**
748
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
749
+ * If a locale is not mapped, it will be passed through to the data source as-is.
750
+ */
751
+ localeMapping?: {
752
+ [key: string]: string;
753
+ };
754
+ /** @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. */
755
+ customPublic?: {
756
+ [key: string]: unknown;
757
+ };
758
+ /** @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
759
  custom?: {
705
760
  [key: string]: unknown;
706
761
  };
@@ -921,4 +976,4 @@ declare class UncachedAssetClient extends AssetClient {
921
976
  */
922
977
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
923
978
 
924
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
979
+ 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
@@ -332,6 +332,11 @@ interface external {
332
332
  helpText?: string;
333
333
  /** @description Type name of the parameter (provided by a Uniform integration) */
334
334
  type: string;
335
+ /**
336
+ * @description If true, this property can have locale-specific values. If false or not defined,
337
+ * this property will have a single value that is shared for all locales.
338
+ */
339
+ localizable?: boolean;
335
340
  /** @description The configuration object for the type (type-specific) */
336
341
  typeConfig?: unknown;
337
342
  };
@@ -429,6 +434,12 @@ interface external {
429
434
  * @default null
430
435
  */
431
436
  titleParameter?: string | null;
437
+ /**
438
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
439
+ *
440
+ * @default null
441
+ */
442
+ thumbnailParameter?: string | null;
432
443
  /**
433
444
  * @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
445
  * @default false
@@ -481,6 +492,12 @@ interface external {
481
492
  * The field type must support being used as an entry name for this to work.
482
493
  */
483
494
  entryName?: string | null;
495
+ /**
496
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
497
+ *
498
+ * @default null
499
+ */
500
+ thumbnailField?: string | null;
484
501
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
485
502
  fields?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
486
503
  /**
@@ -504,15 +521,29 @@ interface external {
504
521
  * @enum {string}
505
522
  */
506
523
  type?: "contentType" | "block";
524
+ /**
525
+ * @description if this content type uses team permissions or custom permissions
526
+ * @default true
527
+ */
528
+ useTeamPermissions?: boolean;
529
+ /** @description Custom role permissions for this content type */
530
+ permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
507
531
  };
508
532
  /** @description Defines an editable parameter on a component. */
509
533
  ComponentParameter: {
510
534
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
511
- value: unknown;
535
+ value?: unknown;
512
536
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
513
537
  type: string;
514
538
  /** @deprecated */
515
539
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
540
+ /**
541
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
542
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
543
+ */
544
+ locales?: {
545
+ [key: string]: unknown;
546
+ };
516
547
  };
517
548
  /** @description Defines a connection to a dynamic token on a data resource. */
518
549
  DataElementConnectionDefinition: {
@@ -587,6 +618,8 @@ interface external {
587
618
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
588
619
  */
589
620
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
621
+ /** @description Array of locales which have data defined. Only set for pattern references or composition defaults. */
622
+ _locales?: string[];
590
623
  };
591
624
  /** @description Defines the shape of the root component in a composition */
592
625
  RootComponentInstance: {
@@ -610,6 +643,15 @@ interface external {
610
643
  _slug?: string | null;
611
644
  /** @description Friendly name of this component. */
612
645
  _name: string;
646
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
647
+ _pattern?: string;
648
+ /**
649
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
650
+ * Means nothing for PUTs; it will be ignored.
651
+ */
652
+ _patternDataResources?: {
653
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
654
+ };
613
655
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
614
656
  /**
615
657
  * @description Defines patch overrides to component IDs that live in the composition.
@@ -634,6 +676,8 @@ interface external {
634
676
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
635
677
  */
636
678
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
679
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
680
+ _locales?: string[];
637
681
  };
638
682
  /**
639
683
  * @description Defines how to override a specific component.
@@ -700,7 +744,18 @@ interface external {
700
744
  variables?: {
701
745
  [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
702
746
  };
703
- /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
747
+ /**
748
+ * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
749
+ * If a locale is not mapped, it will be passed through to the data source as-is.
750
+ */
751
+ localeMapping?: {
752
+ [key: string]: string;
753
+ };
754
+ /** @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. */
755
+ customPublic?: {
756
+ [key: string]: unknown;
757
+ };
758
+ /** @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
759
  custom?: {
705
760
  [key: string]: unknown;
706
761
  };
@@ -921,4 +976,4 @@ declare class UncachedAssetClient extends AssetClient {
921
976
  */
922
977
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
923
978
 
924
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
979
+ 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.13+608a273da",
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.13+608a273da"
40
40
  },
41
- "gitHead": "4547ef8469f21f7f2341bcd87203372c4646bc08"
41
+ "gitHead": "608a273da87aa432f17b2c8ce15d747dadab0cd1"
42
42
  }