@carbon/ibm-products 2.89.0 → 2.90.0

package/es/node_modules/@carbon/icons-react/es/{iconPropTypes-B1cP964Y.js → iconPropTypes-BElKp6Sn.js}

@@ -6,8 +6,7 @@
  */
 
 import PropTypes from "prop-types";
-
-//#region ../../node_modules/@carbon/icons-react/es/iconPropTypes-B1cP964Y.js
+//#region ../../node_modules/@carbon/icons-react/es/iconPropTypes-BElKp6Sn.js
 /**
 * Copyright IBM Corp. 2016, 2023
 *
@@ -17,6 +16,5 @@ import PropTypes from "prop-types";
 * Code generated by @carbon/icon-build-helpers. DO NOT EDIT.
 */
 const iconPropTypes = { size: PropTypes.oneOfType([PropTypes.number, PropTypes.string]) };
-
 //#endregion
-export { iconPropTypes };
+export { iconPropTypes };

package/es/node_modules/classnames/index.js

@@ -6,7 +6,6 @@
  */
 
 import { __commonJSMin } from "../../_virtual/_rolldown/runtime.js";
-
 //#region ../../node_modules/classnames/index.js
 var require_classnames = /* @__PURE__ */ __commonJSMin(((exports, module) => {
 	/*!
@@ -48,8 +47,6 @@ var require_classnames = /* @__PURE__ */ __commonJSMin(((exports, module) => {
 		else window.classNames = classNames;
 	})();
 }));
-
 //#endregion
 export default require_classnames();
-
-export { require_classnames };
+export { require_classnames };

package/es/settings.js

@@ -10,7 +10,6 @@ import { Canary } from "./components/_Canary/Canary.js";
 import pconsole_default from "./global/js/utils/pconsole.js";
 import React from "react";
 import { themes } from "@carbon/themes";
-
 //#region src/settings.js
 /**
 * Copyright IBM Corp. 2024
@@ -47,6 +46,5 @@ package_settings_default.checkComponentEnabled = (component, name) => {
 	}
 };
 const pkg = package_settings_default;
-
 //#endregion
-export { carbon, pkg };
+export { carbon, pkg };

package/lib/_virtual/_rolldown/runtime.js

@@ -12,31 +12,23 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
+var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
 var __exportAll = (all, no_symbols) => {
 	let target = {};
-	for (var name in all) {
-		__defProp(target, name, {
-			get: all[name],
-			enumerable: true
-		});
-	}
-	if (!no_symbols) {
-		__defProp(target, Symbol.toStringTag, { value: "Module" });
-	}
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
 	return target;
 };
 var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") {
-		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-			key = keys[i];
-			if (!__hasOwnProp.call(to, key) && key !== except) {
-				__defProp(to, key, {
-					get: ((k) => from[k]).bind(null, key),
-					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-				});
-			}
-		}
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
 	}
 	return to;
 };
@@ -44,9 +36,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	value: mod,
 	enumerable: true
 }) : target, mod));
-
 //#endregion
-
 exports.__commonJSMin = __commonJSMin;
 exports.__exportAll = __exportAll;
-exports.__toESM = __toESM;
+exports.__toESM = __toESM;

package/lib/components/APIKeyModal/APIKeyDownloader.js

@@ -5,13 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_settings = require('../../settings.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/APIKeyModal/APIKeyDownloader.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -47,13 +46,30 @@ const APIKeyDownloader = (props) => {
 };
 APIKeyDownloader.displayName = componentName;
 APIKeyDownloader.propTypes = {
+	/**
+	* the api key that's displayed to the user when a request to create is fulfilled.
+	*/
 	apiKey: prop_types.default.string.isRequired,
+	/**
+	* body content for the downloader
+	*/
 	body: prop_types.default.string,
+	/**
+	* aria-label for the download link
+	*/
 	downloadLinkLabel: prop_types.default.string,
+	/**
+	* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
+	*/
 	fileName: prop_types.default.string.isRequired,
+	/**
+	* designates the file type for the downloadable key
+	*/
 	fileType: prop_types.default.oneOf(["txt", "json"]).isRequired,
+	/**
+	* anchor text for the download link
+	*/
 	linkText: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.APIKeyDownloader = APIKeyDownloader;
+exports.APIKeyDownloader = APIKeyDownloader;

package/lib/components/APIKeyModal/APIKeyModal.js

@@ -5,22 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
-const require_useFocus = require('../../global/js/hooks/useFocus.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_usePortalTarget = require('../../global/js/hooks/usePortalTarget.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.js');
-const require_APIKeyDownloader = require('./APIKeyDownloader.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_usePreviousValue = require("../../global/js/hooks/usePreviousValue.js");
+const require_useFocus = require("../../global/js/hooks/useFocus.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_usePortalTarget = require("../../global/js/hooks/usePortalTarget.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.js");
+const require_APIKeyDownloader = require("./APIKeyDownloader.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/APIKeyModal/APIKeyModal.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const componentName = "APIKeyModal";
@@ -219,63 +218,222 @@ const APIKeyModal = (0, react.forwardRef)(({ apiKey, apiKeyLabel, apiKeyName = d
 	}, getPrimaryButtonText())))));
 });
 const deprecatedProps = {
+	/**
+	* deprecated
+	* title for a successful edit
+	*/
 	editSuccessTitle: prop_types.default.string,
+	/**
+	* deprecated
+	* title for a successful key generation
+	*/
 	generateSuccessTitle: prop_types.default.string
 };
 APIKeyModal.propTypes = {
+	/**
+	* the api key that's displayed to the user when a request to create is fulfilled.
+	*/
 	apiKey: prop_types.default.string,
+	/**
+	* label for the text input that holds the api key.
+	*/
 	apiKeyLabel: prop_types.default.string,
+	/**
+	* the name of the api key. should only be supplied in edit mode.
+	*/
 	apiKeyName: prop_types.default.string,
+	/**
+	* body content for the modal
+	*/
 	body: prop_types.default.string,
+	/**
+	* optional class name
+	*/
 	className: prop_types.default.string,
+	/**
+	* text for the close button
+	*/
 	closeButtonText: prop_types.default.string,
+	/**
+	* text for the copy button
+	*/
 	copyButtonText: prop_types.default.string,
+	/**
+	* Error message for when the copy function fails
+	*/
 	copyErrorText: prop_types.default.string,
+	/**
+	* text description for the copy button icon
+	*/
 	copyIconDescription: prop_types.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: prop_types.default.arrayOf(prop_types.default.shape({
+		/**
+		* designates if the step has passed whatever validation rules are in place.
+		*/
 		valid: prop_types.default.bool,
+		/**
+		* designates content is the JSX that holds whatever inputs you need
+		*/
 		content: prop_types.default.node,
+		/**
+		* designates the title that's displayed at the top of the modal for each step
+		*/
 		title: prop_types.default.string
 	})),
+	/**
+	* the content that appears that indicates the key is downloadable
+	*/
 	downloadBodyText: prop_types.default.string,
+	/**
+	* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
+	*/
 	downloadFileName: prop_types.default.string,
+	/**
+	* designates the file type for the downloadable key
+	*/
 	downloadFileType: prop_types.default.oneOf(["txt", "json"]),
+	/**
+	* aria-label for the download link
+	*/
 	downloadLinkLabel: prop_types.default.string,
+	/**
+	* anchor text for the download link
+	*/
 	downloadLinkText: prop_types.default.string,
+	/**
+	* text for the edit button
+	*/
 	editButtonText: prop_types.default.string,
+	/**
+	* designates if the edit request was successful
+	*/
 	editSuccess: prop_types.default.bool,
+	/**
+	* title for a successful edit
+	*/
 	editSuccessMessage: prop_types.default.string,
+	/**
+	* designates if the modal is in the edit mode
+	*/
 	editing: prop_types.default.bool,
+	/**
+	* designates if an error has occurred in a request
+	*/
 	error: prop_types.default.bool,
+	/**
+	* text to display if an error has occurred
+	*/
 	errorText: prop_types.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: prop_types.default.string,
+	/**
+	* content to display if generate request was successful
+	*/
 	generateSuccessBody: prop_types.default.node,
+	/**
+	* title for a successful key generation
+	*/
 	generateSuccessMessage: prop_types.default.string,
+	/**
+	* default title for the modal in generate key mode
+	*/
 	generateTitle: prop_types.default.string,
+	/**
+	* designates if the api input has the visibility toggle enabled
+	*/
 	hasAPIKeyVisibilityToggle: prop_types.default.bool,
+	/**
+	* designates if user is able to download the api key
+	*/
 	hasDownloadLink: prop_types.default.bool,
+	/**
+	* helper text for password input
+	*/
 	helperText: prop_types.default.string,
+	/**
+	* label text that's displayed when hovering over visibility toggler to hide key
+	*/
 	hideAPIKeyLabel: prop_types.default.string,
+	/**
+	* Provide a ref to return focus to once the tearsheet is closed.
+	*/
+	/**@ts-ignore */
 	launcherButtonRef: prop_types.default.any,
+	/**
+	* designates if the modal is in a loading state via a request or some other in progress operation
+	*/
 	loading: prop_types.default.bool,
+	/**
+	* text that displays while modal is in the loading state
+	*/
 	loadingText: prop_types.default.string,
+	/**
+	* general label text for modal
+	*/
 	modalLabel: prop_types.default.string,
+	/**
+	* helper text for name input
+	*/
 	nameHelperText: prop_types.default.string,
+	/**
+	* label for api key name input
+	*/
 	nameLabel: prop_types.default.string,
+	/**
+	* placeholder text for api key name input
+	*/
 	namePlaceholder: prop_types.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: prop_types.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: prop_types.default.string,
+	/**
+	* handler for on modal close
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Optional callback if you want to use your own copy function instead of the build in one
+	* onCopy(apiKey)
+	*/
 	onCopy: prop_types.default.func,
+	/**
+	* handler for api key edit
+	*/
 	onRequestEdit: prop_types.default.func,
+	/**
+	* handler for api key generation
+	*/
 	onRequestGenerate: prop_types.default.func,
+	/**
+	* designates if modal is open or closed
+	*/
 	open: prop_types.default.bool.isRequired,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: prop_types.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: prop_types.default.string,
+	/**
+	* label text that's displayed when hovering over visibility toggler to show key
+	*/
 	showAPIKeyLabel: prop_types.default.string,
 	...deprecatedProps
 };
 APIKeyModal.displayName = componentName;
-
 //#endregion
-exports.APIKeyModal = APIKeyModal;
+exports.APIKeyModal = APIKeyModal;

package/lib/components/AboutModal/AboutModal.js

@@ -5,19 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_useFocus = require('../../global/js/hooks/useFocus.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_usePortalTarget = require('../../global/js/hooks/usePortalTarget.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_useFocus = require("../../global/js/hooks/useFocus.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_usePortalTarget = require("../../global/js/hooks/usePortalTarget.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/AboutModal/AboutModal.tsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -71,20 +70,62 @@ const AboutModal = react.default.forwardRef(({ additionalInfo, className, closeI
 });
 AboutModal.displayName = componentName;
 AboutModal.propTypes = {
+	/**
+	* Provide additional detail for the modal footer, such as logos of
+	* technologies used in the product, legally required for some products
+	*/
 	additionalInfo: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the modal root node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide an accessible name for the close icon
+	*/
 	closeIconDescription: prop_types.default.string.isRequired,
+	/**
+	* Provide any relevant product disclaimers or legal information
+	*/
 	content: prop_types.default.node,
+	/**
+	* Specify the first year of product release to the current year
+	*/
 	copyrightText: prop_types.default.string.isRequired,
+	/**
+	* Provide an array of Carbon `Link`s for additional detail about the
+	* product
+	*/
 	links: prop_types.default.arrayOf(prop_types.default.element),
+	/**
+	* Provide a visual representation of the product
+	*/
 	logo: prop_types.default.node.isRequired,
+	/**
+	* Specify an aria-label for the modal
+	*/
 	modalAriaLabel: prop_types.default.string,
+	/**
+	* Specify an optional handler for closing modal. Returning `false`
+	* prevents the modal from closing
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Specify whether the modal is currently open
+	*/
 	open: prop_types.default.bool,
+	/**
+	* Provide the DOM node where the modal should be rendered.
+	* Defaults to `document.body`
+	*/
 	portalTarget: prop_types.default.node,
+	/**
+	* Provide the product name for the modal header
+	*/
 	title: prop_types.default.node.isRequired,
+	/**
+	* Provide the product’s version number
+	*/
 	version: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.AboutModal = AboutModal;
+exports.AboutModal = AboutModal;

package/lib/components/ActionBar/ActionBar.js

@@ -5,20 +5,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.js');
-const require_ActionBarItem = require('./ActionBarItem.js');
-const require_ActionBarOverflowItems = require('./ActionBarOverflowItems.js');
-const require_useOverflowItems = require('../../global/js/hooks/useOverflowItems/useOverflowItems.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.js");
+const require_ActionBarItem = require("./ActionBarItem.js");
+const require_ActionBarOverflowItems = require("./ActionBarOverflowItems.js");
+const require_useOverflowItems = require("../../global/js/hooks/useOverflowItems/useOverflowItems.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/ActionBar/ActionBar.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const blockClass = `${require_settings.pkg.prefix}--action-bar`;
@@ -66,7 +65,24 @@ const ActionBar = react.default.forwardRef(({ actions = defaults.actions, classN
 });
 ActionBar.displayName = componentName;
 ActionBar.propTypes = {
+	/**
+	* Specifies the action bar items. Each item is specified as an object
+	* with required fields: key for array rendering, renderIcon, iconDescription and
+	* label to provide the icon to display,
+	* and optional 'onClick' to receive notifications when the button is clicked.
+	* Additional fields in the object will be passed to the
+	* Button component, and these can include 'disabled', 'ref', 'className',
+	* and any other Button props.
+	*
+	* Note that the Button props 'kind', 'size',
+	* 'tooltipPosition', 'tooltipAlignment' and 'type' are ignored, as these
+	* cannot be used for an action bar item.
+	*
+	* Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+	*/
+	/**@ts-ignore */
 	actions: prop_types.default.arrayOf(prop_types.default.shape({
+		/**@ts-ignore */
 		...require_props_helper.prepareProps(_carbon_react.Button.propTypes, [
 			"kind",
 			"size",
@@ -77,17 +93,39 @@ ActionBar.propTypes = {
 		key: prop_types.default.string.isRequired,
 		iconDescription: prop_types.default.string.isRequired,
 		label: prop_types.default.string.isRequired,
+		/**@ts-ignore */
 		renderIcon: _carbon_react.Button.propTypes.renderIcon.isRequired,
 		onClick: prop_types.default.func
 	})),
+	/**
+	* className
+	*/
 	className: prop_types.default.string,
+	/**
+	* maxVisible : Maximum action bar items visible before going into the overflow menu
+	*/
 	maxVisible: prop_types.default.number,
+	/**
+	* class name applied to the overflow options
+	*/
 	menuOptionsClass: prop_types.default.string,
+	/**
+	* onItemCountChange - event reporting maxWidth
+	*/
 	onWidthChange: prop_types.default.func,
+	/**
+	* overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+	*/
 	overflowAriaLabel: prop_types.default.string.isRequired,
+	/**
+	* overflowMenuRef for the overflow menu width that is needed to calculate the width of the action bar with overflow
+	*/
+	/**@ts-ignore */
 	overflowMenuRef: prop_types.default.oneOfType([prop_types.default.shape({ current: prop_types.default.elementType }), prop_types.default.object]),
+	/**
+	* align tags to right of available space
+	*/
 	rightAlign: prop_types.default.bool
 };
-
 //#endregion
-exports.ActionBar = ActionBar;
+exports.ActionBar = ActionBar;

package/lib/components/ActionBar/ActionBarItem.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/ActionBar/ActionBarItem.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const componentName = "ActionBarItem";
@@ -46,13 +45,41 @@ reservedProps.forEach((prop) => {
 });
 ActionBarItem.displayName = componentName;
 ActionBarItem.propTypes = {
+	/**
+	* The ...propTypes are copies of those from Button minus the props reserved for use by this component
+	*/
 	...propTypes,
+	/**
+	* Specify an optional className to be added to your Button
+	*
+	* (inherited from Carbon Button)
+	*/
 	className: prop_types.default.string,
+	/**
+	* If specifying the `renderIcon` prop, provide a description for that icon that can
+	* be read by screen readers
+	*
+	* (inherited from Carbon Button)
+	*/
 	label: prop_types.default.string,
+	/**
+	* Optional click handler
+	*
+	* (inherited from Carbon Button)
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Optional prop to allow overriding the icon rendering.
+	* Can be a React component class
+	*
+	* (inherited from Carbon Button)
+	*/
+	/**@ts-ignore */
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Optional tab index
+	*/
 	tabIndex: prop_types.default.number
 };
-
 //#endregion
-exports.ActionBarItem = ActionBarItem;
+exports.ActionBarItem = ActionBarItem;