@tellescope/sdk 1.3.42 → 1.3.44

package/lib/cjs/tests/tests.d.ts

@@ -1,3 +1,4 @@
+export declare const cancelConditionsTests: () => Promise<void>;
 export declare const meetings_tests: () => Promise<void>;
 export declare const managed_content_records_tests: () => Promise<void>;
 export declare const calendar_event_RSVPs_tests: () => Promise<void>;

package/lib/cjs/tests/tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tests.d.ts","sourceRoot":"","sources":["../../../src/tests/tests.ts"],"names":[],"mappings":"AAk2DA,eAAO,MAAM,cAAc,qBAqC1B,CAAA;AA0eD,eAAO,MAAM,6BAA6B,qBAgCzC,CAAA;AAED,eAAO,MAAM,0BAA0B,qBAmFtC,CAAA;AAoED,eAAO,MAAM,eAAe,qBA8C3B,CAAA"}
+{"version":3,"file":"tests.d.ts","sourceRoot":"","sources":["../../../src/tests/tests.ts"],"names":[],"mappings":"AAy0DA,eAAO,MAAM,qBAAqB,qBA8IjC,CAAA;AA4FD,eAAO,MAAM,cAAc,qBAqC1B,CAAA;AA0eD,eAAO,MAAM,6BAA6B,qBAgCzC,CAAA;AAED,eAAO,MAAM,0BAA0B,qBAmFtC,CAAA;AAoED,eAAO,MAAM,eAAe,qBA8C3B,CAAA"}

package/lib/cjs/tests/tests.js

@@ -82,7 +82,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.databases_tests = exports.calendar_event_RSVPs_tests = exports.managed_content_records_tests = exports.meetings_tests = void 0;
+exports.databases_tests = exports.calendar_event_RSVPs_tests = exports.managed_content_records_tests = exports.meetings_tests = exports.cancelConditionsTests = void 0;
 require('source-map-support').install();
 var crypto_1 = __importDefault(require("crypto"));
 var buffer = __importStar(require("buffer")); // only node >=15.7.0
@@ -1856,7 +1856,7 @@ var formEventTests = function () { return __awaiter(void 0, void 0, void 0, func
                 field = _a.sent();
                 return [4 /*yield*/, sdk.api.automation_steps.createOne({
                         journeyId: journey.id,
-                        event: { type: 'onJourneyStart', info: {} },
+                        events: [{ type: 'onJourneyStart', info: {} }],
                         // in practice, this would send a form, so that the next step(s) could handle the response
                         // but we don't want to send emails in testing, and can still attach this Id to a form response to test a trigger
                         action: {
@@ -1868,10 +1868,10 @@ var formEventTests = function () { return __awaiter(void 0, void 0, void 0, func
                 triggerStep = _a.sent();
                 return [4 /*yield*/, sdk.api.automation_steps.createOne({
                         journeyId: journey.id,
-                        event: {
-                            type: 'formResponse',
-                            info: { automationStepId: triggerStep.id }
-                        },
+                        events: [{
+                                type: 'formResponse',
+                                info: { automationStepId: triggerStep.id }
+                            }],
                         action: {
                             type: 'setEnduserStatus',
                             info: { status: 'placeholder' },
@@ -1939,7 +1939,7 @@ var ticketEventTests = function () { return __awaiter(void 0, void 0, void 0, fu
                 nullJourney = _c.sent();
                 return [4 /*yield*/, sdk.api.automation_steps.createOne({
                         journeyId: journey.id,
-                        event: { type: 'onJourneyStart', info: {} },
+                        events: [{ type: 'onJourneyStart', info: {} }],
                         action: {
                             type: 'createTicket',
                             info: {
@@ -1957,7 +1957,7 @@ var ticketEventTests = function () { return __awaiter(void 0, void 0, void 0, fu
                 root = _c.sent();
                 return [4 /*yield*/, sdk.api.automation_steps.createOne({
                         journeyId: nullJourney.id,
-                        event: { type: 'onJourneyStart', info: {} },
+                        events: [{ type: 'onJourneyStart', info: {} }],
                         action: {
                             type: 'createTicket',
                             info: {
@@ -1975,7 +1975,7 @@ var ticketEventTests = function () { return __awaiter(void 0, void 0, void 0, fu
                 nullRoot = _c.sent();
                 createStep = function (journeyId, automationStepId, closedForReason) { return (sdk.api.automation_steps.createOne({
                     journeyId: journeyId,
-                    event: { type: 'ticketCompleted', info: { automationStepId: automationStepId, closedForReason: closedForReason, } },
+                    events: [{ type: 'ticketCompleted', info: { automationStepId: automationStepId, closedForReason: closedForReason, } }],
                     action: { type: 'setEnduserStatus', info: { status: closedForReason !== null && closedForReason !== void 0 ? closedForReason : 'Null' }, },
                 })); };
                 return [4 /*yield*/, createStep(nullJourney.id, nullRoot.id)];
@@ -2008,7 +2008,7 @@ var ticketEventTests = function () { return __awaiter(void 0, void 0, void 0, fu
                 return [4 /*yield*/, sdk.api.endusers.updateOne(enduserWithTeam.id, { journeys: (_b = {}, _b[nullJourney.id] = 'Added (Null)', _b) })];
             case 16:
                 _c.sent();
-                return [4 /*yield*/, (0, testing_1.wait)(undefined, 2000)]; // wait for tickets to be automatically created
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 2200)]; // wait for tickets to be automatically created
             case 17:
                 _c.sent(); // wait for tickets to be automatically created
                 return [4 /*yield*/, (0, testing_1.async_test)("Tickets automatically created", function () { return sdk.api.tickets.getSome(); }, { onResult: function (tickets) { return (tickets === null || tickets === void 0 ? void 0 : tickets.length) === 2; } })];
@@ -2078,13 +2078,92 @@ var ticketEventTests = function () { return __awaiter(void 0, void 0, void 0, fu
     });
 }); };
 var removeFromJourneyTests = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var journey, journey2, enduser, enduser2, step, step2, createAction, numberOfActions, i;
+    var journey, enduser, TEST_DELAY, step;
     var _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
                 (0, testing_1.log_header)("Remove from Journey");
                 return [4 /*yield*/, sdk.api.journeys.createOne({ title: 'test journey' })];
+            case 1:
+                journey = _b.sent();
+                return [4 /*yield*/, sdk.api.endusers.createOne({ email: 'test@tellescope.com' })];
+            case 2:
+                enduser = _b.sent();
+                TEST_DELAY = 1000;
+                return [4 /*yield*/, (sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{ type: 'onJourneyStart', info: {} }],
+                        action: { type: 'setEnduserStatus', info: { status: 'Root' }, },
+                    }))];
+            case 3:
+                step = _b.sent();
+                return [4 /*yield*/, (sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{ type: 'afterAction', info: {
+                                    automationStepId: step.id,
+                                    delay: TEST_DELAY / 1000,
+                                    delayInMS: TEST_DELAY,
+                                    unit: 'Seconds',
+                                } }],
+                        action: { type: 'setEnduserStatus', info: { status: 'Delayed Step' }, },
+                    }))
+                    // test empty events step doesn't get triggered or cause errors
+                ];
+            case 4:
+                _b.sent();
+                // test empty events step doesn't get triggered or cause errors
+                return [4 /*yield*/, (sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [],
+                        action: { type: 'setEnduserStatus', info: { status: 'INVARIANT_VIOLATION' }, },
+                    }))
+                    // add to journey to trigger initial action
+                ];
+            case 5:
+                // test empty events step doesn't get triggered or cause errors
+                _b.sent();
+                // add to journey to trigger initial action
+                return [4 /*yield*/, sdk.api.endusers.updateOne(enduser.id, { journeys: (_a = {}, _a[journey.id] = 'New', _a) }, { replaceObjectFields: true })];
+            case 6:
+                // add to journey to trigger initial action
+                _b.sent();
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 500)];
+            case 7:
+                _b.sent();
+                return [4 /*yield*/, (0, testing_1.async_test)("Root action triggered (only root)", function () { return sdk.api.automated_actions.getSome({ filter: { enduserId: enduser.id } }); }, { onResult: function (es) { return es.length === 1; } })];
+            case 8:
+                _b.sent();
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 500)];
+            case 9:
+                _b.sent();
+                return [4 /*yield*/, (0, testing_1.async_test)("Next step not trigged early", function () { return sdk.api.endusers.getOne(enduser.id); }, { onResult: function (e) { var _a; return ((_a = e.journeys) === null || _a === void 0 ? void 0 : _a[journey.id]) !== 'Delayed Step'; } })];
+            case 10:
+                _b.sent();
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 3 * TEST_DELAY)]; // wait long enough for automation to process and delay to pass
+            case 11:
+                _b.sent(); // wait long enough for automation to process and delay to pass
+                return [4 /*yield*/, (0, testing_1.async_test)("Sequenced action triggered", function () { return sdk.api.endusers.getOne(enduser.id); }, { onResult: function (e) { var _a; return ((_a = e.journeys) === null || _a === void 0 ? void 0 : _a[journey.id]) === 'Delayed Step'; } })];
+            case 12:
+                _b.sent();
+                return [4 /*yield*/, Promise.all([
+                        sdk.api.journeys.deleteOne(journey.id),
+                        sdk.api.endusers.deleteOne(enduser.id),
+                    ])];
+            case 13:
+                _b.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+var sequenceTests = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var journey, journey2, enduser, enduser2, step, step2, createAction, numberOfActions, i;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                (0, testing_1.log_header)("Automation Sequencing");
+                return [4 /*yield*/, sdk.api.journeys.createOne({ title: 'test journey' })];
             case 1:
                 journey = _b.sent();
                 return [4 /*yield*/, sdk.api.journeys.createOne({ title: 'other journey' })];
@@ -2101,14 +2180,14 @@ var removeFromJourneyTests = function () { return __awaiter(void 0, void 0, void
                 _b.sent();
                 return [4 /*yield*/, (sdk.api.automation_steps.createOne({
                         journeyId: journey.id,
-                        event: { type: 'onJourneyStart', info: {} },
+                        events: [{ type: 'onJourneyStart', info: {} }],
                         action: { type: 'setEnduserStatus', info: { status: 'Root' }, },
                     }))];
             case 6:
                 step = _b.sent();
                 return [4 /*yield*/, (sdk.api.automation_steps.createOne({
                         journeyId: journey2.id,
-                        event: { type: 'onJourneyStart', info: {} },
+                        events: [{ type: 'onJourneyStart', info: {} }],
                         action: { type: 'setEnduserStatus', info: { status: 'Root' }, },
                     }))];
             case 7:
@@ -2116,7 +2195,6 @@ var removeFromJourneyTests = function () { return __awaiter(void 0, void 0, void
                 createAction = function (journeyId, step, enduserId) { return (sdk.api.automated_actions.createOne({
                     journeyId: journeyId,
                     automationStepId: step.id,
-                    cancelConditions: [],
                     enduserId: enduserId !== null && enduserId !== void 0 ? enduserId : enduser.id,
                     processAfter: Date.now() + 1000000,
                     status: 'active',
@@ -2169,19 +2247,213 @@ var removeFromJourneyTests = function () { return __awaiter(void 0, void 0, void
         }
     });
 }); };
+var cancelConditionsTests = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var enduser, journey, form, field, triggerStep, unsub, fastFollowup, accessCode;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                (0, testing_1.log_header)("Cancel Condition Tests");
+                return [4 /*yield*/, sdk.api.endusers.createOne({ email: 'deletemeee@tellescope.com' })];
+            case 1:
+                enduser = _a.sent();
+                return [4 /*yield*/, sdk.api.journeys.createOne({ title: 'test journey ' })];
+            case 2:
+                journey = _a.sent();
+                return [4 /*yield*/, sdk.api.forms.createOne({ title: 'test form' })];
+            case 3:
+                form = _a.sent();
+                return [4 /*yield*/, sdk.api.form_fields.createOne({
+                        formId: form.id, title: 'question', type: 'string',
+                        previousFields: [{ type: 'root', info: {} }]
+                    })
+                    // this action won't be fired, because patient isn't added to journey as part of tests
+                ];
+            case 4:
+                field = _a.sent();
+                return [4 /*yield*/, sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{ type: 'onJourneyStart', info: {} }],
+                        // in practice, this would send a form, so that the next step(s) could handle the response
+                        // but we don't want to send emails in testing, and can still attach this Id to a form response to test a trigger
+                        action: {
+                            type: 'setEnduserStatus',
+                            info: { status: 'start' },
+                        },
+                    })];
+            case 5:
+                triggerStep = _a.sent();
+                return [4 /*yield*/, sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{
+                                type: 'formUnsubmitted',
+                                info: {
+                                    automationStepId: triggerStep.id,
+                                    delayInMS: 0,
+                                    delay: 0, unit: 'Seconds',
+                                    cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id } }]
+                                }
+                            }],
+                        action: {
+                            type: 'setEnduserStatus',
+                            info: { status: 'triggered' },
+                        },
+                    })];
+            case 6:
+                unsub = _a.sent();
+                return [4 /*yield*/, sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{
+                                type: 'afterAction',
+                                info: {
+                                    automationStepId: unsub.id,
+                                    delayInMS: 0,
+                                    delay: 0, unit: 'Seconds',
+                                    cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id } }]
+                                }
+                            }],
+                        action: {
+                            type: 'setEnduserStatus',
+                            info: { status: 'triggered again' },
+                        },
+                    })];
+            case 7:
+                fastFollowup = _a.sent();
+                return [4 /*yield*/, sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{
+                                type: 'afterAction',
+                                info: {
+                                    automationStepId: unsub.id,
+                                    delayInMS: 1000000,
+                                    delay: 0, unit: 'Seconds',
+                                    cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id } }]
+                                }
+                            }],
+                        action: {
+                            type: 'setEnduserStatus',
+                            info: { status: 'violation 1' },
+                        },
+                    })
+                    // a second followup to the unsub event (to create example of two actions with same cancel condition)
+                ];
+            case 8:
+                _a.sent();
+                // a second followup to the unsub event (to create example of two actions with same cancel condition)
+                return [4 /*yield*/, sdk.api.automation_steps.createOne({
+                        journeyId: journey.id,
+                        events: [{
+                                type: 'afterAction',
+                                info: {
+                                    automationStepId: unsub.id,
+                                    delayInMS: 1000000,
+                                    delay: 0, unit: 'Seconds',
+                                    cancelConditions: [{ type: 'formResponse', info: { automationStepId: triggerStep.id } }]
+                                }
+                            }],
+                        action: {
+                            type: 'setEnduserStatus',
+                            info: { status: 'violation 2' },
+                        },
+                    })];
+            case 9:
+                // a second followup to the unsub event (to create example of two actions with same cancel condition)
+                _a.sent();
+                return [4 /*yield*/, sdk.api.form_responses.prepare_form_response({
+                        formId: form.id,
+                        automationStepId: triggerStep.id,
+                        enduserId: enduser.id
+                    })
+                    // allow formUnsubmitted to trigger
+                    // await wait(undefined, 1500) // allow background creation with generous pause
+                    // await async_test(
+                    //   `formUnsubmitted event with short delay is triggered`,
+                    //   () => sdk.api.endusers.getOne(enduser.id),
+                    //   { onResult: e => e?.journeys?.[journey.id] === 'triggered' }
+                    // )  
+                    // allow fast followup to trigger
+                ];
+            case 10:
+                accessCode = (_a.sent()).accessCode;
+                // allow formUnsubmitted to trigger
+                // await wait(undefined, 1500) // allow background creation with generous pause
+                // await async_test(
+                //   `formUnsubmitted event with short delay is triggered`,
+                //   () => sdk.api.endusers.getOne(enduser.id),
+                //   { onResult: e => e?.journeys?.[journey.id] === 'triggered' }
+                // )  
+                // allow fast followup to trigger
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 4000)]; // allow background creation with generous pause
+            case 11:
+                // allow formUnsubmitted to trigger
+                // await wait(undefined, 1500) // allow background creation with generous pause
+                // await async_test(
+                //   `formUnsubmitted event with short delay is triggered`,
+                //   () => sdk.api.endusers.getOne(enduser.id),
+                //   { onResult: e => e?.journeys?.[journey.id] === 'triggered' }
+                // )  
+                // allow fast followup to trigger
+                _a.sent(); // allow background creation with generous pause
+                return [4 /*yield*/, (0, testing_1.async_test)("formUnsubmitted event with short delay is triggered", function () { return sdk.api.endusers.getOne(enduser.id); }, { onResult: function (e) { var _a; return ((_a = e === null || e === void 0 ? void 0 : e.journeys) === null || _a === void 0 ? void 0 : _a[journey.id]) === 'triggered again'; } })
+                    // trigger cancel conditions
+                ];
+            case 12:
+                _a.sent();
+                // trigger cancel conditions
+                return [4 /*yield*/, sdk.api.form_responses.submit_form_response({ accessCode: accessCode, automationStepId: triggerStep.id, responses: [{
+                                answer: {
+                                    type: 'string',
+                                    value: 'answer'
+                                },
+                                fieldId: field.id,
+                                fieldTitle: field.title,
+                            }] })];
+            case 13:
+                // trigger cancel conditions
+                _a.sent();
+                return [4 /*yield*/, (0, testing_1.wait)(undefined, 1500)]; // allow background creation with generous pause
+            case 14:
+                _a.sent(); // allow background creation with generous pause
+                return [4 /*yield*/, (0, testing_1.async_test)("Cancel conditions work for followup", function () { return sdk.api.automated_actions.getSome(); }, { onResult: function (as) {
+                            var _a, _b;
+                            return as.length === 4
+                                && ((_a = as.find(function (a) { return a.automationStepId === unsub.id; })) === null || _a === void 0 ? void 0 : _a.status) === 'finished'
+                                && ((_b = as.find(function (a) { return a.automationStepId === fastFollowup.id; })) === null || _b === void 0 ? void 0 : _b.status) === 'finished'
+                                && as.filter(function (a) { return a.status === 'cancelled'; }).length === 2;
+                        }
+                    })];
+            case 15:
+                _a.sent();
+                return [4 /*yield*/, Promise.all([
+                        sdk.api.forms.deleteOne(form.id),
+                        sdk.api.journeys.deleteOne(journey.id),
+                        sdk.api.endusers.deleteOne(enduser.id)
+                    ])];
+            case 16:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports.cancelConditionsTests = cancelConditionsTests;
 var automation_events_tests = function () { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
                 (0, testing_1.log_header)("Automation Events");
-                return [4 /*yield*/, formEventTests()];
+                return [4 /*yield*/, (0, exports.cancelConditionsTests)()];
             case 1:
                 _a.sent();
-                return [4 /*yield*/, ticketEventTests()];
+                return [4 /*yield*/, sequenceTests()];
             case 2:
                 _a.sent();
-                return [4 /*yield*/, removeFromJourneyTests()];
+                return [4 /*yield*/, formEventTests()];
             case 3:
+                _a.sent();
+                return [4 /*yield*/, ticketEventTests()];
+            case 4:
+                _a.sent();
+                return [4 /*yield*/, removeFromJourneyTests()];
+            case 5:
                 _a.sent();
                 return [2 /*return*/];
         }
@@ -3172,6 +3444,7 @@ var databases_tests = function () { return __awaiter(void 0, void 0, void 0, fun
 exports.databases_tests = databases_tests;
 var NO_TEST = function () { };
 var tests = {
+    automation_steps: automation_events_tests,
     calendar_event_templates: NO_TEST,
     databases: exports.databases_tests,
     database_records: NO_TEST,
@@ -3197,7 +3470,6 @@ var tests = {
     form_responses: form_response_tests,
     calendar_events: calendar_events_tests,
     webhooks: NO_TEST,
-    automation_steps: automation_events_tests,
     sequence_automations: NO_TEST,
     automated_actions: NO_TEST,
     enduser_status_updates: status_update_tests,