@morphql/language-definitions 0.1.3 → 0.1.5

package/dist/morphql-lang.json

@@ -0,0 +1,495 @@
+{
+  "keywords": [
+    {
+      "name": "from",
+      "category": "control",
+      "doc": {
+        "signature": "from <format>",
+        "description": "Specifies the input data format.",
+        "parameters": [
+          {
+            "name": "format",
+            "description": "If used as first keyword: The starting format, one of `json`, `xml`, or `object`. When used after a section, defines its source"
+          }
+        ],
+        "example": "from json to xml"
+      }
+    },
+    {
+      "name": "to",
+      "category": "control",
+      "doc": {
+        "signature": "to <format>",
+        "description": "Specifies the output data format.",
+        "parameters": [
+          {
+            "name": "format",
+            "description": "One of: `json`, `xml`, or `object`"
+          }
+        ],
+        "example": "from json to xml"
+      }
+    },
+    {
+      "name": "transform",
+      "category": "control",
+      "doc": {
+        "signature": "transform",
+        "description": "Begins the transformation block containing actions.",
+        "example": "transform\n  set name = firstName"
+      }
+    },
+    {
+      "name": "set",
+      "category": "action",
+      "doc": {
+        "signature": "set <target> = <expression>",
+        "description": "Assigns a value to a field in the output.",
+        "parameters": [
+          {
+            "name": "target",
+            "description": "The field name to set"
+          },
+          {
+            "name": "expression",
+            "description": "The value or expression to assign"
+          }
+        ],
+        "example": "set fullName = firstName + \" \" + lastName"
+      }
+    },
+    {
+      "name": "section",
+      "category": "action",
+      "doc": {
+        "signature": "section [multiple] <name>( [subquery] <actions> ) [from <path>]",
+        "description": "Creates a nested object or array in the output. Can optionally include a subquery for format conversion.",
+        "parameters": [
+          {
+            "name": "multiple",
+            "description": "(Optional) Treat as array mapping"
+          },
+          {
+            "name": "name",
+            "description": "The section/field name"
+          },
+          {
+            "name": "subquery",
+            "description": "(Optional) Nested query: from <format> to <format> [transform]"
+          },
+          {
+            "name": "actions",
+            "description": "Actions to perform within the section"
+          },
+          {
+            "name": "from",
+            "description": "(Optional) Source path for the section data"
+          }
+        ],
+        "example": "section metadata(\n  from xml to object\n  transform\n    set name = root.productName\n) from xmlString"
+      }
+    },
+    {
+      "name": "multiple",
+      "category": "action",
+      "doc": {
+        "signature": "section multiple <name>(...)",
+        "description": "Modifier for `section` to map over an array.",
+        "example": "section multiple items(\n  set id = itemId\n) from products"
+      }
+    },
+    {
+      "name": "clone",
+      "category": "action",
+      "doc": {
+        "signature": "clone([field1, field2, ...])",
+        "description": "Copies fields from the source to the output.",
+        "parameters": [
+          {
+            "name": "fields",
+            "description": "(Optional) Specific fields to clone. If omitted, clones all fields."
+          }
+        ],
+        "example": "clone(id, name, email)"
+      }
+    },
+    {
+      "name": "delete",
+      "category": "action",
+      "doc": {
+        "signature": "delete <field>",
+        "description": "Removes a field from the output (useful after `clone`).",
+        "parameters": [
+          {
+            "name": "field",
+            "description": "The field name to delete"
+          }
+        ],
+        "example": "clone()\ndelete password"
+      }
+    },
+    {
+      "name": "define",
+      "category": "action",
+      "doc": {
+        "signature": "define <alias> = <expression>",
+        "description": "Creates a local variable/alias for use in subsequent expressions.",
+        "parameters": [
+          {
+            "name": "alias",
+            "description": "The variable name"
+          },
+          {
+            "name": "expression",
+            "description": "The value to assign"
+          }
+        ],
+        "example": "define taxRate = 0.22\nset totalWithTax = total * (1 + taxRate)"
+      }
+    },
+    {
+      "name": "if",
+      "category": "control",
+      "doc": {
+        "signature": "if (condition) ( actions ) [else ( actions )]",
+        "description": "Conditional execution of action blocks.",
+        "parameters": [
+          {
+            "name": "condition",
+            "description": "Boolean expression"
+          },
+          {
+            "name": "actions",
+            "description": "Actions to execute if true/false"
+          }
+        ],
+        "example": "if (age >= 18) (\n  set status = \"adult\"\n) else (\n  set status = \"minor\"\n)"
+      }
+    },
+    {
+      "name": "else",
+      "category": "control",
+      "doc": {
+        "signature": "else ( actions )",
+        "description": "Defines the else branch of an `if` statement.",
+        "example": "if (condition) (\n  ...\n) else (\n  ...\n)"
+      }
+    },
+    {
+      "name": "modify",
+      "category": "action",
+      "doc": {
+        "signature": "modify <target> = <expression>",
+        "description": "Modifies a field in the output by reading from the target (not source). Useful for post-processing already-mapped values.",
+        "parameters": [
+          {
+            "name": "target",
+            "description": "The field name to modify"
+          },
+          {
+            "name": "expression",
+            "description": "The expression to assign (reads from target, not source)"
+          }
+        ],
+        "example": "set total = price * quantity\nmodify total = total * 1.10"
+      }
+    }
+  ],
+  "functions": [
+    {
+      "name": "substring",
+      "doc": {
+        "signature": "substring(str, start, [length])",
+        "description": "Extracts a portion of a string. Supports negative indices.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The source string"
+          },
+          {
+            "name": "start",
+            "description": "Starting index (0-based, negative counts from end)"
+          },
+          {
+            "name": "length",
+            "description": "(Optional) Number of characters to extract"
+          }
+        ],
+        "returns": "string",
+        "example": "substring(\"Hello World\", 0, 5)  // \"Hello\"\nsubstring(\"Hello World\", -5)     // \"World\""
+      }
+    },
+    {
+      "name": "split",
+      "doc": {
+        "signature": "split(str, [separator], [limit])",
+        "description": "Splits a string into an array.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The string to split"
+          },
+          {
+            "name": "separator",
+            "description": "(Optional) Delimiter string. Default: \"\""
+          },
+          {
+            "name": "limit",
+            "description": "(Optional) Maximum number of splits"
+          }
+        ],
+        "returns": "array",
+        "example": "split(\"a,b,c\", \",\")  // [\"a\", \"b\", \"c\"]"
+      }
+    },
+    {
+      "name": "replace",
+      "doc": {
+        "signature": "replace(str, search, replacement)",
+        "description": "Replaces occurrences in a string.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The source string"
+          },
+          {
+            "name": "search",
+            "description": "The substring to find"
+          },
+          {
+            "name": "replacement",
+            "description": "The replacement string"
+          }
+        ],
+        "returns": "string",
+        "example": "replace(\"Hello World\", \"World\", \"MorphQL\")  // \"Hello MorphQL\""
+      }
+    },
+    {
+      "name": "text",
+      "doc": {
+        "signature": "text(value)",
+        "description": "Converts a value to a string.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The value to convert"
+          }
+        ],
+        "returns": "string",
+        "example": "text(123)  // \"123\""
+      }
+    },
+    {
+      "name": "number",
+      "doc": {
+        "signature": "number(value)",
+        "description": "Converts a value to a number.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The value to convert"
+          }
+        ],
+        "returns": "number",
+        "example": "number(\"42\")  // 42"
+      }
+    },
+    {
+      "name": "uppercase",
+      "doc": {
+        "signature": "uppercase(str)",
+        "description": "Converts a string to uppercase.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The string to convert"
+          }
+        ],
+        "returns": "string",
+        "example": "uppercase(\"hello\")  // \"HELLO\""
+      }
+    },
+    {
+      "name": "lowercase",
+      "doc": {
+        "signature": "lowercase(str)",
+        "description": "Converts a string to lowercase.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The string to convert"
+          }
+        ],
+        "returns": "string",
+        "example": "lowercase(\"HELLO\")  // \"hello\""
+      }
+    },
+    {
+      "name": "extractnumber",
+      "doc": {
+        "signature": "extractnumber(str)",
+        "description": "Extracts the first numeric sequence from a string.",
+        "parameters": [
+          {
+            "name": "str",
+            "description": "The string to extract from"
+          }
+        ],
+        "returns": "number",
+        "example": "extractnumber(\"Price: 100USD\")  // 100"
+      }
+    },
+    {
+      "name": "xmlnode",
+      "doc": {
+        "signature": "xmlnode(value, [attrKey, attrVal, ...])",
+        "description": "Wraps a value for XML output with optional attributes.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The node content"
+          },
+          {
+            "name": "attrKey, attrVal",
+            "description": "(Optional) Pairs of attribute keys and values"
+          }
+        ],
+        "returns": "XML node",
+        "example": "xmlnode(content, \"id\", 1, \"type\", \"text\")"
+      }
+    },
+    {
+      "name": "to_base64",
+      "doc": {
+        "signature": "to_base64(value)",
+        "description": "Encodes a string value to Base64.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The string to encode"
+          }
+        ],
+        "returns": "string",
+        "example": "to_base64(\"hello\")  // \"aGVsbG8=\""
+      }
+    },
+    {
+      "name": "from_base64",
+      "doc": {
+        "signature": "from_base64(value)",
+        "description": "Decodes a Base64 string value.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The Base64 string to decode"
+          }
+        ],
+        "returns": "string",
+        "example": "from_base64(\"aGVsbG8=\")  // \"hello\""
+      }
+    },
+    {
+      "name": "aslist",
+      "doc": {
+        "signature": "aslist(value)",
+        "description": "Ensures a value is an array. Useful for XML nodes that might be a single object or an array.",
+        "parameters": [
+          {
+            "name": "value",
+            "description": "The value to normalize"
+          }
+        ],
+        "returns": "array",
+        "example": "aslist(items)  // Always returns an array"
+      }
+    }
+  ],
+  "operators": [
+    {
+      "symbol": "===",
+      "category": "comparison",
+      "precedence": 7
+    },
+    {
+      "symbol": "!==",
+      "category": "comparison",
+      "precedence": 7
+    },
+    {
+      "symbol": "==",
+      "category": "comparison",
+      "precedence": 7
+    },
+    {
+      "symbol": "!=",
+      "category": "comparison",
+      "precedence": 7
+    },
+    {
+      "symbol": "<=",
+      "category": "comparison",
+      "precedence": 6
+    },
+    {
+      "symbol": ">=",
+      "category": "comparison",
+      "precedence": 6
+    },
+    {
+      "symbol": "<",
+      "category": "comparison",
+      "precedence": 6
+    },
+    {
+      "symbol": ">",
+      "category": "comparison",
+      "precedence": 6
+    },
+    {
+      "symbol": "&&",
+      "category": "logical",
+      "precedence": 5
+    },
+    {
+      "symbol": "||",
+      "category": "logical",
+      "precedence": 4
+    },
+    {
+      "symbol": "!",
+      "category": "logical",
+      "precedence": 9
+    },
+    {
+      "symbol": "+",
+      "category": "arithmetic",
+      "precedence": 10
+    },
+    {
+      "symbol": "-",
+      "category": "arithmetic",
+      "precedence": 10
+    },
+    {
+      "symbol": "*",
+      "category": "arithmetic",
+      "precedence": 11
+    },
+    {
+      "symbol": "/",
+      "category": "arithmetic",
+      "precedence": 11
+    },
+    {
+      "symbol": "=",
+      "category": "assignment",
+      "precedence": 1
+    }
+  ],
+  "comments": {
+    "line": "//",
+    "blockStart": "/*",
+    "blockEnd": "*/"
+  }
+}

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@morphql/language-definitions",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Shared language definitions for MorphQL across VSCode, Monaco, and documentation",
   "type": "module",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -28,8 +33,17 @@
     "vscode",
     "monaco"
   ],
-  "author": "",
+  "author": "Hyperwindmill",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Hyperwindmill/morphql.git",
+    "directory": "packages/language-definitions"
+  },
+  "bugs": {
+    "url": "https://github.com/Hyperwindmill/morphql/issues"
+  },
+  "homepage": "https://github.com/Hyperwindmill/morphql/tree/main/packages/language-definitions#readme",
   "devDependencies": {
     "tsup": "^8.0.0",
     "tsx": "^4.0.0",

package/export-json.ts

@@ -1,107 +0,0 @@
-import { MORPHQL_LANGUAGE } from "./src/index";
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const distDir = path.resolve(__dirname, "dist");
-if (!fs.existsSync(distDir)) {
-  fs.mkdirSync(distDir, { recursive: true });
-}
-
-// 1. Export JSON
-const jsonPath = path.resolve(distDir, "morphql-lang.json");
-fs.writeFileSync(jsonPath, JSON.stringify(MORPHQL_LANGUAGE, null, 2));
-console.log(`Language definitions exported to ${jsonPath}`);
-
-// 2. Export Kotlin Constants
-const constantsPath = path.resolve(
-  __dirname,
-  "../jetbrains-extension/src/main/kotlin/org/morphql/jetbrains/MorphQLConstants.kt",
-);
-
-const keywords = MORPHQL_LANGUAGE.keywords.map((k) => k.name);
-const functions = MORPHQL_LANGUAGE.functions.map((f) => f.name);
-const operators = MORPHQL_LANGUAGE.operators.map((o) => o.symbol);
-
-const constantsContent = `package org.morphql.jetbrains
-
-/**
- * GENERATED FILE - DO NOT EDIT MANUALLY
- * Generated by packages/language-definitions/export-json.ts
- */
-object MorphQLConstants {
-    val KEYWORDS = setOf(
-${keywords.map((k) => `        "${k}"`).join(",\n")}
-    )
-
-    val FUNCTIONS = setOf(
-${functions.map((f) => `        "${f}"`).join(",\n")}
-    )
-
-    val OPERATORS = setOf(
-${operators.map((o) => `        "${o}"`).join(",\n")}
-    )
-}
-`;
-
-if (fs.existsSync(path.dirname(constantsPath))) {
-  fs.writeFileSync(constantsPath, constantsContent);
-  console.log(`Kotlin constants exported to ${constantsPath}`);
-}
-
-// 3. Export Kotlin Documentation
-const docsPath = path.resolve(
-  __dirname,
-  "../jetbrains-extension/src/main/kotlin/org/morphql/jetbrains/MorphQLDocumentation.kt",
-);
-
-const allDocs: Record<string, any> = {};
-MORPHQL_LANGUAGE.keywords.forEach((k) => {
-  allDocs[k.name] = k.doc;
-});
-MORPHQL_LANGUAGE.functions.forEach((f) => {
-  allDocs[f.name] = f.doc;
-});
-
-const escapeQuotes = (str: string) =>
-  str.replace(/"/g, '\\"').replace(/\n/g, "\\n");
-
-const docsEntries = Object.entries(allDocs)
-  .map(([name, doc]) => {
-    return `        "${name}" to """
-            <b>${doc.signature}</b><br/>
-            ${doc.description}<br/><br/>
-            ${
-              doc.parameters && doc.parameters.length > 0
-                ? `<b>Parameters:</b><ul>${doc.parameters
-                    .map(
-                      (p: any) => `<li><b>${p.name}:</b> ${p.description}</li>`,
-                    )
-                    .join("")}</ul>`
-                : ""
-            }
-            ${doc.example ? `<b>Example:</b><pre>${doc.example}</pre>` : ""}
-        """.trimIndent()`;
-  })
-  .join(",\n");
-
-const docsContent = `package org.morphql.jetbrains
-
-/**
- * GENERATED FILE - DO NOT EDIT MANUALLY
- * Generated by packages/language-definitions/export-json.ts
- */
-object MorphQLDocumentation {
-    val DOCS = mapOf(
-${docsEntries}
-    )
-}
-`;
-
-if (fs.existsSync(path.dirname(docsPath))) {
-  fs.writeFileSync(docsPath, docsContent);
-  console.log(`Kotlin documentation exported to ${docsPath}`);
-}