scratch-blocks 2.1.3 → 2.1.4

package/dist/types/src/blocks/procedures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"procedures.d.ts","sourceRoot":"","sources":["../../../../src/blocks/procedures.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAIvC;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CACzB,MAAM,EACN;IACE,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAA;CACxB,GAAG,IAAI,CACT,CAAA;AAED;;GAEG;AACH,aAAK,YAAY;IACf,MAAM,MAAM;IACZ,MAAM,MAAM;IACZ,OAAO,MAAM;CACd;AAikCD,UAAU,cAAe,SAAQ,OAAO,CAAC,QAAQ;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;IACd,WAAW,EAAE,MAAM,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,oBAAoB,EAAE,MAAM,aAAa,CAAA;IACzC,sBAAsB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAA;IAC9D,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAA;IACxD,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,iBAAiB,EAAE,CACjB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,aAAa,EAC5B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,OAAO,CAAC,KAAK,KACjB,IAAI,CAAA;IACT,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAC3C;AAED,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAA;IAC3B,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,IAAI,CAAA;IACnD,qBAAqB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAA;IAC5F,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,OAAO,EAAE,MAAM,OAAO,CAAA;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAChC,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,kBAAkB,EAAE,MAAM,IAAI,CAAA;IAC9B,uBAAuB,EAAE,MAAM,IAAI,CAAA;IACnC,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB"}
+{"version":3,"file":"procedures.d.ts","sourceRoot":"","sources":["../../../../src/blocks/procedures.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAIvC;;GAEG;AACH,KAAK,aAAa,GAAG,MAAM,CACzB,MAAM,EACN;IACE,MAAM,EAAE,OAAO,CAAA;IACf,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAA;CACxB,GAAG,IAAI,CACT,CAAA;AAED;;GAEG;AACH,aAAK,YAAY;IACf,MAAM,MAAM;IACZ,MAAM,MAAM;IACZ,OAAO,MAAM;CACd;AAgoCD,UAAU,cAAe,SAAQ,OAAO,CAAC,QAAQ;IAC/C,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;IACd,WAAW,EAAE,MAAM,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,oBAAoB,EAAE,MAAM,aAAa,CAAA;IACzC,sBAAsB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAA;IAC9D,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAA;IACxD,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,iBAAiB,EAAE,CACjB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,aAAa,EAC5B,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,OAAO,CAAC,KAAK,KACjB,IAAI,CAAA;IACT,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAC3C;AAED,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,EAAE,MAAM,EAAE,CAAA;IAC3B,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,IAAI,CAAA;IACnD,qBAAqB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAA;IAC5F,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,OAAO,EAAE,MAAM,OAAO,CAAA;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;IAChC,gBAAgB,EAAE,MAAM,IAAI,CAAA;IAC5B,kBAAkB,EAAE,MAAM,IAAI,CAAA;IAC9B,uBAAuB,EAAE,MAAM,IAAI,CAAA;IACnC,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scratch-blocks",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Scratch Blocks is a library for building creative computing interfaces.",
   "author": "Massachusetts Institute of Technology",
   "license": "Apache-2.0",

package/src/blocks/procedures.ts

@@ -79,13 +79,20 @@ class DelegateToParentDraggable implements Blockly.IDraggable {
 }
 
 /**
- * Class representing a draggable block that copies itself on drag.
+ * Class representing a draggable block that copies itself on drag, but only
+ * when the block is directly connected to a procedures_prototype block.
+ * When dragged from any other position, it behaves like a normal block.
  */
 class DuplicateOnDragDraggable implements Blockly.IDraggable {
   /**
-   * The newly-created duplicate block.
+   * The block being dragged: a newly-created duplicate when dragging from a
+   * prototype, or the original block when dragging from elsewhere.
    */
   private copy?: Blockly.BlockSvg
+  /**
+   * Whether this drag is duplicating the block (true) or moving it (false).
+   */
+  private isDuplicating_ = false
   constructor(private block: Blockly.BlockSvg) {}
 
   /**
@@ -97,23 +104,41 @@ class DuplicateOnDragDraggable implements Blockly.IDraggable {
   }
 
   /**
-   * Handles the start of a drag.
+   * Handles the start of a drag. If the block is directly connected to a
+   * procedures_prototype, creates a duplicate and drags that. Otherwise,
+   * switches to a normal drag strategy and drags the original block.
    * @param e The event that triggered the drag.
    */
   startDrag(e: PointerEvent) {
-    const data = this.block.toCopyData()
-    if (!data) {
-      console.warn(
-        'DuplicateOnDragDraggable.startDrag: failed to serialize block for copy',
-        this.block.type,
-        this.block.id,
-      )
-      return
+    const parent = this.block.getParent()
+    this.isDuplicating_ = parent?.type === 'procedures_prototype'
+
+    if (this.isDuplicating_) {
+      const data = this.block.toCopyData()
+      if (!data) {
+        console.warn(
+          'DuplicateOnDragDraggable.startDrag: failed to serialize block for copy',
+          this.block.type,
+          this.block.id,
+        )
+        return
+      }
+      this.copy = Blockly.clipboard.paste(data, this.block.workspace) as Blockly.BlockSvg
+      this.copy.setDeletable(true)
+      this.copy.setDragStrategy(new Blockly.dragging.BlockDragStrategy(this.copy))
+      this.copy.startDrag(e)
+    } else {
+      // Not in a prototype: drag the original block normally and replace this
+      // drag strategy so future drags also behave normally.
+      // Also ensure the block is deletable — reporters created by createArgumentReporter_
+      // are non-deletable by default, but one that has escaped a prototype should be
+      // cleanable by the user.
+      this.block.setDeletable(true)
+      const normalStrategy = new Blockly.dragging.BlockDragStrategy(this.block)
+      this.block.setDragStrategy(normalStrategy)
+      this.copy = this.block
+      normalStrategy.startDrag(e)
     }
-    this.copy = Blockly.clipboard.paste(data, this.block.workspace) as Blockly.BlockSvg
-    this.copy.setDeletable(true)
-    this.copy.setDragStrategy(new Blockly.dragging.BlockDragStrategy(this.copy))
-    this.copy.startDrag(e)
   }
 
   drag(newLoc: Blockly.utils.Coordinate, e?: PointerEvent) {
@@ -135,7 +160,11 @@ class DuplicateOnDragDraggable implements Blockly.IDraggable {
   }
 
   revertDrag() {
-    this.copy?.dispose()
+    if (this.isDuplicating_) {
+      this.copy?.dispose()
+    } else {
+      this.copy?.revertDrag()
+    }
   }
 
   getRelativeToSurfaceXY() {
@@ -210,7 +239,34 @@ function definitionDomToMutation(this: ProcedurePrototypeBlock | ProcedureDeclar
   this.argumentIds_ = JSON.parse(xmlElement.getAttribute('argumentids')!)
   this.displayNames_ = JSON.parse(xmlElement.getAttribute('argumentnames')!)
   this.argumentDefaults_ = JSON.parse(xmlElement.getAttribute('argumentdefaults')!)
-  this.updateDisplay_()
+
+  // During full XML deserialization (Blockly.Xml.domToWorkspace), the mutation element
+  // is part of the parsed XML tree and its parent element also contains <value> children
+  // for the argument reporters. Blockly will connect those child blocks AFTER the
+  // mutation runs. To avoid creating duplicate reporters here that would immediately
+  // be orphaned when the XML children connect, skip reporter creation and let the
+  // XML children provide them.
+  // We detect this case by checking that the parent element has <value> children.
+  // This distinguishes full deserialization from:
+  //   - Programmatic mutation (xmlElement.parentElement is null — freshly created element)
+  //   - Block creation from partial XML with no <value> children (e.g. createProcedureCallbackFactory)
+  //   - JSON serialization / undo-redo (xmlElement.parentElement is null — textToDom result)
+  const xmlParent = xmlElement.parentElement
+  const hasXmlArgReporters =
+    this.type === 'procedures_prototype' &&
+    xmlParent !== null &&
+    Array.from(xmlParent.children).some((el) => el.tagName.toLowerCase() === 'value')
+  if (hasXmlArgReporters) {
+    ;(this as ProcedurePrototypeBlock).skipArgumentReporters_ = true
+  }
+  try {
+    this.updateDisplay_()
+  } finally {
+    if (hasXmlArgReporters) {
+      ;(this as ProcedurePrototypeBlock).skipArgumentReporters_ = false
+    }
+  }
+
   if ('updateArgumentReporterNames_' in this) {
     this.updateArgumentReporterNames_(prevArgIds, prevDisplayNames)
   }
@@ -521,6 +577,12 @@ function populateArgumentOnPrototype_(
   id: string,
   input: Blockly.Input,
 ) {
+  // During XML deserialization, skip connecting argument reporters here.
+  // The block's <value> XML children will connect the reporters after the mutation runs.
+  if (this.skipArgumentReporters_) {
+    return
+  }
+
   let oldBlock: Blockly.BlockSvg | null = null
   if (connectionMap && id in connectionMap) {
     const saveInfo = connectionMap[id]
@@ -981,6 +1043,7 @@ Blockly.Blocks.procedures_prototype = {
     this.argumentIds_ = []
     this.argumentDefaults_ = []
     this.warp_ = false
+    this.skipArgumentReporters_ = false
 
     // Shared.
     this.getProcCode = getProcCode.bind(this)
@@ -1173,6 +1236,7 @@ interface ProcedureCallBlock extends ProcedureBlock {
 interface ProcedurePrototypeBlock extends ProcedureBlock {
   displayNames_: string[]
   argumentDefaults_: string[]
+  skipArgumentReporters_: boolean
   createArgumentReporter_: (argumentType: ArgumentType, displayName: string) => Blockly.BlockSvg
   updateArgumentReporterNames_: (prevArgIds: string[], prevDisplayNames: string[]) => void
 }

package/src/index.ts

@@ -165,6 +165,16 @@ Blockly.FlyoutButton.TEXT_MARGIN_Y = 10
 Blockly.ContextMenuRegistry.registry.unregister('blockDisable')
 Blockly.ContextMenuRegistry.registry.unregister('blockInline')
 Blockly.ContextMenuItems.registerCommentOptions()
+// Blockly hides "Add Comment" for simple reporters because comments can't be
+// read in the default renderer. In Scratch they're shown differently, so
+// remove that restriction by dropping the isFullBlockField check.
+Blockly.ContextMenuRegistry.registry.getItem('blockComment')!.preconditionFn = (scope) => {
+  const block = scope.block
+  if (block && !block.isInFlyout && block.workspace.options.comments && !block.isCollapsed() && block.isEditable()) {
+    return 'enabled'
+  }
+  return 'hidden'
+}
 Blockly.ContextMenuRegistry.registry.unregister('blockDelete')
 contextMenuItems.registerDeleteBlock()
 contextMenuItems.registerDuplicateBlock()

package/src/scratch_connection_checker.ts

@@ -38,6 +38,13 @@ class ScratchConnectionChecker extends Blockly.ConnectionChecker {
       return false
     }
 
+    // Prevent dragging any block into a procedures_prototype input. Argument
+    // reporters inside the prototype are managed programmatically and should
+    // not be displaceable by user drag-and-drop.
+    if (b.getSourceBlock().type === 'procedures_prototype') {
+      return false
+    }
+
     return super.doDragChecks(a, b, distance)
   }
 }