@commercetools-frontend-extensions/export-resources-modal 4.6.3 → 4.6.5
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/README.md +5 -8
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.dev.js +285 -151
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.prod.js +279 -145
- package/dist/commercetools-frontend-extensions-export-resources-modal.esm.js +282 -149
- package/dist/{de-695399d9.cjs.prod.js → de-16b6e603.cjs.prod.js} +4 -0
- package/dist/{de-99b348fe.esm.js → de-d065df9f.esm.js} +4 -0
- package/dist/{de-87c7cf7f.cjs.dev.js → de-d4a85a4f.cjs.dev.js} +4 -0
- package/dist/declarations/src/@hooks/index.d.ts +4 -0
- package/dist/declarations/src/@hooks/use-convert-field-definitions-for-export.d.ts +8 -0
- package/dist/declarations/src/@hooks/use-export-resources-modal-context.d.ts +2 -0
- package/dist/declarations/src/@hooks/use-initial-values.d.ts +2 -0
- package/dist/declarations/src/@hooks/use-start-export-operation.d.ts +4 -0
- package/dist/declarations/src/@types/export-api.d.ts +3 -1
- package/dist/declarations/src/@types/export-resources-modal-types.d.ts +2 -3
- package/dist/declarations/src/@types/field-definition.d.ts +6 -0
- package/dist/declarations/src/@types/form.d.ts +0 -5
- package/dist/declarations/src/@types/index.d.ts +1 -0
- package/dist/declarations/src/index.d.ts +1 -0
- package/dist/{en-105944c8.esm.js → en-489b5062.esm.js} +4 -0
- package/dist/{en-d02c912e.cjs.dev.js → en-6be5d801.cjs.prod.js} +4 -0
- package/dist/{en-985e1cb3.cjs.prod.js → en-f3054f24.cjs.dev.js} +4 -0
- package/dist/{es-a50b0543.esm.js → es-3072d392.esm.js} +4 -0
- package/dist/{es-51b65e08.cjs.prod.js → es-b1808cc2.cjs.dev.js} +4 -0
- package/dist/{es-76fb86f4.cjs.dev.js → es-f37701ea.cjs.prod.js} +4 -0
- package/dist/{fr-FR-9067e0c6.cjs.dev.js → fr-FR-66c381ea.cjs.prod.js} +4 -0
- package/dist/{fr-FR-45e4cba6.esm.js → fr-FR-9be90155.esm.js} +4 -0
- package/dist/{fr-FR-edf47120.cjs.prod.js → fr-FR-bf242ea4.cjs.dev.js} +4 -0
- package/dist/{pt-BR-ee02597a.esm.js → pt-BR-5cf442aa.esm.js} +4 -0
- package/dist/{pt-BR-4b462e67.cjs.dev.js → pt-BR-6754aa85.cjs.dev.js} +4 -0
- package/dist/{pt-BR-4ccc10dd.cjs.prod.js → pt-BR-ebc555b4.cjs.prod.js} +4 -0
- package/dist/{zh-CN-4fc3d4db.cjs.prod.js → zh-CN-03a85de5.cjs.dev.js} +4 -0
- package/dist/{zh-CN-1b0b93bc.esm.js → zh-CN-1da404c0.esm.js} +4 -0
- package/dist/{zh-CN-1b65bfd5.cjs.dev.js → zh-CN-e22002dc.cjs.prod.js} +4 -0
- package/package.json +14 -12
package/README.md
CHANGED
|
@@ -84,7 +84,6 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
84
84
|
{
|
|
85
85
|
name: 'custom-type-key-and-type-id',
|
|
86
86
|
label: 'Custom type key and type id',
|
|
87
|
-
isReadOnly: true,
|
|
88
87
|
},
|
|
89
88
|
{
|
|
90
89
|
name: 'general-category-attributes',
|
|
@@ -188,7 +187,6 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
188
187
|
{
|
|
189
188
|
name: 'custom-type-key-and-type-id',
|
|
190
189
|
label: 'Custom type key and type id',
|
|
191
|
-
isReadOnly: true,
|
|
192
190
|
},
|
|
193
191
|
{
|
|
194
192
|
name: 'general-category-attributes',
|
|
@@ -278,13 +276,11 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
278
276
|
{
|
|
279
277
|
name: 'custom-type-key-and-typeid',
|
|
280
278
|
label: 'Custom type key and type id',
|
|
281
|
-
isReadOnly: true,
|
|
282
279
|
isSelectedByDefault: false,
|
|
283
280
|
},
|
|
284
281
|
{
|
|
285
282
|
name: 'general-category-attributes',
|
|
286
283
|
label: 'General category attributes',
|
|
287
|
-
resourceTypeIds: ['category'],
|
|
288
284
|
isSelectedByDefault: false,
|
|
289
285
|
fields: [
|
|
290
286
|
{
|
|
@@ -300,7 +296,6 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
300
296
|
{
|
|
301
297
|
name: 'book-category-attributes',
|
|
302
298
|
label: 'Book category attributes',
|
|
303
|
-
resourceTypeIds: ['category', 'asset'],
|
|
304
299
|
isSelectedByDefault: false,
|
|
305
300
|
fields: [
|
|
306
301
|
{
|
|
@@ -339,11 +334,13 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
339
334
|
| `fieldGroups[].groupName` | `string` | ✅ | | The name of the field group used to determine the state of expanded groups |
|
|
340
335
|
| `fieldGroups[].isExpanded` | `string` | | `false` | This property used to control the default state of each expandable group section in the UI. If `isExpanded` is set to `true`, then the corresponding group will be expanded when the component loads. The default value is `false` which means unless explicitly set to `true`, the group will be collapsed on initial load |
|
|
341
336
|
| `fieldGroups[].fields` | `array` | ✅ | | Array of the fields to export. The fields must align with the [commercetools API schema](https://docs.commercetools.com/api/). Field can have nested `fields` array. |
|
|
342
|
-
| `fieldGroups[].fields[].name` | `string` | ✅ | | A string that represents the unique identifier for each field
|
|
337
|
+
| `fieldGroups[].fields[].name` | `string` | ✅ | | A string that represents the unique identifier for each field. The leaf fields must align with the commercetools HTTP API fields, while parent fields can be developer-specific and created for grouping purposes. |
|
|
343
338
|
| `fieldGroups[].fields[].label` | `string` | ✅ | | The label of the field to be shown in the export modal |
|
|
344
339
|
| `fieldGroups[].fields[].isRequired` | `boolean` | | `false` | `isRequired` field indicates whether a field is required for the export process. If `true` the field will be selected by default and cannot be deselected by the user. This is useful for fields that are essential for the export process. Fields marked as required will have a `*` appended to their label in the UI |
|
|
345
|
-
| `fieldGroups[].fields[].
|
|
346
|
-
| `fieldGroups[].fields[].
|
|
340
|
+
| `fieldGroups[].fields[].extendedFieldNames` | `array` | | | An array of additional field names that should be included along with the main field name when exporting data. |
|
|
341
|
+
| `fieldGroups[].fields[].dependentGroupNames` | `array` | | | The array of group names provided determines the state of the checkbox. If any of the groups mentioned in the `dependentGroupNames` has at least one checkbox selected, then the field is automatically selected. Optionally, `dependentFieldNames` can be used to specify particular fields within the group. <br>**Note:** The field will be readonly if it has dependencies. |
|
|
342
|
+
| `fieldGroups[].fields[].dependentFieldNames` | `array` | | | The array of field names of specific fields within the group to determine the state of the checkbox. If any of the specified fields in the `dependentFieldNames` are checked, the field is automatically selected. |
|
|
343
|
+
| `fieldGroups[].fields[].isSelectedByDefault` | `boolean` | | `false` | This field is a part of the `fields` array is used to control the default state of the corresponding checkbox in the UI. If `isSelectedByDefault` is set to true, the checkbox for that particular field will be checked by default when the component loads. |
|
|
347
344
|
| `fieldGroups[].fields[].isExpandable` | `boolean` | | `false`| `isExpandable` property indicates if the field can be expanded/collapsed on the UI. If the `isExpandable` is passed as true, then a expand/collapse button is displayed on the UI to control |
|
|
348
345
|
| `fieldGroups[].fields[].isExpanded` | `boolean` | | `false` | This property is used along with `fieldGroups[].fields[].isExpandable` to control the default state of each expandable fields in the UI. If `fieldGroups[].fields[].isExpanded` is set to `true`, then the corresponding field will be expanded when the component loads. The default value is `false` which means unless explicitly set to `true`, the field will be collapsed on initial load |
|
|
349
346
|
| `fieldOrder` | `string[]` | | | The field names are sorted based on the order passed. The value `*` can be passed to denote any fields and for example fieldOrder=['*', 'custom'] will push all the fields that starts with custom to the last in the list and any other fields will be at the beginning of the list |
|