Added type to javascriptRules

ioBroker · Jan 14, 2025 · bdcde5e · bdcde5e
1 parent 606c531
commit bdcde5e
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 2 deletions.
diff --git a/packages/types-dev/objects.d.ts b/packages/types-dev/objects.d.ts
@@ -801,9 +801,9 @@ declare global {
             javascriptRules?: {
                 /** Translations */
                 i18n?: boolean | Record<string, Record<ioBroker.Languages, string>> | Record<string, string>;
-                /** Where to load the blocks */
+                /** Where to load the blocks, like "rules/customRuleBlocks.js" */
                 url: string;
-                /** Blocks names */
+                /** Rules block name, like "ActionTelegram" */
                 name: string;
                 /** Load it as TypeScript module */
                 type?: 'module';

diff --git a/schemas/io-package.json b/schemas/io-package.json
@@ -958,6 +958,49 @@
             ]
           }
         },
+        "javascriptRules": {
+          "type": "object",
+          "properties": {
+            "i18n": {
+              "description": "Translation for the rule block",
+              "anyOf": [
+                {
+                  "description": "Translations will be loaded from javascriptRules.url and i18n/<LANG>.json",
+                  "const": true
+                },
+                {
+                  "description": "Define translations here",
+                  "type": "object",
+                  "patternProperties": {
+                    ".+": {
+                      "$ref": "#/definitions/multilingual"
+                    }
+                  }
+                }
+              ]
+            },
+            "type": {
+              "description": "Define type='module' if rules written with TypeScript",
+              "type": "string",
+              "enum": [
+                "module"
+              ]
+            },
+            "url": {
+              "description": "Link to module, like 'rules/customRuleBlocks.js'. That means it will loaded from admin/rules directory of the adapter",
+              "type": "string"
+            },
+            "name": {
+              "description": "Name of the module, like 'ActionTelegram'",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "url",
+            "name"
+          ]
+        },
         "type": {
           "description": "Type of the adapter",
           "type": "string",