@kineticdata/react 6.0.4 → 6.1.0

package/CHANGELOG.md

@@ -1,86 +1,116 @@
-# Changelog for `@kineticdata/react`
-
-When upgrading `@kineticdata/react` to a newer version, remember that all `@kineticdata/*` libraries must be on the same exact version. This is because each `@kineticdata/bundle-*` library has `@kineticdata/react` as a dependency, and if two different versions of `@kineticdata/react` are installed in a bundle, the bundle will never load because authentication happens in a different version of `@kineticdata/react` than the one used during rendering the packages.
-
-Remember to always run `yarn install` after upgrading any dependency versions.
-
-## 6.0.2 (November 6, 2023)
-
-- Removed XSRF header setting from Request Interceptor
-- Added SAML logout options
-- Upgraded various `dependencies` to resolve vulnerabilities
-- Updated the `react` and `react-dom` `peerDependencies` to `>=17.0.2` to support the latest versions of React
-
-### Bundle Issues
-
-One of the `dependencies` that was updated is `axios` whose latest version causes some issues with the latest `react-scripts`. If the bundle has a `craco.config.js` file, the following steps must be taken when upgrading to this version.
-
-1.  In `craco.config.js`, add the following function to the very end of the file:
-
-```javascript
-function getFileLoaderRule(rules) {
-  for (const rule of rules) {
-    if ('oneOf' in rule) {
-      const found = getFileLoaderRule(rule.oneOf);
-      if (found) {
-        return found;
-      }
-    } else if (rule.test === undefined && rule.type === 'asset/resource') {
-      return rule;
-    }
-  }
-}
-```
-
-2.  In `craco.config.js`, add the following code inside the `configure` function of the `webpack` object:
-
-```javascript
-// Fix for CJS files not being treated as JavaScript files
-// https://github.com/facebook/create-react-app/issues/11889#issuecomment-1114928008
-const fileLoaderRule = getFileLoaderRule(webpackConfig.module.rules);
-if (!fileLoaderRule) {
-  throw new Error('File loader not found');
-}
-fileLoaderRule.exclude.push(/\.cjs$/);
-```
-
-## 6.0.1 (September 20, 2023)
-
-- Updated the `react` and `react-dom` `peerDependencies` to `^17.0.2` to support React v17
-
-### Bundle Issues
-
-It is recommended to upgrade the bundle's `react` and `react-dom` versions to `^17.0.2`. This upgrade should not have any breaking changes. To do so, update these two dependency versions in `bundle/packages/app/package.json` and the peer dependency versions in all of the `package.json` files of the other packages.
-
-If you do upgrade `react` to v17, the following steps must also be taken if the bundle has testing configured:
-
-1.  In `bundle/package.json`, remove the `enzyme-adapter-react-16` dependency, and add the following dependency:  
-    `"@wojtekmaj/enzyme-adapter-react-17": "^0.8.0"`
-2.  In `bundle/packages/app/src/setupTests.js`, change the `Adapter` import from `enzyme-adapter-react-16` to be from `@wojtekmaj/enzyme-adapter-react-17`.
-
-## 6.0.0 (February 22, 2023)
-
-- Removed all code related to Discussions
-- Removed most `devDependencies`, which were move to the project root
-
-### Bundle Issues
-
-Because all discussions code was removed from the library, any bundles that are upgraded to this version must have all of their discussions code removed as well, since the various imports from this library that bundles used no longer exist.
-
-We consolidated most of our `devDependencies` into the root of our project, of which `@kineticdata/react` is just one part. Any bundles upgrading to this version must add the following `devDependencies` to the `package.json` file in the root of their `bundle` folder:
-
-```
-"@babel/cli": "^7.23.0",
-"@babel/runtime": "^7.23.2",
-```
-
-If you get the following error when trying to run your bundle:  
-`Uncaught Error: Cannot find module '@babel/runtime/helpers/esm/regeneratorRuntime'`  
-You will need to run the following commands in your `bundle` directory:
-
-```
-npx yarn-deduplicate --packages @babel/runtime -- yarn.lock
-yarn install
-```
-
-The above step will always be required when first upgrading to a v6+ version of `@kineticdata/react`.
+# Changelog for `@kineticdata/react`
+
+This changelog documents the changes to the `@kineticdata/react` library that are relevant when the library is used for customer implementations. It does not document changes made to components used in our internal consoles.
+
+When upgrading `@kineticdata/react` to a newer version, remember that all `@kineticdata/*` libraries must be on the same exact version. This is because each `@kineticdata/bundle-*` library has `@kineticdata/react` as a dependency, and if two different versions of `@kineticdata/react` are installed in a bundle, the bundle will never load because authentication happens in a different version of `@kineticdata/react` than the one used during rendering the packages.
+
+Remember to always run `yarn install` after upgrading any dependency versions.
+
+## 6.1.0 (February 7, 2025)
+
+- Upgraded `axios` version to resolve vulnerabilities
+- Added missing `qs` and `react-beautiful-dnd` dependencies
+- Added new API functions for Kapp Integrations
+  - `fetchIntegrations`, `fetchIntegration`, `createIntegration`, `updateIntegration`, `deleteIntegration`, `executeIntegration`
+- Added new API functions for Connections
+  - `fetchConnections`, `fetchConnection`, `updateConnection`, `createConnection`, `deleteConnection`, `testConnection`
+- Added new API functions for Operations
+  - `fetchOperations`, `fetchOperation`, `updateOperation`, `createOperation`, `deleteOperation`, `fetchBulkOperations`, `inspectOperation`, `executeOperation`
+- Added misc API functions that were missing
+  - `cloneSubmission`
+- Added new props to `CoreForm`
+  - `renderProps` allows passing through props to the `Layout` component
+  - `addSubmissionIncludes` and `addFormIncludes` allows passing an array of additional `include` properties for the corresponding queries
+
+## 6.0.5 (February 16, 2024)
+
+- Upgraded `axios` version to resolve vulnerabilities
+
+## 6.0.4 (January 22, 2024)
+
+- Fixed bug with SAML logout options
+
+## 6.0.3 (December 11, 2023)
+
+_No relevant changes._
+
+## 6.0.2 (November 6, 2023)
+
+- Removed XSRF header setting from Request Interceptor
+- Added SAML logout options
+- Upgraded various `dependencies` to resolve vulnerabilities
+- Updated the `react` and `react-dom` `peerDependencies` to `>=17.0.2` to support the latest versions of React
+
+### Bundle Issues
+
+One of the `dependencies` that was updated is `axios` whose latest version causes some issues with the latest `react-scripts`. If the bundle has a `craco.config.js` file, the following steps must be taken when upgrading to this version.
+
+1.  In `craco.config.js`, add the following function to the very end of the file:
+
+```javascript
+function getFileLoaderRule(rules) {
+  for (const rule of rules) {
+    if ('oneOf' in rule) {
+      const found = getFileLoaderRule(rule.oneOf);
+      if (found) {
+        return found;
+      }
+    } else if (rule.test === undefined && rule.type === 'asset/resource') {
+      return rule;
+    }
+  }
+}
+```
+
+2.  In `craco.config.js`, add the following code inside the `configure` function of the `webpack` object:
+
+```javascript
+// Fix for CJS files not being treated as JavaScript files
+// https://github.com/facebook/create-react-app/issues/11889#issuecomment-1114928008
+const fileLoaderRule = getFileLoaderRule(webpackConfig.module.rules);
+if (!fileLoaderRule) {
+  throw new Error('File loader not found');
+}
+fileLoaderRule.exclude.push(/\.cjs$/);
+```
+
+## 6.0.1 (September 20, 2023)
+
+- Updated the `react` and `react-dom` `peerDependencies` to `^17.0.2` to support React v17
+
+### Bundle Issues
+
+It is recommended to upgrade the bundle's `react` and `react-dom` versions to `^17.0.2`. This upgrade should not have any breaking changes. To do so, update these two dependency versions in `bundle/packages/app/package.json` and the peer dependency versions in all of the `package.json` files of the other packages.
+
+If you do upgrade `react` to v17, the following steps must also be taken if the bundle has testing configured:
+
+1.  In `bundle/package.json`, remove the `enzyme-adapter-react-16` dependency, and add the following dependency:  
+    `"@wojtekmaj/enzyme-adapter-react-17": "^0.8.0"`
+2.  In `bundle/packages/app/src/setupTests.js`, change the `Adapter` import from `enzyme-adapter-react-16` to be from `@wojtekmaj/enzyme-adapter-react-17`.
+
+## 6.0.0 (February 22, 2023)
+
+- Removed all code related to Discussions
+- Removed most `devDependencies`, which were move to the project root
+
+### Bundle Issues
+
+Because all discussions code was removed from the library, any bundles that are upgraded to this version must have all of their discussions code removed as well, since the various imports from this library that bundles used no longer exist.
+
+We consolidated most of our `devDependencies` into the root of our project, of which `@kineticdata/react` is just one part. Any bundles upgrading to this version must add the following `devDependencies` to the `package.json` file in the root of their `bundle` folder:
+
+```
+"@babel/cli": "^7.23.0",
+"@babel/runtime": "^7.23.2",
+```
+
+If you get the following error when trying to run your bundle:  
+`Uncaught Error: Cannot find module '@babel/runtime/helpers/esm/regeneratorRuntime'`  
+You will need to run the following commands in your `bundle` directory:
+
+```
+npx yarn-deduplicate --packages @babel/runtime -- yarn.lock
+yarn install
+```
+
+The above step will always be required when first upgrading to a v6+ version of `@kineticdata/react`.

package/lib/apis/core/attributeDefinitions.js

@@ -8,12 +8,9 @@ exports.updateAttributeDefinition = exports.fetchAttributeDefinitions = exports.
 var _axios = _interopRequireDefault(require("axios"));
 var _helpers = require("../../helpers");
 var _http = require("../http");
-// The API returns the singular name of the attribute type, so we remove the "s",
-// except for userProfileAttributeDefinitions and datastoreFormAttributeDefinitions
-// TODO: KCORE-2982
-// TODO: Remove datastoreFormAttributeDefinitions when fully deprecated. See b4a24c6
+// The API returns the singular name of the attribute type, so we remove the "s"
 var responseEnvelope = function responseEnvelope(attributeType) {
-  return ['userProfileAttributeDefinitions', 'datastoreFormAttributeDefinitions'].includes(attributeType) ? attributeType : attributeType.replace(/s$/, '');
+  return attributeType.replace(/s$/, '');
 };
 var validateOptions = function validateOptions(functionName, requiredOptions, options) {
   var validAttributes = ['spaceAttributeDefinitions', 'teamAttributeDefinitions', 'userAttributeDefinitions', 'userProfileAttributeDefinitions', 'categoryAttributeDefinitions', 'kappAttributeDefinitions', 'formAttributeDefinitions'];
@@ -64,7 +61,13 @@ var fetchAttributeDefinition = exports.fetchAttributeDefinition = function fetch
     headers: (0, _http.headerBuilder)(options)
   }).then(function (response) {
     return {
-      attributeDefinition: response.data[responseEnvelope(attributeType)]
+      // The userProfileAttributeDefinition fetch returns a pluralized name
+      // instead of the singular name as it should, so we want to check both
+      // the singular and plural versions in that case to be backwards
+      // compatible when this gets fixed on the server.
+      // TODO Remove this check and only keep the responseEvelope once the
+      //  server side code is fixed.
+      attributeDefinition: attributeType !== 'userProfileAttributeDefinitions' ? response.data[responseEnvelope(attributeType)] : response.data[responseEnvelope(attributeType)] || response.data[attributeType]
     };
   })["catch"](_http.handleErrors);
 };

package/lib/apis/core/integrations.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateIntegration = exports.fetchIntegrations = exports.fetchIntegration = exports.executeIntegration = exports.deleteIntegration = exports.createIntegration = void 0;
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/objectSpread2"));
+var _http = require("../http");
+var _axios = _interopRequireDefault(require("axios"));
+var _helpers = require("../../helpers");
+var _apiGroup = (0, _http.apiGroup)({
+    name: 'Integration',
+    dataOption: 'integration',
+    plural: {
+      requiredOptions: ['kappSlug'],
+      url: function url(_ref) {
+        var kappSlug = _ref.kappSlug;
+        return "/kapps/".concat(kappSlug, "/integrations");
+      },
+      transform: function transform(response) {
+        return response.data;
+      }
+    },
+    singular: {
+      requiredOptions: ['kappSlug', 'name'],
+      url: function url(_ref2) {
+        var name = _ref2.name,
+          kappSlug = _ref2.kappSlug;
+        return "/kapps/".concat(kappSlug, "/integrations/").concat(name);
+      },
+      transform: function transform(response) {
+        return {
+          integration: response.data.integration
+        };
+      }
+    }
+  }),
+  fetchIntegrations = exports.fetchIntegrations = _apiGroup.fetchIntegrations,
+  fetchIntegration = exports.fetchIntegration = _apiGroup.fetchIntegration,
+  createIntegration = exports.createIntegration = _apiGroup.createIntegration,
+  updateIntegration = exports.updateIntegration = _apiGroup.updateIntegration,
+  deleteIntegration = exports.deleteIntegration = _apiGroup.deleteIntegration;
+var executeIntegration = exports.executeIntegration = function executeIntegration() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  (0, _http.validateOptions)('executeOperation', ['kappSlug', 'integrationName'], options);
+  var kappSlug = options.kappSlug,
+    formSlug = options.formSlug,
+    integrationName = options.integrationName,
+    _options$parameters = options.parameters,
+    parameters = _options$parameters === void 0 ? {} : _options$parameters;
+  var params = (0, _objectSpread2["default"])({}, (0, _http.paramBuilder)(options));
+  return _axios["default"].post("".concat(_helpers.bundle.apiLocation(), "/integrations/kapps/").concat(kappSlug).concat(formSlug ? "/forms/".concat(formSlug) : '', "/").concat(integrationName), parameters, {
+    params: params,
+    headers: (0, _http.headerBuilder)(options)
+  }).then(function (response) {
+    return {
+      data: response.data
+    };
+  })["catch"](_http.handleErrors);
+};

package/lib/apis/core/submissions.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateSubmission = exports.submitSubmission = exports.searchSubmissions = exports.saveSubmissionMultipart = exports.importSubmissions = exports.importSubmissionStatus = exports.fetchSubmission = exports.exportSubmissions = exports.deleteSubmission = exports.createSubmission = exports.VALID_TIMELINES = exports.VALID_KAPP_CORE_STATES = exports.VALID_DS_CORE_STATES = exports.SubmissionSearch = exports.MODE_IMPORT = exports.MODE_BULK = void 0;
+exports.updateSubmission = exports.submitSubmission = exports.searchSubmissions = exports.saveSubmissionMultipart = exports.importSubmissions = exports.importSubmissionStatus = exports.fetchSubmission = exports.exportSubmissions = exports.deleteSubmission = exports.createSubmission = exports.cloneSubmission = exports.VALID_TIMELINES = exports.VALID_KAPP_CORE_STATES = exports.VALID_DS_CORE_STATES = exports.SubmissionSearch = exports.MODE_IMPORT = exports.MODE_BULK = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/toConsumableArray"));
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/objectSpread2"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/classCallCheck"));
@@ -40,8 +40,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
     this.isDatastore = datastore;
   }
 
-  /*
-   * Context Management
+  /*
+   * Context Management
    */
   (0, _createClass2["default"])(SubmissionSearch, [{
     key: "currentContext",
@@ -59,8 +59,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
       return this.queryContext.pop();
     }
 
-    /*
-     * Execution Methods
+    /*
+     * Execution Methods
      */
   }, {
     key: "build",
@@ -81,8 +81,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
       return this.query;
     }
 
-    /*
-     * Equality Methods
+    /*
+     * Equality Methods
      */
   }, {
     key: "eq",
@@ -172,8 +172,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
       return this;
     }
 
-    /*
-     * Grouping Methods
+    /*
+     * Grouping Methods
      */
   }, {
     key: "or",
@@ -205,8 +205,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
       return this;
     }
 
-    /*
-     * Sorting Methods
+    /*
+     * Sorting Methods
      */
   }, {
     key: "sortBy",
@@ -305,8 +305,8 @@ var SubmissionSearch = exports.SubmissionSearch = /*#__PURE__*/function () {
       return this;
     }
 
-    /*
-     * Privately used utilities.
+    /*
+     * Privately used utilities.
      */
   }, {
     key: "validateOuter",
@@ -492,6 +492,43 @@ var createSubmission = exports.createSubmission = function createSubmission(opti
   // cleans up any errors.
   ["catch"](_http.handleErrors);
 };
+var cloneSubmission = exports.cloneSubmission = function cloneSubmission(options) {
+  var id = options.id,
+    _options$completed2 = options.completed,
+    completed = _options$completed2 === void 0 ? false : _options$completed2,
+    _options$submission = options.submission,
+    submission = _options$submission === void 0 ? {} : _options$submission,
+    _options$files = options.files,
+    files = _options$files === void 0 ? [] : _options$files;
+  if (!id) {
+    throw new Error('cloneSubmission failed! The option "id" is required.');
+  }
+  var path = "".concat(_helpers.bundle.apiLocation(), "/submissions/").concat(id, "/clone");
+  var params = (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, (0, _http.paramBuilder)(options)), {}, {
+    completed: completed
+  });
+  var formData = new FormData();
+  formData.append('submission', JSON.stringify(submission));
+  files.forEach(function (_ref) {
+    var fieldName = _ref.fieldName,
+      file = _ref.file,
+      filename = _ref.filename;
+    formData.append(fieldName, file, filename);
+  });
+  return _axios["default"].post(path, formData, {
+    params: params,
+    headers: (0, _http.headerBuilder)(options)
+  })
+  // Remove the response envelop and leave us with the submission one.
+  .then(function (response) {
+    return {
+      submission: response.data.submission
+    };
+  })
+  // Clean up any errors we receive. Make sure this the last thing so that it
+  // cleans up any errors.
+  ["catch"](_http.handleErrors);
+};
 var updateSubmission = exports.updateSubmission = function updateSubmission(options) {
   var id = options.id,
     values = options.values;
@@ -521,8 +558,8 @@ var saveSubmissionMultipart = exports.saveSubmissionMultipart = function saveSub
     files = options.files,
     coreState = options.coreState,
     parent = options.parent,
-    _options$completed2 = options.completed,
-    completed = _options$completed2 === void 0 ? !id : _options$completed2;
+    _options$completed3 = options.completed,
+    completed = _options$completed3 === void 0 ? !id : _options$completed3;
 
   // Determine whether we should use the create or update endpoint based on the
   // options provided (the rest of the HTTP request behaves the same way

package/lib/apis/http.js

@@ -119,12 +119,26 @@ var formDataBuilder = exports.formDataBuilder = function formDataBuilder(data, p
     return result;
   }, formData);
 };
+
+/**
+ *
+ * @param {string} functionName
+ * @param {(string|string[])[]} requiredOptions
+ *    The keys of the required options. You can group keys in a nested array if
+ *    only one of a subset is required.
+ * @param {object} options
+ *    The options object to validate.
+ */
 var validateOptions = exports.validateOptions = function validateOptions(functionName, requiredOptions, options) {
   var missing = requiredOptions.filter(function (requiredOption) {
-    return !options[requiredOption];
+    return Array.isArray(requiredOption) ? !requiredOption.some(function (option) {
+      return options[option];
+    }) : !options[requiredOption];
   });
   if (missing.length > 0) {
-    throw new Error("".concat(functionName, " failed! The following required options are missing: ").concat(missing));
+    throw new Error("".concat(functionName, " failed! The following required options are missing: ").concat(missing.map(function (key) {
+      return Array.isArray(key) ? key.join(' or ') : key;
+    }).join(', ')));
   }
 };
 var apiFunction = exports.apiFunction = function apiFunction(_ref) {

package/lib/apis/index.js

@@ -204,6 +204,18 @@ Object.keys(_formTypes).forEach(function (key) {
     }
   });
 });
+var _integrations = require("./core/integrations");
+Object.keys(_integrations).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _integrations[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _integrations[key];
+    }
+  });
+});
 var _kapps = require("./core/kapps");
 Object.keys(_kapps).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -445,6 +457,18 @@ Object.keys(_workflows).forEach(function (key) {
   });
 });
 var _http = require("./http");
+var _integrator = require("./integrator");
+Object.keys(_integrator).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _integrator[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _integrator[key];
+    }
+  });
+});
 var _task = require("./task");
 Object.keys(_task).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;