@qrvey/formula-lang 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,61 @@
+# Qrvey Formula Language
+
+## Usage
+
+Use it inside a javascript module
+
+```
+import { QFormulaLang, calculateAST } from "@qrvey/formula-lang"
+import { iRootAST, ENGINES, Transpiler } from '../../qrvey-lang/transpiler/lib/constants/interfaces';
+
+// input expression
+const expression = 'MID("this is an ex", 1)';
+
+// get the parser from QFormulaLang
+const parser = QFormulaLang.parser;
+
+// get the tree from input expression
+const tree = parser.parse(expression);
+
+// transform the tree into an understandable AST
+const ast = calculateAST(expression, tree.topNode);
+
+// transpile the code to a specific target Engine
+const transpilated = calculateTranspilation(ast, ENGINES.ELASTICSEARCH)
+
+calculateTranspilation = (ast: iRootAST, engine: ENGINES) => {
+    let result;
+    try {
+        const transpiler = new Transpiler(ast, engine)
+        result = transpiler.get()
+    } catch (error) {
+        result = JSON.stringify(error, undefined, 4)
+    }
+    return result
+}
+```
+
+Use inside codemirror editor
+```
+import { EditorState } from "@codemirror/state";
+import { QFormula, calculateAST } from "@qrvey/formula-lang"
+
+// set the editor state with the QFormula plugin. This adds the support for 
+this._state = EditorState.create({
+    doc: options?.text ?? '',
+    extensions: [
+    basicSetup,
+    QFormula(),
+    ...
+    ]
+})
+
+// On every edit update you can calculate the AST
+private dispatchTextUpdate(state: EditorState) {
+    const tree = (state as any).tree;
+    const text = ((state.doc as any).text as Array<string>).join('\n');
+    const ast = calculateAST(text, tree.topNode);
+    // dispatch event after return
+    return { text, ast }
+}
+```

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from "./grammar/qformula.grammar";
+export * from "./parser/json-parser";

package/dist/index.js

@@ -1 +1,2 @@
 export * from "./grammar/qformula.grammar";
+export * from "./parser/json-parser";

package/dist/models/ast.models.d.ts

@@ -0,0 +1,29 @@
+export interface AstNode {
+    type: string;
+}
+export interface AstBinaryExpressionNode extends AstNode {
+    operator: string;
+    left: AstNode;
+    right: AstNode;
+}
+export interface AstUnaryExpressionNode extends AstNode {
+    operator: string;
+    right: AstNode;
+}
+export interface AstValueNode extends AstNode {
+    value: string | boolean | number | AstNode[];
+    dataType: string;
+}
+export interface AstVariableNode extends AstNode {
+    value: string;
+}
+export interface AstFunctionNode extends AstNode {
+    name: string;
+    arguments: AstNode[];
+}
+export interface AstProgramNode extends AstNode {
+    exp: string;
+    lang: string;
+    version: string;
+    body: AstNode;
+}

package/dist/models/ast.models.js

@@ -0,0 +1 @@
+export {};

package/dist/parser/json-parser.d.ts

@@ -0,0 +1,3 @@
+import { AstNode } from "../models/ast.models";
+import { SyntaxNode } from "@lezer/common";
+export declare function calculateAST(program: string, startNode: SyntaxNode): AstNode;

package/dist/parser/json-parser.js

@@ -0,0 +1,90 @@
+import { getNodeValue } from "../utils/utils";
+const PARSER_VERSION = "0.0.0";
+const LANG_NAME = "QrveyLang";
+export function calculateAST(program, startNode) {
+    if (!startNode)
+        return { type: 'undefined' };
+    return {
+        "type": "Program",
+        "exp": program,
+        "lang": LANG_NAME,
+        "version": PARSER_VERSION,
+        "body": transformNode(program, startNode)
+    };
+}
+function transformNode(program, node) {
+    if (!node)
+        return { type: 'undefined' };
+    switch (node.name) {
+        case 'BinaryExpression':
+            return transformBinaryExpression(program, node);
+        case 'UnaryExpression':
+            return transformUnaryExpression(program, node);
+        case 'Function':
+            return transformFunctionExpression(program, node);
+        case 'Number':
+            return {
+                type: "Literal",
+                dataType: "number",
+                value: parseFloat(getNodeValue(program, node))
+            };
+        case 'String':
+            return {
+                type: "Literal",
+                dataType: "string",
+                value: getNodeValue(program, node).slice(1, -1)
+            };
+        case 'Boolean':
+            return {
+                type: "Literal",
+                dataType: "boolean",
+                value: getNodeValue(program, node) === 'true'
+            };
+        case 'Array':
+            return {
+                type: "Literal",
+                dataType: "array",
+                value: node.getChildren('Value')
+                    .map(node => {
+                    return transformNode(program, node);
+                })
+            };
+        case 'Variable':
+            return {
+                type: "Variable",
+                value: getNodeValue(program, node).slice(1, -1)
+            };
+        default:
+            return transformNode(program, node.firstChild);
+    }
+}
+function transformBinaryExpression(program, node) {
+    const [left, right] = node.getChildren('Expression');
+    const operator = node.getChild('ArithOp');
+    return {
+        operator: getNodeValue(program, operator),
+        type: "BinaryExpression",
+        left: transformNode(program, left),
+        right: transformNode(program, right)
+    };
+}
+function transformUnaryExpression(program, node) {
+    const [right] = node.getChildren('Expression');
+    const operator = node.getChild('ArithOp');
+    return {
+        operator: getNodeValue(program, operator),
+        type: "UnaryExpression",
+        right: transformNode(program, right)
+    };
+}
+function transformFunctionExpression(program, node) {
+    const args = node.getChild('FunctionArguments');
+    const nodeValue = node.getChild('FunctionIdentifier');
+    return {
+        type: "FunctionCall",
+        name: getNodeValue(program, nodeValue),
+        arguments: !!args ? args
+            .getChildren('Expression')
+            .map(node => transformNode(program, node)) : []
+    };
+}

package/dist/utils/utils.d.ts

@@ -0,0 +1,4 @@
+export declare function getNodeValue(str: string, { from, to }: {
+    from: number;
+    to: number;
+}): string;

package/dist/utils/utils.js

@@ -0,0 +1,3 @@
+export function getNodeValue(str, { from, to }) {
+    return str.slice(from, to);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/formula-lang",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "QFormula support for qrvey projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,6 +9,7 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",
     "build:watch": "tsc -w",
+    "prepublishOnly": "npm run build",
     "prepare-lang": "rollup -c --bundleConfigAsCjs"
   },
   "repository": {
@@ -25,6 +26,7 @@
   "homepage": "https://bitbucket.org/qrvey/qrvey_formula_lang#readme",
   "dependencies": {
     "@codemirror/language": "^6.6.0",
+    "@lezer/common": "^1.0.2",
     "@lezer/highlight": "^1.1.4"
   },
   "devDependencies": {
@@ -34,4 +36,4 @@
     "rollup-plugin-ts": "^3.2.0",
     "typescript": "^5.0.4"
   }
-}
+}

package/rollup.config.js

@@ -1,12 +0,0 @@
-import typescript from "rollup-plugin-ts"
-import { lezer } from "@lezer/generator/rollup"
-
-export default {
-  input: "src/grammar/qformula.lang.ts",
-  external: id => id != "tslib" && !/^(\.?\/|\w:)/.test(id),
-  output: [
-    { file: "src/grammar/generated/qformula.lang.cjs", format: "cjs" },
-    { dir: "./src/grammar/generated", format: "es" }
-  ],
-  plugins: [lezer(), typescript()]
-}

package/src/grammar/generated/qformula.lang.cjs

@@ -1,48 +0,0 @@
-'use strict';
-
-var lr = require('@lezer/lr');
-var language = require('@codemirror/language');
-var highlight = require('@lezer/highlight');
-
-// This file was generated by lezer-generator. You probably shouldn't edit it.
-const spec_identifier = {__proto__:null,true:14, false:14};
-const parser = lr.LRParser.deserialize({
-  version: 14,
-  states: "%jO]QPOOOwQPO'#CdOOQO'#C`'#C`OOQO'#Cf'#CfO!YQPO'#CeO!_QQO'#ChO]QPO'#CiQ!dQPOOO]QPO'#CnOOQO'#C_'#C_O!oQPO'#CxO!wQPO,59OO!|QPO,59PO#TQPO,59SOOQO,59T,59TO]QPO,59VO]QPO,59VO#YQPO,59YO#hQPO'#CoO#|QPO,59dOOQO1G.j1G.jO$UQPO'#C|OOQO'#Cg'#CgO$gQPO1G.kOOQO1G.n1G.nOOQO1G.q1G.qO$lQPO1G.qOOQO1G.t1G.tOOQO,59Z,59ZOOQO-E6m-E6mO%QQPO'#CpO%[QPO,59hOOQO7+$V7+$VO%dQPO,59[OOQO-E6n-E6n",
-  stateData: "%|~OgOShOSPOS~OTQOUQOVQO^UOiROkPOoWOrTO~OTQOUQOVQOkPOjlP~Oo[O~Os]O~O^`O`_Oa_O~OmbOjlX~OjdO~OnpP~P]OqhO~O^`O`_Oa_OnkO~OTQOUQOVQOkPOjcXmcX~OmbOjla~O^`O`_Oa_OmnOnpX~OnpO~O`_Oa_O^_ie_in_im_i~OmdXndX~P]OmnOnpa~O^`O`_Oa_Omdanda~OP`ghig~",
-  goto: "#lqPPPr!XPPP!h!s!|#V!s!sP!sPP!s#Y#`PPPPPPP#fPPP#iQVOQ^UQaWQe[Qi_Qj`Rqn^XOUW[_`nQYPRlbcQOPUW[_`bn_XOUW[_`n_SOUW[_`nRg[QcYRmcQoeRroRZPRf[",
-  nodeNames: "⚠ LineComment Program Expression Value Number String Boolean Array Function FunctionIdentifier FunctionArguments Variable UnaryExpression ArithOp BinaryExpression ArithOp ArithOp ParenthesizedExpression",
-  maxTerm: 35,
-  skippedNodes: [0,1],
-  repeatNodeCount: 2,
-  tokenData: ")o~RoXY#SYZ#wZ[#S]^#wpq#Srs#|xy%jyz%oz{%t{|%y|}&{}!O%y!O!P'Q!P!Q'c!Q![(S!^!_(p!`!a(u!c!}(z!}#O)e#P#Q)j#R#S&d#T#o(z$f$g#S#BY#BZ#S$IS$I_#S$I|$I}#w$I}$JO#w$JT$JU#S$KV$KW#S&FU&FV#S?HT?HU#S~#XYg~XY#SZ[#Spq#S$f$g#S#BY#BZ#S$IS$I_#S$JT$JU#S$KV$KW#S&FU&FV#S?HT?HU#S~#|Oh~~$PVOr#|rs$fs#O#|#O#P$k#P;'S#|;'S;=`%d<%lO#|~$kOU~~$nRO;'S#|;'S;=`$w;=`O#|~$zWOr#|rs$fs#O#|#O#P$k#P;'S#|;'S;=`%d;=`<%l#|<%lO#|~%gP;=`<%l#|~%oOo~~%tOn~~%yOa~R&QU^PsQ{|&d}!O&d!Q![&d!c!}&d#R#S&d#T#o&dQ&iUsQ{|&d}!O&d!Q![&d!c!}&d#R#S&d#T#o&d~'QOm~P'TP!Q!['WP']QTP!Q!['W#R#S'W~'hP`~!P!Q'k~'pSP~OY'kZ;'S'k;'S;=`'|<%lO'k~(PP;=`<%l'kR(ZVTPsQ{|&d}!O&d!O!P'W!Q![(S!c!}&d#R#S(S#T#o&d~(uOk~~(zOj~R)RUsQiP{|&d}!O&d!Q![(z!c!}(z#R#S(z#T#o(z~)jOr~~)oOq~",
-  tokenizers: [0, 1],
-  topRules: {"Program":[0,2]},
-  specialized: [{term: 25, get: value => spec_identifier[value] || -1}],
-  tokenPrec: 221
-});
-
-const QFormulaLang = language.LRLanguage.define({
-    parser: parser.configure({
-        props: [
-            highlight.styleTags({
-                Boolean: highlight.tags.bool,
-                String: highlight.tags.string,
-                Number: highlight.tags.number,
-                Variable: highlight.tags.keyword,
-                LineComment: highlight.tags.lineComment,
-                FunctionIdentifier: highlight.tags.lineComment,
-                "( )": highlight.tags.paren
-            })
-        ]
-    }),
-    languageData: {
-        commentTokens: { line: "//" }
-    }
-});
-function QFormula() {
-    return new language.LanguageSupport(QFormulaLang);
-}
-
-exports.QFormula = QFormula;
-exports.QFormulaLang = QFormulaLang;

package/src/grammar/generated/qformula.lang.d.cts

@@ -1,4 +0,0 @@
-import { LRLanguage, LanguageSupport } from "@codemirror/language";
-declare const QFormulaLang: LRLanguage;
-declare function QFormula(): LanguageSupport;
-export { QFormulaLang, QFormula };

package/src/grammar/generated/qformula.lang.d.ts

@@ -1,4 +0,0 @@
-import { LRLanguage, LanguageSupport } from "@codemirror/language";
-declare const QFormulaLang: LRLanguage;
-declare function QFormula(): LanguageSupport;
-export { QFormulaLang, QFormula };

package/src/grammar/generated/qformula.lang.js

@@ -1,45 +0,0 @@
-import { LRParser } from '@lezer/lr';
-import { LRLanguage, LanguageSupport } from '@codemirror/language';
-import { styleTags, tags } from '@lezer/highlight';
-
-// This file was generated by lezer-generator. You probably shouldn't edit it.
-const spec_identifier = {__proto__:null,true:14, false:14};
-const parser = LRParser.deserialize({
-  version: 14,
-  states: "%jO]QPOOOwQPO'#CdOOQO'#C`'#C`OOQO'#Cf'#CfO!YQPO'#CeO!_QQO'#ChO]QPO'#CiQ!dQPOOO]QPO'#CnOOQO'#C_'#C_O!oQPO'#CxO!wQPO,59OO!|QPO,59PO#TQPO,59SOOQO,59T,59TO]QPO,59VO]QPO,59VO#YQPO,59YO#hQPO'#CoO#|QPO,59dOOQO1G.j1G.jO$UQPO'#C|OOQO'#Cg'#CgO$gQPO1G.kOOQO1G.n1G.nOOQO1G.q1G.qO$lQPO1G.qOOQO1G.t1G.tOOQO,59Z,59ZOOQO-E6m-E6mO%QQPO'#CpO%[QPO,59hOOQO7+$V7+$VO%dQPO,59[OOQO-E6n-E6n",
-  stateData: "%|~OgOShOSPOS~OTQOUQOVQO^UOiROkPOoWOrTO~OTQOUQOVQOkPOjlP~Oo[O~Os]O~O^`O`_Oa_O~OmbOjlX~OjdO~OnpP~P]OqhO~O^`O`_Oa_OnkO~OTQOUQOVQOkPOjcXmcX~OmbOjla~O^`O`_Oa_OmnOnpX~OnpO~O`_Oa_O^_ie_in_im_i~OmdXndX~P]OmnOnpa~O^`O`_Oa_Omdanda~OP`ghig~",
-  goto: "#lqPPPr!XPPP!h!s!|#V!s!sP!sPP!s#Y#`PPPPPPP#fPPP#iQVOQ^UQaWQe[Qi_Qj`Rqn^XOUW[_`nQYPRlbcQOPUW[_`bn_XOUW[_`n_SOUW[_`nRg[QcYRmcQoeRroRZPRf[",
-  nodeNames: "⚠ LineComment Program Expression Value Number String Boolean Array Function FunctionIdentifier FunctionArguments Variable UnaryExpression ArithOp BinaryExpression ArithOp ArithOp ParenthesizedExpression",
-  maxTerm: 35,
-  skippedNodes: [0,1],
-  repeatNodeCount: 2,
-  tokenData: ")o~RoXY#SYZ#wZ[#S]^#wpq#Srs#|xy%jyz%oz{%t{|%y|}&{}!O%y!O!P'Q!P!Q'c!Q![(S!^!_(p!`!a(u!c!}(z!}#O)e#P#Q)j#R#S&d#T#o(z$f$g#S#BY#BZ#S$IS$I_#S$I|$I}#w$I}$JO#w$JT$JU#S$KV$KW#S&FU&FV#S?HT?HU#S~#XYg~XY#SZ[#Spq#S$f$g#S#BY#BZ#S$IS$I_#S$JT$JU#S$KV$KW#S&FU&FV#S?HT?HU#S~#|Oh~~$PVOr#|rs$fs#O#|#O#P$k#P;'S#|;'S;=`%d<%lO#|~$kOU~~$nRO;'S#|;'S;=`$w;=`O#|~$zWOr#|rs$fs#O#|#O#P$k#P;'S#|;'S;=`%d;=`<%l#|<%lO#|~%gP;=`<%l#|~%oOo~~%tOn~~%yOa~R&QU^PsQ{|&d}!O&d!Q![&d!c!}&d#R#S&d#T#o&dQ&iUsQ{|&d}!O&d!Q![&d!c!}&d#R#S&d#T#o&d~'QOm~P'TP!Q!['WP']QTP!Q!['W#R#S'W~'hP`~!P!Q'k~'pSP~OY'kZ;'S'k;'S;=`'|<%lO'k~(PP;=`<%l'kR(ZVTPsQ{|&d}!O&d!O!P'W!Q![(S!c!}&d#R#S(S#T#o&d~(uOk~~(zOj~R)RUsQiP{|&d}!O&d!Q![(z!c!}(z#R#S(z#T#o(z~)jOr~~)oOq~",
-  tokenizers: [0, 1],
-  topRules: {"Program":[0,2]},
-  specialized: [{term: 25, get: value => spec_identifier[value] || -1}],
-  tokenPrec: 221
-});
-
-const QFormulaLang = LRLanguage.define({
-    parser: parser.configure({
-        props: [
-            styleTags({
-                Boolean: tags.bool,
-                String: tags.string,
-                Number: tags.number,
-                Variable: tags.keyword,
-                LineComment: tags.lineComment,
-                FunctionIdentifier: tags.lineComment,
-                "( )": tags.paren
-            })
-        ]
-    }),
-    languageData: {
-        commentTokens: { line: "//" }
-    }
-});
-function QFormula() {
-    return new LanguageSupport(QFormulaLang);
-}
-
-export { QFormula, QFormulaLang };

package/src/grammar/qformula.grammar.ts

@@ -1 +0,0 @@
-export * from "./generated/qformula.lang.js";

package/src/grammar/qformula.lang.ts

@@ -1,26 +0,0 @@
-import { parser } from "./syntax.grammar"
-import { LRLanguage, LanguageSupport } from "@codemirror/language"
-import { styleTags, tags as t } from "@lezer/highlight"
-
-export const QFormulaLang = LRLanguage.define({
-  parser: parser.configure({
-    props: [
-      styleTags({
-        Boolean: t.bool,
-        String: t.string,
-        Number: t.number,
-        Variable: t.keyword,
-        LineComment: t.lineComment,
-        FunctionIdentifier: t.lineComment,
-        "( )": t.paren
-      })
-    ]
-  }),
-  languageData: {
-    commentTokens: { line: "//" }
-  }
-})
-
-export function QFormula() {
-  return new LanguageSupport(QFormulaLang)
-}

package/src/grammar/syntax.grammar

@@ -1,89 +0,0 @@
-@precedence{
-  prefix,
-  times @left,
-  plus @left
-}
-
-@top Program { Expression }
-
-@skip { spaces | newline | LineComment}
-
-Expression {
-  Value |
-  Function |
-  Variable |
-  UnaryExpression |
-  BinaryExpression |
-  ParenthesizedExpression
-}
-
-Value {
-  Number |
-  String |
-  boolean |
-  Array
-}
-
-UnaryExpression{
-  !prefix (ArithOp<"+" | "-">) Expression
-}
-
-BinaryExpression{
-  Expression !times (divide | ArithOp<"*">) Expression |
-  Expression !plus ArithOp<"+" | "-"> Expression
-}
-
-ParenthesizedExpression { "(" Expression ")" }
-
-Function {
-  FunctionIdentifier "(" FunctionArguments ")"
-}
-
-FunctionIdentifier {
-  identifier
-}
-
-FunctionArguments{
-  commaSepAllowEmpty<Expression>
-}
-
-Array{
-  "<" commaSepAllowEmpty<Value> ">"
-}
-
-Variable { "\[" variableId "\]" }
-
-commaSepAllowEmpty<content> {
-  "" | content ("," content?)*
-}
-
-boolean { @specialize[@name=Boolean]<identifier, "true" | "false"> }
-
-@tokens {
-  String { '"' (!["\\] | "\\" _)* '"' }
-
-  Number {
-    (@digit ("_" | @digit)* ("." ("_" | @digit)*)? | "." @digit ("_" | @digit)*)
-  }
-
-  LineComment { "//" ![\n]* }
-
-  spaces[@export] { $[\u0009 \u000b\u00a0\u1680\u2000-\u200a\u202f\u205f\u3000\ufeff]+ }
-  newline[@export] { $[\r\n\u2028\u2029] }
-
-  variableId { (@asciiLetter | @digit | $[_\-\+])+ }
-
-  divide[@name=ArithOp] { "/" }
-
-  @precedence { LineComment, divide }
-
-  identifier { word }
-
-  word { @asciiLetter (@asciiLetter | @digit | $[_])* }
-
-  ArithOp<expr> { expr }
-
-  @precedence { spaces, newline, identifier }
-}
-
-@detectDelim

package/src/grammar/syntax.grammar.d.ts

@@ -1,3 +0,0 @@
-import { LRParser } from "@lezer/lr"
-
-export declare const parser: LRParser

package/src/index.ts

@@ -1 +0,0 @@
-export * from "./grammar/qformula.grammar";

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "strict": true,
-    "moduleResolution": "node",
-    "module": "esnext",
-    "target": "es2017",
-    "declaration": true,
-    "outDir": "./dist",
-    "skipLibCheck": true,
-    "sourceMap": false,
-    "allowJs": true
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "src/grammar/qformula.lang.ts"
-  ]
-}