@saasquatch/program-boilerplate 3.5.12-1 → 3.6.0-1

package/dist/conversion.d.ts

@@ -38,6 +38,16 @@ declare type UserQueryResult = {
  * The value of a rule
  */
 declare type RuleValue = string | boolean | number;
+/**
+ * Checks whether any of the edge trigger conditions are met given
+ * a list of fields to check and the current context.
+ *
+ * @param {string[] | undefined} fields The list of edge trigger fields
+ * @param {any} activeTrigger The current program `activeTrigger`
+ *
+ * @return {boolean} Whether any of the edge fields have changed
+ */
+export declare function meetEdgeTriggerConditions(fields: string[] | undefined, activeTrigger: any): boolean;
 /**
  * @deprecated No longer in use, use JSONata expression and evaluation instead
  * Checks if the customFields of the user meet every rule that defines customFields-based conversion

package/dist/conversion.js

@@ -3,7 +3,9 @@
  * @module conversion
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.meetEventTriggerRules = exports.meetCustomFieldRules = void 0;
+exports.meetEventTriggerRules = exports.meetCustomFieldRules = exports.meetEdgeTriggerConditions = void 0;
+const assert = require("assert");
+const jsonata_1 = require("./jsonata");
 //functions
 /**
  * Turns a string scalar into a Number, Boolean or String
@@ -23,6 +25,48 @@ function parseValue(value) {
     }
     return value;
 }
+/**
+ * Checks whether any of the edge trigger conditions are met given
+ * a list of fields to check and the current context.
+ *
+ * @param {string[] | undefined} fields The list of edge trigger fields
+ * @param {any} activeTrigger The current program `activeTrigger`
+ *
+ * @return {boolean} Whether any of the edge fields have changed
+ */
+function meetEdgeTriggerConditions(fields, activeTrigger) {
+    if (fields === undefined || fields.length === 0) {
+        return true;
+    }
+    for (const field of fields) {
+        if (!field.startsWith("user.")) {
+            // we consider a malformed edge field to be "not passing"
+            return false;
+        }
+        // a simple query to retrieve the value of a field from the user should
+        // not take more than a few milliseconds. if it takes longer than 500ms
+        // something is definitely wrong with the query
+        const jsonataTimeoutMs = 500;
+        const { success: prevSuccess, result: previousValue } = jsonata_1.safeJsonata2(field.replace("user.", "previous."), activeTrigger, jsonataTimeoutMs);
+        const { success: currentSuccess, result: currentValue } = jsonata_1.safeJsonata2(field, activeTrigger, jsonataTimeoutMs);
+        // one of the JSONata expressions failed to evaluate -- edge field is considered
+        // "not passing"
+        if (!prevSuccess || !currentSuccess) {
+            return false;
+        }
+        try {
+            assert.deepStrictEqual(currentValue, previousValue);
+            // assertion passed -- field did not change
+            // continue on to other fields and see if any changed
+        }
+        catch (_e) {
+            // assertion failed -- field must have changed
+            return true;
+        }
+    }
+    return false;
+}
+exports.meetEdgeTriggerConditions = meetEdgeTriggerConditions;
 /**
  * Checks if the customFields of a user meet a certain customField-based conversion rule.
  *

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as express from "express";
-import { meetCustomFieldRules, meetEventTriggerRules } from "./conversion";
+import { meetCustomFieldRules, meetEventTriggerRules, meetEdgeTriggerConditions } from "./conversion";
 import { rewardEmailQuery } from "./queries";
 import Transaction from "./transaction";
 import { triggerProgram } from "./trigger";
@@ -10,7 +10,7 @@ import { timeboxExpression, safeJsonata } from "./jsonata";
 import { ProgramType } from "./types/saasquatch";
 import { inferType, getGoalAnalyticTimestamp, setRewardSchedule, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata } from "./utils";
 export { types };
-export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, timeboxExpression, safeJsonata, getLogger, setLogLevel, };
+export { Transaction, ProgramTriggerBody, Program, ProgramType, RequirementValidationResult, ProgramRequirement, ValidationProgramField, meetEventTriggerRules, meetCustomFieldRules, meetEdgeTriggerConditions, rewardEmailQuery, setRewardSchedule, getGoalAnalyticTimestamp, triggerProgram, inferType, numToEquality, getTriggerSchema, getUserCustomFieldsFromJsonata, timeboxExpression, safeJsonata, getLogger, setLogLevel, };
 /**
  * Returns an express server that serves the provided handlers
  * as a program

package/dist/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxExpression = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.triggerProgram = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.rewardEmailQuery = exports.meetCustomFieldRules = exports.meetEventTriggerRules = exports.Transaction = exports.types = void 0;
+exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxExpression = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.triggerProgram = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.rewardEmailQuery = exports.meetEdgeTriggerConditions = exports.meetCustomFieldRules = exports.meetEventTriggerRules = exports.Transaction = exports.types = void 0;
 const express = require("express");
 const conversion_1 = require("./conversion");
 Object.defineProperty(exports, "meetCustomFieldRules", { enumerable: true, get: function () { return conversion_1.meetCustomFieldRules; } });
 Object.defineProperty(exports, "meetEventTriggerRules", { enumerable: true, get: function () { return conversion_1.meetEventTriggerRules; } });
+Object.defineProperty(exports, "meetEdgeTriggerConditions", { enumerable: true, get: function () { return conversion_1.meetEdgeTriggerConditions; } });
 const queries_1 = require("./queries");
 Object.defineProperty(exports, "rewardEmailQuery", { enumerable: true, get: function () { return queries_1.rewardEmailQuery; } });
 const transaction_1 = require("./transaction");

package/dist/jsonata.d.ts

@@ -7,5 +7,9 @@ import * as jsonata from "jsonata";
  * @param {Number} timeout - max time in ms
  * @param {Number} maxDepth - max stack depth
  */
-export declare function timeboxExpression(expr: jsonata.Expression): void;
+export declare function timeboxExpression(expr: jsonata.Expression, timeout?: number, maxDepth?: number): void;
 export declare function safeJsonata(expression: string, inputData: any): any;
+export declare function safeJsonata2(expression: string, inputData: any, timeout?: number, maxDepth?: number): {
+    success: boolean;
+    result: any;
+};

package/dist/jsonata.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJsonata = exports.timeboxExpression = void 0;
+exports.safeJsonata2 = exports.safeJsonata = exports.timeboxExpression = void 0;
 const jsonata = require("jsonata");
 const logger_1 = require("./logger");
 const TIMEOUT = 5000;
@@ -14,19 +14,21 @@ const logger = logger_1.getLogger(process.env.PROGRAM_LOG_LEVEL || "debug");
  * @param {Number} timeout - max time in ms
  * @param {Number} maxDepth - max stack depth
  */
-function timeboxExpression(expr) {
-    let depth = 0;
-    const time = Date.now();
-    let checkRunnaway = function () {
-        if (depth > MAXDEPTH) {
+function timeboxExpression(expr, timeout, maxDepth) {
+    const startTime = Date.now();
+    const actualTimeout = timeout !== null && timeout !== void 0 ? timeout : TIMEOUT;
+    const actualMaxDepth = maxDepth !== null && maxDepth !== void 0 ? maxDepth : MAXDEPTH;
+    let currentDepth = 0;
+    const checkRunnaway = function () {
+        if (currentDepth > actualMaxDepth) {
             // stack too deep
             throw {
                 code: "U1001",
-                message: "Stack overflow error: Check for non-terminating recursive function.  Consider rewriting as tail-recursive.",
+                message: "Stack overflow error: Check for non-terminating recursive function. Consider rewriting as tail-recursive.",
                 stack: new Error().stack,
             };
         }
-        if (Date.now() - time > TIMEOUT) {
+        if (Date.now() - startTime > actualTimeout) {
             // expression has run for too long
             throw {
                 code: "U1002",
@@ -36,12 +38,12 @@ function timeboxExpression(expr) {
         }
     };
     // register callbacks
-    expr.assign("__evaluate_entry", function (expr, input, environment) {
-        depth++;
+    expr.assign("__evaluate_entry", () => {
+        currentDepth++;
         checkRunnaway();
     });
-    expr.assign("__evaluate_exit", function (expr, input, environment, result) {
-        depth--;
+    expr.assign("__evaluate_exit", () => {
+        currentDepth--;
         checkRunnaway();
     });
 }
@@ -57,3 +59,18 @@ function safeJsonata(expression, inputData) {
     }
 }
 exports.safeJsonata = safeJsonata;
+function safeJsonata2(expression, inputData, timeout, maxDepth) {
+    try {
+        const jsonataQuery = jsonata(expression);
+        timeboxExpression(jsonataQuery, timeout, maxDepth);
+        const result = jsonataQuery.evaluate(inputData);
+        return { success: true, result };
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            logger.warn(`Failed to evaluate JSONata expression: ${e.message}`);
+        }
+        return { success: false, result: undefined };
+    }
+}
+exports.safeJsonata2 = safeJsonata2;

package/dist/utils.d.ts

@@ -56,15 +56,15 @@ export declare function getGoalAnalyticTimestamp(trigger: any): number;
 export declare function inferType(val: string): any;
 /**
  * Converts a number representation of a conversion operator set in program
- * rules to a string that can be user in a graphQL query
- * @param num the conversion criteria set in a program
+ * rules to a string that can be user in a GraphQL query
+ * @param {number} num conversion criteria set in a program
  * @return {string} the string representation of the conversion operator
  */
 export declare function numToEquality(num: number): string;
 /**
- * Converts a trigger context into the relavent information for the specified trigger type.
+ * Converts a trigger context into the relevant information for the specified trigger type.
  * @param body the body of the trigger
- * @return object[] The tranformed data that is relavent for the trigger type
+ * @return object[] The transformed data that is relevant for the trigger type
  */
 export declare function getTriggerSchema(body: ProgramTriggerBody): object[];
 /**

package/dist/utils.js

@@ -120,8 +120,8 @@ function inferType(val) {
 exports.inferType = inferType;
 /**
  * Converts a number representation of a conversion operator set in program
- * rules to a string that can be user in a graphQL query
- * @param num the conversion criteria set in a program
+ * rules to a string that can be user in a GraphQL query
+ * @param {number} num conversion criteria set in a program
  * @return {string} the string representation of the conversion operator
  */
 function numToEquality(num) {
@@ -138,9 +138,9 @@ function numToEquality(num) {
 }
 exports.numToEquality = numToEquality;
 /**
- * Converts a trigger context into the relavent information for the specified trigger type.
+ * Converts a trigger context into the relevant information for the specified trigger type.
  * @param body the body of the trigger
- * @return object[] The tranformed data that is relavent for the trigger type
+ * @return object[] The transformed data that is relevant for the trigger type
  */
 function getTriggerSchema(body) {
     const activeTrigger = body.activeTrigger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasquatch/program-boilerplate",
-  "version": "3.5.12-1",
+  "version": "3.6.0-1",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [