blockly-fluid 1.0.17 → 1.0.19

package/README.md

@@ -1,4 +1,76 @@
-# Blockly Dynamic Blocks Proxy 🎛️✨
+# Blockly, but fluid
+
+If you've ever used Blockly before, you'd know what kind of pain it is to use. Especially crafting your own blocks. You're not alone. Blockly Fluid is the DX-focused adapter of defining blocks with their own generators.
+
+## Installation
+
+### Node.js/Deno/Bun
+
+```sh
+$ npm install blockly-fluid
+```
+
+#### ESM
+
+```js
+import BlocklyFluid from "blockly-fluid";
+```
+
+#### CommonJS
+
+```js
+const BlockyFluid = require("blockly-fluid");
+```
+
+### Browser
+
+```js
+import BlockyFluid from "https://esm.sh/blockly-fluid";
+```
+
+## Initialization
+
+You have to provide your own Blockly instance since there isn't a reliable way to import Blockly in every environment.
+
+```js
+const Blocks = BlocklyFluid(Blockly, options);
+```
+
+### Options
+
+All options are **optional**, Blockly Fluid tries to never force specifying specific information and assumes defaults by default.
+
+```js
+{
+  generator: Blockly.JavaScript /*
+    This is the fallback generator. It will be used for the "generator" property of a block's definition.
+  */,
+  generators: {
+    JavaScript: Blockly.JavaScript // etc.
+  },
+  translate: (text) => mySuperCoolTranslationLogic(text) // translates labels, default values & tooltips
+}
+```
+
+## Make My Block
+
+```js
+Blocks["block-name"] = {
+  hat: false /*
+    default: false,
+    purpose:
+      - creates a round shape on top of the block
+      - great for event blocks
+  */,
+  layout: ["wait", "SECONDS", "seconds"] /*
+    default: [],
+    purpose:
+      - specifies the parts of a block in chronological order
+      - if the value is found to be the name of an input, field or statement, it will be inserted
+      - otherwise, the text will be inserted as a label
+  */
+}
+```
 
 A flexible **Proxy wrapper** for Blockly blocks that lets you define **dynamic inputs, layouts, fields, and shadows** with ease! Perfect for creating modular, reusable blocks that can adapt at runtime.
 

package/index.js

@@ -107,7 +107,7 @@ module.exports = (Blockly, { generator: languageGeneratorFallback, generators: l
             this.setOutput(true, (output === true) ? null : (([String, Number, Boolean, Array, Object].includes(output)) ? output.name : output));
           };
 
-          this.setColour((color != null) ? ((typeof color === "function") ? color() : color) : (((toolbox) => toolbox.contents || toolbox.contents_)(Blockly.getMainWorkspace().getToolbox()).find((category) => category.toolboxItemDef_.contents?.some((block) => block.type === name))?.toolboxItemDef_?.colour || "#000000"));
+          this.setColour((color != null) ? ((typeof color === "function") ? color() : color) : (((toolbox) => toolbox.contents_ || toolbox.contents.values())(Blockly.getMainWorkspace().getToolbox()).find((category) => category.toolboxItemDef_.contents?.some((block) => block.type === name))?.toolboxItemDef_?.colour || "#000000"));
           this.setInputsInline((typeof inline === "function") ? inline() : inline);
           this.setDeletable((typeof deletable === "function") ? deletable() : deletable);
           this.setTooltip(translate((typeof tooltip === "function") ? tooltip() : tooltip));
@@ -183,7 +183,7 @@ module.exports = (Blockly, { generator: languageGeneratorFallback, generators: l
             code,
             languageGenerator.ORDER_NONE
           ];
-        })(blockGenerator({
+        })((typeof blockGenerator === "function") ? blockGenerator({
           ...block.inputList.reduce((accumulator, input) => ({
             ...accumulator,
             ...Object.fromEntries(input.fieldRow.filter((field) => field.name).map((field) => [
@@ -201,7 +201,7 @@ module.exports = (Blockly, { generator: languageGeneratorFallback, generators: l
               })[input.type] || (() => null))()
             } : {}
           }), {}),
-        }, languageGenerator)));
+        }, languageGenerator) : blockGenerator));
       });
 
       return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockly-fluid",
-  "version": "1.0.17",
+  "version": "1.0.19",
   "description": "A flexible proxy wrapper for Blockly blocks.",
   "main": "index.js",
   "scripts": {