blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/shortcut_registry.d.ts

@@ -9,6 +9,7 @@ import type { Workspace } from './workspace.js';
  * Class for the registry of keyboard shortcuts. This is intended to be a
  * singleton. You should not create a new instance, and only access this class
  * from ShortcutRegistry.registry.
+ *
  * @alias Blockly.ShortcutRegistry
  */
 export declare class ShortcutRegistry {
@@ -23,6 +24,7 @@ export declare class ShortcutRegistry {
     reset(): void;
     /**
      * Registers a keyboard shortcut.
+     *
      * @param shortcut The shortcut for this key code.
      * @param opt_allowOverrides True to prevent a warning when overriding an
      *     already registered item.
@@ -32,12 +34,14 @@ export declare class ShortcutRegistry {
     /**
      * Unregisters a keyboard shortcut registered with the given key code. This
      * will also remove any key mappings that reference this shortcut.
+     *
      * @param shortcutName The name of the shortcut to unregister.
-     * @return True if an item was unregistered, false otherwise.
+     * @returns True if an item was unregistered, false otherwise.
      */
     unregister(shortcutName: string): boolean;
     /**
      * Adds a mapping between a keycode and a keyboard shortcut.
+     *
      * @param keyCode The key code for the keyboard shortcut. If registering a key
      *     code with a modifier (ex: ctrl+c) use
      *     ShortcutRegistry.registry.createSerializedKey;
@@ -50,6 +54,7 @@ export declare class ShortcutRegistry {
     addKeyMapping(keyCode: string | number | KeyCodes, shortcutName: string, opt_allowCollision?: boolean): void;
     /**
      * Removes a mapping between a keycode and a keyboard shortcut.
+     *
      * @param keyCode The key code for the keyboard shortcut. If registering a key
      *     code with a modifier (ex: ctrl+c) use
      *     ShortcutRegistry.registry.createSerializedKey;
@@ -57,19 +62,21 @@ export declare class ShortcutRegistry {
      *     keycode is pressed.
      * @param opt_quiet True to not console warn when there is no shortcut to
      *     remove.
-     * @return True if a key mapping was removed, false otherwise.
+     * @returns True if a key mapping was removed, false otherwise.
      */
     removeKeyMapping(keyCode: string, shortcutName: string, opt_quiet?: boolean): boolean;
     /**
      * Removes all the key mappings for a shortcut with the given name.
      * Useful when changing the default key mappings and the key codes registered
      * to the shortcut are unknown.
+     *
      * @param shortcutName The name of the shortcut to remove from the key map.
      */
     removeAllKeyMappings(shortcutName: string): void;
     /**
      * Sets the key map. Setting the key map will override any default key
      * mappings.
+     *
      * @param newKeyMap The object with key code to shortcut names.
      */
     setKeyMap(newKeyMap: {
@@ -77,57 +84,65 @@ export declare class ShortcutRegistry {
     }): void;
     /**
      * Gets the current key map.
-     * @return The object holding key codes to ShortcutRegistry.KeyboardShortcut.
+     *
+     * @returns The object holding key codes to ShortcutRegistry.KeyboardShortcut.
      */
     getKeyMap(): {
         [key: string]: string[];
     };
     /**
      * Gets the registry of keyboard shortcuts.
-     * @return The registry of keyboard shortcuts.
+     *
+     * @returns The registry of keyboard shortcuts.
      */
     getRegistry(): {
         [key: string]: KeyboardShortcut;
     };
     /**
      * Handles key down events.
+     *
      * @param workspace The main workspace where the event was captured.
      * @param e The key down event.
-     * @return True if the event was handled, false otherwise.
+     * @returns True if the event was handled, false otherwise.
      */
     onKeyDown(workspace: Workspace, e: KeyboardEvent): boolean;
     /**
      * Gets the shortcuts registered to the given key code.
+     *
      * @param keyCode The serialized key code.
-     * @return The list of shortcuts to call when the given keyCode is used.
+     * @returns The list of shortcuts to call when the given keyCode is used.
      *     Undefined if no shortcuts exist.
      */
     getShortcutNamesByKeyCode(keyCode: string): string[] | undefined;
     /**
      * Gets the serialized key codes that the shortcut with the given name is
      * registered under.
+     *
      * @param shortcutName The name of the shortcut.
-     * @return An array with all the key codes the shortcut is registered under.
+     * @returns An array with all the key codes the shortcut is registered under.
      */
     getKeyCodesByShortcutName(shortcutName: string): string[];
     /**
      * Serializes a key event.
+     *
      * @param e A key down event.
-     * @return The serialized key code for the given event.
+     * @returns The serialized key code for the given event.
      */
     private serializeKeyEvent_;
     /**
      * Checks whether any of the given modifiers are not valid.
+     *
      * @param modifiers List of modifiers to be used with the key.
      * @throws {Error} if the modifier is not in the valid modifiers list.
      */
     private checkModifiers_;
     /**
      * Creates the serialized key code that will be used in the key map.
+     *
      * @param keyCode Number code representing the key.
      * @param modifiers List of modifier key codes to be used with the key. All
      *     valid modifiers can be found in the ShortcutRegistry.modifierKeys.
-     * @return The serialized key code for the given modifiers and key.
+     * @returns The serialized key code for the given modifiers and key.
      */
     createSerializedKey(keyCode: number, modifiers: KeyCodes[] | null): string;
 }
@@ -149,3 +164,4 @@ export declare namespace ShortcutRegistry {
     }
 }
 export declare type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
+//# sourceMappingURL=shortcut_registry.d.ts.map

package/core/sprites.d.ts

@@ -3,13 +3,10 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-/**
- * Holds constants that have to do with the sprites that create the trashcan
- * and zoom controls.
- */
 /**
  * Contains the path to a single png tat holds the images for the trashcan
  * as well as the zoom controls.
+ *
  * @alias Blockly.sprite.SPRITE
  */
 export declare const SPRITE: {
@@ -17,3 +14,4 @@ export declare const SPRITE: {
     height: number;
     url: string;
 };
+//# sourceMappingURL=sprites.d.ts.map

package/core/theme/classic.d.ts

@@ -7,6 +7,8 @@ import { Theme } from '../theme.js';
 /**
  * Classic theme.
  * Contains multi-coloured border to create shadow effect.
+ *
  * @alias Blockly.Themes.Classic
  */
 export declare const Classic: Theme;
+//# sourceMappingURL=classic.d.ts.map

package/core/theme/themes.d.ts

@@ -6,3 +6,4 @@
 import { Classic } from './classic.js';
 import { Zelos } from './zelos.js';
 export { Classic, Zelos };
+//# sourceMappingURL=themes.d.ts.map

package/core/theme/zelos.d.ts

@@ -6,6 +6,8 @@
 import { Theme } from '../theme.js';
 /**
  * Zelos theme.
+ *
  * @alias Blockly.Themes.Zelos
  */
 export declare const Zelos: Theme;
+//# sourceMappingURL=zelos.d.ts.map

package/core/theme.d.ts

@@ -4,20 +4,21 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 export interface ITheme {
-    blockStyles: {
+    blockStyles?: {
         [key: string]: BlockStyle;
     };
-    categoryStyles: {
+    categoryStyles?: {
         [key: string]: CategoryStyle;
     };
-    componentStyles: ComponentStyle;
-    fontStyle: FontStyle;
-    startHats: boolean | null;
+    componentStyles?: ComponentStyle;
+    fontStyle?: FontStyle;
+    startHats?: boolean;
     base?: string | Theme;
     name: string;
 }
 /**
  * Class for a theme.
+ *
  * @alias Blockly.Theme
  */
 export declare class Theme implements ITheme {
@@ -37,9 +38,10 @@ export declare class Theme implements ITheme {
     /**
      * Whether or not to add a 'hat' on top of all blocks with no previous or
      * output connections.
+     *
      * @internal
      */
-    startHats: boolean | null;
+    startHats?: boolean;
     /**
      * @param name Theme name.
      * @param opt_blockStyles A map from style names (strings) to objects with
@@ -55,18 +57,21 @@ export declare class Theme implements ITheme {
     }, opt_componentStyles?: ComponentStyle);
     /**
      * Gets the class name that identifies this theme.
-     * @return The CSS class name.
+     *
+     * @returns The CSS class name.
      * @internal
      */
     getClassName(): string;
     /**
      * Overrides or adds a style to the blockStyles map.
+     *
      * @param blockStyleName The name of the block style.
      * @param blockStyle The block style.
      */
     setBlockStyle(blockStyleName: string, blockStyle: BlockStyle): void;
     /**
      * Overrides or adds a style to the categoryStyles map.
+     *
      * @param categoryStyleName The name of the category style.
      * @param categoryStyle The category style.
      */
@@ -74,69 +79,75 @@ export declare class Theme implements ITheme {
     /**
      * Gets the style for a given Blockly UI component.  If the style value is a
      * string, we attempt to find the value of any named references.
+     *
      * @param componentName The name of the component.
-     * @return The style value.
+     * @returns The style value.
      */
     getComponentStyle(componentName: string): string | null;
     /**
      * Configure a specific Blockly UI component with a style value.
+     *
      * @param componentName The name of the component.
      * @param styleValue The style value.
      */
     setComponentStyle(componentName: string, styleValue: any): void;
     /**
      * Configure a theme's font style.
+     *
      * @param fontStyle The font style.
      */
     setFontStyle(fontStyle: FontStyle): void;
     /**
      * Configure a theme's start hats.
+     *
      * @param startHats True if the theme enables start hats, false otherwise.
      */
     setStartHats(startHats: boolean): void;
     /**
      * Define a new Blockly theme.
+     *
      * @param name The name of the theme.
      * @param themeObj An object containing theme properties.
-     * @return A new Blockly theme.
+     * @returns A new Blockly theme.
      */
     static defineTheme(name: string, themeObj: ITheme): Theme;
 }
 export declare namespace Theme {
     interface BlockStyle {
         colourPrimary: string;
-        colourSecondary: string;
-        colourTertiary: string;
+        colourSecondary?: string;
+        colourTertiary?: string;
         hat?: string;
     }
     interface CategoryStyle {
         colour: string;
     }
     interface ComponentStyle {
-        workspaceBackgroundColour: string | null;
-        toolboxBackgroundColour: string | null;
-        toolboxForegroundColour: string | null;
-        flyoutBackgroundColour: string | null;
-        flyoutForegroundColour: string | null;
-        flyoutOpacity: number | null;
-        scrollbarColour: string | null;
-        scrollbarOpacity: number | null;
-        insertionMarkerColour: string | null;
-        insertionMarkerOpacity: number | null;
-        markerColour: string | null;
-        cursorColour: string | null;
-        selectedGlowColour: string | null;
-        selectedGlowOpacity: number | null;
-        replacementGlowColour: string | null;
-        replacementGlowOpacity: number | null;
+        workspaceBackgroundColour?: string;
+        toolboxBackgroundColour?: string;
+        toolboxForegroundColour?: string;
+        flyoutBackgroundColour?: string;
+        flyoutForegroundColour?: string;
+        flyoutOpacity?: number;
+        scrollbarColour?: string;
+        scrollbarOpacity?: number;
+        insertionMarkerColour?: string;
+        insertionMarkerOpacity?: number;
+        markerColour?: string;
+        cursorColour?: string;
+        selectedGlowColour?: string;
+        selectedGlowOpacity?: number;
+        replacementGlowColour?: string;
+        replacementGlowOpacity?: number;
     }
     interface FontStyle {
-        family: string | null;
-        weight: string | null;
-        size: number | null;
+        family?: string;
+        weight?: string;
+        size?: number;
     }
 }
 export declare type BlockStyle = Theme.BlockStyle;
 export declare type CategoryStyle = Theme.CategoryStyle;
 export declare type ComponentStyle = Theme.ComponentStyle;
 export declare type FontStyle = Theme.FontStyle;
+//# sourceMappingURL=theme.d.ts.map

package/core/theme_manager.d.ts

@@ -8,6 +8,7 @@ import type { Workspace } from './workspace.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for storing and updating a workspace's theme and UI components.
+ *
  * @alias Blockly.ThemeManager
  */
 export declare class ThemeManager {
@@ -25,12 +26,14 @@ export declare class ThemeManager {
     constructor(workspace: WorkspaceSvg, theme: Theme);
     /**
      * Get the workspace theme.
-     * @return The workspace theme.
+     *
+     * @returns The workspace theme.
      * @internal
      */
     getTheme(): Theme;
     /**
      * Set the workspace theme, and refresh the workspace and all components.
+     *
      * @param theme The workspace theme.
      * @internal
      */
@@ -38,12 +41,14 @@ export declare class ThemeManager {
     /**
      * Subscribe a workspace to changes to the selected theme.  If a new theme is
      * set, the workspace is called to refresh its blocks.
+     *
      * @param workspace The workspace to subscribe.
      * @internal
      */
     subscribeWorkspace(workspace: Workspace): void;
     /**
      * Unsubscribe a workspace to changes to the selected theme.
+     *
      * @param workspace The workspace to unsubscribe.
      * @internal
      */
@@ -51,6 +56,7 @@ export declare class ThemeManager {
     /**
      * Subscribe an element to changes to the selected theme.  If a new theme is
      * selected, the element's style is refreshed with the new theme's style.
+     *
      * @param element The element to subscribe.
      * @param componentName The name used to identify the component. This must be
      *     the same name used to configure the style in the Theme object.
@@ -60,12 +66,14 @@ export declare class ThemeManager {
     subscribe(element: Element, componentName: string, propertyName: string): void;
     /**
      * Unsubscribe an element to changes to the selected theme.
+     *
      * @param element The element to unsubscribe.
      * @internal
      */
     unsubscribe(element: Element): void;
     /**
      * Dispose of this theme manager.
+     *
      * @suppress {checkTypes}
      * @internal
      */
@@ -79,3 +87,4 @@ export declare namespace ThemeManager {
     }
 }
 export declare type Component = ThemeManager.Component;
+//# sourceMappingURL=theme_manager.d.ts.map

package/core/toolbox/category.d.ts

@@ -6,10 +6,11 @@
 import type { ICollapsibleToolboxItem } from '../interfaces/i_collapsible_toolbox_item.js';
 import type { ISelectableToolboxItem } from '../interfaces/i_selectable_toolbox_item.js';
 import type { IToolbox } from '../interfaces/i_toolbox.js';
-import * as toolbox from '../utils/toolbox.js';
+import type { CategoryInfo, FlyoutDefinition, FlyoutItemInfoArray } from '../utils/toolbox.js';
 import { ToolboxItem } from './toolbox_item.js';
 /**
  * Class for a category in a toolbox.
+ *
  * @alias Blockly.ToolboxCategory
  */
 export declare class ToolboxCategory extends ToolboxItem implements ISelectableToolboxItem {
@@ -24,7 +25,7 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
      * of the category when it is selected.
      */
     static defaultBackgroundColour: string;
-    toolboxItemDef_: toolbox.CategoryInfo;
+    toolboxItemDef_: CategoryInfo;
     /** The name that will be displayed on the category. */
     protected name_: string;
     /** The colour of the category. */
@@ -45,7 +46,7 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
     /** True if this category is disabled, false otherwise. */
     protected isDisabled_: boolean;
     /** The flyout items for this category. */
-    protected flyoutItems_: string | toolbox.FlyoutItemInfoArray;
+    protected flyoutItems_: string | FlyoutItemInfoArray;
     /**
      * @param categoryDef The information needed to create a category in the
      *     toolbox.
@@ -53,7 +54,7 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
      * @param opt_parent The parent category or null if the category does not have
      *     a parent.
      */
-    constructor(categoryDef: toolbox.CategoryInfo, parentToolbox: IToolbox, opt_parent?: ICollapsibleToolboxItem);
+    constructor(categoryDef: CategoryInfo, parentToolbox: IToolbox, opt_parent?: ICollapsibleToolboxItem);
     /**
      * Initializes the toolbox item.
      * This includes creating the DOM and updating the state of any items based
@@ -64,73 +65,85 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
     init(): void;
     /**
      * Creates an object holding the default classes for a category.
-     * @return The configuration object holding all the CSS classes for a
+     *
+     * @returns The configuration object holding all the CSS classes for a
      *     category.
      */
     protected makeDefaultCssConfig_(): CssConfig;
     /**
      * Parses the contents array depending on if the category is a dynamic
      * category, or if its contents are meant to be shown in the flyout.
+     *
      * @param categoryDef The information needed to create a category.
      */
-    protected parseContents_(categoryDef: toolbox.CategoryInfo): void;
+    protected parseContents_(categoryDef: CategoryInfo): void;
     /**
      * Parses the non-contents parts of the category def.
+     *
      * @param categoryDef The information needed to create a category.
      */
-    protected parseCategoryDef_(categoryDef: toolbox.CategoryInfo): void;
+    protected parseCategoryDef_(categoryDef: CategoryInfo): void;
     /**
      * Creates the DOM for the category.
-     * @return The parent element for the category.
+     *
+     * @returns The parent element for the category.
      */
     protected createDom_(): HTMLDivElement;
     /**
      * Creates the container that holds the row and any subcategories.
-     * @return The div that holds the icon and the label.
+     *
+     * @returns The div that holds the icon and the label.
      */
     protected createContainer_(): HTMLDivElement;
     /**
      * Creates the parent of the contents container. All clicks will happen on
      * this div.
-     * @return The div that holds the contents container.
+     *
+     * @returns The div that holds the contents container.
      */
     protected createRowContainer_(): HTMLDivElement;
     /**
      * Creates the container for the label and icon.
      * This is necessary so we can set all subcategory pointer events to none.
-     * @return The div that holds the icon and the label.
+     *
+     * @returns The div that holds the icon and the label.
      */
     protected createRowContentsContainer_(): HTMLDivElement;
     /**
      * Creates the span that holds the category icon.
-     * @return The span that holds the category icon.
+     *
+     * @returns The span that holds the category icon.
      */
     protected createIconDom_(): Element;
     /**
      * Creates the span that holds the category label.
      * This should have an ID for accessibility purposes.
+     *
      * @param name The name of the category.
-     * @return The span that holds the category label.
+     * @returns The span that holds the category label.
      */
     protected createLabelDom_(name: string): Element;
     /** Updates the colour for this category. */
     refreshTheme(): void;
     /**
      * Add the strip of colour to the toolbox category.
+     *
      * @param colour The category colour.
      */
     protected addColourBorder_(colour: string): void;
     /**
      * Gets either the colour or the style for a category.
+     *
      * @param categoryDef The object holding information on the category.
-     * @return The hex colour for the category.
+     * @returns The hex colour for the category.
      */
-    protected getColour_(categoryDef: toolbox.CategoryInfo): string;
+    protected getColour_(categoryDef: CategoryInfo): string;
     /**
      * Sets the colour for the category using the style name and returns the new
      * colour as a hex string.
+     *
      * @param styleName Name of the style.
-     * @return The hex colour for the category.
+     * @returns The hex colour for the category.
      */
     private getColourfromStyle_;
     /**
@@ -138,29 +151,34 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
      * The parent toolbox element receives clicks. The parent toolbox will add an
      * ID to this element so it can pass the onClick event to the correct
      * toolboxItem.
-     * @return The HTML element that receives clicks.
+     *
+     * @returns The HTML element that receives clicks.
      */
     getClickTarget(): Element;
     /**
      * Parses the colour on the category.
+     *
      * @param colourValue HSV hue value (0 to 360), #RRGGBB string, or a message
      *     reference string pointing to one of those two values.
-     * @return The hex colour for the category.
+     * @returns The hex colour for the category.
      */
     private parseColour_;
     /**
      * Adds appropriate classes to display an open icon.
+     *
      * @param iconDiv The div that holds the icon.
      */
     protected openIcon_(iconDiv: Element | null): void;
     /**
      * Adds appropriate classes to display a closed icon.
+     *
      * @param iconDiv The div that holds the icon.
      */
     protected closeIcon_(iconDiv: Element | null): void;
     /**
      * Sets whether the category is visible or not.
      * For a category to be visible its parent category must also be expanded.
+     *
      * @param isVisible True if category should be visible.
      */
     setVisible_(isVisible: boolean): void;
@@ -175,34 +193,40 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
      * Whether the category is visible.
      * A category is only visible if all of its ancestors are expanded and
      * isHidden_ is false.
-     * @return True if the category is visible, false otherwise.
+     *
+     * @returns True if the category is visible, false otherwise.
      */
     isVisible(): boolean;
     /**
      * Whether all ancestors of a category (parent and parent's parent, etc.) are
      * expanded.
-     * @return True only if every ancestor is expanded
+     *
+     * @returns True only if every ancestor is expanded
      */
     protected allAncestorsExpanded_(): boolean;
     isSelectable(): boolean;
     /**
      * Handles when the toolbox item is clicked.
+     *
      * @param _e Click event to handle.
      */
     onClick(_e: Event): void;
     /**
      * Sets the current category as selected.
+     *
      * @param isSelected True if this category is selected, false otherwise.
      */
     setSelected(isSelected: boolean): void;
     /**
      * Sets whether the category is disabled.
+     *
      * @param isDisabled True to disable the category, false otherwise.
      */
     setDisabled(isDisabled: boolean): void;
     /**
      * Gets the name of the category. Used for emitting events.
-     * @return The name of the toolbox item.
+     *
+     * @returns The name of the toolbox item.
      */
     getName(): string;
     getParent(): ICollapsibleToolboxItem | null;
@@ -210,30 +234,34 @@ export declare class ToolboxCategory extends ToolboxItem implements ISelectableT
     /**
      * Gets the contents of the category. These are items that are meant to be
      * displayed in the flyout.
-     * @return The definition of items to be displayed in the flyout.
+     *
+     * @returns The definition of items to be displayed in the flyout.
      */
-    getContents(): toolbox.FlyoutItemInfoArray | string;
+    getContents(): FlyoutItemInfoArray | string;
     /**
      * Updates the contents to be displayed in the flyout.
      * If the flyout is open when the contents are updated, refreshSelection on
      * the toolbox must also be called.
+     *
      * @param contents The contents to be displayed in the flyout. A string can be
      *     supplied to create a dynamic category.
      */
-    updateFlyoutContents(contents: toolbox.FlyoutDefinition | string): void;
+    updateFlyoutContents(contents: FlyoutDefinition | string): void;
     dispose(): void;
 }
 export declare namespace ToolboxCategory {
     /** All the CSS class names that are used to create a category. */
     interface CssConfig {
-        container: string | undefined;
-        row: string | undefined;
-        rowcontentcontainer: string | undefined;
-        icon: string | undefined;
-        label: string | undefined;
-        selected: string | undefined;
-        openicon: string | undefined;
-        closedicon: string | undefined;
+        container?: string;
+        row?: string;
+        rowcontentcontainer?: string;
+        icon?: string;
+        label?: string;
+        contents?: string;
+        selected?: string;
+        openicon?: string;
+        closedicon?: string;
     }
 }
 export declare type CssConfig = ToolboxCategory.CssConfig;
+//# sourceMappingURL=category.d.ts.map