@cp949/phyx-blockly 12.5.1-p1

package/core/comments/workspace_comment.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Coordinate } from '../utils/coordinate.js';
+import { Size } from '../utils/size.js';
+import { Workspace } from '../workspace.js';
+export declare class WorkspaceComment {
+    readonly workspace: Workspace;
+    /** The unique identifier for this comment. */
+    readonly id: string;
+    /** The text of the comment. */
+    private text;
+    /** The size of the comment in workspace units. */
+    private size;
+    /** Whether the comment is collapsed or not. */
+    private collapsed;
+    /** Whether the comment is editable or not. */
+    private editable;
+    /** Whether the comment is movable or not. */
+    private movable;
+    /** Whether the comment is deletable or not. */
+    private deletable;
+    /** The location of the comment in workspace coordinates. */
+    protected location: Coordinate;
+    /** Whether this comment has been disposed or not. */
+    protected disposed: boolean;
+    /** Whether this comment is being disposed or not. */
+    protected disposing: boolean;
+    /**
+     * Constructs the comment.
+     *
+     * @param workspace The workspace to construct the comment in.
+     * @param id An optional ID to give to the comment. If not provided, one will
+     *     be generated.
+     */
+    constructor(workspace: Workspace, id?: string);
+    private fireCreateEvent;
+    private fireDeleteEvent;
+    /** Fires a comment change event. */
+    private fireChangeEvent;
+    /** Fires a comment collapse event. */
+    private fireCollapseEvent;
+    /** Sets the text of the comment. */
+    setText(text: string): void;
+    /** Returns the text of the comment. */
+    getText(): string;
+    /** Sets the comment's size in workspace units. */
+    setSize(size: Size): void;
+    /** Returns the comment's size in workspace units. */
+    getSize(): Size;
+    /** Sets whether the comment is collapsed or not. */
+    setCollapsed(collapsed: boolean): void;
+    /** Returns whether the comment is collapsed or not. */
+    isCollapsed(): boolean;
+    /** Sets whether the comment is editable or not. */
+    setEditable(editable: boolean): void;
+    /**
+     * Returns whether the comment is editable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isEditable(): boolean;
+    /**
+     * Returns whether the comment is editable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnEditable(): boolean;
+    /** Sets whether the comment is movable or not. */
+    setMovable(movable: boolean): void;
+    /**
+     * Returns whether the comment is movable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isMovable(): boolean;
+    /**
+     * Returns whether the comment is movable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnMovable(): boolean;
+    /** Sets whether the comment is deletable or not. */
+    setDeletable(deletable: boolean): void;
+    /**
+     * Returns whether the comment is deletable or not, respecting whether the
+     * workspace is read-only.
+     */
+    isDeletable(): boolean;
+    /**
+     * Returns whether the comment is deletable or not, only examining its own
+     * state and ignoring the state of the workspace.
+     */
+    isOwnDeletable(): boolean;
+    /** Moves the comment to the given location in workspace coordinates. */
+    moveTo(location: Coordinate, reason?: string[] | undefined): void;
+    /** Returns the position of the comment in workspace coordinates. */
+    getRelativeToSurfaceXY(): Coordinate;
+    /** Disposes of this comment. */
+    dispose(): void;
+    /** Returns whether the comment has been disposed or not. */
+    isDisposed(): boolean;
+    /**
+     * Returns true if this comment view is currently being disposed or has
+     * already been disposed.
+     */
+    isDeadOrDying(): boolean;
+}
+//# sourceMappingURL=workspace_comment.d.ts.map

package/core/comments.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export { CollapseCommentBarButton } from './comments/collapse_comment_bar_button.js';
+export { CommentBarButton } from './comments/comment_bar_button.js';
+export { CommentEditor } from './comments/comment_editor.js';
+export { CommentView } from './comments/comment_view.js';
+export { DeleteCommentBarButton } from './comments/delete_comment_bar_button.js';
+export { RenderedWorkspaceComment } from './comments/rendered_workspace_comment.js';
+export { WorkspaceComment } from './comments/workspace_comment.js';
+//# sourceMappingURL=comments.d.ts.map

package/core/common.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Block } from './block.js';
+import { BlockDefinition } from './blocks.js';
+import type { Connection } from './connection.js';
+import { ISelectable } from './interfaces/i_selectable.js';
+import type { Workspace } from './workspace.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Find the workspace with the specified ID.
+ *
+ * @param id ID of workspace to find.
+ * @returns The sought after workspace or null if not found.
+ */
+export declare function getWorkspaceById(id: string): Workspace | null;
+/**
+ * Find all workspaces.
+ *
+ * @returns Array of workspaces.
+ */
+export declare function getAllWorkspaces(): Workspace[];
+/**
+ * Register a workspace in the workspace db.
+ *
+ * @param workspace
+ */
+export declare function registerWorkspace(workspace: Workspace): void;
+/**
+ * Unregister a workspace from the workspace db.
+ *
+ * @param workspace
+ */
+export declare function unregisterWorkpace(workspace: Workspace): void;
+/**
+ * Returns the last used top level workspace (based on focus).  Try not to use
+ * this function, particularly if there are multiple Blockly instances on a
+ * page.
+ *
+ * @returns The main workspace.
+ */
+export declare function getMainWorkspace(): Workspace;
+/**
+ * Sets last used main workspace.
+ *
+ * @param workspace The most recently used top level workspace.
+ */
+export declare function setMainWorkspace(workspace: Workspace): void;
+/**
+ * Returns the current selection.
+ */
+export declare function getSelected(): ISelectable | null;
+/**
+ * Sets the current selection.
+ *
+ * To clear the current selection, select another ISelectable or focus a
+ * non-selectable (like the workspace root node).
+ *
+ * @param newSelection The new selection to make.
+ * @internal
+ */
+export declare function setSelected(newSelection: ISelectable): void;
+/**
+ * Fires a selection change event based on the new selection.
+ *
+ * This is only expected to be called by ISelectable implementations and should
+ * always be called before updating the current selection state. It does not
+ * change focus or selection state.
+ *
+ * @param newSelection The new selection.
+ * @internal
+ */
+export declare function fireSelectedEvent(newSelection: ISelectable | null): void;
+/**
+ * Get the container element in which to render the WidgetDiv, DropDownDiv and
+ * Tooltip.
+ *
+ * @returns The parent container.
+ */
+export declare function getParentContainer(): Element | null;
+/**
+ * Set the parent container.  This is the container element that the WidgetDiv,
+ * DropDownDiv, and Tooltip are rendered into the first time `Blockly.inject`
+ * is called.
+ * This method is a NOP if called after the first `Blockly.inject`.
+ *
+ * @param newParent The container element.
+ */
+export declare function setParentContainer(newParent: Element): void;
+/**
+ * Size the SVG image to completely fill its container. Call this when the view
+ * actually changes sizes (e.g. on a window resize/device orientation change).
+ * See workspace.resizeContents to resize the workspace when the contents
+ * change (e.g. when a block is added or removed).
+ * Record the height/width of the SVG image.
+ *
+ * @param workspace Any workspace in the SVG.
+ */
+export declare function svgResize(workspace: WorkspaceSvg): void;
+/**
+ * All of the connections on blocks that are currently being dragged.
+ */
+export declare const draggingConnections: Connection[];
+/**
+ * Get a map of all the block's descendants mapping their type to the number of
+ *    children with that type.
+ *
+ * @param block The block to map.
+ * @param opt_stripFollowing Optionally ignore all following
+ *    statements (blocks that are not inside a value or statement input
+ *    of the block).
+ * @returns Map of types to type counts for descendants of the bock.
+ */
+export declare function getBlockTypeCounts(block: Block, opt_stripFollowing?: boolean): {
+    [key: string]: number;
+};
+/**
+ * Define blocks from an array of JSON block definitions, as might be generated
+ * by the Blockly Developer Tools.
+ *
+ * @param jsonArray An array of JSON block definitions.
+ */
+export declare function defineBlocksWithJsonArray(jsonArray: any[]): void;
+/**
+ * Private version of defineBlocksWithJsonArray for stubbing in tests.
+ */
+declare function defineBlocksWithJsonArrayInternal(jsonArray: any[]): void;
+/**
+ * Define blocks from an array of JSON block definitions, as might be generated
+ * by the Blockly Developer Tools.
+ *
+ * @param jsonArray An array of JSON block definitions.
+ * @returns A map of the block
+ *     definitions created.
+ */
+export declare function createBlockDefinitionsFromJsonArray(jsonArray: any[]): {
+    [key: string]: BlockDefinition;
+};
+/**
+ * Add the specified block definitions to the block definitions
+ * dictionary (Blockly.Blocks).
+ *
+ * @param blocks A map of block
+ *     type names to block definitions.
+ */
+export declare function defineBlocks(blocks: {
+    [key: string]: BlockDefinition;
+}): void;
+/**
+ * Handle a key-down on SVG drawing surface. Does nothing if the main workspace
+ * is not visible.
+ *
+ * @internal
+ * @param e Key down event.
+ */
+export declare function globalShortcutHandler(e: KeyboardEvent): void;
+export declare const TEST_ONLY: {
+    defineBlocksWithJsonArrayInternal: typeof defineBlocksWithJsonArrayInternal;
+};
+export {};
+//# sourceMappingURL=common.d.ts.map

package/core/component_manager.d.ts

@@ -0,0 +1,112 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Manager for all items registered with the workspace.
+ *
+ * @class
+ */
+import type { IAutoHideable } from './interfaces/i_autohideable.js';
+import type { IComponent } from './interfaces/i_component.js';
+import type { IDeleteArea } from './interfaces/i_delete_area.js';
+import type { IDragTarget } from './interfaces/i_drag_target.js';
+import type { IPositionable } from './interfaces/i_positionable.js';
+declare class Capability<_T> {
+    static POSITIONABLE: Capability<IPositionable>;
+    static DRAG_TARGET: Capability<IDragTarget>;
+    static DELETE_AREA: Capability<IDeleteArea>;
+    static AUTOHIDEABLE: Capability<IAutoHideable>;
+    private readonly name;
+    /** @param name The name of the component capability. */
+    constructor(name: string);
+    /**
+     * Returns the name of the capability.
+     *
+     * @returns The name.
+     */
+    toString(): string;
+}
+/**
+ * Manager for all items registered with the workspace.
+ */
+export declare class ComponentManager {
+    static Capability: typeof Capability;
+    /**
+     * A map of the components registered with the workspace, mapped to id.
+     */
+    private readonly componentData;
+    /** A map of capabilities to component IDs. */
+    private readonly capabilityToComponentIds;
+    /**
+     * Adds a component.
+     *
+     * @param componentInfo The data for the component to register.
+     * @param opt_allowOverrides True to prevent an error when overriding an
+     *     already registered item.
+     */
+    addComponent(componentInfo: ComponentDatum, opt_allowOverrides?: boolean): void;
+    /**
+     * Removes a component.
+     *
+     * @param id The ID of the component to remove.
+     */
+    removeComponent(id: string): void;
+    /**
+     * Adds a capability to a existing registered component.
+     *
+     * @param id The ID of the component to add the capability to.
+     * @param capability The capability to add.
+     */
+    addCapability<T>(id: string, capability: string | Capability<T>): void;
+    /**
+     * Removes a capability from an existing registered component.
+     *
+     * @param id The ID of the component to remove the capability from.
+     * @param capability The capability to remove.
+     */
+    removeCapability<T>(id: string, capability: string | Capability<T>): void;
+    /**
+     * Returns whether the component with this id has the specified capability.
+     *
+     * @param id The ID of the component to check.
+     * @param capability The capability to check for.
+     * @returns Whether the component has the capability.
+     */
+    hasCapability<T>(id: string, capability: string | Capability<T>): boolean;
+    /**
+     * Gets the component with the given ID.
+     *
+     * @param id The ID of the component to get.
+     * @returns The component with the given name or undefined if not found.
+     */
+    getComponent(id: string): IComponent | undefined;
+    /**
+     * Gets all the components with the specified capability.
+     *
+     * @param capability The capability of the component.
+     * @param sorted Whether to return list ordered by weights.
+     * @returns The components that match the specified capability.
+     */
+    getComponents<T extends IComponent>(capability: string | Capability<T>, sorted: boolean): T[];
+}
+export declare namespace ComponentManager {
+    enum ComponentWeight {
+        TOOLBOX_WEIGHT = 0,
+        FLYOUT_WEIGHT = 1,
+        TRASHCAN_WEIGHT = 2,
+        ZOOM_CONTROLS_WEIGHT = 3
+    }
+    /** An object storing component information. */
+    interface ComponentDatum {
+        component: IComponent;
+        capabilities: Array<string | Capability<IComponent>>;
+        weight: number;
+    }
+}
+export type ComponentWeight = ComponentManager.ComponentWeight;
+export declare const ComponentWeight: typeof ComponentManager.ComponentWeight;
+export type ComponentDatum = ComponentManager.ComponentDatum;
+export {};
+//# sourceMappingURL=component_manager.d.ts.map

package/core/config.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * All the values that we expect developers to be able to change
+ * before injecting Blockly.
+ */
+interface Config {
+    dragRadius: number;
+    flyoutDragRadius: number;
+    snapRadius: number;
+    currentConnectionPreference: number;
+    bumpDelay: number;
+    connectingSnapRadius: number;
+}
+/**
+ * Object holding all the values on Blockly that we expect developers to be
+ * able to change.
+ */
+export declare const config: Config;
+export {};
+//# sourceMappingURL=config.d.ts.map