@carbon/ibm-products 2.43.2-canary.27 → 2.43.2-canary.270

package/es/settings.d.ts

@@ -25,6 +25,7 @@ export const pkg: {
         ErrorEmptyState: boolean;
         ExportModal: boolean;
         ExpressiveCard: boolean;
+        FullPageError: boolean;
         HTTPError403: boolean;
         HTTPError404: boolean;
         HTTPErrorOther: boolean;
@@ -63,10 +64,11 @@ export const pkg: {
         EditFullPage: boolean;
         EditUpdateCards: boolean;
         Nav: boolean;
+        NavItem: boolean;
+        NavList: boolean;
         BigNumbers: boolean;
         TruncatedList: boolean;
         DelimitedList: boolean;
-        FullPageError: boolean;
         ScrollGradient: boolean;
         StringFormatter: boolean;
         StatusIndicator: boolean;

package/flags.js

@@ -1,3 +1,10 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
 const { pkg } = require('./lib/settings.js');
 const { component, feature } = pkg;
 

package/lib/_virtual/_commonjsHelpers.js

@@ -7,8 +7,6 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
 }

package/lib/_virtual/_rollupPluginBabelHelpers.js

@@ -7,8 +7,6 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 function _iterableToArrayLimit(r, l) {
   var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
   if (null != t) {
@@ -563,7 +561,7 @@ exports.arrayWithoutHoles = _arrayWithoutHoles;
 exports.asyncToGenerator = _asyncToGenerator;
 exports.createForOfIteratorHelper = _createForOfIteratorHelper;
 exports.defineProperty = _defineProperty;
-exports["extends"] = _extends;
+exports.extends = _extends;
 exports.iterableToArray = _iterableToArray;
 exports.iterableToArrayLimit = _iterableToArrayLimit;
 exports.nonIterableRest = _nonIterableRest;
@@ -578,5 +576,5 @@ exports.toArray = _toArray;
 exports.toConsumableArray = _toConsumableArray;
 exports.toPrimitive = _toPrimitive;
 exports.toPropertyKey = _toPropertyKey;
-exports["typeof"] = _typeof;
+exports.typeof = _typeof;
 exports.unsupportedIterableToArray = _unsupportedIterableToArray;

package/lib/_virtual/index.js

@@ -7,8 +7,6 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var propTypes = {exports: {}};
 
 exports.__module = propTypes;

package/lib/components/APIKeyModal/APIKeyDownloader.js

@@ -7,17 +7,11 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
 var React = require('react');
 var index = require('../../node_modules/prop-types/index.js');
 var settings = require('../../settings.js');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-
 var componentName = 'APIKeyDownloader';
 var APIKeyDownloader = function APIKeyDownloader(_ref) {
   var apiKey = _ref.apiKey,
@@ -64,11 +58,11 @@ var APIKeyDownloader = function APIKeyDownloader(_ref) {
     }();
     generateLinkProps();
   }, [apiKey, fileName, fileType]);
-  return /*#__PURE__*/React__default["default"].createElement("div", {
+  return /*#__PURE__*/React.createElement("div", {
     className: "".concat(settings.pkg.prefix, "--apikey-modal__download-container")
-  }, /*#__PURE__*/React__default["default"].createElement("p", {
+  }, /*#__PURE__*/React.createElement("p", {
     className: "".concat(settings.pkg.prefix, "--apikey-modal__messaging-text")
-  }, body, ' ', /*#__PURE__*/React__default["default"].createElement("a", _rollupPluginBabelHelpers["extends"]({}, linkProps, {
+  }, body, ' ', /*#__PURE__*/React.createElement("a", _rollupPluginBabelHelpers.extends({}, linkProps, {
     className: "".concat(settings.pkg.prefix, "--apikey-modal__download-link")
   }), linkText)));
 };
@@ -77,23 +71,23 @@ APIKeyDownloader.propTypes = {
   /**
    * the api key that's displayed to the user when a request to create is fulfilled.
    */
-  apiKey: index["default"].string.isRequired,
+  apiKey: index.default.string.isRequired,
   /**
    * body content for the downloader
    */
-  body: index["default"].string.isRequired,
+  body: index.default.string.isRequired,
   /**
    * designates the name of downloadable json file with the key. if not specified will default to 'apikey'
    */
-  fileName: index["default"].string.isRequired,
+  fileName: index.default.string.isRequired,
   /**
    * designates the file type for the downloadable key
    */
-  fileType: index["default"].oneOf(['txt', 'json']).isRequired,
+  fileType: index.default.oneOf(['txt', 'json']).isRequired,
   /**
    * anchor text for the download link
    */
-  linkText: index["default"].string.isRequired
+  linkText: index.default.string.isRequired
 };
 
 exports.APIKeyDownloader = APIKeyDownloader;

package/lib/components/APIKeyModal/APIKeyModal.js

@@ -7,8 +7,6 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
 var React = require('react');
 var index = require('../../node_modules/prop-types/index.js');
@@ -22,11 +20,6 @@ var devtools = require('../../global/js/utils/devtools.js');
 var propsHelper = require('../../global/js/utils/props-helper.js');
 var uuidv4 = require('../../global/js/utils/uuidv4.js');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
-
 var _ErrorFilled, _InformationFilled;
 var _excluded = ["apiKey", "apiKeyLabel", "apiKeyName", "body", "className", "closeButtonText", "copyButtonText", "copyErrorText", "copyIconDescription", "customSteps", "downloadBodyText", "downloadFileName", "downloadFileType", "downloadLinkText", "editButtonText", "editSuccess", "editSuccessTitle", "editing", "error", "errorText", "generateButtonText", "generateSuccessBody", "generateSuccessTitle", "generateTitle", "hasAPIKeyVisibilityToggle", "hasDownloadLink", "hideAPIKeyLabel", "loading", "loadingText", "modalLabel", "nameHelperText", "nameLabel", "namePlaceholder", "nameRequired", "nextStepButtonText", "onClose", "onCopy", "onRequestEdit", "onRequestGenerate", "open", "portalTarget", "previousStepButtonText", "showAPIKeyLabel"];
 var componentName = 'APIKeyModal';
@@ -101,8 +94,8 @@ exports.APIKeyModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     currentStep = _useState8[0],
     setCurrentStep = _useState8[1];
   var copyRef = React.useRef();
-  var apiKeyInputId = React.useRef(uuidv4["default"]());
-  var nameInputId = React.useRef(uuidv4["default"]());
+  var apiKeyInputId = React.useRef(uuidv4.default());
+  var nameInputId = React.useRef(uuidv4.default());
   var renderPortalUse = usePortalTarget.usePortalTarget(portalTargetIn);
   var hasSteps = Boolean(customSteps.length);
   var apiKeyLoaded = apiKey && !loading;
@@ -110,7 +103,7 @@ exports.APIKeyModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var hasPreviousStep = hasSteps && currentStep !== 0;
   var copyButtonProps = {
     renderIcon: function renderIcon(props) {
-      return /*#__PURE__*/React__default["default"].createElement(icons.Copy, _rollupPluginBabelHelpers["extends"]({
+      return /*#__PURE__*/React.createElement(icons.Copy, _rollupPluginBabelHelpers.extends({
         size: 16
       }, props));
     },
@@ -237,38 +230,38 @@ exports.APIKeyModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       onCloseHandler();
     }
   };
-  return renderPortalUse( /*#__PURE__*/React__default["default"].createElement(react.ComposedModal, _rollupPluginBabelHelpers["extends"]({}, rest, _rollupPluginBabelHelpers.objectSpread2({
+  return renderPortalUse( /*#__PURE__*/React.createElement(react.ComposedModal, _rollupPluginBabelHelpers.extends({}, rest, _rollupPluginBabelHelpers.objectSpread2({
     open: open,
     ref: ref
   }, devtools.getDevtoolsProps(componentName)), {
-    className: cx__default["default"](className, blockClass),
+    className: cx(className, blockClass),
     onClose: onCloseHandler,
     size: "sm",
     "aria-label": modalLabel,
     preventCloseOnClickOutside: true
-  }), /*#__PURE__*/React__default["default"].createElement(react.ModalHeader, {
+  }), /*#__PURE__*/React.createElement(react.ModalHeader, {
     className: "".concat(blockClass, "__header"),
     title: title,
     label: modalLabel
-  }), /*#__PURE__*/React__default["default"].createElement(react.ModalBody, {
+  }), /*#__PURE__*/React.createElement(react.ModalBody, {
     className: "".concat(blockClass, "__body-container")
-  }, hasSteps && !apiKeyLoaded ? (_customSteps$currentS3 = customSteps[currentStep]) === null || _customSteps$currentS3 === void 0 ? void 0 : _customSteps$currentS3.content : /*#__PURE__*/React__default["default"].createElement(React__default["default"].Fragment, null, body && /*#__PURE__*/React__default["default"].createElement("p", {
+  }, hasSteps && !apiKeyLoaded ? (_customSteps$currentS3 = customSteps[currentStep]) === null || _customSteps$currentS3 === void 0 ? void 0 : _customSteps$currentS3.content : /*#__PURE__*/React.createElement(React.Fragment, null, body && /*#__PURE__*/React.createElement("p", {
     className: "".concat(blockClass, "__body")
-  }, body), !editing && apiKey && hasAPIKeyVisibilityToggle && /*#__PURE__*/React__default["default"].createElement(react.PasswordInput, {
+  }, body), !editing && apiKey && hasAPIKeyVisibilityToggle && /*#__PURE__*/React.createElement(react.PasswordInput, {
     value: apiKey,
     labelText: apiKeyLabel,
     id: apiKeyInputId.current,
     showPasswordLabel: showAPIKeyLabel,
     hidePasswordLabel: hideAPIKeyLabel,
     tooltipPosition: "left"
-  }), !editing && apiKey && !hasAPIKeyVisibilityToggle && /*#__PURE__*/React__default["default"].createElement(react.TextInput, {
+  }), !editing && apiKey && !hasAPIKeyVisibilityToggle && /*#__PURE__*/React.createElement(react.TextInput, {
     value: apiKey,
     labelText: apiKeyLabel,
     id: apiKeyInputId.current
-  }), (editing || !apiKeyLoaded && nameRequired) && /*#__PURE__*/React__default["default"].createElement(react.Form, {
+  }), (editing || !apiKeyLoaded && nameRequired) && /*#__PURE__*/React.createElement(react.Form, {
     onSubmit: submitHandler,
     "aria-label": title !== null && title !== void 0 ? title : undefined
-  }, /*#__PURE__*/React__default["default"].createElement(react.TextInput, {
+  }, /*#__PURE__*/React.createElement(react.TextInput, {
     helperText: nameHelperText,
     placeholder: namePlaceholder,
     labelText: nameLabel,
@@ -278,36 +271,36 @@ exports.APIKeyModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     disabled: loading,
     required: nameRequired,
     "data-modal-primary-focus": true
-  })), loading && /*#__PURE__*/React__default["default"].createElement(react.InlineLoading, {
+  })), loading && /*#__PURE__*/React.createElement(react.InlineLoading, {
     description: loadingText,
     className: "".concat(blockClass, "__loader")
-  }), (copyError || error) && /*#__PURE__*/React__default["default"].createElement("div", {
+  }), (copyError || error) && /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__messaging")
-  }, /*#__PURE__*/React__default["default"].createElement("div", {
+  }, /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__error-icon")
-  }, _ErrorFilled || (_ErrorFilled = /*#__PURE__*/React__default["default"].createElement(icons.ErrorFilled, {
+  }, _ErrorFilled || (_ErrorFilled = /*#__PURE__*/React.createElement(icons.ErrorFilled, {
     size: 16
-  }))), /*#__PURE__*/React__default["default"].createElement("p", {
+  }))), /*#__PURE__*/React.createElement("p", {
     className: "".concat(blockClass, "__messaging-text")
-  }, copyError ? copyErrorText : errorText)), apiKeyLoaded && /*#__PURE__*/React__default["default"].createElement("div", {
+  }, copyError ? copyErrorText : errorText)), apiKeyLoaded && /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__messaging")
-  }, _InformationFilled || (_InformationFilled = /*#__PURE__*/React__default["default"].createElement(icons.InformationFilled, {
+  }, _InformationFilled || (_InformationFilled = /*#__PURE__*/React.createElement(icons.InformationFilled, {
     size: 16
-  })), hasDownloadLink ? /*#__PURE__*/React__default["default"].createElement(APIKeyDownloader.APIKeyDownloader, {
+  })), hasDownloadLink ? /*#__PURE__*/React.createElement(APIKeyDownloader.APIKeyDownloader, {
     apiKey: apiKey,
     body: downloadBodyText,
     fileName: downloadFileName,
     linkText: downloadLinkText,
     fileType: downloadFileType
-  }) : /*#__PURE__*/React__default["default"].createElement("div", {
+  }) : /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__messaging-text")
-  }, generateSuccessBody)))), /*#__PURE__*/React__default["default"].createElement(react.ModalFooter, {
+  }, generateSuccessBody)))), /*#__PURE__*/React.createElement(react.ModalFooter, {
     className: "".concat(blockClass, "__footer")
-  }, /*#__PURE__*/React__default["default"].createElement(react.Button, {
+  }, /*#__PURE__*/React.createElement(react.Button, {
     type: "button",
     kind: "secondary",
     onClick: onBackHandler
-  }, getSecondaryButtonText()), /*#__PURE__*/React__default["default"].createElement(react.Button, _rollupPluginBabelHelpers["extends"]({}, apiKeyLoaded && copyButtonProps, {
+  }, getSecondaryButtonText()), /*#__PURE__*/React.createElement(react.Button, _rollupPluginBabelHelpers.extends({}, apiKeyLoaded && copyButtonProps, {
     type: "submit",
     kind: "primary",
     onClick: submitHandler,
@@ -339,191 +332,191 @@ exports.APIKeyModal.propTypes = {
   /**
    * the api key that's displayed to the user when a request to create is fulfilled.
    */
-  apiKey: index["default"].string,
+  apiKey: index.default.string,
   /**
    * label for the text input that holds the api key.
    */
-  apiKeyLabel: index["default"].string,
+  apiKeyLabel: index.default.string,
   /**
    * the name of the api key. should only be supplied in edit mode.
    */
-  apiKeyName: index["default"].string,
+  apiKeyName: index.default.string,
   /**
    * body content for the modal
    */
-  body: index["default"].string,
+  body: index.default.string,
   /**
    * optional class name
    */
-  className: index["default"].string,
+  className: index.default.string,
   /**
    * text for the close button
    */
-  closeButtonText: index["default"].string,
+  closeButtonText: index.default.string,
   /**
    * text for the copy button
    */
-  copyButtonText: index["default"].string,
+  copyButtonText: index.default.string,
   /**
    * Error message for when the copy function fails
    */
-  copyErrorText: index["default"].string,
+  copyErrorText: index.default.string,
   /**
    * text description for the copy button icon
    */
-  copyIconDescription: index["default"].string,
+  copyIconDescription: index.default.string,
   /**
    * if you need more options for key creation beyond just the name use custom steps to obtain whatever data is required.
    */
   /**@ts-ignore*/
-  customSteps: index["default"].arrayOf(index["default"].shape({
+  customSteps: index.default.arrayOf(index.default.shape({
     /**
      * designates if the step has passed whatever validation rules are in place.
      */
-    valid: index["default"].bool,
+    valid: index.default.bool,
     /**
      * designates content is the JSX that holds whatever inputs you need
      */
-    content: index["default"].node,
+    content: index.default.node,
     /**
      * designates the title that's displayed at the top of the modal for each step
      */
-    title: index["default"].string
+    title: index.default.string
   })),
   /**
    * the content that appears that indicates the key is downloadable
    */
-  downloadBodyText: downloadRequiredProps(index["default"].string),
+  downloadBodyText: downloadRequiredProps(index.default.string),
   /**
    * designates the name of downloadable json file with the key. if not specified will default to 'apikey'
    */
-  downloadFileName: downloadRequiredProps(index["default"].string),
+  downloadFileName: downloadRequiredProps(index.default.string),
   /**
    * designates the file type for the downloadable key
    */
-  downloadFileType: downloadRequiredProps(index["default"].oneOf(['txt', 'json'])),
+  downloadFileType: downloadRequiredProps(index.default.oneOf(['txt', 'json'])),
   /**
    * anchor text for the download link
    */
-  downloadLinkText: downloadRequiredProps(index["default"].string),
+  downloadLinkText: downloadRequiredProps(index.default.string),
   /**
    * text for the edit button
    */
-  editButtonText: editRequiredProps(index["default"].string),
+  editButtonText: editRequiredProps(index.default.string),
   /**
    * designates if the edit request was successful
    */
-  editSuccess: editRequiredProps(index["default"].bool),
+  editSuccess: editRequiredProps(index.default.bool),
   /**
    * title for a successful edit
    */
-  editSuccessTitle: editRequiredProps(index["default"].string),
+  editSuccessTitle: editRequiredProps(index.default.string),
   /**
    * designates if the modal is in the edit mode
    */
-  editing: index["default"].bool,
+  editing: index.default.bool,
   /**
    * designates if an error has occurred in a request
    */
-  error: index["default"].bool,
+  error: index.default.bool,
   /**
    * text to display if an error has occurred
    */
-  errorText: index["default"].string,
+  errorText: index.default.string,
   /**
    * default primary button text for modal in assumed default mode create or generate.
    * in create mode this is the button text prior to supplying an api key, which then
    * uses copyButtonText
    */
-  generateButtonText: index["default"].string,
+  generateButtonText: index.default.string,
   /**
    * content to display if generate request was successful
    */
-  generateSuccessBody: index["default"].node,
+  generateSuccessBody: index.default.node,
   /**
    * title for a successful key generation
    */
-  generateSuccessTitle: index["default"].string,
+  generateSuccessTitle: index.default.string,
   /**
    * default title for the modal in generate key mode
    */
-  generateTitle: index["default"].string,
+  generateTitle: index.default.string,
   /**
    * designates if the api input has the visibility toggle enabled
    */
-  hasAPIKeyVisibilityToggle: index["default"].bool,
+  hasAPIKeyVisibilityToggle: index.default.bool,
   /**
    * designates if user is able to download the api key
    */
-  hasDownloadLink: index["default"].bool,
+  hasDownloadLink: index.default.bool,
   /**
    * label text that's displayed when hovering over visibility toggler to hide key
    */
-  hideAPIKeyLabel: index["default"].string,
+  hideAPIKeyLabel: index.default.string,
   /**
    * designates if the modal is in a loading state via a request or some other in progress operation
    */
-  loading: index["default"].bool,
+  loading: index.default.bool,
   /**
    * text that displays while modal is in the loading state
    */
-  loadingText: index["default"].string,
+  loadingText: index.default.string,
   /**
    * general label text for modal
    */
-  modalLabel: index["default"].string,
+  modalLabel: index.default.string,
   /**
    * helper text for name input
    */
-  nameHelperText: index["default"].string,
+  nameHelperText: index.default.string,
   /**
    * label for api key name input
    */
-  nameLabel: index["default"].string,
+  nameLabel: index.default.string,
   /**
    * placeholder text for api key name input
    */
-  namePlaceholder: index["default"].string,
+  namePlaceholder: index.default.string,
   /**
    * designates if a name is required or not for key generation. NOTE- if using custom steps set this to false since you will be using your own validation
    */
-  nameRequired: index["default"].bool,
+  nameRequired: index.default.bool,
   /**
    * text that displays in the primary button when using custom steps to indicate to the user that there is a next step
    */
-  nextStepButtonText: customStepsRequiredProps(index["default"].string),
+  nextStepButtonText: customStepsRequiredProps(index.default.string),
   /**
    * handler for on modal close
    */
-  onClose: index["default"].func,
+  onClose: index.default.func,
   /**
    * Optional callback if you want to use your own copy function instead of the build in one
    * onCopy(apiKey)
    */
-  onCopy: index["default"].func,
+  onCopy: index.default.func,
   /**
    * handler for api key edit
    */
-  onRequestEdit: index["default"].func,
+  onRequestEdit: index.default.func,
   /**
    * handler for api key generation
    */
-  onRequestGenerate: index["default"].func,
+  onRequestGenerate: index.default.func,
   /**
    * designates if modal is open or closed
    */
-  open: index["default"].bool.isRequired,
+  open: index.default.bool.isRequired,
   /**
    * The DOM node the tearsheet should be rendered within. Defaults to document.body.
    */
-  portalTarget: index["default"].node,
+  portalTarget: index.default.node,
   /**
    * text that displays in the secondary button when using custom steps to indicate to the user that there is a previous step
    */
-  previousStepButtonText: customStepsRequiredProps(index["default"].string),
+  previousStepButtonText: customStepsRequiredProps(index.default.string),
   /**
    * label text that's displayed when hovering over visibility toggler to show key
    */
-  showAPIKeyLabel: index["default"].string
+  showAPIKeyLabel: index.default.string
 };
 exports.APIKeyModal.displayName = componentName;

package/lib/components/APIKeyModal/APIKeyModal.types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 import { ReactNode } from 'react';
 interface APIKeyModalCommonProps {
     /**
@@ -138,7 +144,7 @@ interface APIKeyModalCommonProps {
     /**
      * The DOM node the tearsheet should be rendered within. Defaults to document.body.
      */
-    portalTarget: ReactNode;
+    portalTarget?: ReactNode;
     /**
      * label text that's displayed when hovering over visibility toggler to show key
      */

package/lib/components/APIKeyModal/index.d.ts

@@ -1 +1,2 @@
-export { APIKeyModal } from "./APIKeyModal";
+export { APIKeyModal } from './APIKeyModal';
+export type { APIKeyModalProps } from './APIKeyModal.types';

package/lib/components/AboutModal/AboutModal.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface AboutModalProps {
+export interface AboutModalProps {
     /**
      * If you are legally required to display logos of technologies used
      * to build your product you can provide this in the additionalInfo.
@@ -77,4 +77,3 @@ interface AboutModalProps {
  * to completion.
  */
 export declare let AboutModal: React.ForwardRefExoticComponent<AboutModalProps & React.RefAttributes<HTMLDivElement>>;
-export {};