scratch-blocks 2.0.2 → 2.0.3

package/src/events/events_block_comment_base.ts

@@ -1,29 +1,27 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
 
 export class BlockCommentBase extends Blockly.Events.Abstract {
-  isBlank = true;
-  commentId!: string;
-  blockId!: string;
-  workspaceId!: string;
+  isBlank = true
+  commentId!: string
+  blockId!: string
+  workspaceId!: string
 
   constructor(opt_blockComment?: ScratchCommentBubble) {
-    super();
-    this.isBlank = !opt_blockComment;
+    super()
+    this.isBlank = !opt_blockComment
 
-    if (!opt_blockComment) return;
+    if (!opt_blockComment) return
 
-    this.commentId = opt_blockComment.getId();
-    const sourceBlock = opt_blockComment.getSourceBlock();
+    this.commentId = opt_blockComment.getId()
+    const sourceBlock = opt_blockComment.getSourceBlock()
     if (sourceBlock) {
-      this.blockId = sourceBlock.id;
-      this.workspaceId = sourceBlock.workspace.id;
+      this.blockId = sourceBlock.id
+      this.workspaceId = sourceBlock.workspace.id
     }
   }
 
@@ -32,26 +30,18 @@ export class BlockCommentBase extends Blockly.Events.Abstract {
       ...super.toJson(),
       commentId: this.commentId,
       blockId: this.blockId,
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentBaseJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentBase {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentBase()
-    ) as BlockCommentBase;
-    newEvent.commentId = json["commentId"];
-    newEvent.blockId = json["blockId"];
-    return newEvent;
+  static fromJson(json: BlockCommentBaseJson, workspace: Blockly.Workspace, event?: any): BlockCommentBase {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentBase()) as BlockCommentBase
+    newEvent.commentId = json.commentId
+    newEvent.blockId = json.blockId
+    return newEvent
   }
 }
 
 export interface BlockCommentBaseJson extends Blockly.Events.AbstractEventJson {
-  commentId: string;
-  blockId: string;
+  commentId: string
+  blockId: string
 }

package/src/events/events_block_comment_change.ts

@@ -1,33 +1,24 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import {
-  BlockCommentBase,
-  BlockCommentBaseJson,
-} from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase, BlockCommentBaseJson } from './events_block_comment_base'
 
 class BlockCommentChange extends BlockCommentBase {
-  oldContents_!: string;
-  newContents_!: string;
-
-  constructor(
-    opt_blockComment?: ScratchCommentBubble,
-    oldContents?: string,
-    newContents?: string
-  ) {
-    super(opt_blockComment);
-    this.type = "block_comment_change";
-    if (oldContents !== undefined) this.oldContents_ = oldContents;
-    if (newContents !== undefined) this.newContents_ = newContents;
+  oldContents_!: string
+  newContents_!: string
+
+  constructor(opt_blockComment?: ScratchCommentBubble, oldContents?: string, newContents?: string) {
+    super(opt_blockComment)
+    this.type = 'block_comment_change'
+    if (oldContents !== undefined) this.oldContents_ = oldContents
+    if (newContents !== undefined) this.newContents_ = newContents
     // Disable undo because Blockly already tracks changes to comment text for
     // undo purposes; this event exists solely to keep the Scratch VM apprised
     // of the state of things.
-    this.recordUndo = false;
+    this.recordUndo = false
   }
 
   toJson(): BlockCommentChangeJson {
@@ -35,33 +26,21 @@ class BlockCommentChange extends BlockCommentBase {
       ...super.toJson(),
       newContents: this.newContents_,
       oldContents: this.oldContents_,
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentChangeJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentChange {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentChange()
-    ) as BlockCommentChange;
-    newEvent.newContents_ = json["newContents"];
-    newEvent.oldContents_ = json["oldContents"];
+  static fromJson(json: BlockCommentChangeJson, workspace: Blockly.Workspace, event?: any): BlockCommentChange {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentChange()) as BlockCommentChange
+    newEvent.newContents_ = json.newContents
+    newEvent.oldContents_ = json.oldContents
 
-    return newEvent;
+    return newEvent
   }
 }
 
 interface BlockCommentChangeJson extends BlockCommentBaseJson {
-  newContents: string;
-  oldContents: string;
+  newContents: string
+  oldContents: string
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_change",
-  BlockCommentChange
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_change', BlockCommentChange)

package/src/events/events_block_comment_collapse.ts

@@ -1,73 +1,52 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import {
-  BlockCommentBase,
-  BlockCommentBaseJson,
-} from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase, BlockCommentBaseJson } from './events_block_comment_base'
 
 class BlockCommentCollapse extends BlockCommentBase {
-  newCollapsed!: boolean;
+  newCollapsed!: boolean
 
   constructor(opt_blockComment?: ScratchCommentBubble, collapsed?: boolean) {
-    super(opt_blockComment);
-    this.type = "block_comment_collapse";
-    if (collapsed !== undefined) this.newCollapsed = collapsed;
+    super(opt_blockComment)
+    this.type = 'block_comment_collapse'
+    if (collapsed !== undefined) this.newCollapsed = collapsed
   }
 
   toJson(): BlockCommentCollapseJson {
     return {
       ...super.toJson(),
       collapsed: this.newCollapsed,
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentCollapseJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentCollapse {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentCollapse()
-    ) as BlockCommentCollapse;
-    newEvent.newCollapsed = json["collapsed"];
+  static fromJson(json: BlockCommentCollapseJson, workspace: Blockly.Workspace, event?: any): BlockCommentCollapse {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentCollapse()) as BlockCommentCollapse
+    newEvent.newCollapsed = json.collapsed
 
-    return newEvent;
+    return newEvent
   }
 
   run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    const block = workspace.getBlockById(this.blockId);
+    const workspace = this.getEventWorkspace_()
+    const block = workspace.getBlockById(this.blockId)
     if (!block) {
-      console.warn(
-        "BlockCommentCollapse.run: block not found",
-        this.blockId,
-        this.workspaceId
-      );
-      return;
+      console.warn('BlockCommentCollapse.run: block not found', this.blockId, this.workspaceId)
+      return
     }
-    const comment = block.getIcon(Blockly.icons.IconType.COMMENT);
+    const comment = block.getIcon(Blockly.icons.IconType.COMMENT)
     if (!comment) {
-      console.warn("BlockCommentCollapse.run: comment icon not found", block.id);
-      return;
+      console.warn('BlockCommentCollapse.run: comment icon not found', block.id)
+      return
     }
-    comment.setBubbleVisible(forward ? !this.newCollapsed : this.newCollapsed);
+    comment.setBubbleVisible(forward ? !this.newCollapsed : this.newCollapsed)
   }
 }
 
 interface BlockCommentCollapseJson extends BlockCommentBaseJson {
-  collapsed: boolean;
+  collapsed: boolean
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_collapse",
-  BlockCommentCollapse
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_collapse', BlockCommentCollapse)

package/src/events/events_block_comment_create.ts

@@ -1,81 +1,64 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import {
-  BlockCommentBase,
-  BlockCommentBaseJson,
-} from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase, BlockCommentBaseJson } from './events_block_comment_base'
 
 class BlockCommentCreate extends BlockCommentBase {
   json!: {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-  };
+    x: number
+    y: number
+    width: number
+    height: number
+  }
 
   constructor(opt_blockComment?: ScratchCommentBubble) {
-    super(opt_blockComment);
-    this.type = "block_comment_create";
+    super(opt_blockComment)
+    this.type = 'block_comment_create'
     // opt_blockComment is absent when this class is instantiated by fromJson.
     // In that case fromJson sets this.json directly, so return early here.
-    if (!opt_blockComment) return;
-    const size = opt_blockComment.getSize();
-    const location = opt_blockComment.getRelativeToSurfaceXY();
+    if (!opt_blockComment) return
+    const size = opt_blockComment.getSize()
+    const location = opt_blockComment.getRelativeToSurfaceXY()
     this.json = {
       x: location.x,
       y: location.y,
       width: size.width,
       height: size.height,
-    };
+    }
     // Disable undo because Blockly already tracks comment creation for
     // undo purposes; this event exists solely to keep the Scratch VM apprised
     // of the state of things.
-    this.recordUndo = false;
+    this.recordUndo = false
   }
 
   toJson(): BlockCommentCreateJson {
     return {
       ...super.toJson(),
       ...this.json,
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentCreateJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentCreate {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentCreate()
-    ) as BlockCommentCreate;
+  static fromJson(json: BlockCommentCreateJson, workspace: Blockly.Workspace, event?: any): BlockCommentCreate {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentCreate()) as BlockCommentCreate
     newEvent.json = {
-      x: json["x"],
-      y: json["y"],
-      width: json["width"],
-      height: json["height"],
-    };
+      x: json.x,
+      y: json.y,
+      width: json.width,
+      height: json.height,
+    }
 
-    return newEvent;
+    return newEvent
   }
 }
 
 interface BlockCommentCreateJson extends BlockCommentBaseJson {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
+  x: number
+  y: number
+  width: number
+  height: number
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_create",
-  BlockCommentCreate
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_create', BlockCommentCreate)

package/src/events/events_block_comment_delete.ts

@@ -1,33 +1,24 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import { BlockCommentBase } from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase } from './events_block_comment_base'
 
 class BlockCommentDelete extends BlockCommentBase {
-  constructor(
-    opt_blockComment?: ScratchCommentBubble,
-    sourceBlock?: Blockly.Block
-  ) {
-    super(opt_blockComment);
-    this.type = "block_comment_delete";
+  constructor(opt_blockComment?: ScratchCommentBubble, sourceBlock?: Blockly.Block) {
+    super(opt_blockComment)
+    this.type = 'block_comment_delete'
     if (sourceBlock) {
-      this.blockId = sourceBlock.id;
-      this.workspaceId = sourceBlock.workspace.id;
+      this.blockId = sourceBlock.id
+      this.workspaceId = sourceBlock.workspace.id
     }
     // Disable undo because Blockly already tracks comment deletion for
     // undo purposes; this event exists solely to keep the Scratch VM apprised
     // of the state of things.
-    this.recordUndo = false;
+    this.recordUndo = false
   }
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_delete",
-  BlockCommentDelete
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_delete', BlockCommentDelete)

package/src/events/events_block_comment_move.ts

@@ -1,29 +1,24 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import {
-  BlockCommentBase,
-  BlockCommentBaseJson,
-} from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase, BlockCommentBaseJson } from './events_block_comment_base'
 
 class BlockCommentMove extends BlockCommentBase {
-  oldCoordinate_!: Blockly.utils.Coordinate;
-  newCoordinate_!: Blockly.utils.Coordinate;
+  oldCoordinate_!: Blockly.utils.Coordinate
+  newCoordinate_!: Blockly.utils.Coordinate
 
   constructor(
     opt_blockComment?: ScratchCommentBubble,
     oldCoordinate?: Blockly.utils.Coordinate,
-    newCoordinate?: Blockly.utils.Coordinate
+    newCoordinate?: Blockly.utils.Coordinate,
   ) {
-    super(opt_blockComment);
-    this.type = "block_comment_move";
-    if (oldCoordinate !== undefined) this.oldCoordinate_ = oldCoordinate;
-    if (newCoordinate !== undefined) this.newCoordinate_ = newCoordinate;
+    super(opt_blockComment)
+    this.type = 'block_comment_move'
+    if (oldCoordinate !== undefined) this.oldCoordinate_ = oldCoordinate
+    if (newCoordinate !== undefined) this.newCoordinate_ = newCoordinate
   }
 
   toJson(): BlockCommentMoveJson {
@@ -31,54 +26,34 @@ class BlockCommentMove extends BlockCommentBase {
       ...super.toJson(),
       newCoordinate: this.newCoordinate_,
       oldCoordinate: this.oldCoordinate_,
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentMoveJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentMove {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentMove()
-    ) as BlockCommentMove;
-    newEvent.newCoordinate_ = new Blockly.utils.Coordinate(
-      json["newCoordinate"]["x"],
-      json["newCoordinate"]["y"]
-    );
-    newEvent.oldCoordinate_ = new Blockly.utils.Coordinate(
-      json["oldCoordinate"]["x"],
-      json["oldCoordinate"]["y"]
-    );
+  static fromJson(json: BlockCommentMoveJson, workspace: Blockly.Workspace, event?: any): BlockCommentMove {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentMove()) as BlockCommentMove
+    newEvent.newCoordinate_ = new Blockly.utils.Coordinate(json.newCoordinate.x, json.newCoordinate.y)
+    newEvent.oldCoordinate_ = new Blockly.utils.Coordinate(json.oldCoordinate.x, json.oldCoordinate.y)
 
-    return newEvent;
+    return newEvent
   }
 
   run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    const block = workspace?.getBlockById(this.blockId);
-    const comment = block?.getIcon(Blockly.icons.IconType.COMMENT);
-    comment?.setBubbleLocation(
-      forward ? this.newCoordinate_ : this.oldCoordinate_
-    );
+    const workspace = this.getEventWorkspace_()
+    const block = workspace?.getBlockById(this.blockId)
+    const comment = block?.getIcon(Blockly.icons.IconType.COMMENT)
+    comment?.setBubbleLocation(forward ? this.newCoordinate_ : this.oldCoordinate_)
   }
 }
 
 interface BlockCommentMoveJson extends BlockCommentBaseJson {
   newCoordinate: {
-    x: number;
-    y: number;
-  };
+    x: number
+    y: number
+  }
   oldCoordinate: {
-    x: number;
-    y: number;
-  };
+    x: number
+    y: number
+  }
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_move",
-  BlockCommentMove
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_move', BlockCommentMove)

package/src/events/events_block_comment_resize.ts

@@ -1,29 +1,20 @@
 /**
- * @license
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-
-import * as Blockly from "blockly/core";
-import {
-  BlockCommentBase,
-  BlockCommentBaseJson,
-} from "./events_block_comment_base";
-import type { ScratchCommentBubble } from "../scratch_comment_bubble";
+import * as Blockly from 'blockly/core'
+import type { ScratchCommentBubble } from '../scratch_comment_bubble'
+import { BlockCommentBase, BlockCommentBaseJson } from './events_block_comment_base'
 
 class BlockCommentResize extends BlockCommentBase {
-  oldSize!: Blockly.utils.Size;
-  newSize!: Blockly.utils.Size;
-
-  constructor(
-    opt_blockComment?: ScratchCommentBubble,
-    oldSize?: Blockly.utils.Size,
-    newSize?: Blockly.utils.Size
-  ) {
-    super(opt_blockComment);
-    this.type = "block_comment_resize";
-    if (oldSize !== undefined) this.oldSize = oldSize;
-    if (newSize !== undefined) this.newSize = newSize;
+  oldSize!: Blockly.utils.Size
+  newSize!: Blockly.utils.Size
+
+  constructor(opt_blockComment?: ScratchCommentBubble, oldSize?: Blockly.utils.Size, newSize?: Blockly.utils.Size) {
+    super(opt_blockComment)
+    this.type = 'block_comment_resize'
+    if (oldSize !== undefined) this.oldSize = oldSize
+    if (newSize !== undefined) this.newSize = newSize
   }
 
   toJson(): BlockCommentResizeJson {
@@ -37,52 +28,34 @@ class BlockCommentResize extends BlockCommentBase {
         width: this.oldSize.width,
         height: this.oldSize.height,
       },
-    };
+    }
   }
 
-  static fromJson(
-    json: BlockCommentResizeJson,
-    workspace: Blockly.Workspace,
-    event?: any
-  ): BlockCommentResize {
-    const newEvent = super.fromJson(
-      json,
-      workspace,
-      event ?? new BlockCommentResize()
-    ) as BlockCommentResize;
-    newEvent.newSize = new Blockly.utils.Size(
-      json["newSize"]["width"],
-      json["newSize"]["height"]
-    );
-    newEvent.oldSize = new Blockly.utils.Size(
-      json["oldSize"]["width"],
-      json["oldSize"]["height"]
-    );
+  static fromJson(json: BlockCommentResizeJson, workspace: Blockly.Workspace, event?: any): BlockCommentResize {
+    const newEvent = super.fromJson(json, workspace, event ?? new BlockCommentResize()) as BlockCommentResize
+    newEvent.newSize = new Blockly.utils.Size(json.newSize.width, json.newSize.height)
+    newEvent.oldSize = new Blockly.utils.Size(json.oldSize.width, json.oldSize.height)
 
-    return newEvent;
+    return newEvent
   }
 
   run(forward: boolean) {
-    const workspace = this.getEventWorkspace_();
-    const block = workspace?.getBlockById(this.blockId);
-    const comment = block?.getIcon(Blockly.icons.IconType.COMMENT);
-    comment?.setBubbleSize(forward ? this.newSize : this.oldSize);
+    const workspace = this.getEventWorkspace_()
+    const block = workspace?.getBlockById(this.blockId)
+    const comment = block?.getIcon(Blockly.icons.IconType.COMMENT)
+    comment?.setBubbleSize(forward ? this.newSize : this.oldSize)
   }
 }
 
 interface BlockCommentResizeJson extends BlockCommentBaseJson {
   newSize: {
-    width: number;
-    height: number;
-  };
+    width: number
+    height: number
+  }
   oldSize: {
-    width: number;
-    height: number;
-  };
+    width: number
+    height: number
+  }
 }
 
-Blockly.registry.register(
-  Blockly.registry.Type.EVENT,
-  "block_comment_resize",
-  BlockCommentResize
-);
+Blockly.registry.register(Blockly.registry.Type.EVENT, 'block_comment_resize', BlockCommentResize)