@cloudscape-design/board-components 3.0.0

package/internal/api-docs/components/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+    "board-item":require('./board-item'),
+"board":require('./board'),
+"items-palette":require('./items-palette')
+  }

package/internal/api-docs/components/items-palette.js

@@ -0,0 +1,58 @@
+module.exports = {
+  "name": "ItemsPalette",
+  "releaseStatus": "stable",
+  "regions": [],
+  "functions": [],
+  "properties": [
+    {
+      "name": "i18nStrings",
+      "type": "ItemsPaletteProps.I18nStrings<D>",
+      "inlineType": {
+        "name": "ItemsPaletteProps.I18nStrings",
+        "type": "object",
+        "properties": [
+          {
+            "name": "liveAnnouncementDndDiscarded",
+            "type": "string",
+            "optional": false
+          },
+          {
+            "name": "liveAnnouncementDndStarted",
+            "type": "string",
+            "optional": false
+          },
+          {
+            "name": "navigationAriaDescription",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "navigationAriaLabel",
+            "type": "string",
+            "optional": false
+          },
+          {
+            "name": "navigationItemAriaLabel",
+            "type": "(item: ItemsPaletteProps.Item<D>) => string",
+            "optional": false
+          }
+        ]
+      },
+      "optional": false,
+      "description": "An object containing all the necessary localized strings required by the component.\nLive announcements:\n* `liveAnnouncementDndStarted` (string) - live announcement string to indicate start of DnD.\n* `liveAnnouncementDndDiscarded` (string) - live announcement string to indicate discard of DnD.\n\nNavigation labels:\n* `navigationAriaLabel` (string) - the ARIA label for the accessible board navigation element.\n* `navigationAriaDescription` (string, optional) - the ARIA description for the accessible board navigation element.\n* `navigationItemAriaLabel(null | BoardProps.Item<D>): string` - the function to create the ARIA label for a navigation board item.\n"
+    },
+    {
+      "name": "items",
+      "type": "ReadonlyArray<ItemsPaletteProps.Item<D>>",
+      "optional": false,
+      "description": "Specifies the items displayed in the palette. The content of each item is controlled by the `renderItem` property.\nThe ItemsPaletteProps.Item includes:\n* `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.\n* `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.\n* `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take (in a 4 column layout). It can't be less than one. Defaults to one.\n* `definition.defaultRowSpan` (number) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.\n* `definition.defaultColumnSpan` (number) - the number or columns the item will take (in a 4 column layout) when inserted to the board. It can't be less than `definition.minColumnSpan`.\n* `data` (D) - optional item data which can include the specific configurations of an item, such as its title.\n"
+    },
+    {
+      "name": "renderItem",
+      "type": "(item: ItemsPaletteProps.Item<D>, context: ItemsPaletteProps.ItemContext) => Element",
+      "optional": false,
+      "description": "Specifies a function to render content for a palette item. The return value must include board item component.\nThe function takes the item and its associated context (ItemsPaletteProps.ItemContext) that include:\n* `showPreview` (boolean) - a flag that indicates if the item's content needs to be rendered in preview mode.\n"
+    }
+  ],
+  "events": []
+};

package/internal/api-docs/test-utils-doc/dom.js

@@ -0,0 +1,4 @@
+module.exports = {
+      classes: [{"name":"BoardItemWrapper","methods":[{"name":"blur","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.blur"}},{"name":"click","description":"Performs a click by triggering a mouse event.\nNote that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"params","typeName":"MouseEventInit","flags":{"isOptional":true}}],"inheritedFrom":{"name":"AbstractWrapper.click"}},{"name":"find","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findContent","returnType":{"name":"ComponentWrapper","type":"reference"},"parameters":[]},{"name":"findDragHandle","returnType":{"name":"ComponentWrapper","type":"reference"},"parameters":[]},{"name":"findFooter","returnType":{"name":"null | ComponentWrapper","type":"union"},"parameters":[]},{"name":"findHeader","returnType":{"name":"null | ComponentWrapper","type":"union"},"parameters":[]},{"name":"findResizeHandle","returnType":{"name":"ComponentWrapper","type":"reference"},"parameters":[]},{"name":"findSettings","returnType":{"name":"null | ComponentWrapper","type":"union"},"parameters":[]},{"name":"fireEvent","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"event","typeName":"Event","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.fireEvent"}},{"name":"focus","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.focus"}},{"name":"getElement","returnType":{"name":"HTMLElement","type":"reference"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"keydown","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keydown"}},{"name":"keypress","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keypress"}},{"name":"keyup","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keyup"}},{"name":"matches","returnType":{"name":"this | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}}]},{"name":"BoardWrapper","methods":[{"name":"blur","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.blur"}},{"name":"click","description":"Performs a click by triggering a mouse event.\nNote that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"params","typeName":"MouseEventInit","flags":{"isOptional":true}}],"inheritedFrom":{"name":"AbstractWrapper.click"}},{"name":"find","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findItemById","returnType":{"name":"null | BoardItemWrapper","type":"union"},"parameters":[{"name":"itemId","typeName":"string","flags":{"isOptional":false}}]},{"name":"fireEvent","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"event","typeName":"Event","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.fireEvent"}},{"name":"focus","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.focus"}},{"name":"getElement","returnType":{"name":"HTMLElement","type":"reference"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"keydown","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keydown"}},{"name":"keypress","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keypress"}},{"name":"keyup","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keyup"}},{"name":"matches","returnType":{"name":"this | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}}]},{"name":"ItemsPaletteWrapper","methods":[{"name":"blur","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.blur"}},{"name":"click","description":"Performs a click by triggering a mouse event.\nNote that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"params","typeName":"MouseEventInit","flags":{"isOptional":true}}],"inheritedFrom":{"name":"AbstractWrapper.click"}},{"name":"find","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findItemById","returnType":{"name":"null | PaletteItemWrapper","type":"union"},"parameters":[{"name":"itemId","typeName":"string","flags":{"isOptional":false}}]},{"name":"findItems","returnType":{"name":"array","type":"reference"},"parameters":[]},{"name":"fireEvent","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"event","typeName":"Event","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.fireEvent"}},{"name":"focus","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.focus"}},{"name":"getElement","returnType":{"name":"HTMLElement","type":"reference"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"keydown","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keydown"}},{"name":"keypress","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keypress"}},{"name":"keyup","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keyup"}},{"name":"matches","returnType":{"name":"this | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}}]},{"name":"PaletteItemWrapper","methods":[{"name":"blur","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.blur"}},{"name":"click","description":"Performs a click by triggering a mouse event.\nNote that programmatic events ignore disabled attribute and will trigger listeners even if the element is disabled.","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"params","typeName":"MouseEventInit","flags":{"isOptional":true}}],"inheritedFrom":{"name":"AbstractWrapper.click"}},{"name":"find","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"array","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper | null","type":"union"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findDragHandle","returnType":{"name":"ComponentWrapper","type":"reference"},"parameters":[]},{"name":"fireEvent","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"event","typeName":"Event","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.fireEvent"}},{"name":"focus","returnType":{"name":"void","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.focus"}},{"name":"getElement","returnType":{"name":"HTMLElement","type":"reference"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"keydown","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keydown"}},{"name":"keypress","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keypress"}},{"name":"keyup","returnType":{"name":"void","type":"intrinsic"},"parameters":[{"name":"keyCode","typeName":"KeyCode","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.keyup"}},{"name":"matches","returnType":{"name":"this | null","type":"union"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}}]}]
+    }
+    

package/internal/api-docs/test-utils-doc/selectors.js

@@ -0,0 +1,4 @@
+module.exports = {
+      classes: [{"name":"BoardItemWrapper","methods":[{"name":"find","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper","type":"typeParameter"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findContent","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"findDragHandle","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"findFooter","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"findHeader","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"findResizeHandle","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"findSettings","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"getElement","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"matches","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}},{"name":"toSelector","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.toSelector"}}]},{"name":"BoardWrapper","methods":[{"name":"find","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper","type":"typeParameter"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findItemById","returnType":{"name":"BoardItemWrapper","type":"reference","typeArguments":[]},"parameters":[{"name":"itemId","typeName":"string","flags":{"isOptional":false}}]},{"name":"getElement","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"matches","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}},{"name":"toSelector","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.toSelector"}}]},{"name":"ItemsPaletteWrapper","methods":[{"name":"find","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper","type":"typeParameter"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findItemById","returnType":{"name":"PaletteItemWrapper","type":"reference","typeArguments":[]},"parameters":[{"name":"itemId","typeName":"string","flags":{"isOptional":false}}]},{"name":"findItems","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"PaletteItemWrapper","type":"reference"}]},"parameters":[]},{"name":"getElement","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"matches","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}},{"name":"toSelector","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.toSelector"}}]},{"name":"PaletteItemWrapper","methods":[{"name":"find","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.find"}},{"name":"findAll","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAll"}},{"name":"findAllByClassName","returnType":{"name":"MultiElementWrapper","type":"reference","typeArguments":[{"name":"ElementWrapper","type":"reference"}]},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findAllByClassName"}},{"name":"findByClassName","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"className","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findByClassName"}},{"name":"findComponent","returnType":{"name":"Wrapper","type":"typeParameter"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}},{"name":"ComponentClass","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.findComponent"}},{"name":"findDragHandle","returnType":{"name":"ElementWrapper","type":"reference","typeArguments":[]},"parameters":[]},{"name":"getElement","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.getElement"}},{"name":"matches","returnType":{"name":"ElementWrapper","type":"reference"},"parameters":[{"name":"selector","typeName":"string","flags":{"isOptional":false}}],"inheritedFrom":{"name":"AbstractWrapper.matches"}},{"name":"toSelector","returnType":{"name":"string","type":"intrinsic"},"parameters":[],"inheritedFrom":{"name":"AbstractWrapper.toSelector"}}]}]
+    }
+    

package/internal/base-component/use-base-component.d.ts

@@ -0,0 +1,12 @@
+import { MutableRefObject } from "react";
+export interface InternalBaseComponentProps {
+    __internalRootRef?: MutableRefObject<any> | null;
+}
+/**
+ * This hook is used for components which are exported to customers. The returned __internalRootRef needs to be
+ * attached to the (internal) component's root DOM node. The hook takes care of attaching the metadata to this
+ * root DOM node and emits the telemetry for this component.
+ */
+export default function useBaseComponent<T = any>(componentName: string): {
+    __internalRootRef: import("react").RefObject<T>;
+};

package/internal/base-component/use-base-component.js

@@ -0,0 +1,16 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { initAwsUiVersions, useComponentMetadata } from "@cloudscape-design/component-toolkit/internal";
+import { PACKAGE_SOURCE, PACKAGE_VERSION } from "../environment";
+import { useTelemetry } from "./use-telemetry";
+initAwsUiVersions(PACKAGE_SOURCE, PACKAGE_VERSION);
+/**
+ * This hook is used for components which are exported to customers. The returned __internalRootRef needs to be
+ * attached to the (internal) component's root DOM node. The hook takes care of attaching the metadata to this
+ * root DOM node and emits the telemetry for this component.
+ */
+export default function useBaseComponent(componentName) {
+    useTelemetry(componentName);
+    const elementRef = useComponentMetadata(componentName, PACKAGE_VERSION);
+    return { __internalRootRef: elementRef };
+}

package/internal/base-component/use-telemetry.d.ts

@@ -0,0 +1 @@
+export declare function useTelemetry(componentName: string): void;

package/internal/base-component/use-telemetry.js

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { useComponentMetrics } from "@cloudscape-design/component-toolkit/internal";
+import { PACKAGE_SOURCE, PACKAGE_VERSION, THEME } from "../environment";
+import { useVisualRefresh } from "./use-visual-refresh";
+export function useTelemetry(componentName) {
+    const theme = useVisualRefresh() ? "vr" : THEME;
+    useComponentMetrics(componentName, { packageSource: PACKAGE_SOURCE, packageVersion: PACKAGE_VERSION, theme });
+}

package/internal/base-component/use-visual-refresh.d.ts

@@ -0,0 +1 @@
+export declare const useVisualRefresh: () => boolean;

package/internal/base-component/use-visual-refresh.js

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ALWAYS_VISUAL_REFRESH } from "../environment";
+import { IS_DEV } from "../is-development";
+import { warnOnce } from "../logging";
+export const useVisualRefresh = ALWAYS_VISUAL_REFRESH ? () => true : useVisualRefreshDynamic;
+// We expect VR is to be set only once and before the application is rendered.
+let visualRefreshState = undefined;
+function detectVisualRefresh() {
+    return typeof document !== "undefined" && !!document.querySelector(".awsui-visual-refresh");
+}
+function useVisualRefreshDynamic() {
+    if (visualRefreshState === undefined) {
+        visualRefreshState = detectVisualRefresh();
+    }
+    if (IS_DEV) {
+        const newVisualRefreshState = detectVisualRefresh();
+        if (newVisualRefreshState !== visualRefreshState) {
+            warnOnce("Visual Refresh", "Dynamic visual refresh change detected. This is not supported. " +
+                "Make sure `awsui-visual-refresh` is attached to the `<body>` element before initial React render");
+        }
+    }
+    return visualRefreshState;
+}

package/internal/breakpoints.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function useContainerColumns(): readonly [0 | 1 | 2 | 4 | 6, import("react").Ref<any>];

package/internal/breakpoints.js

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { useContainerQuery } from "@cloudscape-design/component-toolkit";
+export function useContainerColumns() {
+    const [columns, containerQueryRef] = useContainerQuery((entry) => {
+        if (entry.contentBoxWidth < 688) {
+            return 1;
+        }
+        if (entry.contentBoxWidth < 912) {
+            return 2;
+        }
+        if (entry.contentBoxWidth < 2100) {
+            return 4;
+        }
+        return 6;
+    }, []);
+    return [columns !== null && columns !== void 0 ? columns : 0, containerQueryRef];
+}

package/internal/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const MIN_ROW_SPAN = 2;
+export declare const MIN_COL_SPAN = 1;
+export declare const TRANSITION_DURATION_MS = 200;

package/internal/constants.js

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export const MIN_ROW_SPAN = 2;
+export const MIN_COL_SPAN = 1;
+export const TRANSITION_DURATION_MS = 200;

package/internal/debug-tools/converters.d.ts

@@ -0,0 +1,4 @@
+import { GridLayout } from "../interfaces";
+import { GridMatrix } from "./interfaces";
+export declare function toMatrix({ items, columns }: GridLayout): GridMatrix;
+export declare function toString(input: GridLayout | GridMatrix): string;

package/internal/debug-tools/converters.js

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export function toMatrix({ items, columns }) {
+    const matrix = [];
+    for (const item of items) {
+        for (let y = item.y; y < item.y + item.height; y++) {
+            while (matrix.length <= y) {
+                matrix.push([...Array(columns)].map(() => " "));
+            }
+            for (let x = item.x; x < item.x + item.width; x++) {
+                const newValue = matrix[y][x] === " " ? item.id : matrix[y][x] + "/" + item.id;
+                matrix[y][x] = newValue.split("/").sort().join("/");
+            }
+        }
+    }
+    return matrix;
+}
+export function toString(input) {
+    const matrix = Array.isArray(input) ? input : toMatrix(input);
+    return matrix.map((row) => row.join("\t")).join("\n");
+}

package/internal/debug-tools/generators.d.ts

@@ -0,0 +1,25 @@
+import { GridLayout } from "../interfaces";
+import { InsertCommand, MoveCommand, ResizeCommand } from "../layout-engine/interfaces";
+import { Position } from "../utils/position";
+export type GenerateMoveType = "any" | "vertical" | "horizontal";
+export interface GenerateGridOptions {
+    width?: number;
+    totalItems?: number;
+    averageItemWidth?: number;
+    averageItemHeight?: number;
+}
+export interface GenerateGridResizeOptions {
+    maxWidthIncrement?: number;
+    maxWidthDecrement?: number;
+    maxHeightIncrement?: number;
+    maxHeightDecrement?: number;
+}
+export interface GenerateGridInsertOptions {
+    maxWidth?: number;
+    maxHeight?: number;
+}
+export declare function generateGrid(options?: GenerateGridOptions): GridLayout;
+export declare function generateMove(grid: GridLayout, type?: GenerateMoveType): MoveCommand;
+export declare function generateResize(grid: GridLayout, options?: GenerateGridResizeOptions): ResizeCommand;
+export declare function generateInsert(grid: GridLayout, insertId?: string, options?: GenerateGridInsertOptions): InsertCommand;
+export declare function generateRandomPath(from: Position, to: Position): Position[];

package/internal/debug-tools/generators.js

@@ -0,0 +1,258 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Position } from "../utils/position";
+import { toMatrix } from ".";
+const LETTER_INDICES = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+export function generateGrid(options) {
+    var _a, _b, _c, _d;
+    const width = (_a = options === null || options === void 0 ? void 0 : options.width) !== null && _a !== void 0 ? _a : 6;
+    const totalItems = (_b = options === null || options === void 0 ? void 0 : options.totalItems) !== null && _b !== void 0 ? _b : 20;
+    const averageItemWidth = (_c = options === null || options === void 0 ? void 0 : options.averageItemWidth) !== null && _c !== void 0 ? _c : 1.44;
+    const averageItemHeight = (_d = options === null || options === void 0 ? void 0 : options.averageItemHeight) !== null && _d !== void 0 ? _d : 1.44;
+    const allowance = {
+        horizontal: Math.floor(totalItems * (averageItemWidth - 1)),
+        vertical: Math.floor(totalItems * (averageItemHeight - 1)),
+    };
+    const items = [...Array(totalItems)].map((_, index) => ({
+        id: getGridItemId(index),
+        width: 1,
+        height: 1,
+        y: 0,
+        x: 0,
+    }));
+    let selectedAllowance = "horizontal";
+    while (allowance.horizontal > 0 || allowance.vertical > 0) {
+        if (allowance.horizontal === 0) {
+            selectedAllowance = "vertical";
+        }
+        else if (allowance.vertical === 0) {
+            selectedAllowance = "horizontal";
+        }
+        else {
+            selectedAllowance = selectedAllowance === "horizontal" ? "vertical" : "horizontal";
+        }
+        const index = getRandomIndex(items);
+        if (selectedAllowance === "horizontal") {
+            items[index].width = Math.min(width - items[index].x, items[index].width + 1);
+            for (let i = 0; i < items[index].height; i++) {
+                allowance.horizontal--;
+            }
+        }
+        else {
+            items[index].height++;
+            for (let i = 0; i < items[index].width; i++) {
+                allowance.vertical--;
+            }
+        }
+    }
+    const grid = [];
+    for (const item of items) {
+        item.x = getRandomOffset(width, item.width);
+        for (let y = 0; y < grid.length; y++) {
+            for (let x = item.x; x < item.x + item.width; x++) {
+                if (grid[y][x].trim()) {
+                    item.y = y + 1;
+                    break;
+                }
+            }
+        }
+        for (let y = item.y; y < item.y + item.height; y++) {
+            while (grid.length <= y) {
+                grid.push([...Array(width)].map(() => " "));
+            }
+            for (let x = item.x; x < item.x + item.width; x++) {
+                grid[y][x] = item.id;
+            }
+        }
+    }
+    items.sort((a, b) => (b.y - a.y === 0 ? b.x - a.x : b.y - a.y));
+    return { items, columns: width, rows: grid.length };
+}
+export function generateMove(grid, type = "any") {
+    const textGrid = toMatrix(grid);
+    const moveTarget = grid.items[getRandomIndex(grid.items)];
+    const affordance = [];
+    if (moveTarget.y > 0) {
+        affordance.push(["up", moveTarget.y]);
+    }
+    if (moveTarget.y + moveTarget.height <= textGrid.length) {
+        affordance.push(["down", 1 + textGrid.length - (moveTarget.y + moveTarget.height)]);
+    }
+    if (moveTarget.x > 0) {
+        affordance.push(["left", moveTarget.x]);
+    }
+    if (moveTarget.x + moveTarget.width < textGrid[0].length) {
+        affordance.push(["right", textGrid[0].length - (moveTarget.x + moveTarget.width)]);
+    }
+    function swap(type) {
+        const verticalAffordance = affordance.filter(([direction]) => direction === "up" || direction === "down");
+        const horizontalAffordance = affordance.filter(([direction]) => direction === "left" || direction === "right");
+        const chosenAffordance = type === "any" ? affordance : type === "vertical" ? verticalAffordance : horizontalAffordance;
+        if (chosenAffordance.length === 0) {
+            throw new Error("Move is not possible");
+        }
+        const [direction, maxDistance] = chosenAffordance[getRandomIndex(chosenAffordance)];
+        const distance = 1 + Math.floor(Math.random() * maxDistance);
+        switch (direction) {
+            case "up":
+                return new Position({ y: moveTarget.y - distance, x: moveTarget.x });
+            case "down":
+                return new Position({ y: moveTarget.y + distance, x: moveTarget.x });
+            case "left":
+                return new Position({ y: moveTarget.y, x: moveTarget.x - distance });
+            case "right":
+                return new Position({ y: moveTarget.y, x: moveTarget.x + distance });
+        }
+    }
+    function replace() {
+        const verticalAffordance = affordance.filter(([direction]) => direction === "up" || direction === "down");
+        const horizontalAffordance = affordance.filter(([direction]) => direction === "left" || direction === "right");
+        if (horizontalAffordance.length === 0) {
+            throw new Error("Move is not possible");
+        }
+        const [directionVertical, maxDistanceVertical] = verticalAffordance[getRandomIndex(verticalAffordance)];
+        const distanceVertical = 1 + Math.floor(Math.random() * maxDistanceVertical);
+        const [directionHorizontal, maxDistanceHorizontal] = horizontalAffordance[getRandomIndex(horizontalAffordance)];
+        const distanceHorizontal = 1 + Math.floor(Math.random() * maxDistanceHorizontal);
+        switch (`${directionVertical}-${directionHorizontal}`) {
+            case "top-left":
+                return new Position({
+                    y: moveTarget.y - distanceVertical,
+                    x: moveTarget.x - distanceHorizontal,
+                });
+            case "top-right":
+                return new Position({
+                    y: moveTarget.y - distanceVertical,
+                    x: moveTarget.x + distanceHorizontal,
+                });
+            case "bottom-left":
+                return new Position({
+                    y: moveTarget.y + distanceVertical,
+                    x: moveTarget.x - distanceHorizontal,
+                });
+            case "bottom-right":
+                return new Position({
+                    y: moveTarget.y + distanceVertical,
+                    x: moveTarget.x + distanceHorizontal,
+                });
+        }
+        return new Position({ y: moveTarget.y, x: moveTarget.x });
+    }
+    const position = (() => {
+        let repeatCounter = 0;
+        while (repeatCounter < 10) {
+            try {
+                repeatCounter++;
+                switch (type) {
+                    case "vertical":
+                        return swap("vertical");
+                    case "horizontal":
+                        return swap("horizontal");
+                    case "any":
+                        return Math.random() > 0.5 ? swap("any") : replace();
+                }
+            }
+            catch {
+                // noop
+            }
+        }
+        throw new Error("Move is not possible");
+    })();
+    const path = generateRandomPath(new Position({ y: moveTarget.y, x: moveTarget.x }), position);
+    return { itemId: moveTarget.id, path };
+}
+export function generateResize(grid, options) {
+    var _a, _b, _c, _d;
+    const maxWidthIncrement = (_a = options === null || options === void 0 ? void 0 : options.maxHeightIncrement) !== null && _a !== void 0 ? _a : grid.columns - 1;
+    const maxWidthDecrement = (_b = options === null || options === void 0 ? void 0 : options.maxHeightDecrement) !== null && _b !== void 0 ? _b : grid.columns - 1;
+    const maxHeightIncrement = (_c = options === null || options === void 0 ? void 0 : options.maxHeightIncrement) !== null && _c !== void 0 ? _c : Math.floor((grid.items.length - 1) % 2) + 1;
+    const maxHeightDecrement = (_d = options === null || options === void 0 ? void 0 : options.maxHeightDecrement) !== null && _d !== void 0 ? _d : Math.floor((grid.items.length - 1) % 2) + 1;
+    const resizeTarget = grid.items[getRandomIndex(grid.items)];
+    let maxWidthDelta = getRandomDirection();
+    if (maxWidthDelta === 1 && maxWidthIncrement) {
+        maxWidthDelta *= maxWidthIncrement;
+    }
+    else if (maxWidthDelta === -1 && maxWidthDecrement) {
+        maxWidthDelta *= maxWidthDecrement;
+    }
+    else if (maxWidthIncrement) {
+        maxWidthDelta = maxWidthIncrement;
+    }
+    else {
+        maxWidthDelta = -maxWidthDecrement;
+    }
+    if (resizeTarget.width + maxWidthDelta < 1) {
+        maxWidthDelta = -(resizeTarget.width - 1);
+    }
+    else if (resizeTarget.x + resizeTarget.width + maxWidthDelta >= grid.columns) {
+        maxWidthDelta = grid.columns - (resizeTarget.x + resizeTarget.width);
+    }
+    const widthDelta = Math.sign(maxWidthDelta) * getRandomInt(0, Math.abs(maxWidthDelta) + 1);
+    let maxHeightDelta = getRandomDirection();
+    if (maxHeightDelta === 1 && maxHeightIncrement) {
+        maxHeightDelta *= maxHeightIncrement;
+    }
+    else if (maxHeightDelta === -1 && maxHeightDecrement) {
+        maxHeightDelta *= maxHeightDecrement;
+    }
+    else if (maxHeightIncrement) {
+        maxHeightDelta = maxHeightIncrement;
+    }
+    else {
+        maxHeightDelta = -maxHeightDecrement;
+    }
+    if (resizeTarget.height + maxHeightDelta < 1) {
+        maxHeightDelta = -(resizeTarget.height - 1);
+    }
+    const heightDelta = Math.sign(maxHeightDelta) * getRandomInt(0, Math.abs(maxHeightDelta) + 1);
+    const path = generateRandomPath(new Position({ x: resizeTarget.x + resizeTarget.width, y: resizeTarget.y + resizeTarget.height }), new Position({
+        x: resizeTarget.x + resizeTarget.width + widthDelta,
+        y: resizeTarget.y + resizeTarget.height + heightDelta,
+    }));
+    return { itemId: resizeTarget.id, path };
+}
+export function generateInsert(grid, insertId = "X", options) {
+    var _a, _b;
+    const maxWidth = (_a = options === null || options === void 0 ? void 0 : options.maxWidth) !== null && _a !== void 0 ? _a : grid.columns;
+    const maxHeight = (_b = options === null || options === void 0 ? void 0 : options.maxHeight) !== null && _b !== void 0 ? _b : Math.floor(grid.items.length / 2) + 1;
+    const textGrid = toMatrix(grid);
+    const y = getRandomIndex(textGrid);
+    const x = getRandomIndex(textGrid[y]);
+    const width = getRandomInt(1, maxWidth + 1 - x);
+    const height = getRandomInt(1, maxHeight + 1);
+    return { itemId: insertId, width, height, path: [new Position({ x, y })] };
+}
+export function generateRandomPath(from, to) {
+    const path = [];
+    const directions = ["y", "x"];
+    const last = { ...from };
+    while (last.y !== to.y || last.x !== to.x) {
+        let direction = directions[getRandomIndex(directions)];
+        if (last.y === to.y) {
+            direction = "x";
+        }
+        if (last.x === to.x) {
+            direction = "y";
+        }
+        last[direction] += to[direction] > from[direction] ? 1 : -1;
+        path.push({ ...last });
+    }
+    return path;
+}
+function getRandomIndex(array) {
+    return Math.floor(Math.random() * array.length);
+}
+function getRandomOffset(gridWidth, itemWidth) {
+    return Math.floor(Math.random() * (1 + gridWidth - itemWidth));
+}
+function getRandomDirection() {
+    return Math.random() > 0.5 ? 1 : -1;
+}
+function getRandomInt(from, until) {
+    return Math.floor(Math.random() * (until - from)) + from;
+}
+function getGridItemId(index) {
+    const letter = LETTER_INDICES[index % LETTER_INDICES.length];
+    const letterIndex = Math.floor(index / LETTER_INDICES.length);
+    return letter + (letterIndex === 0 ? "" : letterIndex);
+}

package/internal/debug-tools/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Use debug tools for tests, test pages and experiments.
+ *
+ * Do not use them for source code.
+ */
+export { toMatrix, toString } from "./converters";
+export { generateGrid, generateMove, generateResize, generateInsert, generateRandomPath } from "./generators";
+export { fromMatrix, fromTextPath } from "./parsers";

package/internal/debug-tools/index.js

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Use debug tools for tests, test pages and experiments.
+ *
+ * Do not use them for source code.
+ */
+export { toMatrix, toString } from "./converters";
+export { generateGrid, generateMove, generateResize, generateInsert, generateRandomPath } from "./generators";
+export { fromMatrix, fromTextPath } from "./parsers";

package/internal/debug-tools/interfaces.d.ts

@@ -0,0 +1,2 @@
+import { ItemId } from "../interfaces";
+export type GridMatrix = ItemId[][];

package/internal/debug-tools/interfaces.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};

package/internal/debug-tools/parsers.d.ts

@@ -0,0 +1,8 @@
+import { GridLayout } from "../interfaces";
+import { Position } from "../utils/position";
+import { GridMatrix } from "./interfaces";
+export declare function fromMatrix(matrix: GridMatrix): GridLayout;
+export declare function fromTextPath(textPath: string, gridArg: GridLayout | GridMatrix): {
+    itemId: string;
+    path: Position[];
+};