fig-tree-evaluator 1.9.0

package/build/typeCheck.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.typeCheck = void 0;
+const helpers_1 = require("./helpers");
+const typeCheckItem = ({ value, name, not = false, expectedType, }) => {
+    let result;
+    if (Array.isArray(expectedType)) {
+        result = expectedType.some((type) => typeCheckItem({ value, name, expectedType: type }) === true);
+        if (not)
+            result = !result;
+        return result ? true : makeErrorString(name, value, expectedType.join('|'), not);
+    }
+    else {
+        const checker = typeCheckMap[expectedType];
+        result = checker(value);
+        if (not)
+            result = !result;
+        return result ? true : makeErrorString(name, value, expectedType, not);
+    }
+};
+const typeCheck = (...args) => {
+    const errorStrings = [];
+    args.forEach((item) => {
+        const result = typeCheckItem(item);
+        if (result !== true)
+            errorStrings.push(result);
+    });
+    return errorStrings.length > 0 ? errorStrings.join('\n') : true;
+};
+exports.typeCheck = typeCheck;
+const typeCheckMap = {
+    string: (value) => typeof value === 'string',
+    number: (value) => typeof value === 'number',
+    boolean: (value) => typeof value === 'boolean',
+    array: (value) => Array.isArray(value),
+    undefined: (value) => value === undefined,
+    null: (value) => value === null,
+    object: (value) => typeof value === 'object' && !Array.isArray(value) && value !== null,
+};
+const makeErrorString = (name, value, type, not) => {
+    if (name !== undefined)
+        return `- Property "${name}" (value: ${stringifyValue(value)}) is not of type: ${not ? `!(${type})` : type}`;
+    return `- ${stringifyValue(value)} is not of type: ${not ? `!(${type})` : type}`;
+};
+const stringifyValue = (value) => {
+    const stringValue = value === undefined || Number.isNaN(value) ? String(value) : JSON.stringify(value);
+    return (0, helpers_1.truncateString)(stringValue, 50);
+};

package/build/types.d.ts

@@ -0,0 +1,53 @@
+import { BasicExtendedNode, SubtractionNode, DivisionNode, ComparatorNode, ConditionalNode, RegexNode, StringSubNode, SplitNode, ObjPropNode, APINode, PGNode, GraphQLNode, BuildObjectNode, FunctionNode, PassThruNode, PGConnection, GraphQLConnection } from './operators';
+import { TypeCheckInput } from './typeCheck';
+export declare const Operators: readonly ["AND", "OR", "EQUAL", "NOT_EQUAL", "PLUS", "SUBTRACT", "MULTIPLY", "DIVIDE", "GREATER_THAN", "LESS_THAN", "CONDITIONAL", "REGEX", "OBJECT_PROPERTIES", "STRING_SUBSTITUTION", "SPLIT", "COUNT", "GET", "POST", "PG_SQL", "GRAPHQL", "BUILD_OBJECT", "CUSTOM_FUNCTIONS", "PASSTHRU"];
+export declare type Operator = typeof Operators[number];
+export declare type GenericObject = {
+    [key: string]: any;
+};
+export interface FigTreeOptions {
+    objects?: GenericObject;
+    functions?: {
+        [key: string]: Function;
+    };
+    pgConnection?: PGConnection;
+    graphQLConnection?: GraphQLConnection;
+    baseEndpoint?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    returnErrorAsString?: boolean;
+    allowJSONStringInput?: boolean;
+    skipRuntimeTypeCheck?: boolean;
+}
+export interface FigTreeConfig {
+    options: FigTreeOptions;
+    operators: OperatorReference;
+    operatorAliases: {
+        [key: string]: Operator;
+    };
+    typeChecker: (...input: TypeCheckInput[]) => void;
+}
+export declare type OutputType = 'string' | 'number' | 'boolean' | 'bool' | 'array';
+export interface BaseOperatorNode {
+    operator: Operator;
+    outputType?: OutputType;
+    children?: Array<EvaluatorNode>;
+    fallback?: any;
+}
+export declare type CombinedOperatorNode = BaseOperatorNode & BasicExtendedNode & SubtractionNode & DivisionNode & ComparatorNode & ConditionalNode & RegexNode & StringSubNode & SplitNode & ObjPropNode & APINode & PGNode & GraphQLNode & BuildObjectNode & FunctionNode & PassThruNode;
+export declare type OperatorNodeUnion = BasicExtendedNode | SubtractionNode | DivisionNode | ComparatorNode | ConditionalNode | RegexNode | StringSubNode | SplitNode | ObjPropNode | PGNode | GraphQLNode | APINode | BuildObjectNode | FunctionNode | PassThruNode;
+export declare type EvaluatorOutput = string | boolean | number | GenericObject | null | undefined | any[];
+export declare type EvaluatorNode = CombinedOperatorNode | EvaluatorOutput;
+export declare type OperatorObject = {
+    requiredProperties: readonly string[];
+    operatorAliases: string[];
+    propertyAliases: {
+        [key: string]: string;
+    };
+    evaluate: (expression: CombinedOperatorNode, config: FigTreeConfig) => Promise<EvaluatorOutput>;
+    parseChildren: (expression: CombinedOperatorNode, config: FigTreeConfig) => OperatorNodeUnion | Promise<OperatorNodeUnion>;
+};
+export declare type OperatorReference = {
+    [key in Operator]: OperatorObject;
+};

package/build/types.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operators = void 0;
+exports.Operators = [
+    'AND',
+    'OR',
+    'EQUAL',
+    'NOT_EQUAL',
+    'PLUS',
+    'SUBTRACT',
+    'MULTIPLY',
+    'DIVIDE',
+    'GREATER_THAN',
+    'LESS_THAN',
+    'CONDITIONAL',
+    'REGEX',
+    'OBJECT_PROPERTIES',
+    'STRING_SUBSTITUTION',
+    'SPLIT',
+    'COUNT',
+    'GET',
+    'POST',
+    'PG_SQL',
+    'GRAPHQL',
+    'BUILD_OBJECT',
+    'CUSTOM_FUNCTIONS',
+    'PASSTHRU',
+];

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "fig-tree-evaluator",
+  "version": "1.9.0",
+  "description": "Module to evaluate JSON-structured expression trees",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "files": [
+    "build/**/*"
+  ],
+  "repository": "git+https://github.com/CarlosNZ/fig-tree.git",
+  "author": "Carl Smith <5456533+CarlosNZ@users.noreply.github.com>",
+  "license": "GPL-3.0",
+  "devDependencies": {
+    "@testing-library/jest-dom": "^5.14.1",
+    "@testing-library/react": "^13.0.0",
+    "@types/jest": "^27.5.1",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "^17.0.38",
+    "@types/pg": "^8.6.5",
+    "dotenv": "^16.0.1",
+    "jest": "^28.1.0",
+    "pg": "^8.7.3",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.3",
+    "ts-node": "^10.8.0",
+    "typescript": "^4.7.2"
+  },
+  "scripts": {
+    "setup": "yarn install && cd demo && yarn install",
+    "test": "jest",
+    "generate": "ts-node ./codegen/buildOperatorAliasReference.ts",
+    "build": "yarn generate && rimraf ./lib && tsc",
+    "dev": "cp -n src/dev/playground_example.ts src/dev/playground.ts || ts-node src/dev/playground.ts",
+    "demo": "cd demo && yarn start"
+  },
+  "dependencies": {
+    "axios": "^0.27.2",
+    "lodash": "^4.17.21",
+    "object-property-extractor": "^1.0.3"
+  },
+  "bugs": {
+    "url": "https://github.com/CarlosNZ/fig-tree/issues"
+  },
+  "homepage": "https://github.com/CarlosNZ/fig-tree#readme"
+}