@stackone/expressions 0.1.0

package/README.md

@@ -0,0 +1,49 @@
+# @stackone/expressions
+## Description
+
+This package can be used to parse and evaluate string expressions with support for variables replacement, functions and operators.
+
+This package uses the tech stack provided by the **Connect Monorepo** global setup. Please check the [root README](../../README.md) for more information.
+
+## Requirements
+
+Please check the [root README](../../README.md) for requirements.
+
+## Installation
+
+```bash
+# install dependencies
+$ npm run install
+```
+
+## Available commands
+
+```bash
+# clean build output
+$ npm run clean
+```
+
+```bash
+# build package
+$ npm run build
+```
+
+```bash
+# run tests
+$ npm run test
+```
+
+```bash
+# run tests on watch mode
+$ npm run test:watch
+```
+
+```bash
+# run linter
+$ npm run lint
+```
+
+```bash
+# run linter and try to fix any error
+$ npm run lint:fix
+```

package/dist/index.es.mjs

@@ -0,0 +1 @@
+import{isObject as r}from"@stackone/utils";import*as t from"jexl";const e=(r=()=>new t.Jexl)=>r(),n=r=>r.replace(/\$\./g,"").trim(),l=(r,t)=>{try{return r.compile(t)}catch(r){return null}},o=(t,o)=>{const c=r(o)?o:{},a=e(),u=n(t),s=l(a,u);return s?s.evalSync(c):null},c=r=>{const t=e(),o=n(r);return!!l(t,o)};export{o as evaluate,c as isValidExpression};

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var e=require("@stackone/utils");function r(e){var r=Object.create(null);return e&&Object.keys(e).forEach((function(t){if("default"!==t){var n=Object.getOwnPropertyDescriptor(e,t);Object.defineProperty(r,t,n.get?n:{enumerable:!0,get:function(){return e[t]}})}})),r.default=e,Object.freeze(r)}var t=r(require("jexl"));const n=(e=()=>new t.Jexl)=>e(),c=e=>e.replace(/\$\./g,"").trim(),u=(e,r)=>{try{return e.compile(r)}catch(e){return null}};exports.evaluate=(r,t)=>{const l=e.isObject(t)?t:{},a=n(),i=c(r),o=u(a,i);return o?o.evalSync(l):null},exports.isValidExpression=e=>{const r=n(),t=c(e);return!!u(r,t)};

package/dist/types/evaluate.d.ts

@@ -0,0 +1 @@
+export declare const evaluateExpression: (expression: string, context?: unknown) => unknown;

package/dist/types/factory.d.ts

@@ -0,0 +1,39 @@
+export declare const createExpressionHandler: (instanceBuilder?: () => {
+    addBinaryOp(operator: string, precedence: number, fn: (left: any, right: any) => any): void;
+    addUnaryOp(operator: string, fn: (right: any) => any): void;
+    addTransform(name: string, fn: (value: any, ...args: any[]) => any): void;
+    addTransforms(map: {
+        [key: string]: (value: any, ...args: any[]) => any;
+    }): void;
+    getTransform(name: string): (value: any, ...args: any[]) => any;
+    addFunction(name: string, fn: (value: any, ...args: any[]) => any): void;
+    addFunctions(map: {
+        [key: string]: (value: any, ...args: any[]) => any;
+    }): void;
+    getFunction(name: string): (value: any, ...args: any[]) => any;
+    eval(expression: string, context?: import("jexl/Expression").Context): Promise<any>;
+    evalSync(expression: string, context?: import("jexl/Expression").Context): any;
+    compile(expression: string): import("jexl/Expression").default;
+    createExpression(expression: string): import("jexl/Expression").default;
+    removeOp(operator: string): void;
+    _grammar: import("jexl/Grammar").default;
+}) => {
+    addBinaryOp(operator: string, precedence: number, fn: (left: any, right: any) => any): void;
+    addUnaryOp(operator: string, fn: (right: any) => any): void;
+    addTransform(name: string, fn: (value: any, ...args: any[]) => any): void;
+    addTransforms(map: {
+        [key: string]: (value: any, ...args: any[]) => any;
+    }): void;
+    getTransform(name: string): (value: any, ...args: any[]) => any;
+    addFunction(name: string, fn: (value: any, ...args: any[]) => any): void;
+    addFunctions(map: {
+        [key: string]: (value: any, ...args: any[]) => any;
+    }): void;
+    getFunction(name: string): (value: any, ...args: any[]) => any;
+    eval(expression: string, context?: import("jexl/Expression").Context): Promise<any>;
+    evalSync(expression: string, context?: import("jexl/Expression").Context): any;
+    compile(expression: string): import("jexl/Expression").default;
+    createExpression(expression: string): import("jexl/Expression").default;
+    removeOp(operator: string): void;
+    _grammar: import("jexl/Grammar").default;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { evaluateExpression as evaluate } from './evaluate';
+export { isValidExpression } from './validate';

package/dist/types/types.d.ts

@@ -0,0 +1,3 @@
+export type ExpressionContext = {
+    [key: string]: unknown;
+};

package/dist/types/utils.d.ts

@@ -0,0 +1,5 @@
+import Expression from 'jexl/Expression';
+export declare const cleanExpression: (expression: string) => string;
+export declare const compileExpression: (expressionHandler: {
+    compile: (expr: string) => Expression;
+}, expression: string) => Expression | null;

package/dist/types/validate.d.ts

@@ -0,0 +1 @@
+export declare const isValidExpression: (expression: string) => boolean;

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@stackone/expressions",
+    "version": "0.1.0",
+    "description": "",
+    "main": "dist/index.js",
+    "module": "dist/index.es.js",
+    "types": "dist/types/index.d.ts",
+    "files": [
+        "dist",
+        "package.json",
+        "README.md"
+    ],
+    "scripts": {
+        "clean": "rimraf dist",
+        "prebuild": "npm run clean",
+        "build": "rollup -c --environment NODE_ENV:production",
+        "prebuild:dev": "npm run clean",
+        "build:dev": "rollup -c --environment NODE_ENV:development",
+        "code:format": "biome format ./src ./*.mjs",
+        "code:format:fix": "biome format --write ./src ./*.mjs",
+        "code:lint": "biome lint --error-on-warnings ./src ./*.mjs",
+        "code:lint:fix": "biome lint --write ./src ./*.mjs",
+        "code:check": "biome check ./src ./*.mjs",
+        "code:check:fix": "biome check --write ./src ./*.mjs",
+        "lint": "npm run code:check",
+        "lint:fix": "npm run code:check:fix",
+        "test": "vitest run",
+        "test:watch": "vitest watch",
+        "publish-release": "npm publish --access=public"
+    },
+    "keywords": [],
+    "author": "StackOne",
+    "license": "ISC",
+    "dependencies": {
+        "jexl": "^2.3.0",
+        "@stackone/utils": "*"
+    },
+    "devDependencies": {
+        "@types/jexl": "^2.3.4"
+    }
+}