@saasquatch/program-boilerplate 3.5.11 → 3.5.12-2

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 = require("jsonata");
 //functions
 /**
  * Turns a string scalar into a Number, Boolean or String
@@ -23,6 +25,39 @@ 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.")) {
+            // TODO: what to do here? this is probably some kind of error case
+            continue;
+        }
+        const previousValue = jsonata(field.replace("user.", "previous.")).evaluate(activeTrigger);
+        const currentValue = jsonata(field).evaluate(activeTrigger);
+        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";
@@ -8,9 +8,9 @@ import * as types from "./types";
 import { Program, ProgramRequirement, RequirementValidationResult, ValidationProgramField, ProgramTriggerBody } from "./types/rpc";
 import { timeboxExpression, safeJsonata } from "./jsonata";
 import { ProgramType } from "./types/saasquatch";
-import { inferType, getGoalAnalyticTimestamp, setRewardSchedule, numToEquality, getTriggerSchema } from "./utils";
+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, 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.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");
@@ -25,6 +26,7 @@ Object.defineProperty(exports, "getGoalAnalyticTimestamp", { enumerable: true, g
 Object.defineProperty(exports, "setRewardSchedule", { enumerable: true, get: function () { return utils_1.setRewardSchedule; } });
 Object.defineProperty(exports, "numToEquality", { enumerable: true, get: function () { return utils_1.numToEquality; } });
 Object.defineProperty(exports, "getTriggerSchema", { enumerable: true, get: function () { return utils_1.getTriggerSchema; } });
+Object.defineProperty(exports, "getUserCustomFieldsFromJsonata", { enumerable: true, get: function () { return utils_1.getUserCustomFieldsFromJsonata; } });
 /**
  * Returns an express server that serves the provided handlers
  * as a program

package/dist/utils.d.ts

@@ -56,14 +56,21 @@ 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[];
+/**
+ * Parses JSONata expressions and finds user custom fields used in the expression(s)
+ *
+ * @param jsonataExpressions string | string[] input JSONata expression(s)
+ * @returns string[] a deduplicated list of user custom fields found in the input expression(s)
+ */
+export declare function getUserCustomFieldsFromJsonata(jsonataExpressions: string | string[]): string[];

package/dist/utils.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = void 0;
+exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = void 0;
 const queries_1 = require("./queries");
+const jsonata_paths_extractor_1 = require("@saasquatch/jsonata-paths-extractor");
 /**
  * Append a reward schedule to the template and return the new template
  *
@@ -119,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) {
@@ -137,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;
@@ -182,3 +183,43 @@ function getTriggerSchema(body) {
     }
 }
 exports.getTriggerSchema = getTriggerSchema;
+/**
+ * Parses JSONata expressions and finds user custom fields used in the expression(s)
+ *
+ * @param jsonataExpressions string | string[] input JSONata expression(s)
+ * @returns string[] a deduplicated list of user custom fields found in the input expression(s)
+ */
+function getUserCustomFieldsFromJsonata(jsonataExpressions) {
+    let userCustomFields = [];
+    if (typeof jsonataExpressions === "string") {
+        jsonataExpressions = [jsonataExpressions];
+    }
+    for (const expression of jsonataExpressions) {
+        try {
+            const allPaths = jsonata_paths_extractor_1.default(expression);
+            for (const path of allPaths) {
+                if (path.startsWith("/user/customFields/")) {
+                    const key = path.split("/")[3];
+                    if (key)
+                        userCustomFields.push(key);
+                }
+                if (path.startsWith("/user/referredByReferral/referrerUser/customFields/")) {
+                    const key = path.split("/")[5];
+                    if (key)
+                        userCustomFields.push(key);
+                }
+                if (path.startsWith("/referral/referrerUser/customFields/")) {
+                    const key = path.split("/")[4];
+                    if (key)
+                        userCustomFields.push(key);
+                }
+            }
+        }
+        catch (e) {
+            continue;
+        }
+    }
+    //dedup
+    return Array.from(new Set(userCustomFields));
+}
+exports.getUserCustomFieldsFromJsonata = getUserCustomFieldsFromJsonata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saasquatch/program-boilerplate",
-  "version": "3.5.11",
+  "version": "3.5.12-2",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [
@@ -32,6 +32,7 @@
     "typescript": "^3.9.9"
   },
   "dependencies": {
+    "@saasquatch/jsonata-paths-extractor": "^1.0.0-0",
     "bson-objectid": "^1.3.1",
     "compression": "^1.7.4",
     "express": "^4.17.1",

package/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [3.5.11] - 2021-12-1
-
-- Set default payload size limit to 1mb
-- Added MAX_PAYLOAD_SIZE env var to allow easier configuration
-- Fixes payload too large error that can occur during introspection
-
-## [3.5.9] - 2021-10-20
-
-### Added
-
-- Added CHANGELOG.md
-- Added referrer/referred emails to the email context query so they can be used in email templates
-
-### Changed
-
-### Removed
-
-[unreleased]: https://github.com/saasquatch/program-tools/compare/%40saasquatch/program-boilerplate%403.5.9...HEAD
-[3.5.9]: https://github.com/saasquatch/program-tools/releases/tag/%40saasquatch/program-boilerplate%403.5.9