@carbon/ibm-products 2.89.0 → 2.90.0

package/es/_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,6 +36,5 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	value: mod,
 	enumerable: true
 }) : target, mod));
-
 //#endregion
-export { __commonJSMin, __exportAll, __toESM };
+export { __commonJSMin, __exportAll, __toESM };

package/es/components/APIKeyModal/APIKeyDownloader.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../settings.js";
 import React, { useEffect, useState } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/APIKeyModal/APIKeyDownloader.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -44,13 +43,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: PropTypes.string.isRequired,
+	/**
+	* body content for the downloader
+	*/
 	body: PropTypes.string,
+	/**
+	* aria-label for the download link
+	*/
 	downloadLinkLabel: PropTypes.string,
+	/**
+	* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
+	*/
 	fileName: PropTypes.string.isRequired,
+	/**
+	* designates the file type for the downloadable key
+	*/
 	fileType: PropTypes.oneOf(["txt", "json"]).isRequired,
+	/**
+	* anchor text for the download link
+	*/
 	linkText: PropTypes.string.isRequired
 };
-
 //#endregion
-export { APIKeyDownloader };
+export { APIKeyDownloader };

package/es/components/APIKeyModal/APIKeyModal.js

@@ -18,7 +18,6 @@ import React, { forwardRef, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ComposedModal, Form, InlineLoading, ModalBody, ModalFooter, ModalHeader, PasswordInput, TextInput, unstable_FeatureFlags } from "@carbon/react";
 import { CheckmarkFilled, Copy, ErrorFilled, InformationFilled } from "@carbon/react/icons";
-
 //#region src/components/APIKeyModal/APIKeyModal.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const componentName = "APIKeyModal";
@@ -217,63 +216,222 @@ const APIKeyModal = forwardRef(({ apiKey, apiKeyLabel, apiKeyName = defaults.api
 	}, getPrimaryButtonText())))));
 });
 const deprecatedProps = {
+	/**
+	* deprecated
+	* title for a successful edit
+	*/
 	editSuccessTitle: PropTypes.string,
+	/**
+	* deprecated
+	* title for a successful key generation
+	*/
 	generateSuccessTitle: PropTypes.string
 };
 APIKeyModal.propTypes = {
+	/**
+	* the api key that's displayed to the user when a request to create is fulfilled.
+	*/
 	apiKey: PropTypes.string,
+	/**
+	* label for the text input that holds the api key.
+	*/
 	apiKeyLabel: PropTypes.string,
+	/**
+	* the name of the api key. should only be supplied in edit mode.
+	*/
 	apiKeyName: PropTypes.string,
+	/**
+	* body content for the modal
+	*/
 	body: PropTypes.string,
+	/**
+	* optional class name
+	*/
 	className: PropTypes.string,
+	/**
+	* text for the close button
+	*/
 	closeButtonText: PropTypes.string,
+	/**
+	* text for the copy button
+	*/
 	copyButtonText: PropTypes.string,
+	/**
+	* Error message for when the copy function fails
+	*/
 	copyErrorText: PropTypes.string,
+	/**
+	* text description for the copy button icon
+	*/
 	copyIconDescription: PropTypes.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: PropTypes.arrayOf(PropTypes.shape({
+		/**
+		* designates if the step has passed whatever validation rules are in place.
+		*/
 		valid: PropTypes.bool,
+		/**
+		* designates content is the JSX that holds whatever inputs you need
+		*/
 		content: PropTypes.node,
+		/**
+		* designates the title that's displayed at the top of the modal for each step
+		*/
 		title: PropTypes.string
 	})),
+	/**
+	* the content that appears that indicates the key is downloadable
+	*/
 	downloadBodyText: PropTypes.string,
+	/**
+	* designates the name of downloadable json file with the key. if not specified will default to 'apikey'
+	*/
 	downloadFileName: PropTypes.string,
+	/**
+	* designates the file type for the downloadable key
+	*/
 	downloadFileType: PropTypes.oneOf(["txt", "json"]),
+	/**
+	* aria-label for the download link
+	*/
 	downloadLinkLabel: PropTypes.string,
+	/**
+	* anchor text for the download link
+	*/
 	downloadLinkText: PropTypes.string,
+	/**
+	* text for the edit button
+	*/
 	editButtonText: PropTypes.string,
+	/**
+	* designates if the edit request was successful
+	*/
 	editSuccess: PropTypes.bool,
+	/**
+	* title for a successful edit
+	*/
 	editSuccessMessage: PropTypes.string,
+	/**
+	* designates if the modal is in the edit mode
+	*/
 	editing: PropTypes.bool,
+	/**
+	* designates if an error has occurred in a request
+	*/
 	error: PropTypes.bool,
+	/**
+	* text to display if an error has occurred
+	*/
 	errorText: PropTypes.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: PropTypes.string,
+	/**
+	* content to display if generate request was successful
+	*/
 	generateSuccessBody: PropTypes.node,
+	/**
+	* title for a successful key generation
+	*/
 	generateSuccessMessage: PropTypes.string,
+	/**
+	* default title for the modal in generate key mode
+	*/
 	generateTitle: PropTypes.string,
+	/**
+	* designates if the api input has the visibility toggle enabled
+	*/
 	hasAPIKeyVisibilityToggle: PropTypes.bool,
+	/**
+	* designates if user is able to download the api key
+	*/
 	hasDownloadLink: PropTypes.bool,
+	/**
+	* helper text for password input
+	*/
 	helperText: PropTypes.string,
+	/**
+	* label text that's displayed when hovering over visibility toggler to hide key
+	*/
 	hideAPIKeyLabel: PropTypes.string,
+	/**
+	* Provide a ref to return focus to once the tearsheet is closed.
+	*/
+	/**@ts-ignore */
 	launcherButtonRef: PropTypes.any,
+	/**
+	* designates if the modal is in a loading state via a request or some other in progress operation
+	*/
 	loading: PropTypes.bool,
+	/**
+	* text that displays while modal is in the loading state
+	*/
 	loadingText: PropTypes.string,
+	/**
+	* general label text for modal
+	*/
 	modalLabel: PropTypes.string,
+	/**
+	* helper text for name input
+	*/
 	nameHelperText: PropTypes.string,
+	/**
+	* label for api key name input
+	*/
 	nameLabel: PropTypes.string,
+	/**
+	* placeholder text for api key name input
+	*/
 	namePlaceholder: PropTypes.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: PropTypes.bool,
+	/**
+	* text that displays in the primary button when using custom steps to indicate to the user that there is a next step
+	*/
 	nextStepButtonText: PropTypes.string,
+	/**
+	* handler for on modal close
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Optional callback if you want to use your own copy function instead of the build in one
+	* onCopy(apiKey)
+	*/
 	onCopy: PropTypes.func,
+	/**
+	* handler for api key edit
+	*/
 	onRequestEdit: PropTypes.func,
+	/**
+	* handler for api key generation
+	*/
 	onRequestGenerate: PropTypes.func,
+	/**
+	* designates if modal is open or closed
+	*/
 	open: PropTypes.bool.isRequired,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: PropTypes.node,
+	/**
+	* text that displays in the secondary button when using custom steps to indicate to the user that there is a previous step
+	*/
 	previousStepButtonText: PropTypes.string,
+	/**
+	* label text that's displayed when hovering over visibility toggler to show key
+	*/
 	showAPIKeyLabel: PropTypes.string,
 	...deprecatedProps
 };
 APIKeyModal.displayName = componentName;
-
 //#endregion
-export { APIKeyModal };
+export { APIKeyModal };

package/es/components/AboutModal/AboutModal.js

@@ -15,7 +15,6 @@ import uuidv4 from "../../global/js/utils/uuidv4.js";
 import React, { useEffect, useRef } from "react";
 import PropTypes from "prop-types";
 import { ComposedModal, ModalBody, ModalFooter, ModalHeader, unstable_FeatureFlags } from "@carbon/react";
-
 //#region src/components/AboutModal/AboutModal.tsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -69,20 +68,62 @@ const AboutModal = React.forwardRef(({ additionalInfo, className, closeIconDescr
 });
 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: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the modal root node
+	*/
 	className: PropTypes.string,
+	/**
+	* Provide an accessible name for the close icon
+	*/
 	closeIconDescription: PropTypes.string.isRequired,
+	/**
+	* Provide any relevant product disclaimers or legal information
+	*/
 	content: PropTypes.node,
+	/**
+	* Specify the first year of product release to the current year
+	*/
 	copyrightText: PropTypes.string.isRequired,
+	/**
+	* Provide an array of Carbon `Link`s for additional detail about the
+	* product
+	*/
 	links: PropTypes.arrayOf(PropTypes.element),
+	/**
+	* Provide a visual representation of the product
+	*/
 	logo: PropTypes.node.isRequired,
+	/**
+	* Specify an aria-label for the modal
+	*/
 	modalAriaLabel: PropTypes.string,
+	/**
+	* Specify an optional handler for closing modal. Returning `false`
+	* prevents the modal from closing
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specify whether the modal is currently open
+	*/
 	open: PropTypes.bool,
+	/**
+	* Provide the DOM node where the modal should be rendered.
+	* Defaults to `document.body`
+	*/
 	portalTarget: PropTypes.node,
+	/**
+	* Provide the product name for the modal header
+	*/
 	title: PropTypes.node.isRequired,
+	/**
+	* Provide the product’s version number
+	*/
 	version: PropTypes.string.isRequired
 };
-
 //#endregion
-export { AboutModal };
+export { AboutModal };

package/es/components/ActionBar/ActionBar.js

@@ -16,7 +16,6 @@ import { useOverflowItems } from "../../global/js/hooks/useOverflowItems/useOver
 import React, { useRef } from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/ActionBar/ActionBar.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--action-bar`;
@@ -64,7 +63,24 @@ const ActionBar = React.forwardRef(({ actions = defaults.actions, className, max
 });
 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: PropTypes.arrayOf(PropTypes.shape({
+		/**@ts-ignore */
 		...prepareProps(Button.propTypes, [
 			"kind",
 			"size",
@@ -75,17 +91,39 @@ ActionBar.propTypes = {
 		key: PropTypes.string.isRequired,
 		iconDescription: PropTypes.string.isRequired,
 		label: PropTypes.string.isRequired,
+		/**@ts-ignore */
 		renderIcon: Button.propTypes.renderIcon.isRequired,
 		onClick: PropTypes.func
 	})),
+	/**
+	* className
+	*/
 	className: PropTypes.string,
+	/**
+	* maxVisible : Maximum action bar items visible before going into the overflow menu
+	*/
 	maxVisible: PropTypes.number,
+	/**
+	* class name applied to the overflow options
+	*/
 	menuOptionsClass: PropTypes.string,
+	/**
+	* onItemCountChange - event reporting maxWidth
+	*/
 	onWidthChange: PropTypes.func,
+	/**
+	* overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+	*/
 	overflowAriaLabel: PropTypes.string.isRequired,
+	/**
+	* overflowMenuRef for the overflow menu width that is needed to calculate the width of the action bar with overflow
+	*/
+	/**@ts-ignore */
 	overflowMenuRef: PropTypes.oneOfType([PropTypes.shape({ current: PropTypes.elementType }), PropTypes.object]),
+	/**
+	* align tags to right of available space
+	*/
 	rightAlign: PropTypes.bool
 };
-
 //#endregion
-export { ActionBar };
+export { ActionBar };

package/es/components/ActionBar/ActionBarItem.js

@@ -11,7 +11,6 @@ import { pkg } from "../../settings.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { IconButton } from "@carbon/react";
-
 //#region src/components/ActionBar/ActionBarItem.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const componentName = "ActionBarItem";
@@ -44,13 +43,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: PropTypes.string,
+	/**
+	* If specifying the `renderIcon` prop, provide a description for that icon that can
+	* be read by screen readers
+	*
+	* (inherited from Carbon Button)
+	*/
 	label: PropTypes.string,
+	/**
+	* Optional click handler
+	*
+	* (inherited from Carbon Button)
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Optional prop to allow overriding the icon rendering.
+	* Can be a React component class
+	*
+	* (inherited from Carbon Button)
+	*/
+	/**@ts-ignore */
 	renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Optional tab index
+	*/
 	tabIndex: PropTypes.number
 };
-
 //#endregion
-export { ActionBarItem };
+export { ActionBarItem };

package/es/components/ActionBar/ActionBarOverflowItems.js

@@ -12,7 +12,6 @@ import uuidv4 from "../../global/js/utils/uuidv4.js";
 import React, { useRef } from "react";
 import PropTypes from "prop-types";
 import { OverflowMenu, OverflowMenuItem } from "@carbon/react";
-
 //#region src/components/ActionBar/ActionBarOverflowItems.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--action-bar-overflow-items`;
@@ -43,17 +42,35 @@ const ActionBarOverflowItems = ({ className, menuOptionsClass, overflowItems, ov
 };
 ActionBarOverflowItems.displayName = componentName;
 ActionBarOverflowItems.propTypes = {
+	/**
+	* className
+	*/
 	className: PropTypes.string,
+	/**
+	* class name applied to the overflow options
+	*/
 	menuOptionsClass: PropTypes.string,
+	/**
+	* overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+	*/
 	overflowAriaLabel: PropTypes.string,
+	/**
+	* overflowItems: items to bre shown in the ActionBar overflow menu
+	*/
 	overflowItems: PropTypes.arrayOf(PropTypes.element),
+	/**
+	* overflowMenuRef for the overflow menu width that is needed to calculate the width of the action bar with overflow
+	*/
+	/**@ts-ignore */
 	overflowMenuRef: PropTypes.oneOfType([
 		PropTypes.shape({ current: PropTypes.elementType }),
 		PropTypes.object,
 		PropTypes.func
 	]),
+	/**
+	* Optional tab index
+	*/
 	tabIndex: PropTypes.number
 };
-
 //#endregion
-export { ActionBarOverflowItems };
+export { ActionBarOverflowItems };

package/es/components/ActionSet/ActionSet.js

@@ -13,7 +13,6 @@ import { allPropTypes, prepareProps } from "../../global/js/utils/props-helper.j
 import React from "react";
 import PropTypes from "prop-types";
 import { Button, ButtonSet, InlineLoading } from "@carbon/react";
-
 //#region src/components/ActionSet/ActionSet.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -37,6 +36,7 @@ const ActionSetButton = React.forwardRef(({ className, disabled, kind, label, lo
 }, label, loading && /* @__PURE__ */ React.createElement(InlineLoading, null)));
 ActionSetButton.displayName = "ActionSetButton";
 ActionSetButton.propTypes = {
+	/**@ts-ignore*/
 	...Button.PropTypes,
 	kind: PropTypes.oneOf([
 		"ghost",
@@ -135,7 +135,20 @@ ActionSet.displayName = componentName;
 * an explanatory message.
 */
 ActionSet.propTypes = {
+	/**
+	* The action buttons to show. Each action is specified as an
+	* object with optional fields 'label' to supply the button label, 'kind'
+	* to select the button kind (must be 'primary', 'secondary' or 'ghost'),
+	* 'loading' to display a loading indicator, and '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. Any other fields in the
+	* object will be passed through to the button element as HTML attributes.
+	*
+	* See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+	*/
 	actions: allPropTypes([PropTypes.arrayOf(PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
 		kind: PropTypes.oneOf([
 			"ghost",
@@ -147,11 +160,31 @@ ActionSet.propTypes = {
 		]),
 		label: PropTypes.string,
 		loading: PropTypes.bool,
+		/**@ts-ignore*/
 		onClick: Button.propTypes.onClick
 	}))]),
+	/**
+	* The size of buttons to use for the actions. The allowed values are
+	* those for the size prop of carbon Button. If this prop is specified, all
+	* the buttons will be set to this size, overriding any 'size' values (if any)
+	* supplied in the actions array (if any).
+	*/
+	/**@ts-ignore*/
 	buttonSize: Button.propTypes.size,
+	/**
+	* An optional class or classes to be added to the outermost element.
+	*/
 	className: PropTypes.string,
+	/**
+	* When true, prevents automatic stacking of buttons even when size would
+	* normally trigger stacking (e.g., 'sm' size or 'md' with 3+ actions).
+	* Buttons will remain in a horizontal layout.
+	*/
 	disableStacking: PropTypes.bool,
+	/**
+	* The size of the action set. Different button arrangements are used at
+	* different sizes, to make best use of the available space.
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",
@@ -160,6 +193,5 @@ ActionSet.propTypes = {
 		"2xl"
 	])
 };
-
 //#endregion
-export { ActionSet };
+export { ActionSet };

package/es/components/AddSelect/AddSelect.js

@@ -9,7 +9,6 @@ import { getGlobalFilterValues, normalize } from "./add-select-utils.js";
 import { AddSelectBody } from "./AddSelectBody.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/AddSelect/AddSelect.tsx
 const componentName = "AddSelect";
 const AddSelect = forwardRef(({ items = { entries: [] }, globalFilters, ...props }, ref) => {
@@ -40,6 +39,7 @@ AddSelect.propTypes = {
 	columnInputPlaceholder: PropTypes.string,
 	description: PropTypes.string.isRequired,
 	filterByLabel: PropTypes.string,
+	/**@ts-ignore */
 	globalFilters: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		label: PropTypes.string
@@ -54,6 +54,7 @@ AddSelect.propTypes = {
 	globalSortBy: PropTypes.array,
 	illustrationTheme: PropTypes.oneOf(["light", "dark"]),
 	influencerTitle: PropTypes.string,
+	/**@ts-ignore */
 	items: PropTypes.shape({
 		modifiers: PropTypes.shape({
 			id: PropTypes.string,
@@ -97,12 +98,15 @@ AddSelect.propTypes = {
 	onSubmit: PropTypes.func.isRequired,
 	onSubmitButtonText: PropTypes.string.isRequired,
 	open: PropTypes.bool.isRequired,
+	/**
+	* portal target for the all tags modal
+	*/
+	/**@ts-ignore */
 	portalTarget: PropTypes.node,
 	searchResultsTitle: PropTypes.string,
 	sortByLabel: PropTypes.string,
 	title: PropTypes.string.isRequired
 };
 AddSelect.displayName = componentName;
-
 //#endregion
-export { AddSelect };
+export { AddSelect };