@saasquatch/program-boilerplate 3.10.1-1 → 3.10.1-2

package/dist/conversion.d.ts

@@ -4,7 +4,7 @@
 /**
  * A custom field based conversion rule
  */
-declare type CustomFieldConversionRule = {
+type CustomFieldConversionRule = {
     operator: number | string;
     fieldName: string;
     value: RuleValue;
@@ -12,7 +12,7 @@ declare type CustomFieldConversionRule = {
 /**
  * An event-based conversion rule
  */
-declare type EventTriggerRule = {
+type EventTriggerRule = {
     operator: string;
     eventKey: string;
     value: string;
@@ -20,7 +20,7 @@ declare type EventTriggerRule = {
 /**
  * A key-value pair
  */
-declare type Event = {
+type Event = {
     key: string;
     fields: {
         [key: string]: any;
@@ -29,7 +29,7 @@ declare type Event = {
 /**
  * A user object returned from a GraphQL query
  */
-declare type UserQueryResult = {
+type UserQueryResult = {
     customFields: {
         [key: string]: any;
     };
@@ -37,7 +37,7 @@ declare type UserQueryResult = {
 /**
  * The value of a rule
  */
-declare type RuleValue = string | boolean | number;
+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.

package/dist/conversion.js

@@ -4,7 +4,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -14,15 +18,27 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.meetEventTriggerRules = exports.meetCustomFieldRules = exports.meetEdgeTriggerConditions = void 0;
+exports.meetEdgeTriggerConditions = meetEdgeTriggerConditions;
+exports.meetCustomFieldRules = meetCustomFieldRules;
+exports.meetEventTriggerRules = meetEventTriggerRules;
 const assert = __importStar(require("assert"));
 const jsonata_1 = require("./jsonata");
 //functions
@@ -66,8 +82,8 @@ function meetEdgeTriggerConditions(fields, activeTrigger) {
         // 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.timeboxedJsonata(field.replace("user.", "previous."), activeTrigger, jsonataTimeoutMs);
-        const { success: currentSuccess, result: currentValue } = jsonata_1.timeboxedJsonata(field, activeTrigger, jsonataTimeoutMs);
+        const { success: prevSuccess, result: previousValue } = (0, jsonata_1.timeboxedJsonata)(field.replace("user.", "previous."), activeTrigger, jsonataTimeoutMs);
+        const { success: currentSuccess, result: currentValue } = (0, jsonata_1.timeboxedJsonata)(field, activeTrigger, jsonataTimeoutMs);
         // one of the JSONata expressions failed to evaluate -- edge field is considered
         // "not passing"
         if (!prevSuccess || !currentSuccess) {
@@ -85,7 +101,6 @@ function meetEdgeTriggerConditions(fields, activeTrigger) {
     }
     return false;
 }
-exports.meetEdgeTriggerConditions = meetEdgeTriggerConditions;
 /**
  * Checks if the customFields of a user meet a certain customField-based conversion rule.
  *
@@ -151,7 +166,6 @@ function meetCustomFieldRules(user, customConversionRules) {
     }
     return customConversionRules.every((rule) => meetCustomFieldCondition(user, rule));
 }
-exports.meetCustomFieldRules = meetCustomFieldRules;
 /**
  * @deprecated No longer in use, use JSONata expression and evaluation instead
  * Checks if the events triggering the program meet every rule that defines event-based conversion
@@ -169,4 +183,3 @@ function meetEventTriggerRules(events, eventTriggerRules) {
     }
     return eventTriggerRules.every((rule) => meetEventCondition(events, rule));
 }
-exports.meetEventTriggerRules = meetEventTriggerRules;

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -11,18 +15,30 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runWebtask = exports.webtask = exports.loadStandardWebtaskConfig = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = exports.timeboxExpression = exports.getRewardUnitsFromJsonata = 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;
+exports.loadStandardWebtaskConfig = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = exports.timeboxExpression = exports.getRewardUnitsFromJsonata = 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;
+exports.webtask = webtask;
+exports.runWebtask = runWebtask;
 const express_1 = __importDefault(require("express"));
 const conversion_1 = require("./conversion");
 Object.defineProperty(exports, "meetCustomFieldRules", { enumerable: true, get: function () { return conversion_1.meetCustomFieldRules; } });
@@ -64,11 +80,11 @@ const logger_3 = require("@saasquatch/logger");
  */
 function webtask(program = {}) {
     const compression = require("compression");
-    const app = express_1.default();
-    const logger = logger_2.getLogger("program-boilerplate");
+    const app = (0, express_1.default)();
+    const logger = (0, logger_2.getLogger)("program-boilerplate");
     app.use(express_1.default.json({ limit: process.env.MAX_PAYLOAD_SIZE || "1mb" }));
     app.use(compression());
-    app.use(logger_3.httpLogMiddleware(logger, { logNonErrorResponses: false }));
+    app.use((0, logger_3.httpLogMiddleware)(logger, { logNonErrorResponses: false }));
     // Enforce HTTPS. The server does not redirect http -> https
     // because OWASP advises not to
     app.use((req, res, next) => {
@@ -92,14 +108,13 @@ function webtask(program = {}) {
     app.get("/livez", healthCheck);
     app.get("/readyz", healthCheck);
     app.post("/*", (req, res) => {
-        const { json, code } = trigger_1.triggerProgram(req.body, program);
+        const { json, code } = (0, trigger_1.triggerProgram)(req.body, program);
         return res.status(code).json(json);
     });
     return app;
 }
-exports.webtask = webtask;
 function runWebtask(webtask, config) {
-    const logger = logger_2.getLogger("program-boilerplate");
+    const logger = (0, logger_2.getLogger)("program-boilerplate");
     const server = webtask.listen(config.port, () => logger.notice(`${config.webtaskName} running on port ${config.port}`));
     if (config.keepAliveTimeoutSeconds !== undefined) {
         // https://cloud.google.com/load-balancing/docs/https/https-logging-monitoring#failure-messages
@@ -123,4 +138,3 @@ function runWebtask(webtask, config) {
     process.on("SIGTERM", gracefulShutdown("SIGTERM"));
     process.on("SIGINT", gracefulShutdown("SIGINT"));
 }
-exports.runWebtask = runWebtask;

package/dist/jsonata.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeboxedJsonata = exports.safeJsonata = exports.timeboxExpression = void 0;
+exports.timeboxExpression = timeboxExpression;
+exports.safeJsonata = safeJsonata;
+exports.timeboxedJsonata = timeboxedJsonata;
 const jsonata_1 = __importDefault(require("jsonata"));
 const logger_1 = require("@saasquatch/logger");
 const TIMEOUT = 5000;
@@ -49,33 +51,30 @@ function timeboxExpression(expr, timeout, maxDepth) {
         checkRunnaway();
     });
 }
-exports.timeboxExpression = timeboxExpression;
 /**
  * @deprecated Use timeboxedJsonata instead
  */
 function safeJsonata(expression, inputData) {
     try {
-        const jsonataQuery = jsonata_1.default(expression);
+        const jsonataQuery = (0, jsonata_1.default)(expression);
         timeboxExpression(jsonataQuery);
         return jsonataQuery.evaluate(inputData);
     }
     catch (e) {
-        logger_1.getLogger("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
+        (0, logger_1.getLogger)("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
     }
 }
-exports.safeJsonata = safeJsonata;
 function timeboxedJsonata(expression, inputData, timeout, maxDepth) {
     try {
-        const jsonataQuery = jsonata_1.default(expression);
+        const jsonataQuery = (0, jsonata_1.default)(expression);
         timeboxExpression(jsonataQuery, timeout, maxDepth);
         const result = jsonataQuery.evaluate(inputData);
         return { success: true, result };
     }
     catch (e) {
         if (e instanceof Error) {
-            logger_1.getLogger("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
+            (0, logger_1.getLogger)("program-boilerplate").warn(`Failed to evaluate JSONata expression: ${e.message}`);
         }
         return { success: false, result: undefined };
     }
 }
-exports.timeboxedJsonata = timeboxedJsonata;

package/dist/logger.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLogLevel = exports.getLogger = void 0;
+exports.getLogger = getLogger;
+exports.setLogLevel = setLogLevel;
 const logger_1 = require("@saasquatch/logger");
 // Lazily initialized logger instance
 let _logger;
@@ -19,12 +20,11 @@ function getLogger(logLevel) {
     if (!logger_1.LOG_LEVELS.includes(logLevel)) {
         logLevel = "info";
     }
-    _logger = logger_1.initializeLogger({
+    _logger = (0, logger_1.initializeLogger)({
         logLevel: logLevel,
     });
     return _logger;
 }
-exports.getLogger = getLogger;
 /**
  * Set the log level of the singleton logger.
  *
@@ -35,4 +35,3 @@ function setLogLevel(logLevel) {
         return;
     _logger.level = logLevel;
 }
-exports.setLogLevel = setLogLevel;

package/dist/queries.js

@@ -185,7 +185,7 @@ exports.nonRewardEmailQueryForNonReferralPrograms = `
   }
 `;
 //context for reward schedule trigger
-exports.rewardScheduleQuery = (emailKey) => {
+const rewardScheduleQuery = (emailKey) => {
     const query = `query ProgramTrigger($programId: ID!) {
     activeTrigger: activeProgramTrigger {
       type
@@ -350,3 +350,4 @@ exports.rewardScheduleQuery = (emailKey) => {
   }`;
     return query;
 };
+exports.rewardScheduleQuery = rewardScheduleQuery;

package/dist/transaction.d.ts

@@ -1,9 +1,9 @@
 import { ProgramTriggerBody } from "./types/rpc";
 import { ProgramType, User } from "./types/saasquatch";
-declare type TransactionContext = {
+type TransactionContext = {
     body: ProgramTriggerBody;
 };
-declare type ReferralRewardInput = {
+type ReferralRewardInput = {
     rewardKey: string;
     user: User;
     referralId: string;
@@ -119,7 +119,7 @@ export default class Transaction {
      */
     toJson(): {
         mutations: any[];
-        programId: any;
+        programId: string;
         analytics: any[];
     };
 }

package/dist/trigger.d.ts

@@ -1,4 +1,4 @@
-import { ProgramTriggerResult, ProgramTriggerBody, ProgramIntrospectionBody, ProgramValidationBody, ProgramVariableSchemaRequestBody, Program } from "./types/rpc";
+import { Program, ProgramIntrospectionBody, ProgramTriggerBody, ProgramTriggerResult, ProgramValidationBody, ProgramVariableSchemaRequestBody } from "./types/rpc";
 /**
  * Triggers the program and returns the result (JSON + HTTP code)
  *

package/dist/trigger.js

@@ -3,9 +3,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.triggerProgram = void 0;
-const transaction_1 = __importDefault(require("./transaction"));
+exports.triggerProgram = triggerProgram;
 const logger_1 = require("@saasquatch/logger");
+const transaction_1 = __importDefault(require("./transaction"));
+function handleTriggerError(triggerType, e) {
+    const stack = typeof e === "object" && e !== null && "stack" in e ? e.stack : undefined;
+    const message = typeof e === "object" && e !== null && "message" in e
+        ? e.message
+        : undefined;
+    const errorMes = {
+        error: `An error occurred in a webtask (${triggerType})`,
+        // consider not returning stack trace for security reasons
+        message: typeof e === "object" && e !== null && "stack" in e ? e.stack : undefined,
+    };
+    (0, logger_1.getLogger)("program-boilerplate").error({
+        message: errorMes.error,
+        ["error.message"]: message,
+        ["error.stack"]: stack,
+    });
+    return errorMes;
+}
 /**
  * Triggers the program and returns the result (JSON + HTTP code)
  *
@@ -40,14 +57,13 @@ function triggerProgram(body, program = {}) {
             return handleProgramVariableSchemaRequest(body, program);
         default:
             const message = `Unrecognized messageType ${body.messageType}`;
-            logger_1.getLogger("program-boilerplate").warn(message);
+            (0, logger_1.getLogger)("program-boilerplate").warn(message);
             return {
                 json: { message },
                 code: 501,
             };
     }
 }
-exports.triggerProgram = triggerProgram;
 /**
  * Trigger the program for the default cases
  *
@@ -70,20 +86,8 @@ function handleProgramTrigger(body, program) {
         };
     }
     catch (e) {
-        const errorMes = {
-            error: "An error occurred in a webtask",
-            // consider not returning stack trace for security reasons
-            message: e.stack,
-        };
-        logger_1.getLogger("program-boilerplate").error({
-            message: errorMes.error,
-            ["error.message"]: e.message,
-            ["error.stack"]: e.stack,
-        });
-        return {
-            json: errorMes,
-            code: 500,
-        };
+        const errorMes = handleTriggerError(triggerType, e);
+        return { json: errorMes, code: 500 };
     }
 }
 /**
@@ -111,20 +115,8 @@ function handleProgramIntrospection(body, program) {
         };
     }
     catch (e) {
-        const errorMes = {
-            error: "An error occurred in a webtask",
-            // consider not returning stack trace for security reasons
-            message: e.stack,
-        };
-        logger_1.getLogger("program-boilerplate").error({
-            message: "Error ocurred in a webtask",
-            ["error.message"]: e.message,
-            ["error.stack"]: e.stack,
-        });
-        return {
-            json: errorMes,
-            code: 500,
-        };
+        const errorMes = handleTriggerError(body.messageType, e);
+        return { json: errorMes, code: 500 };
     }
 }
 /**
@@ -181,15 +173,7 @@ function handleProgramVariableSchemaRequest(body, program) {
             newSchema = handleSchemaRequest(schema, triggerType, scheduleKey);
         }
         catch (e) {
-            const errorMes = {
-                error: "An error occurred in a webtask (PROGRAM_TRIGGER_VARIABLES_SCHEMA_REQUEST)",
-                message: e.stack,
-            };
-            logger_1.getLogger("program-boilerplate").error({
-                message: errorMes.error,
-                ["error.message"]: e.message,
-                ["error.stack"]: e.stack,
-            });
+            handleTriggerError(body.messageType, e);
         }
         if (!newSchema) {
             return {

package/dist/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -11,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.saasquatch = exports.rpc = void 0;
 const rpc = __importStar(require("./rpc"));

package/dist/types/rpc.d.ts

@@ -1,15 +1,20 @@
 import { ProgramTemplateBuilder } from "@saasquatch/schema/types/ProgramTemplate";
 import Transaction from "../transaction";
+import { Referral, RSJsonNode, User, UserEvent } from "./saasquatch";
 /********************************************************/
 /********************************************************/
 /**
  * The different trigger handlers the programs can export
  */
-export declare type TriggerType = "AFTER_USER_CREATED_OR_UPDATED" | "AFTER_USER_EVENT_PROCESSED" | "REFERRAL" | "PROGRAM_INTROSPECTION" | "SCHEDULED" | "REWARD_SCHEDULED" | "PROGRAM_VALIDATION" | "PROGRAM_TRIGGER_VARIABLES_SCHEMA_REQUEST";
+export type ActiveTriggerType = "AFTER_USER_CREATED_OR_UPDATED" | "SCHEDULED" | "REWARD_SCHEDULED" | "REFERRAL" | "AFTER_USER_EVENT_PROCESSED";
+/**
+ * The different trigger handlers the programs can export
+ */
+export type TriggerType = ActiveTriggerType | ("PROGRAM_INTROSPECTION" | "PROGRAM_VALIDATION" | "PROGRAM_TRIGGER_VARIABLES_SCHEMA_REQUEST");
 /**
  * The Program type
  */
-export declare type Program = {
+export type Program = {
     AFTER_USER_CREATED_OR_UPDATED?: ProgramTriggerHandler;
     AFTER_USER_EVENT_PROCESSED?: ProgramTriggerHandler;
     REFERRAL?: ProgramTriggerHandler;
@@ -22,13 +27,24 @@ export declare type Program = {
 /********************************************************/
 /********************************************************/
 /**
- * A JSON request body for the PROGRAM_TRIGGER case. This type
- * may not be complete.
+ * A JSON request body for the PROGRAM_TRIGGER case. Defined in core under ProgramTriggerQuery.graphql
  */
-export declare type ProgramTriggerBody = {
+export type ProgramTriggerBody = {
     messageType: "PROGRAM_TRIGGER";
-    activeTrigger: any;
-    program: any;
+    activeTrigger: {
+        type: ActiveTriggerType;
+        time: number;
+        user: User;
+        previous?: User;
+        events?: UserEvent[];
+        referral?: Referral;
+        [key: string]: any;
+    };
+    program: {
+        id: string;
+        rules: RSJsonNode;
+        templateId: string;
+    };
     tenant: {
         impactBrandId: string | undefined | null;
         settings: {
@@ -37,7 +53,7 @@ export declare type ProgramTriggerBody = {
     };
     ids: string[];
 };
-declare type TenantInfo = {
+type TenantInfo = {
     tenantAlias: string;
     featureFlags?: string[] | null;
     isLiveMode: boolean;
@@ -45,7 +61,7 @@ declare type TenantInfo = {
 /**
  * A JSON request body for the PROGRAM_INTROSPECTION case
  */
-export declare type ProgramIntrospectionBody = {
+export type ProgramIntrospectionBody = {
     messageType: "PROGRAM_INTROSPECTION";
     template: any;
     rules: any;
@@ -57,7 +73,7 @@ export declare type ProgramIntrospectionBody = {
  * to be validated along with the result of the graphql query
  * associated with the requirement
  */
-export declare type ValidationRequest = {
+export type ValidationRequest = {
     key: string;
     queryResult: any;
 };
@@ -65,14 +81,14 @@ export declare type ValidationRequest = {
  * The program information included by the backend for validation
  * requests
  */
-export declare type ValidationProgramField = {
+export type ValidationProgramField = {
     id: string;
     rules: any;
 };
 /**
  * A JSON request body for the PROGRAM_VALIDATION case
  */
-export declare type ProgramValidationBody = {
+export type ProgramValidationBody = {
     messageType: "PROGRAM_VALIDATION";
     validationRequests: ValidationRequest[];
     program: ValidationProgramField;
@@ -82,7 +98,7 @@ export declare type ProgramValidationBody = {
  * The program information provided by the backend for
  * requesting custom schema
  */
-export declare type ProgramVariableSchemaRequestBody = {
+export type ProgramVariableSchemaRequestBody = {
     messageType: "PROGRAM_TRIGGER_VARIABLES_SCHEMA_REQUEST";
     schema: any;
     triggerType: TriggerType;
@@ -93,11 +109,11 @@ export declare type ProgramVariableSchemaRequestBody = {
 /**
  * Handler for the default program trigger cases
  */
-export declare type ProgramTriggerHandler = (transaction: Transaction) => void;
+export type ProgramTriggerHandler = (transaction: Transaction) => void;
 /**
  * Output of program introspection
  */
-export declare type ProgramIntrospectionResponse = ProgramTemplateBuilder | {
+export type ProgramIntrospectionResponse = ProgramTemplateBuilder | {
     template: ProgramTemplateBuilder;
     errors?: {
         key: string;
@@ -108,7 +124,7 @@ export declare type ProgramIntrospectionResponse = ProgramTemplateBuilder | {
 /**
  * Introspection handler
  */
-export declare type ProgramIntrospectionHandler = (template: ProgramTemplateBuilder, rules: any, program: any, tenant: TenantInfo) => ProgramIntrospectionResponse;
+export type ProgramIntrospectionHandler = (template: ProgramTemplateBuilder, rules: any, program: any, tenant: TenantInfo) => ProgramIntrospectionResponse;
 /**
  * Handler for an individual program requirement validation.
  * Handlers will be exported as key-value pairs in the
@@ -117,13 +133,13 @@ export declare type ProgramIntrospectionHandler = (template: ProgramTemplateBuil
  * that will be used to compute the `queryResult` parameter for this
  * function.
  */
-export declare type RequirementValidationHandler = (queryResult: any, program: ValidationProgramField, time: number) => RequirementValidationResult[];
-export declare type ProgramVariableSchemaHandler = (schema: any, triggerType: TriggerType, scheduleKey?: string) => ProgramVariableSchemaResult;
+export type RequirementValidationHandler = (queryResult: any, program: ValidationProgramField, time: number) => RequirementValidationResult[];
+export type ProgramVariableSchemaHandler = (schema: any, triggerType: TriggerType, scheduleKey?: string) => ProgramVariableSchemaResult;
 /**
  * Key-value list of validation functions to be exported by
  * the program
  */
-declare type ProgramValidationFunctions = {
+type ProgramValidationFunctions = {
     [key: string]: RequirementValidationHandler;
 };
 /********************************************************/
@@ -134,14 +150,14 @@ declare type ProgramValidationFunctions = {
  * calculated by the boilerplate depending on the result
  * of the trigger.
  */
-export declare type ProgramTriggerResult = {
+export type ProgramTriggerResult = {
     json: any;
     code: number;
 };
 /**
  * A result for an individual program requirement check
  */
-export declare type RequirementValidationResult = {
+export type RequirementValidationResult = {
     message: string;
     longDescription: string;
     status: "ERROR" | "WARN" | "SUCCESS";
@@ -151,11 +167,11 @@ export declare type RequirementValidationResult = {
  * The key provided here corresponds to a key from the
  * `ProgramRequirement` type from below.
  */
-export declare type ValidationResult = {
+export type ValidationResult = {
     key: string;
     results: RequirementValidationResult[];
 };
-export declare type ProgramVariableSchemaResult = {
+export type ProgramVariableSchemaResult = {
     schema: any;
 };
 /********************************************************/
@@ -163,7 +179,7 @@ export declare type ProgramVariableSchemaResult = {
 /**
  * A program requirement
  */
-export declare type ProgramRequirement = {
+export type ProgramRequirement = {
     key: string;
     name: string;
     description: string;
@@ -173,4 +189,12 @@ export declare type ProgramRequirement = {
         [key: string]: any;
     };
 };
+export type TriggerSchemaObject = {
+    type: ProgramTriggerBody["activeTrigger"]["type"];
+    time: ProgramTriggerBody["activeTrigger"]["time"];
+    user: ProgramTriggerBody["activeTrigger"]["user"];
+    previous?: User;
+    event?: UserEvent;
+    referral?: Referral;
+};
 export {};

package/dist/types/saasquatch.d.ts

@@ -1,20 +1,69 @@
 /**
  * A program type
  */
-export declare type ProgramType = "ACQUISITION" | "LOYALTY" | "RETENTION";
+export type ProgramType = "ACQUISITION" | "LOYALTY" | "RETENTION";
+export type RSJsonNode = any;
 /**
- * A referral. This type is not complete and is only
- * used internally by the programs.
+ * Defined in core under ProgramTriggerQuery.graphql
  */
-export declare type Referral = {
+export type User = {
     id: string;
+    accountId: string;
+    firstName?: string;
+    lastName?: string;
+    referredByReferral?: Referral;
+    [key: string]: any;
 };
 /**
- * A user. This type is not complete and is only
- * used internally by the programs.
+ * Defined in core under ProgramTriggerQuery.graphql
  */
-export declare type User = {
+export type UserEvent = {
+    key: string;
     id: string;
-    accountId: string;
-    referredByReferral: Referral;
+    fields: RSJsonNode;
+    isModification: boolean;
+    dateTriggered?: number;
+    dateReceived?: number;
+    dateProcessed?: number;
+};
+/**
+ * Defined in core under ProgramTriggerQuery.graphql
+ */
+export type UserReward = {
+    id: string;
+    dateGiven?: number;
+    dateExpires?: number;
+    dateCancelled?: number;
+    programId?: string;
+    programRewardKey?: string;
+    referralId?: string;
+};
+/**
+ * Defined in core under ProgramTriggerQuery.graphql
+ */
+export type FraudFlag = "IP" | "EMAIL" | "NAME" | "RATE" | "DAILY_REFERRAL_REWARD_LIMIT" | "TEMP_EMAIL" | "BLOCKED_USER" | "BLOCKED_IP";
+/**
+ * Defined in core under ProgramTriggerQuery.graphql
+ */
+export type Referral = {
+    id: string;
+    moderationStatus?: "PENDING" | "ACTIONED";
+    referrerModerationStatus?: "PENDING" | "APPROVED" | "DENIED";
+    referredModerationStatus?: "PENDING" | "APPROVED" | "DENIED";
+    dateReferralStarted?: number;
+    dateFraudChecksCompleted?: number;
+    dateConverted?: number;
+    fraudSignals?: any;
+    fraudFlags: {
+        type: FraudFlag;
+        message: string;
+    }[];
+    isFraudExempt: boolean;
+    referrerUser: User & {
+        rewards: {
+            totalCount: number;
+            data: UserReward[];
+        };
+    };
+    rewards: UserReward[];
 };

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
-import { ProgramTriggerBody } from "./types/rpc";
+import { ProgramTriggerBody, TriggerSchemaObject } from "./types/rpc";
 import jsonata from "jsonata";
-export declare type WebtaskConfig = {
+export type WebtaskConfig = {
     port: number;
     webtaskName: string;
     keepAliveTimeoutSeconds: number;
@@ -74,7 +74,7 @@ export declare function numToEquality(num: number): string;
  * @param body the body of the trigger
  * @return object[] The transformed data that is relevant for the trigger type
  */
-export declare function getTriggerSchema(body: ProgramTriggerBody): object[];
+export declare function getTriggerSchema(body: ProgramTriggerBody): TriggerSchemaObject[];
 /**
  * Parses JSONata expressions and finds user custom fields used in the expression(s)
  *

package/dist/utils.js

@@ -3,7 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRewardUnitsFromJsonata = exports.getUserCustomFieldsFromJsonata = exports.getTriggerSchema = exports.numToEquality = exports.inferType = exports.getGoalAnalyticTimestamp = exports.setRewardSchedule = exports.loadStandardWebtaskConfig = void 0;
+exports.loadStandardWebtaskConfig = loadStandardWebtaskConfig;
+exports.setRewardSchedule = setRewardSchedule;
+exports.getGoalAnalyticTimestamp = getGoalAnalyticTimestamp;
+exports.inferType = inferType;
+exports.numToEquality = numToEquality;
+exports.getTriggerSchema = getTriggerSchema;
+exports.getUserCustomFieldsFromJsonata = getUserCustomFieldsFromJsonata;
+exports.getRewardUnitsFromJsonata = getRewardUnitsFromJsonata;
 const queries_1 = require("./queries");
 const jsonata_paths_extractor_1 = __importDefault(require("@saasquatch/jsonata-paths-extractor"));
 function loadStandardWebtaskConfig() {
@@ -29,7 +36,6 @@ function loadStandardWebtaskConfig() {
         terminationDelaySeconds,
     };
 }
-exports.loadStandardWebtaskConfig = loadStandardWebtaskConfig;
 /**
  * Append a reward schedule to the template and return the new template
  *
@@ -48,7 +54,7 @@ function setRewardSchedule({ template, expiryWarningDays, key, emailKey, periodI
             filter: {
                 dateExpires_timeframe,
             },
-            query: queries_1.rewardScheduleQuery(emailKey),
+            query: (0, queries_1.rewardScheduleQuery)(emailKey),
             periodInHours,
         };
         const currentSchedules = template.schedules;
@@ -62,7 +68,6 @@ function setRewardSchedule({ template, expiryWarningDays, key, emailKey, periodI
         return template;
     }
 }
-exports.setRewardSchedule = setRewardSchedule;
 /**
  * Returns the appropriate timestamp based on the trigger.
  * If the trigger includes a purchase event, the timestamp
@@ -79,7 +84,6 @@ function getGoalAnalyticTimestamp(trigger) {
         : undefined;
     return purchaseEvent ? purchaseEvent.dateTriggered - 1 : trigger.time;
 }
-exports.getGoalAnalyticTimestamp = getGoalAnalyticTimestamp;
 /**
  * Translates a string type into its proper JavaScript type.
  * Supports conversion to number, boolean, null and undefined values.
@@ -144,7 +148,6 @@ function inferType(val) {
             return 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
@@ -163,13 +166,13 @@ function numToEquality(num) {
             return "eq";
     }
 }
-exports.numToEquality = numToEquality;
 /**
  * Converts a trigger context into the relevant information for the specified trigger type.
  * @param body the body of the trigger
  * @return object[] The transformed data that is relevant for the trigger type
  */
 function getTriggerSchema(body) {
+    var _a;
     const activeTrigger = body.activeTrigger;
     const triggerType = activeTrigger.type;
     const standardData = {
@@ -187,17 +190,7 @@ function getTriggerSchema(body) {
                 Object.assign(Object.assign({}, standardData), { referral: activeTrigger.referral }),
             ];
         case "AFTER_USER_EVENT_PROCESSED":
-            let contexts = [];
-            activeTrigger.events.forEach((event) => {
-                contexts.push(Object.assign(Object.assign({}, standardData), { event: {
-                        key: event.key,
-                        id: event.id,
-                        isModification: event.isModification,
-                        dateTriggered: event.dateTriggered,
-                        fields: event.fields,
-                    } }));
-            });
-            return contexts;
+            return ((_a = activeTrigger.events) !== null && _a !== void 0 ? _a : []).map((event) => (Object.assign(Object.assign({}, standardData), { event })));
         case "SCHEDULED":
             return [
                 Object.assign({}, standardData),
@@ -210,7 +203,6 @@ function getTriggerSchema(body) {
             throw new Error("Trigger type did not match expected options");
     }
 }
-exports.getTriggerSchema = getTriggerSchema;
 /**
  * Parses JSONata expressions and finds user custom fields used in the expression(s)
  *
@@ -224,7 +216,7 @@ function getUserCustomFieldsFromJsonata(jsonataExpressions) {
     }
     for (const expression of jsonataExpressions) {
         try {
-            const allPaths = jsonata_paths_extractor_1.default(expression);
+            const allPaths = (0, jsonata_paths_extractor_1.default)(expression);
             for (const path of allPaths) {
                 if (path.startsWith("/user/customFields/")) {
                     const key = path.split("/")[3];
@@ -250,7 +242,6 @@ function getUserCustomFieldsFromJsonata(jsonataExpressions) {
     //dedup
     return Array.from(new Set(userCustomFields));
 }
-exports.getUserCustomFieldsFromJsonata = getUserCustomFieldsFromJsonata;
 function getRewardUnitsFromJsonata(expr) {
     if (expr === undefined) {
         return undefined;
@@ -270,4 +261,3 @@ function getRewardUnitsFromJsonata(expr) {
         }
     }
 }
-exports.getRewardUnitsFromJsonata = getRewardUnitsFromJsonata;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@saasquatch/program-boilerplate",
-  "version": "3.10.1-1",
+  "version": "3.10.1-2",
   "description": "Boilerplate for writing programs",
   "main": "dist/index.js",
   "files": [
     "dist/"
   ],
   "engines": {
-    "node": "^18 || ^20 || ^22"
+    "node": "^20 || ^22 || ^24"
   },
   "scripts": {
     "build": "tsc --declaration",
@@ -28,27 +28,27 @@
     "source-map": "^0.7.4"
   },
   "devDependencies": {
-    "@types/express": "^4.17.11",
-    "@types/node": "^13.13.50",
+    "@types/express": "^4.17.25",
+    "@types/node": "^24.10.0",
     "@types/supertest": "^2.0.11",
-    "jest": "^26.6.3",
-    "jest-cucumber": "^3.0.1",
+    "jest": "^30.2.0",
+    "jest-cucumber": "^4.5.0",
     "prettier": "^2.2.1",
     "source-map": "^0.7.4",
     "supertest": "^6.1.3",
-    "ts-jest": "^26.5.5",
-    "ts-node": "^9.1.1",
+    "ts-jest": "^29.4.5",
+    "ts-node": "^10.9.2",
     "typedoc": "^0.17.8",
-    "typescript": "^3.9.9"
+    "typescript": "^5.9.3"
   },
   "dependencies": {
     "@saasquatch/jsonata-paths-extractor": "^1.0.1",
-    "@saasquatch/logger": "^1.5.1",
+    "@saasquatch/logger": "^2.0.0",
     "@saasquatch/schema": "^2.0.0",
     "bson-objectid": "^1.3.1",
     "compression": "^1.7.4",
     "express": "^4.17.1",
     "jsonata": "^1.8.4",
-    "winston": "^3.3.3"
+    "winston": "^3.18.3"
   }
 }