@actions/expressions 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright GitHub
+
+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,95 @@
+# actions/expressions
+
+`@actions/expressions` is a library to parse and evaluate GitHub Actions [expressions](https://docs.github.com/actions/learn-github-actions/expressions).
+
+## Installation
+
+The [package](https://www.npmjs.com/package/@actions/expressions) contains TypeScript types and compiled ECMAScript modules.
+
+```bash
+npm install @actions/expressions
+```
+
+## Usage
+
+### Simple example
+
+```ts
+import { Parser, Lexer, Evaluator, data } from '@actions/expressions';
+
+const lexer = new Lexer("1 == 2");
+const lr = lexer.lex();
+
+const parser = new Parser(lr.tokens, [], []);
+const expr = parser.parse();
+
+const evaluator = new Evaluator(expr, new data.Dictionary());
+const result = evaluator.evaluate();
+
+console.log(result.coerceString()) // false
+```
+
+### With context data
+
+```ts
+import { Parser, Lexer, Evaluator, data } from '@actions/expressions';
+
+const lexer = new Lexer("'monalisa' == context.name");
+const lr = lexer.lex();
+
+const parser = new Parser(lr.tokens, ["context"], []);
+const expr = parser.parse();
+
+const evaluator = new Evaluator(expr, new data.Dictionary([{
+  key: "context"
+  value: new data.Dictionary([{
+    key: "name"
+    value: new data.StringData("monalisa")
+  }])
+}]));
+const result = evaluator.evaluate();
+
+console.log(result.coerceString()) // true
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](../CONTRIBUTING.md) at the root of the repository for general guidelines and recommendations.
+
+This project is just one of multiple implementations of the GitHub Actions Expressions language. We therefore cannot accept contributions that add new language features or significantly change the behavior of existing language features. If you would like to propose a change to the language itself, please use our [Community Forum](https://github.com/community/community/discussions/categories/actions-and-packages).
+
+If you do want to contribute, please run [prettier](https://prettier.io/) to format your code and add unit tests as appropriate before submitting your PR. [./testdata](./testdata) contains test cases that all implementations should pass, please also make sure those tests are still passing.
+
+### Build
+
+```bash
+npm run build
+```
+
+or to watch for changes
+
+```bash
+npm run watch
+```
+
+### Test
+
+```bash
+npm test
+```
+
+or to watch for changes and run tests:
+
+```bash
+npm run test-watch
+```
+
+### Lint
+
+```bash
+npm run format-check
+```
+
+## License
+
+This project is licensed under the terms of the MIT open source license. Please refer to [MIT](../LICENSE) for the full terms.

package/dist/ast.d.ts

@@ -0,0 +1,66 @@
+import { ExpressionData } from "./data";
+import { Token } from "./lexer";
+export interface ExprVisitor<R> {
+    visitLiteral(literal: Literal): R;
+    visitUnary(unary: Unary): R;
+    visitBinary(binary: Binary): R;
+    visitLogical(binary: Logical): R;
+    visitGrouping(grouping: Grouping): R;
+    visitContextAccess(contextAccess: ContextAccess): R;
+    visitIndexAccess(indexAccess: IndexAccess): R;
+    visitFunctionCall(functionCall: FunctionCall): R;
+}
+export declare abstract class Expr {
+    abstract accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Literal extends Expr {
+    literal: ExpressionData;
+    token: Token;
+    constructor(literal: ExpressionData, token: Token);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Unary extends Expr {
+    operator: Token;
+    expr: Expr;
+    constructor(operator: Token, expr: Expr);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class FunctionCall extends Expr {
+    functionName: Token;
+    args: Expr[];
+    constructor(functionName: Token, args: Expr[]);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Binary extends Expr {
+    left: Expr;
+    operator: Token;
+    right: Expr;
+    constructor(left: Expr, operator: Token, right: Expr);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Logical extends Expr {
+    operator: Token;
+    args: Expr[];
+    constructor(operator: Token, args: Expr[]);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Grouping extends Expr {
+    group: Expr;
+    constructor(group: Expr);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class ContextAccess extends Expr {
+    name: Token;
+    constructor(name: Token);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class IndexAccess extends Expr {
+    expr: Expr;
+    index: Expr;
+    constructor(expr: Expr, index: Expr);
+    accept<R>(v: ExprVisitor<R>): R;
+}
+export declare class Star extends Expr {
+    accept<R>(): R;
+}
+//# sourceMappingURL=ast.d.ts.map

package/dist/ast.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAE9B,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC;IAClC,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC;IAC5B,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC;IAC/B,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,CAAC,CAAC;IACjC,aAAa,CAAC,QAAQ,EAAE,QAAQ,GAAG,CAAC,CAAC;IACrC,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG,CAAC,CAAC;IACpD,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC;IAC9C,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,CAAC,CAAC;CAClD;AAED,8BAAsB,IAAI;IACxB,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CACzC;AAED,qBAAa,OAAQ,SAAQ,IAAI;IACZ,OAAO,EAAE,cAAc;IAAS,KAAK,EAAE,KAAK;gBAA5C,OAAO,EAAE,cAAc,EAAS,KAAK,EAAE,KAAK;IAI/D,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,KAAM,SAAQ,IAAI;IACV,QAAQ,EAAE,KAAK;IAAS,IAAI,EAAE,IAAI;gBAAlC,QAAQ,EAAE,KAAK,EAAS,IAAI,EAAE,IAAI;IAIrD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,YAAa,SAAQ,IAAI;IACjB,YAAY,EAAE,KAAK;IAAS,IAAI,EAAE,IAAI,EAAE;gBAAxC,YAAY,EAAE,KAAK,EAAS,IAAI,EAAE,IAAI,EAAE;IAI3D,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,MAAO,SAAQ,IAAI;IACX,IAAI,EAAE,IAAI;IAAS,QAAQ,EAAE,KAAK;IAAS,KAAK,EAAE,IAAI;gBAAtD,IAAI,EAAE,IAAI,EAAS,QAAQ,EAAE,KAAK,EAAS,KAAK,EAAE,IAAI;IAIzE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,OAAQ,SAAQ,IAAI;IACZ,QAAQ,EAAE,KAAK;IAAS,IAAI,EAAE,IAAI,EAAE;gBAApC,QAAQ,EAAE,KAAK,EAAS,IAAI,EAAE,IAAI,EAAE;IAIvD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,QAAS,SAAQ,IAAI;IACb,KAAK,EAAE,IAAI;gBAAX,KAAK,EAAE,IAAI;IAI9B,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,aAAc,SAAQ,IAAI;IAClB,IAAI,EAAE,KAAK;gBAAX,IAAI,EAAE,KAAK;IAI9B,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,WAAY,SAAQ,IAAI;IAChB,IAAI,EAAE,IAAI;IAAS,KAAK,EAAE,IAAI;gBAA9B,IAAI,EAAE,IAAI,EAAS,KAAK,EAAE,IAAI;IAIjD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC;CAGhC;AAED,qBAAa,IAAK,SAAQ,IAAI;IAC5B,MAAM,CAAC,CAAC,KAAK,CAAC;CAGf"}

package/dist/ast.js

@@ -0,0 +1,87 @@
+export class Expr {
+}
+export class Literal extends Expr {
+    constructor(literal, token) {
+        super();
+        this.literal = literal;
+        this.token = token;
+    }
+    accept(v) {
+        return v.visitLiteral(this);
+    }
+}
+export class Unary extends Expr {
+    constructor(operator, expr) {
+        super();
+        this.operator = operator;
+        this.expr = expr;
+    }
+    accept(v) {
+        return v.visitUnary(this);
+    }
+}
+export class FunctionCall extends Expr {
+    constructor(functionName, args) {
+        super();
+        this.functionName = functionName;
+        this.args = args;
+    }
+    accept(v) {
+        return v.visitFunctionCall(this);
+    }
+}
+export class Binary extends Expr {
+    constructor(left, operator, right) {
+        super();
+        this.left = left;
+        this.operator = operator;
+        this.right = right;
+    }
+    accept(v) {
+        return v.visitBinary(this);
+    }
+}
+export class Logical extends Expr {
+    constructor(operator, args) {
+        super();
+        this.operator = operator;
+        this.args = args;
+    }
+    accept(v) {
+        return v.visitLogical(this);
+    }
+}
+export class Grouping extends Expr {
+    constructor(group) {
+        super();
+        this.group = group;
+    }
+    accept(v) {
+        return v.visitGrouping(this);
+    }
+}
+export class ContextAccess extends Expr {
+    constructor(name) {
+        super();
+        this.name = name;
+    }
+    accept(v) {
+        return v.visitContextAccess(this);
+    }
+}
+export class IndexAccess extends Expr {
+    constructor(expr, index) {
+        super();
+        this.expr = expr;
+        this.index = index;
+    }
+    accept(v) {
+        return v.visitIndexAccess(this);
+    }
+}
+export class Star extends Expr {
+    accept() {
+        throw new Error("Method not implemented.");
+    }
+}
+//# sourceMappingURL=ast.js.map

package/dist/ast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast.js","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAcA,MAAM,OAAgB,IAAI;CAEzB;AAED,MAAM,OAAO,OAAQ,SAAQ,IAAI;IAC/B,YAAmB,OAAuB,EAAS,KAAY;QAC7D,KAAK,EAAE,CAAC;QADS,YAAO,GAAP,OAAO,CAAgB;QAAS,UAAK,GAAL,KAAK,CAAO;IAE/D,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,KAAM,SAAQ,IAAI;IAC7B,YAAmB,QAAe,EAAS,IAAU;QACnD,KAAK,EAAE,CAAC;QADS,aAAQ,GAAR,QAAQ,CAAO;QAAS,SAAI,GAAJ,IAAI,CAAM;IAErD,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,IAAI;IACpC,YAAmB,YAAmB,EAAS,IAAY;QACzD,KAAK,EAAE,CAAC;QADS,iBAAY,GAAZ,YAAY,CAAO;QAAS,SAAI,GAAJ,IAAI,CAAQ;IAE3D,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,OAAO,MAAO,SAAQ,IAAI;IAC9B,YAAmB,IAAU,EAAS,QAAe,EAAS,KAAW;QACvE,KAAK,EAAE,CAAC;QADS,SAAI,GAAJ,IAAI,CAAM;QAAS,aAAQ,GAAR,QAAQ,CAAO;QAAS,UAAK,GAAL,KAAK,CAAM;IAEzE,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,OAAQ,SAAQ,IAAI;IAC/B,YAAmB,QAAe,EAAS,IAAY;QACrD,KAAK,EAAE,CAAC;QADS,aAAQ,GAAR,QAAQ,CAAO;QAAS,SAAI,GAAJ,IAAI,CAAQ;IAEvD,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,QAAS,SAAQ,IAAI;IAChC,YAAmB,KAAW;QAC5B,KAAK,EAAE,CAAC;QADS,UAAK,GAAL,KAAK,CAAM;IAE9B,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAI;IACrC,YAAmB,IAAW;QAC5B,KAAK,EAAE,CAAC;QADS,SAAI,GAAJ,IAAI,CAAO;IAE9B,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAI;IACnC,YAAmB,IAAU,EAAS,KAAW;QAC/C,KAAK,EAAE,CAAC;QADS,SAAI,GAAJ,IAAI,CAAM;QAAS,UAAK,GAAL,KAAK,CAAM;IAEjD,CAAC;IAED,MAAM,CAAI,CAAiB;QACzB,OAAO,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAED,MAAM,OAAO,IAAK,SAAQ,IAAI;IAC5B,MAAM;QACJ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/completion/descriptionDictionary.d.ts

@@ -0,0 +1,15 @@
+import { Dictionary } from "../data/dictionary";
+import { ExpressionData, Pair } from "../data/expressiondata";
+export type DescriptionPair = Pair & {
+    description?: string;
+};
+export declare function isDescriptionDictionary(x: ExpressionData): x is DescriptionDictionary;
+export declare class DescriptionDictionary extends Dictionary {
+    private readonly descriptions;
+    complete: boolean;
+    constructor(...pairs: DescriptionPair[]);
+    add(key: string, value: ExpressionData, description?: string): void;
+    pairs(): DescriptionPair[];
+    getDescription(key: string): string | undefined;
+}
+//# sourceMappingURL=descriptionDictionary.d.ts.map

package/dist/completion/descriptionDictionary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptionDictionary.d.ts","sourceRoot":"","sources":["../../src/completion/descriptionDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAC,cAAc,EAAQ,IAAI,EAAC,MAAM,wBAAwB,CAAC;AAElE,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE5D,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,IAAI,qBAAqB,CAErF;AAED,qBAAa,qBAAsB,SAAQ,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA6B;IACnD,QAAQ,UAAQ;gBAEX,GAAG,KAAK,EAAE,eAAe,EAAE;IAQ9B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAYnE,KAAK,IAAI,eAAe,EAAE;IAKnC,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAGhD"}

package/dist/completion/descriptionDictionary.js

@@ -0,0 +1,33 @@
+import { Dictionary } from "../data/dictionary";
+import { Kind } from "../data/expressiondata";
+export function isDescriptionDictionary(x) {
+    return x.kind === Kind.Dictionary && x instanceof DescriptionDictionary;
+}
+export class DescriptionDictionary extends Dictionary {
+    constructor(...pairs) {
+        super();
+        this.descriptions = new Map();
+        this.complete = true;
+        for (const p of pairs) {
+            this.add(p.key, p.value, p.description);
+        }
+    }
+    add(key, value, description) {
+        if (this.get(key) !== undefined) {
+            // Key already added, ignore
+            return;
+        }
+        super.add(key, value);
+        if (description) {
+            this.descriptions.set(key, description);
+        }
+    }
+    pairs() {
+        const pairs = super.pairs();
+        return pairs.map(p => ({ ...p, description: this.descriptions.get(p.key) }));
+    }
+    getDescription(key) {
+        return this.descriptions.get(key);
+    }
+}
+//# sourceMappingURL=descriptionDictionary.js.map

package/dist/completion/descriptionDictionary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptionDictionary.js","sourceRoot":"","sources":["../../src/completion/descriptionDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAiB,IAAI,EAAO,MAAM,wBAAwB,CAAC;AAIlE,MAAM,UAAU,uBAAuB,CAAC,CAAiB;IACvD,OAAO,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,UAAU,IAAI,CAAC,YAAY,qBAAqB,CAAC;AAC1E,CAAC;AAED,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IAInD,YAAY,GAAG,KAAwB;QACrC,KAAK,EAAE,CAAC;QAJO,iBAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;QACnD,aAAQ,GAAG,IAAI,CAAC;QAKrB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACrB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;SACzC;IACH,CAAC;IAEQ,GAAG,CAAC,GAAW,EAAE,KAAqB,EAAE,WAAoB;QACnE,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC/B,4BAA4B;YAC5B,OAAO;SACR;QAED,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,IAAI,WAAW,EAAE;YACf,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;SACzC;IACH,CAAC;IAEQ,KAAK;QACZ,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAC,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,cAAc,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;CACF"}

package/dist/completion.d.ts

@@ -0,0 +1,26 @@
+import { Dictionary } from "./data/dictionary";
+import { FunctionDefinition, FunctionInfo } from "./funcs/info";
+import { Token } from "./lexer";
+export type CompletionItem = {
+    label: string;
+    description?: string;
+    function: boolean;
+};
+/**
+ * Complete returns a list of completion items for the given expression.
+ * The main functionality is auto-completing functions and context access:
+ * We can only provide assistance if the input is in one of the following forms (with | denoting the cursor position):
+ * - context.path.inp| or context.path['inp| -- auto-complete context access
+ * - context.path.| or context.path['| -- auto-complete context access
+ * - toJS| -- auto-complete function call or top-level
+ * - | -- auto-complete function call or top-level context access
+ *
+ * @param input Input expression
+ * @param context Context available for the expression
+ * @param extensionFunctions List of functions available
+ * @param functions Optional map of functions to use during evaluation
+ * @returns Array of completion items
+ */
+export declare function complete(input: string, context: Dictionary, extensionFunctions: FunctionInfo[], functions?: Map<string, FunctionDefinition>): CompletionItem[];
+export declare function trimTokenVector(tokenVector: Token[]): Token[];
+//# sourceMappingURL=completion.d.ts.map

package/dist/completion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,UAAU,EAAe,MAAM,mBAAmB,CAAC;AAI3D,OAAO,EAAC,kBAAkB,EAAE,YAAY,EAAC,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAQ,KAAK,EAAY,MAAM,SAAS,CAAC;AAGhD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,UAAU,EACnB,kBAAkB,EAAE,YAAY,EAAE,EAClC,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAC1C,cAAc,EAAE,CAqDlB;AA6CD,wBAAgB,eAAe,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAqC7D"}

package/dist/completion.js

@@ -0,0 +1,124 @@
+import { isDictionary } from "./data/dictionary";
+import { Evaluator } from "./evaluator";
+import { wellKnownFunctions } from "./funcs";
+import { Lexer, TokenType } from "./lexer";
+import { Parser } from "./parser";
+/**
+ * Complete returns a list of completion items for the given expression.
+ * The main functionality is auto-completing functions and context access:
+ * We can only provide assistance if the input is in one of the following forms (with | denoting the cursor position):
+ * - context.path.inp| or context.path['inp| -- auto-complete context access
+ * - context.path.| or context.path['| -- auto-complete context access
+ * - toJS| -- auto-complete function call or top-level
+ * - | -- auto-complete function call or top-level context access
+ *
+ * @param input Input expression
+ * @param context Context available for the expression
+ * @param extensionFunctions List of functions available
+ * @param functions Optional map of functions to use during evaluation
+ * @returns Array of completion items
+ */
+export function complete(input, context, extensionFunctions, functions) {
+    // Lex
+    const lexer = new Lexer(input);
+    const lexResult = lexer.lex();
+    // Find interesting part of the tokenVector. For example, for an expression like `github.actor == env.actor.log|`, we are
+    // only interested in the `env.actor.log` part for auto-completion
+    const tokenInputVector = trimTokenVector(lexResult.tokens);
+    // Start by skipping the EOF token
+    let tokenIdx = tokenInputVector.length - 2;
+    if (tokenIdx >= 0) {
+        switch (tokenInputVector[tokenIdx].type) {
+            // If there is a (partial) identifier under the cursor, ignore that
+            case TokenType.IDENTIFIER:
+                tokenIdx--;
+                break;
+            case TokenType.STRING:
+                // TODO: Support string for `context.name['test|`
+                return [];
+        }
+    }
+    if (tokenIdx < 0) {
+        // Vector only contains the EOF token. Suggest functions and root context access
+        const result = contextKeys(context);
+        // Merge with functions
+        result.push(...functionItems(extensionFunctions));
+        return result;
+    }
+    // Determine path that led to the last token
+    // Use parser & evaluator to determine context to complete.
+    const pathTokenVector = tokenInputVector.slice(0, tokenIdx);
+    // Include the original EOF token to make the parser happy
+    pathTokenVector.push(tokenInputVector[tokenInputVector.length - 1]);
+    const p = new Parser(pathTokenVector, context.pairs().map(x => x.key), extensionFunctions);
+    const expr = p.parse();
+    const ev = new Evaluator(expr, context, functions);
+    const result = ev.evaluate();
+    return contextKeys(result);
+}
+function functionItems(extensionFunctions) {
+    const result = [];
+    for (const fdef of [...Object.values(wellKnownFunctions), ...extensionFunctions]) {
+        result.push({
+            label: fdef.name,
+            description: fdef.description,
+            function: true
+        });
+    }
+    // Sort functions
+    result.sort((a, b) => a.label.localeCompare(b.label));
+    return result;
+}
+function contextKeys(context) {
+    if (isDictionary(context)) {
+        return (context
+            .pairs()
+            .map(x => completionItemFromContext(x))
+            // Sort contexts
+            .sort((a, b) => a.label.localeCompare(b.label)));
+    }
+    return [];
+}
+function completionItemFromContext(pair) {
+    const context = pair.key.toString();
+    const parenIndex = context.indexOf("(");
+    const isFunc = parenIndex >= 0 && context.indexOf(")") >= 0;
+    return {
+        label: isFunc ? context.substring(0, parenIndex) : context,
+        description: pair.description,
+        function: isFunc
+    };
+}
+export function trimTokenVector(tokenVector) {
+    let tokenIdx = tokenVector.length;
+    let openParen = 0;
+    while (tokenIdx > 0) {
+        const token = tokenVector[tokenIdx - 1];
+        switch (token.type) {
+            case TokenType.LEFT_PAREN:
+                if (openParen == 0) {
+                    // Encountered an open parenthesis without a closing first, stop here
+                    break;
+                }
+                openParen--;
+                tokenIdx--;
+                continue;
+            case TokenType.RIGHT_PAREN:
+                openParen++;
+                tokenIdx--;
+                continue;
+            case TokenType.IDENTIFIER:
+            case TokenType.DOT:
+            case TokenType.EOF:
+            case TokenType.LEFT_BRACKET:
+            case TokenType.RIGHT_BRACKET:
+            case TokenType.STRING:
+                tokenIdx--;
+                continue;
+        }
+        break;
+    }
+    // Only keep the part of the token vector we're interested in
+    return tokenVector.slice(tokenIdx);
+}
+//# sourceMappingURL=completion.js.map

package/dist/completion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion.js","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAE3D,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,kBAAkB,EAAC,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAC,KAAK,EAAS,SAAS,EAAC,MAAM,SAAS,CAAC;AAChD,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAQhC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAa,EACb,OAAmB,EACnB,kBAAkC,EAClC,SAA2C;IAE3C,MAAM;IACN,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;IAE9B,yHAAyH;IACzH,kEAAkE;IAClE,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAE3D,kCAAkC;IAClC,IAAI,QAAQ,GAAG,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3C,IAAI,QAAQ,IAAI,CAAC,EAAE;QACjB,QAAQ,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE;YACvC,mEAAmE;YACnE,KAAK,SAAS,CAAC,UAAU;gBACvB,QAAQ,EAAE,CAAC;gBACX,MAAM;YAER,KAAK,SAAS,CAAC,MAAM;gBACnB,iDAAiD;gBACjD,OAAO,EAAE,CAAC;SACb;KACF;IAED,IAAI,QAAQ,GAAG,CAAC,EAAE;QAChB,gFAAgF;QAChF,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QAEpC,uBAAuB;QACvB,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAElD,OAAO,MAAM,CAAC;KACf;IAED,4CAA4C;IAC5C,2DAA2D;IAC3D,MAAM,eAAe,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE5D,0DAA0D;IAC1D,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,GAAG,IAAI,MAAM,CAClB,eAAe,EACf,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAC/B,kBAAkB,CACnB,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAEvB,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE7B,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,kBAAkC;IACvD,MAAM,MAAM,GAAqB,EAAE,CAAC;IAEpC,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,GAAG,kBAAkB,CAAC,EAAE;QAChF,MAAM,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,IAAI,CAAC,IAAI;YAChB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;KACJ;IAED,iBAAiB;IACjB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,WAAW,CAAC,OAAuB;IAC1C,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;QACzB,OAAO,CACL,OAAO;aACJ,KAAK,EAAE;aACP,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC;YACvC,gBAAgB;aACf,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAClD,CAAC;KACH;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAqB;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACpC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,UAAU,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE5D,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;QAC1D,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,QAAQ,EAAE,MAAM;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,WAAoB;IAClD,IAAI,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC;IAElC,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,OAAO,QAAQ,GAAG,CAAC,EAAE;QACnB,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;QACxC,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,SAAS,CAAC,UAAU;gBACvB,IAAI,SAAS,IAAI,CAAC,EAAE;oBAClB,qEAAqE;oBACrE,MAAM;iBACP;gBACD,SAAS,EAAE,CAAC;gBACZ,QAAQ,EAAE,CAAC;gBACX,SAAS;YAEX,KAAK,SAAS,CAAC,WAAW;gBACxB,SAAS,EAAE,CAAC;gBACZ,QAAQ,EAAE,CAAC;gBACX,SAAS;YAEX,KAAK,SAAS,CAAC,UAAU,CAAC;YAC1B,KAAK,SAAS,CAAC,GAAG,CAAC;YACnB,KAAK,SAAS,CAAC,GAAG,CAAC;YACnB,KAAK,SAAS,CAAC,YAAY,CAAC;YAC5B,KAAK,SAAS,CAAC,aAAa,CAAC;YAC7B,KAAK,SAAS,CAAC,MAAM;gBACnB,QAAQ,EAAE,CAAC;gBACX,SAAS;SACZ;QAED,MAAM;KACP;IAED,6DAA6D;IAC7D,OAAO,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC"}

package/dist/data/array.d.ts

@@ -0,0 +1,13 @@
+import { ExpressionData, ExpressionDataInterface, Kind } from "./expressiondata";
+export declare class Array implements ExpressionDataInterface {
+    private v;
+    constructor(...data: ExpressionData[]);
+    readonly kind = Kind.Array;
+    primitive: boolean;
+    coerceString(): string;
+    number(): number;
+    add(value: ExpressionData): void;
+    get(index: number): ExpressionData;
+    values(): ExpressionData[];
+}
+//# sourceMappingURL=array.d.ts.map

package/dist/data/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/data/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,uBAAuB,EAAE,IAAI,EAAU,MAAM,kBAAkB,CAAC;AAExF,qBAAa,KAAM,YAAW,uBAAuB;IACnD,OAAO,CAAC,CAAC,CAAwB;gBAErB,GAAG,IAAI,EAAE,cAAc,EAAE;IAMrC,SAAgB,IAAI,cAAc;IAE3B,SAAS,UAAS;IAEzB,YAAY,IAAI,MAAM;IAItB,MAAM,IAAI,MAAM;IAIhB,GAAG,CAAC,KAAK,EAAE,cAAc;IAIzB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc;IAIlC,MAAM,IAAI,cAAc,EAAE;CAG3B"}

package/dist/data/array.js

@@ -0,0 +1,27 @@
+import { Kind, kindStr } from "./expressiondata";
+export class Array {
+    constructor(...data) {
+        this.v = [];
+        this.kind = Kind.Array;
+        this.primitive = false;
+        for (const d of data) {
+            this.add(d);
+        }
+    }
+    coerceString() {
+        return kindStr(this.kind);
+    }
+    number() {
+        return NaN;
+    }
+    add(value) {
+        this.v.push(value);
+    }
+    get(index) {
+        return this.v[index];
+    }
+    values() {
+        return this.v;
+    }
+}
+//# sourceMappingURL=array.js.map

package/dist/data/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../src/data/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,IAAI,EAAE,OAAO,EAAC,MAAM,kBAAkB,CAAC;AAExF,MAAM,OAAO,KAAK;IAGhB,YAAY,GAAG,IAAsB;QAF7B,MAAC,GAAqB,EAAE,CAAC;QAQjB,SAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,cAAS,GAAG,KAAK,CAAC;QAPvB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACb;IACH,CAAC;IAMD,YAAY;QACV,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,OAAO,GAAG,CAAC;IACb,CAAC;IAED,GAAG,CAAC,KAAqB;QACvB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,CAAC,CAAC;IAChB,CAAC;CACF"}

package/dist/data/boolean.d.ts

@@ -0,0 +1,10 @@
+import { ExpressionDataInterface, Kind } from "./expressiondata";
+export declare class BooleanData implements ExpressionDataInterface {
+    readonly value: boolean;
+    constructor(value: boolean);
+    readonly kind = Kind.Boolean;
+    primitive: boolean;
+    coerceString(): string;
+    number(): number;
+}
+//# sourceMappingURL=boolean.d.ts.map

package/dist/data/boolean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../src/data/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAE,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAE/D,qBAAa,WAAY,YAAW,uBAAuB;aAC7B,KAAK,EAAE,OAAO;gBAAd,KAAK,EAAE,OAAO;IAE1C,SAAgB,IAAI,gBAAgB;IAE7B,SAAS,UAAQ;IAExB,YAAY,IAAI,MAAM;IAQtB,MAAM,IAAI,MAAM;CAOjB"}

package/dist/data/boolean.js

@@ -0,0 +1,21 @@
+import { Kind } from "./expressiondata";
+export class BooleanData {
+    constructor(value) {
+        this.value = value;
+        this.kind = Kind.Boolean;
+        this.primitive = true;
+    }
+    coerceString() {
+        if (this.value) {
+            return "true";
+        }
+        return "false";
+    }
+    number() {
+        if (this.value) {
+            return 1;
+        }
+        return 0;
+    }
+}
+//# sourceMappingURL=boolean.js.map

package/dist/data/boolean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../src/data/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAE/D,MAAM,OAAO,WAAW;IACtB,YAA4B,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;QAE1B,SAAI,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,cAAS,GAAG,IAAI,CAAC;IAJqB,CAAC;IAM9C,YAAY;QACV,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,MAAM,CAAC;SACf;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM;QACJ,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,CAAC,CAAC;SACV;QAED,OAAO,CAAC,CAAC;IACX,CAAC;CACF"}

package/dist/data/dictionary.d.ts

@@ -0,0 +1,17 @@
+import { ExpressionData, ExpressionDataInterface, Kind, Pair } from "./expressiondata";
+export declare class Dictionary implements ExpressionDataInterface {
+    private keys;
+    private v;
+    private indexMap;
+    constructor(...pairs: Pair[]);
+    readonly kind = Kind.Dictionary;
+    primitive: boolean;
+    coerceString(): string;
+    number(): number;
+    add(key: string, value: ExpressionData): void;
+    get(key: string): ExpressionData | undefined;
+    values(): ExpressionData[];
+    pairs(): Pair[];
+}
+export declare function isDictionary(x: ExpressionData): x is Dictionary;
+//# sourceMappingURL=dictionary.d.ts.map

package/dist/data/dictionary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary.d.ts","sourceRoot":"","sources":["../../src/data/dictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,uBAAuB,EAAE,IAAI,EAAW,IAAI,EAAC,MAAM,kBAAkB,CAAC;AAE9F,qBAAa,UAAW,YAAW,uBAAuB;IACxD,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,CAAC,CAAwB;IACjC,OAAO,CAAC,QAAQ,CAA+B;gBAEnC,GAAG,KAAK,EAAE,IAAI,EAAE;IAM5B,SAAgB,IAAI,mBAAmB;IAEhC,SAAS,UAAS;IAEzB,YAAY,IAAI,MAAM;IAItB,MAAM,IAAI,MAAM;IAIhB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc;IAUtC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAS5C,MAAM,IAAI,cAAc,EAAE;IAI1B,KAAK,IAAI,IAAI,EAAE;CAShB;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,IAAI,UAAU,CAE/D"}