@uniformdev/assets 19.69.0 → 19.71.1-alpha.103

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 (6) hide show
  1. package/dist/index.d.mts +86 -64
  2. package/dist/index.d.ts +86 -64
  3. package/dist/index.esm.js +6 -3
  4. package/dist/index.js +6 -3
  5. package/dist/index.mjs +6 -3
  6. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -139,50 +139,52 @@ interface components {
139
139
  _name?: string;
140
140
  /** @description Name of the author of the most recent change. */
141
141
  _author?: string;
142
- title?: {
143
- value: string;
144
- /** @constant */
145
- type: "text";
146
- };
147
- description?: {
148
- value: string;
149
- /** @constant */
150
- type: "text";
151
- };
152
- file?: {
153
- /** Format: uuid */
154
- value: string;
155
- /** @constant */
156
- type: "file";
157
- };
158
- mediaType?: {
159
- value: string;
160
- /** @constant */
161
- type: "text";
162
- };
163
- url?: {
164
- value: string;
165
- /** @constant */
166
- type: "text";
167
- };
168
- size?: {
169
- value: number;
170
- /** @constant */
171
- type: "number";
172
- };
173
- width?: {
174
- value: number;
175
- /** @constant */
176
- type: "number";
177
- };
178
- height?: {
179
- value: number;
180
- /** @constant */
181
- type: "number";
182
- };
183
- /** @description Asset field values. */
184
- custom?: {
185
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
142
+ fields?: {
143
+ title?: {
144
+ value: string;
145
+ /** @constant */
146
+ type: "text";
147
+ };
148
+ description?: {
149
+ value: string;
150
+ /** @constant */
151
+ type: "text";
152
+ };
153
+ file?: {
154
+ /** Format: uuid */
155
+ value: string;
156
+ /** @constant */
157
+ type: "file";
158
+ };
159
+ mediaType?: {
160
+ value: string;
161
+ /** @constant */
162
+ type: "text";
163
+ };
164
+ url?: {
165
+ value: string;
166
+ /** @constant */
167
+ type: "text";
168
+ };
169
+ size?: {
170
+ value: number;
171
+ /** @constant */
172
+ type: "number";
173
+ };
174
+ width?: {
175
+ value: number;
176
+ /** @constant */
177
+ type: "number";
178
+ };
179
+ height?: {
180
+ value: number;
181
+ /** @constant */
182
+ type: "number";
183
+ };
184
+ /** @description Asset field values. */
185
+ custom?: {
186
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
187
+ };
186
188
  };
187
189
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
188
190
  };
@@ -197,21 +199,23 @@ interface components {
197
199
  _id?: string;
198
200
  /** @description The internal name of the asset. */
199
201
  _name?: string;
200
- title?: {
201
- value: string;
202
- /** @constant */
203
- type: "text";
204
- };
205
- description?: {
206
- value: string;
207
- /** @constant */
208
- type: "text";
209
- };
210
- file?: {
211
- /** Format: uuid */
212
- value: string;
213
- /** @constant */
214
- type: "file";
202
+ fields?: {
203
+ title?: {
204
+ value: string;
205
+ /** @constant */
206
+ type: "text";
207
+ };
208
+ description?: {
209
+ value: string;
210
+ /** @constant */
211
+ type: "text";
212
+ };
213
+ file?: {
214
+ /** Format: uuid */
215
+ value: string;
216
+ /** @constant */
217
+ type: "file";
218
+ };
215
219
  };
216
220
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
217
221
  };
@@ -328,6 +332,11 @@ interface external {
328
332
  helpText?: string;
329
333
  /** @description Type name of the parameter (provided by a Uniform integration) */
330
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;
331
340
  /** @description The configuration object for the type (type-specific) */
332
341
  typeConfig?: unknown;
333
342
  };
@@ -504,11 +513,18 @@ interface external {
504
513
  /** @description Defines an editable parameter on a component. */
505
514
  ComponentParameter: {
506
515
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
507
- value: unknown;
516
+ value?: unknown;
508
517
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
509
518
  type: string;
510
519
  /** @deprecated */
511
520
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
521
+ /**
522
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
523
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
524
+ */
525
+ locales?: {
526
+ [key: string]: unknown;
527
+ };
512
528
  };
513
529
  /** @description Defines a connection to a dynamic token on a data resource. */
514
530
  DataElementConnectionDefinition: {
@@ -630,6 +646,8 @@ interface external {
630
646
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
631
647
  */
632
648
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
649
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
650
+ _locales?: string[];
633
651
  };
634
652
  /**
635
653
  * @description Defines how to override a specific component.
@@ -861,15 +879,19 @@ interface external {
861
879
  /** @description Unique identifier for the integration that this prompt belongs to. */
862
880
  integrationType: string;
863
881
  /** @description Name for the prompt */
864
- promptName?: string | null;
882
+ name?: string | null;
865
883
  /** @description Text for the prompt */
866
- promptText?: string | null;
884
+ text?: string | null;
867
885
  /** @description Data for the prompt */
868
- promptData?: string | null;
886
+ data?: {
887
+ [key: string]: unknown;
888
+ } | null;
869
889
  /** @description Turn off/on prompt */
870
890
  enabled?: boolean | null;
871
891
  /** @description Integration default prompt */
872
892
  builtIn?: boolean | null;
893
+ /** @description Supported parameter types */
894
+ parameterTypes?: string[] | null;
873
895
  };
874
896
  };
875
897
  };
@@ -913,4 +935,4 @@ declare class UncachedAssetClient extends AssetClient {
913
935
  */
914
936
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
915
937
 
916
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
938
+ 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
@@ -139,50 +139,52 @@ interface components {
139
139
  _name?: string;
140
140
  /** @description Name of the author of the most recent change. */
141
141
  _author?: string;
142
- title?: {
143
- value: string;
144
- /** @constant */
145
- type: "text";
146
- };
147
- description?: {
148
- value: string;
149
- /** @constant */
150
- type: "text";
151
- };
152
- file?: {
153
- /** Format: uuid */
154
- value: string;
155
- /** @constant */
156
- type: "file";
157
- };
158
- mediaType?: {
159
- value: string;
160
- /** @constant */
161
- type: "text";
162
- };
163
- url?: {
164
- value: string;
165
- /** @constant */
166
- type: "text";
167
- };
168
- size?: {
169
- value: number;
170
- /** @constant */
171
- type: "number";
172
- };
173
- width?: {
174
- value: number;
175
- /** @constant */
176
- type: "number";
177
- };
178
- height?: {
179
- value: number;
180
- /** @constant */
181
- type: "number";
182
- };
183
- /** @description Asset field values. */
184
- custom?: {
185
- [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
142
+ fields?: {
143
+ title?: {
144
+ value: string;
145
+ /** @constant */
146
+ type: "text";
147
+ };
148
+ description?: {
149
+ value: string;
150
+ /** @constant */
151
+ type: "text";
152
+ };
153
+ file?: {
154
+ /** Format: uuid */
155
+ value: string;
156
+ /** @constant */
157
+ type: "file";
158
+ };
159
+ mediaType?: {
160
+ value: string;
161
+ /** @constant */
162
+ type: "text";
163
+ };
164
+ url?: {
165
+ value: string;
166
+ /** @constant */
167
+ type: "text";
168
+ };
169
+ size?: {
170
+ value: number;
171
+ /** @constant */
172
+ type: "number";
173
+ };
174
+ width?: {
175
+ value: number;
176
+ /** @constant */
177
+ type: "number";
178
+ };
179
+ height?: {
180
+ value: number;
181
+ /** @constant */
182
+ type: "number";
183
+ };
184
+ /** @description Asset field values. */
185
+ custom?: {
186
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
187
+ };
186
188
  };
187
189
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
188
190
  };
@@ -197,21 +199,23 @@ interface components {
197
199
  _id?: string;
198
200
  /** @description The internal name of the asset. */
199
201
  _name?: string;
200
- title?: {
201
- value: string;
202
- /** @constant */
203
- type: "text";
204
- };
205
- description?: {
206
- value: string;
207
- /** @constant */
208
- type: "text";
209
- };
210
- file?: {
211
- /** Format: uuid */
212
- value: string;
213
- /** @constant */
214
- type: "file";
202
+ fields?: {
203
+ title?: {
204
+ value: string;
205
+ /** @constant */
206
+ type: "text";
207
+ };
208
+ description?: {
209
+ value: string;
210
+ /** @constant */
211
+ type: "text";
212
+ };
213
+ file?: {
214
+ /** Format: uuid */
215
+ value: string;
216
+ /** @constant */
217
+ type: "file";
218
+ };
215
219
  };
216
220
  _dataResources?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
217
221
  };
@@ -328,6 +332,11 @@ interface external {
328
332
  helpText?: string;
329
333
  /** @description Type name of the parameter (provided by a Uniform integration) */
330
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;
331
340
  /** @description The configuration object for the type (type-specific) */
332
341
  typeConfig?: unknown;
333
342
  };
@@ -504,11 +513,18 @@ interface external {
504
513
  /** @description Defines an editable parameter on a component. */
505
514
  ComponentParameter: {
506
515
  /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
507
- value: unknown;
516
+ value?: unknown;
508
517
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
509
518
  type: string;
510
519
  /** @deprecated */
511
520
  connectedData?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
521
+ /**
522
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
523
+ * Note that locales must be registered on the entry/composition `_locales` before being used.
524
+ */
525
+ locales?: {
526
+ [key: string]: unknown;
527
+ };
512
528
  };
513
529
  /** @description Defines a connection to a dynamic token on a data resource. */
514
530
  DataElementConnectionDefinition: {
@@ -630,6 +646,8 @@ interface external {
630
646
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
631
647
  */
632
648
  _overridability?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
649
+ /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data. */
650
+ _locales?: string[];
633
651
  };
634
652
  /**
635
653
  * @description Defines how to override a specific component.
@@ -861,15 +879,19 @@ interface external {
861
879
  /** @description Unique identifier for the integration that this prompt belongs to. */
862
880
  integrationType: string;
863
881
  /** @description Name for the prompt */
864
- promptName?: string | null;
882
+ name?: string | null;
865
883
  /** @description Text for the prompt */
866
- promptText?: string | null;
884
+ text?: string | null;
867
885
  /** @description Data for the prompt */
868
- promptData?: string | null;
886
+ data?: {
887
+ [key: string]: unknown;
888
+ } | null;
869
889
  /** @description Turn off/on prompt */
870
890
  enabled?: boolean | null;
871
891
  /** @description Integration default prompt */
872
892
  builtIn?: boolean | null;
893
+ /** @description Supported parameter types */
894
+ parameterTypes?: string[] | null;
873
895
  };
874
896
  };
875
897
  };
@@ -913,4 +935,4 @@ declare class UncachedAssetClient extends AssetClient {
913
935
  */
914
936
  declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
915
937
 
916
- export { Asset, AssetClient, AssetDeleteRequest, AssetGetRequest, AssetGetRequestList, AssetGetRequestSingle, AssetGetResponse, AssetGetResponseList, AssetGetResponseSingle, AssetUpsertRequest, UncachedAssetClient, convertAssetToPutAsset };
938
+ 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.esm.js CHANGED
@@ -40,15 +40,18 @@ var UncachedAssetClient = class extends AssetClient {
40
40
 
41
41
  // src/utils/assetConverter.ts
42
42
  function convertAssetToPutAsset(asset) {
43
+ var _a, _b, _c;
43
44
  return {
44
45
  asset: {
45
46
  _id: asset.asset._id,
46
47
  _dataResources: asset.asset._dataResources,
47
48
  _name: asset.asset._name,
48
49
  type: asset.asset.type,
49
- title: asset.asset.title,
50
- description: asset.asset.description,
51
- file: asset.asset.file
50
+ fields: {
51
+ title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
52
+ description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
53
+ file: (_c = asset.asset.fields) == null ? void 0 : _c.file
54
+ }
52
55
  },
53
56
  projectId: asset.projectId
54
57
  };
package/dist/index.js CHANGED
@@ -68,15 +68,18 @@ var UncachedAssetClient = class extends AssetClient {
68
68
 
69
69
  // src/utils/assetConverter.ts
70
70
  function convertAssetToPutAsset(asset) {
71
+ var _a, _b, _c;
71
72
  return {
72
73
  asset: {
73
74
  _id: asset.asset._id,
74
75
  _dataResources: asset.asset._dataResources,
75
76
  _name: asset.asset._name,
76
77
  type: asset.asset.type,
77
- title: asset.asset.title,
78
- description: asset.asset.description,
79
- file: asset.asset.file
78
+ fields: {
79
+ title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
80
+ description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
81
+ file: (_c = asset.asset.fields) == null ? void 0 : _c.file
82
+ }
80
83
  },
81
84
  projectId: asset.projectId
82
85
  };
package/dist/index.mjs CHANGED
@@ -40,15 +40,18 @@ var UncachedAssetClient = class extends AssetClient {
40
40
 
41
41
  // src/utils/assetConverter.ts
42
42
  function convertAssetToPutAsset(asset) {
43
+ var _a, _b, _c;
43
44
  return {
44
45
  asset: {
45
46
  _id: asset.asset._id,
46
47
  _dataResources: asset.asset._dataResources,
47
48
  _name: asset.asset._name,
48
49
  type: asset.asset.type,
49
- title: asset.asset.title,
50
- description: asset.asset.description,
51
- file: asset.asset.file
50
+ fields: {
51
+ title: (_a = asset.asset.fields) == null ? void 0 : _a.title,
52
+ description: (_b = asset.asset.fields) == null ? void 0 : _b.description,
53
+ file: (_c = asset.asset.fields) == null ? void 0 : _c.file
54
+ }
52
55
  },
53
56
  projectId: asset.projectId
54
57
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.69.0",
3
+ "version": "19.71.1-alpha.103+2e172bb17",
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.69.0"
39
+ "@uniformdev/context": "19.71.1-alpha.103+2e172bb17"
40
40
  },
41
- "gitHead": "327658d8c6e5735499845ebb29d74906f2a43dad"
41
+ "gitHead": "2e172bb17f644b34be818605979a1436b8621c90"
42
42
  }