blockly-fluid 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 DinoscapeProgramming
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# Blockly Dynamic Blocks Proxy 🎛️✨
+
+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.
+
+---
+
+## Features 🚀
+
+* **Dynamic Inputs** 🔌
+  Define `inputs` with optional `check` types and `shadow DOM` — all can be functions for runtime evaluation.
+
+* **Flexible Layouts** 🧩
+  Use `layout` arrays to arrange your block fields. Tokens can be functions or strings.
+
+* **Custom Fields** ✏️
+  Supports:
+
+  * `text` → `FieldTextInput`
+  * `multiline` → `FieldMultilineInput`
+  * `dropdown` → `FieldDropdown`
+  * Default → translated text
+
+* **Dynamic Statements** 📑
+  `statements` labels can be functions for runtime flexibility.
+
+* **Previous / Next / Output / Tooltip / Color** 🎨
+  All block properties can be static values or functions.
+
+* **Automatic Shadow DOM** 🌟
+  Automatically adds shadow DOM to inputs with `"String"` or `"Number"` checks.
+
+* **Translation Ready** 🌍
+  Built-in support for multi-language translations with placeholders.
+
+---
+
+## Usage 💡
+
+```js
+const Blockly = require("blockly");
+const Blocks = require("blockly-fluid")(Blockly);
+
+Blocks["controls_repeat_forever"] = {
+  layout: ["repeat forever", "DO"],
+  statements: {
+    DO: {
+      label: () => Blockly.Msg["CONTROLS_REPEAT_INPUT_DO"] || "do"
+    }
+  },
+  previous: true,
+  next: true,
+  tooltip: "Repeat the enclosed blocks forever",
+};
+```
+
+### Features in action:
+
+* Dynamic field labels ✅
+* Custom multiline input ✅
+* Shadow DOM automatically set ✅
+* Runtime evaluated inputs, statements, colors, tooltips ✅
+
+---
+
+## Example Block 🧱
+
+```js
+Blocks["metadata_set_description"] = {
+  color: "#565353",
+  layout: ["set description", "DESCRIPTION"],
+  fields: {
+    DESCRIPTION: {
+      type: "multiline",
+      default: "Enter description..."
+    }
+  },
+  tooltip: "Metadata block to specify command's description."
+};
+```
+
+---
+
+## Supported Field Types ✨
+
+| Type        | Blockly Field       |
+| ----------- | ------------------- |
+| `text`      | FieldTextInput      |
+| `multiline` | FieldMultilineInput |
+| `dropdown`  | FieldDropdown       |
+| Default     | Translated text     |
+
+---
+
+## Why use this module? 💖
+
+* Save time creating complex Blockly blocks
+* All block properties can be **dynamic functions**
+* Built-in **shadow DOM support**
+* Built-in **translation** handling
+* Works for **both static and runtime-generated blocks**
+
+---
+
+## License 📄
+
+MIT License — free to use, modify, and distribute!

package/index.js

@@ -0,0 +1,122 @@
+module.exports = (Blockly, { translate = (text) => text } = {}) => new Proxy({}, {
+  set(_, name, {
+    inputs = {},
+    layout = [],
+    fields = {},
+    statements = {},
+    previous = true,
+    next = true,
+    output,
+    color,
+    inline = true,
+    deletable = true,
+    tooltip = "",
+    help = ""
+  }) {
+    Blockly.Blocks[name] = {
+      init: function () {
+        if (typeof inputs === "function") (inputs = inputs());
+        if (typeof layout === "function") (layout = layout());
+        if (typeof statements === "function") (statements = statements());
+
+        if ((Array.isArray(layout)) ? layout.length : ((typeof layout === "string") ? layout : false)) {
+          ((Array.isArray(layout)) ? layout : [layout]).forEach((token) => {
+            if (typeof token === "function") (token = token());
+
+            const input = (typeof inputs[token] === "function") ? inputs[token]() : inputs[token];
+            const field = (typeof fields[token] === "function") ? fields[token]() : fields[token];
+            const statement = (typeof statements[token] === "function") ? statements[token]() : statements[token];
+
+            if (input) {
+              if ((typeof input.check === "function") && ![String, Number, Boolean, Array, Object].includes(input.check)) (input.check = input.check());
+
+              const valueInput = this.appendValueInput(token)
+
+              if (input.check) {
+                if (!Array.isArray(input.check)) (input.check = [input.check]);
+
+                input.check = input.check.map((check) => [null, "null"].includes(check) ? "Null" : ((check === "undefined") ? "Undefined" : ([String, Number, Boolean, Array, Object].includes(check) ? check.name : check)));
+
+                valueInput.setCheck(input.check || null);
+              } else {
+                valueInput.connection.setShadowDom(new DOMParser().parseFromString(`<shadow type="string"><field name="TEXT"></field></shadow>`, "text/xml").firstChild);
+              };
+
+              if (input.shadow) {
+                if (typeof input.shadow === "function") (input.shadow = input.shadow());
+
+                valueInput.connection.setShadowDom(new DOMParser().parseFromString(`<shadow type="${((typeof input.shadow.type === "function") ? input.shadow.type() : (input.shadow.type || "text")).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;")}">${(typeof input.shadow.content === "function") ? input.shadow.content() : (input.shadow.content || "")}</shadow>`, "text/xml").firstChild);
+              };
+            } else if (field) {
+              const dummy = this.appendDummyInput();
+
+              switch (field.type) {
+                case "text":
+                  dummy.appendField(new Blockly.FieldTextInput(...[
+                    translate((typeof field.default === "function") ? field.default() : (field.default || "")),
+                    ...(field.validator) ? [field.validator] : []
+                  ]), token);
+                  break;
+                case "multiline":
+                  dummy.appendField(new Blockly.FieldMultilineInput(...[
+                    translate((typeof field.default === "function") ? field.default() : (field.default || "")),
+                    ...(field.validator) ? [field.validator] : []
+                  ]), token);
+                  break;
+                case "dropdown":
+                  dummy.appendField(new Blockly.FieldDropdown(...[
+                    Object.entries(field.options).map(([name, text]) => [translate((typeof text === "function") ? text() : text), (typeof name === "function") ? name() : name]),
+                    ...(field.validator) ? [field.validator] : []
+                  ]), token);
+                  break;
+                case "variable":
+                  dummy.appendField(new Blockly.FieldVariable(...[
+                    translate((typeof field.default === "function") ? field.default() : (field.default || "")),
+                    ...(field.validator) ? [field.validator] : []
+                  ]), token);
+                  break;
+                default:
+                  dummy.appendField(translate(token));
+              };
+            } else if (statement) {
+              const statementInput = this.appendStatementInput(token).setCheck(null);
+
+              if (statement.label) statementInput.appendField(translate((typeof statement.label === "function") ? statement.label() : statement.label));
+            } else {
+              this.appendDummyInput().appendField(translate(token));
+            };
+          });
+        };
+
+        if (!output) {
+          if ((typeof previous === "function") ? previous() : previous) this.setPreviousStatement(true, null);
+          if ((typeof next === "function") ? next() : next) this.setNextStatement(true, null);
+        } else {
+          if ((typeof output === "function") && ![String, Number, Boolean, Array, Object].includes(output)) (output = output());
+
+          this.setPreviousStatement(false);
+          this.setNextStatement(false);
+          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) : (Blockly.getMainWorkspace().getToolbox().contents_.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));
+        this.setHelpUrl((typeof help === "function") ? help() : help);
+
+        this.inputList.forEach((input) => {
+          if (input.connection?.shadowDom || !Array.isArray(input.connection?.check) || input.connection.check.every((check) => !["String", "Number"].includes(check))) return;
+
+          input.connection.setShadowDom(new DOMParser().parseFromString(`<shadow type="${((input.connection.check?.length === 1) && (input.connection.check[0] === "Number")) ? "number" : "string"}"><field name="${((input.connection.check?.length === 1) && (input.connection.check[0] === "Number")) ? "NUMBER" : "TEXT"}"></field></shadow>`, "text/xml").firstChild);
+        });
+      }
+    };
+
+    return true;
+  },
+
+  get(_, name) {
+    return Blockly.Blocks[name];
+  }
+});

package/index.ts

@@ -0,0 +1,46 @@
+type InputDefinition = {
+  check?: string | Function | (string | Function)[];
+  shadow?: {
+    type?: string | Function;
+    content?: string | Function;
+  } | Function;
+};
+
+type FieldDefinition = {
+  type?: "text" | "multiline" | "dropdown" | "variable" | string;
+  default?: string | Function;
+  options?: Record<string, string | Function>;
+  validator?: Function;
+};
+
+type StatementDefinition = {
+  label?: string | Function;
+};
+
+type BlockDefinition = {
+  inputs?: Record<string, InputDefinition | Function>;
+  layout?: string | string[] | Function | Function[];
+  fields?: Record<string, FieldDefinition | Function>;
+  statements?: Record<string, StatementDefinition | Function>;
+  previous?: boolean | Function;
+  next?: boolean | Function;
+  output?: boolean | string | Function;
+  color?: string | Function;
+  inline?: boolean | Function;
+  deletable?: boolean | Function;
+  tooltip?: string | Function;
+  help?: string | Function;
+};
+
+interface BlocklyProxy {
+  [name: string]: BlockDefinition | undefined;
+}
+
+/**
+ * Main module function.
+ * @param Blockly - The Blockly instance.
+ * @returns A Proxy object for defining or accessing Blockly blocks.
+ */
+declare function initBlocklyModule(Blockly: any): BlocklyProxy;
+
+export default initBlocklyModule;

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "blockly-fluid",
+  "version": "1.0.0",
+  "description": "A flexible proxy wrapper for Blockly blocks.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "DinoscapeProgramming",
+  "license": "MIT",
+  "type": "commonjs"
+}