@saasquatch/program-boilerplate 3.5.11 → 3.5.12-0

package/dist/index.d.ts

@@ -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, 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,6 +1,6 @@
 "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.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; } });
@@ -25,6 +25,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

@@ -67,3 +67,10 @@ export declare function numToEquality(num: number): string;
  * @return object[] The tranformed data that is relavent 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,9 @@
 "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 = require("jsonata");
+const jsonata_paths_extractor_1 = require("@saasquatch/jsonata-paths-extractor");
 /**
  * Append a reward schedule to the template and return the new template
  *
@@ -182,3 +184,47 @@ 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 = [];
+    const getJsonataASTSafe = (expression) => {
+        try {
+            return jsonata(expression).ast();
+        }
+        catch (e) { }
+    };
+    if (typeof jsonataExpressions === "string") {
+        jsonataExpressions = [jsonataExpressions];
+    }
+    for (const expression of jsonataExpressions) {
+        const ast = getJsonataASTSafe(expression);
+        if (!ast)
+            continue;
+        const allPaths = jsonata_paths_extractor_1.default(ast);
+        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);
+            }
+        }
+    }
+    //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-0",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [
@@ -32,6 +32,7 @@
     "typescript": "^3.9.9"
   },
   "dependencies": {
+    "@saasquatch/jsonata-paths-extractor": "^0.1.0-1",
     "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