@saasquatch/program-boilerplate 3.6.0-1 → 3.6.1-0

package/dist/conversion.js

@@ -2,9 +2,28 @@
 /**
  * @module conversion
  */
+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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.meetEventTriggerRules = exports.meetCustomFieldRules = exports.meetEdgeTriggerConditions = void 0;
-const assert = require("assert");
+const assert = __importStar(require("assert"));
 const jsonata_1 = require("./jsonata");
 //functions
 /**
@@ -47,8 +66,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.safeJsonata2(field.replace("user.", "previous."), activeTrigger, jsonataTimeoutMs);
-        const { success: currentSuccess, result: currentValue } = jsonata_1.safeJsonata2(field, activeTrigger, jsonataTimeoutMs);
+        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);
         // one of the JSONata expressions failed to evaluate -- edge field is considered
         // "not passing"
         if (!prevSuccess || !currentSuccess) {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as express from "express";
+import express from "express";
 import { meetCustomFieldRules, meetEventTriggerRules, meetEdgeTriggerConditions } from "./conversion";
 import { rewardEmailQuery } from "./queries";
 import Transaction from "./transaction";
@@ -6,11 +6,11 @@ import { triggerProgram } from "./trigger";
 import { getLogger, setLogLevel } from "./logger";
 import * as types from "./types";
 import { Program, ProgramRequirement, RequirementValidationResult, ValidationProgramField, ProgramTriggerBody } from "./types/rpc";
-import { timeboxExpression, safeJsonata } from "./jsonata";
+import { timeboxExpression, timeboxedJsonata, 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, meetEdgeTriggerConditions, 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, timeboxedJsonata, safeJsonata, getLogger, setLogLevel, };
 /**
  * Returns an express server that serves the provided handlers
  * as a program

package/dist/index.js

@@ -1,24 +1,47 @@
 "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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 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.meetEdgeTriggerConditions = exports.meetCustomFieldRules = exports.meetEventTriggerRules = exports.Transaction = exports.types = void 0;
-const express = require("express");
+exports.webtask = exports.setLogLevel = exports.getLogger = exports.safeJsonata = exports.timeboxedJsonata = 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_1 = __importDefault(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");
+const transaction_1 = __importDefault(require("./transaction"));
 exports.Transaction = transaction_1.default;
 const trigger_1 = require("./trigger");
 Object.defineProperty(exports, "triggerProgram", { enumerable: true, get: function () { return trigger_1.triggerProgram; } });
 const logger_1 = require("./logger");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return logger_1.getLogger; } });
 Object.defineProperty(exports, "setLogLevel", { enumerable: true, get: function () { return logger_1.setLogLevel; } });
-const types = require("./types");
+const types = __importStar(require("./types"));
 exports.types = types;
 const jsonata_1 = require("./jsonata");
 Object.defineProperty(exports, "timeboxExpression", { enumerable: true, get: function () { return jsonata_1.timeboxExpression; } });
+Object.defineProperty(exports, "timeboxedJsonata", { enumerable: true, get: function () { return jsonata_1.timeboxedJsonata; } });
 Object.defineProperty(exports, "safeJsonata", { enumerable: true, get: function () { return jsonata_1.safeJsonata; } });
 const utils_1 = require("./utils");
 Object.defineProperty(exports, "inferType", { enumerable: true, get: function () { return utils_1.inferType; } });
@@ -37,8 +60,8 @@ Object.defineProperty(exports, "getUserCustomFieldsFromJsonata", { enumerable: t
  */
 function webtask(program = {}) {
     const compression = require("compression");
-    const app = express();
-    app.use(express.json({ limit: process.env.MAX_PAYLOAD_SIZE || "1mb" }));
+    const app = express_1.default();
+    app.use(express_1.default.json({ limit: process.env.MAX_PAYLOAD_SIZE || "1mb" }));
     app.use(compression());
     // Enforce HTTPS. The server does not redirect http -> https
     // because OWASP advises not to

package/dist/jsonata.d.ts

@@ -1,4 +1,4 @@
-import * as jsonata from "jsonata";
+import jsonata from "jsonata";
 /**
  * Protect the process/browser from a runnaway expression
  * i.e. Infinite loop (tail recursion), or excessive stack growth
@@ -8,8 +8,11 @@ import * as jsonata from "jsonata";
  * @param {Number} maxDepth - max stack depth
  */
 export declare function timeboxExpression(expr: jsonata.Expression, timeout?: number, maxDepth?: number): void;
+/**
+ * @deprecated Use timeboxedJsonata instead
+ */
 export declare function safeJsonata(expression: string, inputData: any): any;
-export declare function safeJsonata2(expression: string, inputData: any, timeout?: number, maxDepth?: number): {
+export declare function timeboxedJsonata(expression: string, inputData: any, timeout?: number, maxDepth?: number): {
     success: boolean;
     result: any;
 };

package/dist/jsonata.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeJsonata2 = exports.safeJsonata = exports.timeboxExpression = void 0;
-const jsonata = require("jsonata");
+exports.timeboxedJsonata = exports.safeJsonata = exports.timeboxExpression = void 0;
+const jsonata_1 = __importDefault(require("jsonata"));
 const logger_1 = require("./logger");
 const TIMEOUT = 5000;
 const MAXDEPTH = 1000;
@@ -48,9 +51,12 @@ function timeboxExpression(expr, timeout, maxDepth) {
     });
 }
 exports.timeboxExpression = timeboxExpression;
+/**
+ * @deprecated Use timeboxedJsonata instead
+ */
 function safeJsonata(expression, inputData) {
     try {
-        const jsonataQuery = jsonata(expression);
+        const jsonataQuery = jsonata_1.default(expression);
         timeboxExpression(jsonataQuery);
         return jsonataQuery.evaluate(inputData);
     }
@@ -59,9 +65,9 @@ function safeJsonata(expression, inputData) {
     }
 }
 exports.safeJsonata = safeJsonata;
-function safeJsonata2(expression, inputData, timeout, maxDepth) {
+function timeboxedJsonata(expression, inputData, timeout, maxDepth) {
     try {
-        const jsonataQuery = jsonata(expression);
+        const jsonataQuery = jsonata_1.default(expression);
         timeboxExpression(jsonataQuery, timeout, maxDepth);
         const result = jsonataQuery.evaluate(inputData);
         return { success: true, result };
@@ -73,4 +79,4 @@ function safeJsonata2(expression, inputData, timeout, maxDepth) {
         return { success: false, result: undefined };
     }
 }
-exports.safeJsonata2 = safeJsonata2;
+exports.timeboxedJsonata = timeboxedJsonata;

package/dist/logger.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setLogLevel = exports.getLogger = void 0;
-const winston_1 = require("winston");
+const logger_1 = require("@saasquatch/logger");
 // Lazily initialized logger instance
 let _logger;
 /**
@@ -16,13 +16,11 @@ function getLogger(logLevel) {
     if (_logger) {
         return _logger;
     }
-    const logFormat = winston_1.format.printf(({ level, message }) => {
-        return `[${level.toUpperCase()}] ${message}`;
-    });
-    _logger = winston_1.createLogger({
-        level: logLevel,
-        format: winston_1.format.combine(logFormat),
-        transports: [new winston_1.transports.Console()],
+    if (!logger_1.LOG_LEVELS.includes(logLevel)) {
+        logLevel = "info";
+    }
+    _logger = logger_1.initializeLogger({
+        logLevel: logLevel,
     });
     return _logger;
 }

package/dist/transaction.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 // @ts-check
 const queries_1 = require("./queries");
-const bson_objectid_1 = require("bson-objectid");
+const bson_objectid_1 = __importDefault(require("bson-objectid"));
 class Transaction {
     /**
      * @classdesc A Transaction instance takes a context object from Express, generates mutations and analytics as the program requested.

package/dist/trigger.js

@@ -1,7 +1,10 @@
 "use strict";
+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 = require("./transaction");
+const transaction_1 = __importDefault(require("./transaction"));
 /**
  * Triggers the program and returns the result (JSON + HTTP code)
  *

package/dist/types/index.js

@@ -1,7 +1,26 @@
 "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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.saasquatch = exports.rpc = void 0;
-const rpc = require("./rpc");
+const rpc = __importStar(require("./rpc"));
 exports.rpc = rpc;
-const saasquatch = require("./saasquatch");
+const saasquatch = __importStar(require("./saasquatch"));
 exports.saasquatch = saasquatch;

package/dist/utils.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
+const jsonata_paths_extractor_1 = __importDefault(require("@saasquatch/jsonata-paths-extractor"));
 /**
  * Append a reward schedule to the template and return the new template
  *

package/package.json

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