blockly 8.20220331.0-beta.0 → 9.0.0-beta.1

package/core/serialization/workspaces.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Workspace } from '../workspace.js';
+/**
+ * Returns the state of the workspace as a plain JavaScript object.
+ *
+ * @param workspace The workspace to serialize.
+ * @returns The serialized state of the workspace.
+ * @alias Blockly.serialization.workspaces.save
+ */
+export declare function save(workspace: Workspace): {
+    [key: string]: any;
+};
+/**
+ * Loads the variable represented by the given state into the given workspace.
+ *
+ * @param state The state of the workspace to deserialize into the workspace.
+ * @param workspace The workspace to add the new state to.
+ * @param param1 recordUndo: If true, events triggered by this function will be
+ *     undo-able by the user. False by default.
+ * @alias Blockly.serialization.workspaces.load
+ */
+export declare function load(state: {
+    [key: string]: any;
+}, workspace: Workspace, { recordUndo }?: {
+    recordUndo?: boolean;
+}): void;
+//# sourceMappingURL=workspaces.d.ts.map

package/core/shortcut_items.d.ts

@@ -0,0 +1,71 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Object holding the names of the default shortcut items.
+ *
+ * @alias Blockly.ShortcutItems.names
+ */
+export declare enum names {
+    ESCAPE = "escape",
+    DELETE = "delete",
+    COPY = "copy",
+    CUT = "cut",
+    PASTE = "paste",
+    UNDO = "undo",
+    REDO = "redo"
+}
+/**
+ * Keyboard shortcut to hide chaff on escape.
+ *
+ * @alias Blockly.ShortcutItems.registerEscape
+ */
+export declare function registerEscape(): void;
+/**
+ * Keyboard shortcut to delete a block on delete or backspace
+ *
+ * @alias Blockly.ShortcutItems.registerDelete
+ */
+export declare function registerDelete(): void;
+/**
+ * Keyboard shortcut to copy a block on ctrl+c, cmd+c, or alt+c.
+ *
+ * @alias Blockly.ShortcutItems.registerCopy
+ */
+export declare function registerCopy(): void;
+/**
+ * Keyboard shortcut to copy and delete a block on ctrl+x, cmd+x, or alt+x.
+ *
+ * @alias Blockly.ShortcutItems.registerCut
+ */
+export declare function registerCut(): void;
+/**
+ * Keyboard shortcut to paste a block on ctrl+v, cmd+v, or alt+v.
+ *
+ * @alias Blockly.ShortcutItems.registerPaste
+ */
+export declare function registerPaste(): void;
+/**
+ * Keyboard shortcut to undo the previous action on ctrl+z, cmd+z, or alt+z.
+ *
+ * @alias Blockly.ShortcutItems.registerUndo
+ */
+export declare function registerUndo(): void;
+/**
+ * Keyboard shortcut to redo the previous action on ctrl+shift+z, cmd+shift+z,
+ * or alt+shift+z.
+ *
+ * @alias Blockly.ShortcutItems.registerRedo
+ */
+export declare function registerRedo(): void;
+/**
+ * Registers all default keyboard shortcut item. This should be called once per
+ * instance of KeyboardShortcutRegistry.
+ *
+ * @alias Blockly.ShortcutItems.registerDefaultShortcuts
+ * @internal
+ */
+export declare function registerDefaultShortcuts(): void;
+//# sourceMappingURL=shortcut_items.d.ts.map

package/core/shortcut_registry.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { KeyCodes } from './utils/keycodes.js';
+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 {
+    static readonly registry: ShortcutRegistry;
+    /** Registry of all keyboard shortcuts, keyed by name of shortcut. */
+    private shortcuts;
+    /** Map of key codes to an array of shortcut names. */
+    private keyMap;
+    /** Resets the existing ShortcutRegistry singleton. */
+    private constructor();
+    /** Clear and recreate the registry and keyMap. */
+    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.
+     * @throws {Error} if a shortcut with the same name already exists.
+     */
+    register(shortcut: KeyboardShortcut, opt_allowOverrides?: boolean): void;
+    /**
+     * 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.
+     * @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;
+     * @param shortcutName The name of the shortcut to execute when the given
+     *     keycode is pressed.
+     * @param opt_allowCollision True to prevent an error when adding a shortcut
+     *     to a key that is already mapped to a shortcut.
+     * @throws {Error} if the given key code is already mapped to a shortcut.
+     */
+    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;
+     * @param shortcutName The name of the shortcut to execute when the given
+     *     keycode is pressed.
+     * @param opt_quiet True to not console warn when there is no shortcut to
+     *     remove.
+     * @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: {
+        [key: string]: string[];
+    }): void;
+    /**
+     * Gets the current key map.
+     *
+     * @returns The object holding key codes to ShortcutRegistry.KeyboardShortcut.
+     */
+    getKeyMap(): {
+        [key: string]: string[];
+    };
+    /**
+     * Gets 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.
+     * @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.
+     * @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.
+     * @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.
+     * @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.
+     * @returns The serialized key code for the given modifiers and key.
+     */
+    createSerializedKey(keyCode: number, modifiers: KeyCodes[] | null): string;
+}
+export declare namespace ShortcutRegistry {
+    interface KeyboardShortcut {
+        callback?: ((p1: Workspace, p2: Event, p3: KeyboardShortcut) => boolean);
+        name: string;
+        preconditionFn?: ((p1: Workspace) => boolean);
+        metadata?: object;
+        keyCodes?: (number | string)[];
+        allowCollision?: boolean;
+    }
+    /** Supported modifiers. */
+    enum modifierKeys {
+        Shift = 16,
+        Control = 17,
+        Alt = 18,
+        Meta = 91
+    }
+}
+export declare type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
+//# sourceMappingURL=shortcut_registry.d.ts.map

package/core/sprites.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * 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: {
+    width: number;
+    height: number;
+    url: string;
+};
+//# sourceMappingURL=sprites.d.ts.map

package/core/theme/classic.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Classic } from './classic.js';
+import { Zelos } from './zelos.js';
+export { Classic, Zelos };
+//# sourceMappingURL=themes.d.ts.map

package/core/theme/zelos.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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

@@ -0,0 +1,153 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export interface ITheme {
+    blockStyles: {
+        [key: string]: BlockStyle;
+    };
+    categoryStyles: {
+        [key: string]: CategoryStyle;
+    };
+    componentStyles: ComponentStyle;
+    fontStyle: FontStyle;
+    startHats: boolean | null;
+    base?: string | Theme;
+    name: string;
+}
+/**
+ * Class for a theme.
+ *
+ * @alias Blockly.Theme
+ */
+export declare class Theme implements ITheme {
+    name: string;
+    /** @internal */
+    blockStyles: {
+        [key: string]: BlockStyle;
+    };
+    /** @internal */
+    categoryStyles: {
+        [key: string]: CategoryStyle;
+    };
+    /** @internal */
+    componentStyles: ComponentStyle;
+    /** @internal */
+    fontStyle: FontStyle;
+    /**
+     * Whether or not to add a 'hat' on top of all blocks with no previous or
+     * output connections.
+     *
+     * @internal
+     */
+    startHats: boolean | null;
+    /**
+     * @param name Theme name.
+     * @param opt_blockStyles A map from style names (strings) to objects with
+     *     style attributes for blocks.
+     * @param opt_categoryStyles A map from style names (strings) to objects with
+     *     style attributes for categories.
+     * @param opt_componentStyles A map of Blockly component names to style value.
+     */
+    constructor(name: string, opt_blockStyles?: {
+        [key: string]: BlockStyle;
+    }, opt_categoryStyles?: {
+        [key: string]: CategoryStyle;
+    }, opt_componentStyles?: ComponentStyle);
+    /**
+     * Gets the class name that identifies this theme.
+     *
+     * @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.
+     */
+    setCategoryStyle(categoryStyleName: string, categoryStyle: CategoryStyle): void;
+    /**
+     * 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.
+     * @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.
+     * @returns A new Blockly theme.
+     */
+    static defineTheme(name: string, themeObj: ITheme): Theme;
+}
+export declare namespace Theme {
+    interface BlockStyle {
+        colourPrimary: 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;
+    }
+    interface FontStyle {
+        family: string | null;
+        weight: string | null;
+        size: number | null;
+    }
+}
+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

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Theme } from './theme.js';
+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 {
+    private readonly workspace;
+    private theme;
+    /** A list of workspaces that are subscribed to this theme. */
+    private subscribedWorkspaces_;
+    private componentDB;
+    owner_: any;
+    /**
+     * @param workspace The main workspace.
+     * @param theme The workspace theme.
+     * @internal
+     */
+    constructor(workspace: WorkspaceSvg, theme: Theme);
+    /**
+     * Get 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
+     */
+    setTheme(theme: Theme): void;
+    /**
+     * 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
+     */
+    unsubscribeWorkspace(workspace: Workspace): void;
+    /**
+     * 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.
+     * @param propertyName The inline style property name to update.
+     * @internal
+     */
+    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
+     */
+    dispose(): void;
+}
+export declare namespace ThemeManager {
+    /** The type for a Blockly UI Component. */
+    interface Component {
+        element: Element;
+        propertyName: string;
+    }
+}
+export declare type Component = ThemeManager.Component;
+//# sourceMappingURL=theme_manager.d.ts.map