@commercetools-frontend-extensions/export-resources-modal 0.0.0-canary-20240821150843 → 0.0.0-canary-20240823130607

package/README.md

@@ -130,7 +130,7 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
     outputFormat="csv"
     resourceType="category"
     filters={{
-      where: 'key = "category-key"',
+      queryPredicate: 'key = "category-key"',
       total: 20
     }}
     totalResourcesCount={143}

package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.dev.js

@@ -36,6 +36,7 @@ var _Array$isArray = require('@babel/runtime-corejs3/core-js-stable/array/is-arr
 var _Set = require('@babel/runtime-corejs3/core-js-stable/set');
 var _sortInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/sort');
 var _indexOfInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/index-of');
+var _trimInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/trim');
 var moment = require('moment');
 var _someInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/some');
 var _findInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/find');
@@ -73,6 +74,7 @@ var _Array$isArray__default = /*#__PURE__*/_interopDefault(_Array$isArray);
 var _Set__default = /*#__PURE__*/_interopDefault(_Set);
 var _sortInstanceProperty__default = /*#__PURE__*/_interopDefault(_sortInstanceProperty);
 var _indexOfInstanceProperty__default = /*#__PURE__*/_interopDefault(_indexOfInstanceProperty);
+var _trimInstanceProperty__default = /*#__PURE__*/_interopDefault(_trimInstanceProperty);
 var moment__default = /*#__PURE__*/_interopDefault(moment);
 var _someInstanceProperty__default = /*#__PURE__*/_interopDefault(_someInstanceProperty);
 var _findInstanceProperty__default = /*#__PURE__*/_interopDefault(_findInstanceProperty);
@@ -634,11 +636,23 @@ function buildSelectedExportFilters(selectedResourceIds) {
   const formattedIds = _mapInstanceProperty__default["default"](selectedResourceIds).call(selectedResourceIds, id => `"${id}"`).join(', ');
   return `id in (${formattedIds})`;
 }
+function validateFilters(filters) {
+  var _context;
+  const hasQueryPredicate = typeof filters.queryPredicate === 'string' && _trimInstanceProperty__default["default"](_context = filters.queryPredicate).call(_context) !== '';
+  const hasSearchQuery = !!(filters.searchQuery && typeof filters.searchQuery === 'object');
+  const hasValidTotal = typeof filters.total === 'number' && filters.total >= 0;
+
+  // Ensure only one of `queryPredicate` or `searchQuery` is applied
+  const onlyOneFilterApplied = hasQueryPredicate && !hasSearchQuery || !hasQueryPredicate && hasSearchQuery;
+  return onlyOneFilterApplied && hasValidTotal;
+}
 function areFiltersApplied(filters) {
   if (!filters) {
     return false;
   }
-  return filters.where !== undefined && filters.where?.trim() !== '';
+  const hasQueryPredicate = (filters.queryPredicate?.trim() ?? '') !== '';
+  const hasSearchQuery = _Object$keys__default["default"](filters.searchQuery ?? {}).length > 0;
+  return hasQueryPredicate || hasSearchQuery;
 }
 function getInitialExportType(args) {
   if (args.selectedResourceIds?.length) {
@@ -807,6 +821,7 @@ async function createExportOperation(_ref) {
     fields = _ref.fields,
     locales = _ref.locales,
     filters = _ref.filters,
+    where = _ref.where,
     asyncDispatchFn = _ref.asyncDispatchFn;
   const uri = `/${projectKey}/export-operations`;
   const response = await asyncDispatchFn(sdk.actions.post({
@@ -821,6 +836,9 @@ async function createExportOperation(_ref) {
       fileFormat,
       fields,
       locales,
+      // Query predicate
+      where,
+      // Search API filters
       filters
     }
   }));
@@ -859,13 +877,6 @@ const useStartExportOperation = props => {
   const startExportOperation = async values => {
     try {
       const fields = extractFieldsFromGroups(values.groups);
-      let filters = undefined;
-      if (props.exportType === EXPORT_TYPES.SELECTED) filters = buildSelectedExportFilters(props.selectedResourceIds);
-      if (props.exportType === EXPORT_TYPES.FILTERED) {
-        filters = props.filters.where;
-        // TODO: handle search query when Export API supports it
-        // filters = props.filters.where || props.filters.searchQuery
-      }
       const response = await createExportOperation({
         projectKey,
         resourceType: props.resourceType,
@@ -873,7 +884,8 @@ const useStartExportOperation = props => {
         fileFormat: values.outputFormat,
         locales: values.locales,
         fields,
-        filters: typeof filters === 'string' ? [filters] : undefined,
+        where: props.exportType === EXPORT_TYPES.SELECTED ? buildSelectedExportFilters(props.selectedResourceIds) : props.filters?.queryPredicate,
+        filters: props.filters?.searchQuery,
         asyncDispatchFn: asyncDispatch
       });
       switch (response.state) {
@@ -1759,6 +1771,10 @@ const ExportResourcesModal = props => {
     locale = _useApplicationContex.locale;
   const messages = useAsyncIntlMessages(locale, loadMessages);
   if (!props.isOpen || messages.isLoading) return null;
+  if (props.filters && !validateFilters(props.filters)) {
+    console.error('Invalid filters prop:', props.filters, 'Filters must have either a valid `queryPredicate` or a valid `searchQuery`, but not both.');
+    return null;
+  }
   return jsxRuntime.jsx(reactIntl.IntlProvider, {
     locale: locale,
     messages: messages.messages,

package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.prod.js

@@ -36,6 +36,7 @@ var _Array$isArray = require('@babel/runtime-corejs3/core-js-stable/array/is-arr
 var _Set = require('@babel/runtime-corejs3/core-js-stable/set');
 var _sortInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/sort');
 var _indexOfInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/index-of');
+var _trimInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/trim');
 var moment = require('moment');
 var _someInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/some');
 var _findInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/find');
@@ -73,6 +74,7 @@ var _Array$isArray__default = /*#__PURE__*/_interopDefault(_Array$isArray);
 var _Set__default = /*#__PURE__*/_interopDefault(_Set);
 var _sortInstanceProperty__default = /*#__PURE__*/_interopDefault(_sortInstanceProperty);
 var _indexOfInstanceProperty__default = /*#__PURE__*/_interopDefault(_indexOfInstanceProperty);
+var _trimInstanceProperty__default = /*#__PURE__*/_interopDefault(_trimInstanceProperty);
 var moment__default = /*#__PURE__*/_interopDefault(moment);
 var _someInstanceProperty__default = /*#__PURE__*/_interopDefault(_someInstanceProperty);
 var _findInstanceProperty__default = /*#__PURE__*/_interopDefault(_findInstanceProperty);
@@ -634,11 +636,23 @@ function buildSelectedExportFilters(selectedResourceIds) {
   const formattedIds = _mapInstanceProperty__default["default"](selectedResourceIds).call(selectedResourceIds, id => `"${id}"`).join(', ');
   return `id in (${formattedIds})`;
 }
+function validateFilters(filters) {
+  var _context;
+  const hasQueryPredicate = typeof filters.queryPredicate === 'string' && _trimInstanceProperty__default["default"](_context = filters.queryPredicate).call(_context) !== '';
+  const hasSearchQuery = !!(filters.searchQuery && typeof filters.searchQuery === 'object');
+  const hasValidTotal = typeof filters.total === 'number' && filters.total >= 0;
+
+  // Ensure only one of `queryPredicate` or `searchQuery` is applied
+  const onlyOneFilterApplied = hasQueryPredicate && !hasSearchQuery || !hasQueryPredicate && hasSearchQuery;
+  return onlyOneFilterApplied && hasValidTotal;
+}
 function areFiltersApplied(filters) {
   if (!filters) {
     return false;
   }
-  return filters.where !== undefined && filters.where?.trim() !== '';
+  const hasQueryPredicate = (filters.queryPredicate?.trim() ?? '') !== '';
+  const hasSearchQuery = _Object$keys__default["default"](filters.searchQuery ?? {}).length > 0;
+  return hasQueryPredicate || hasSearchQuery;
 }
 function getInitialExportType(args) {
   if (args.selectedResourceIds?.length) {
@@ -807,6 +821,7 @@ async function createExportOperation(_ref) {
     fields = _ref.fields,
     locales = _ref.locales,
     filters = _ref.filters,
+    where = _ref.where,
     asyncDispatchFn = _ref.asyncDispatchFn;
   const uri = `/${projectKey}/export-operations`;
   const response = await asyncDispatchFn(sdk.actions.post({
@@ -821,6 +836,9 @@ async function createExportOperation(_ref) {
       fileFormat,
       fields,
       locales,
+      // Query predicate
+      where,
+      // Search API filters
       filters
     }
   }));
@@ -859,13 +877,6 @@ const useStartExportOperation = props => {
   const startExportOperation = async values => {
     try {
       const fields = extractFieldsFromGroups(values.groups);
-      let filters = undefined;
-      if (props.exportType === EXPORT_TYPES.SELECTED) filters = buildSelectedExportFilters(props.selectedResourceIds);
-      if (props.exportType === EXPORT_TYPES.FILTERED) {
-        filters = props.filters.where;
-        // TODO: handle search query when Export API supports it
-        // filters = props.filters.where || props.filters.searchQuery
-      }
       const response = await createExportOperation({
         projectKey,
         resourceType: props.resourceType,
@@ -873,7 +884,8 @@ const useStartExportOperation = props => {
         fileFormat: values.outputFormat,
         locales: values.locales,
         fields,
-        filters: typeof filters === 'string' ? [filters] : undefined,
+        where: props.exportType === EXPORT_TYPES.SELECTED ? buildSelectedExportFilters(props.selectedResourceIds) : props.filters?.queryPredicate,
+        filters: props.filters?.searchQuery,
         asyncDispatchFn: asyncDispatch
       });
       switch (response.state) {
@@ -1726,6 +1738,10 @@ const ExportResourcesModal = props => {
     locale = _useApplicationContex.locale;
   const messages = useAsyncIntlMessages(locale, loadMessages);
   if (!props.isOpen || messages.isLoading) return null;
+  if (props.filters && !validateFilters(props.filters)) {
+    console.error('Invalid filters prop:', props.filters, 'Filters must have either a valid `queryPredicate` or a valid `searchQuery`, but not both.');
+    return null;
+  }
   return jsxRuntime.jsx(reactIntl.IntlProvider, {
     locale: locale,
     messages: messages.messages,

package/dist/commercetools-frontend-extensions-export-resources-modal.esm.js

@@ -32,6 +32,7 @@ import _Array$isArray from '@babel/runtime-corejs3/core-js-stable/array/is-array
 import _Set from '@babel/runtime-corejs3/core-js-stable/set';
 import _sortInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/sort';
 import _indexOfInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/index-of';
+import _trimInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/trim';
 import moment from 'moment';
 import _someInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/some';
 import _findInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/find';
@@ -600,11 +601,23 @@ function buildSelectedExportFilters(selectedResourceIds) {
   const formattedIds = _mapInstanceProperty(selectedResourceIds).call(selectedResourceIds, id => `"${id}"`).join(', ');
   return `id in (${formattedIds})`;
 }
+function validateFilters(filters) {
+  var _context;
+  const hasQueryPredicate = typeof filters.queryPredicate === 'string' && _trimInstanceProperty(_context = filters.queryPredicate).call(_context) !== '';
+  const hasSearchQuery = !!(filters.searchQuery && typeof filters.searchQuery === 'object');
+  const hasValidTotal = typeof filters.total === 'number' && filters.total >= 0;
+
+  // Ensure only one of `queryPredicate` or `searchQuery` is applied
+  const onlyOneFilterApplied = hasQueryPredicate && !hasSearchQuery || !hasQueryPredicate && hasSearchQuery;
+  return onlyOneFilterApplied && hasValidTotal;
+}
 function areFiltersApplied(filters) {
   if (!filters) {
     return false;
   }
-  return filters.where !== undefined && filters.where?.trim() !== '';
+  const hasQueryPredicate = (filters.queryPredicate?.trim() ?? '') !== '';
+  const hasSearchQuery = _Object$keys(filters.searchQuery ?? {}).length > 0;
+  return hasQueryPredicate || hasSearchQuery;
 }
 function getInitialExportType(args) {
   if (args.selectedResourceIds?.length) {
@@ -773,6 +786,7 @@ async function createExportOperation(_ref) {
     fields = _ref.fields,
     locales = _ref.locales,
     filters = _ref.filters,
+    where = _ref.where,
     asyncDispatchFn = _ref.asyncDispatchFn;
   const uri = `/${projectKey}/export-operations`;
   const response = await asyncDispatchFn(actions.post({
@@ -787,6 +801,9 @@ async function createExportOperation(_ref) {
       fileFormat,
       fields,
       locales,
+      // Query predicate
+      where,
+      // Search API filters
       filters
     }
   }));
@@ -825,13 +842,6 @@ const useStartExportOperation = props => {
   const startExportOperation = async values => {
     try {
       const fields = extractFieldsFromGroups(values.groups);
-      let filters = undefined;
-      if (props.exportType === EXPORT_TYPES.SELECTED) filters = buildSelectedExportFilters(props.selectedResourceIds);
-      if (props.exportType === EXPORT_TYPES.FILTERED) {
-        filters = props.filters.where;
-        // TODO: handle search query when Export API supports it
-        // filters = props.filters.where || props.filters.searchQuery
-      }
       const response = await createExportOperation({
         projectKey,
         resourceType: props.resourceType,
@@ -839,7 +849,8 @@ const useStartExportOperation = props => {
         fileFormat: values.outputFormat,
         locales: values.locales,
         fields,
-        filters: typeof filters === 'string' ? [filters] : undefined,
+        where: props.exportType === EXPORT_TYPES.SELECTED ? buildSelectedExportFilters(props.selectedResourceIds) : props.filters?.queryPredicate,
+        filters: props.filters?.searchQuery,
         asyncDispatchFn: asyncDispatch
       });
       switch (response.state) {
@@ -1725,6 +1736,10 @@ const ExportResourcesModal = props => {
     locale = _useApplicationContex.locale;
   const messages = useAsyncIntlMessages(locale, loadMessages);
   if (!props.isOpen || messages.isLoading) return null;
+  if (props.filters && !validateFilters(props.filters)) {
+    console.error('Invalid filters prop:', props.filters, 'Filters must have either a valid `queryPredicate` or a valid `searchQuery`, but not both.');
+    return null;
+  }
   return jsx(IntlProvider, {
     locale: locale,
     messages: messages.messages,

package/dist/declarations/src/@types/export-resources-modal-types.d.ts

@@ -33,6 +33,7 @@ export interface ExportResourcesModalShape {
 }
 export type ExportType = keyof typeof EXPORT_TYPES;
 export type Filters = {
-    where?: string;
+    queryPredicate?: string;
+    searchQuery?: Record<string, unknown>;
     total: number;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-frontend-extensions/export-resources-modal",
   "description": "Shared export modal for exporting resources",
-  "version": "0.0.0-canary-20240821150843",
+  "version": "0.0.0-canary-20240823130607",
   "license": "BSD-3-Clause",
   "publishConfig": {
     "access": "public"