@tellescope/sdk 1.4.105 → 1.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/sdk",
-  "version": "1.4.105",
+  "version": "1.5.1",
   "description": "Code for interacting with the Tellescope API",
   "main": "./lib/cjs/sdk.js",
   "module": "./lib/esm/sdk.js",
@@ -32,14 +32,14 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "^1.4.104",
-    "@tellescope/schema": "^1.4.105",
-    "@tellescope/testing": "^1.4.48",
-    "@tellescope/types-client": "^1.4.104",
-    "@tellescope/types-models": "^1.4.104",
-    "@tellescope/types-utilities": "^1.4.27",
-    "@tellescope/utilities": "^1.4.105",
-    "@tellescope/validation": "^1.4.105",
+    "@tellescope/constants": "^1.5.1",
+    "@tellescope/schema": "^1.5.1",
+    "@tellescope/testing": "^1.5.1",
+    "@tellescope/types-client": "^1.5.1",
+    "@tellescope/types-models": "^1.5.1",
+    "@tellescope/types-utilities": "^1.5.1",
+    "@tellescope/utilities": "^1.5.1",
+    "@tellescope/validation": "^1.5.1",
     "axios": "^0.21.1",
     "dotenv": "^14.2.0",
     "express": "^4.17.1",
@@ -58,5 +58,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f0dd59b66f81a25758d01848a94a211f1cebf6a4"
+  "gitHead": "d4235f7b61b4b067da331ea7149058871f53379b"
 }

package/src/sdk.ts

@@ -13,6 +13,7 @@ import {
   SearchOptions,
   AccessPermissions,
   OrganizationLimits,
+  SortBy,
 } from "@tellescope/types-models"
 
 import {
@@ -38,6 +39,7 @@ export interface LoadFunctionArguments <T> {
   lastId?: string, 
   limit?: number, 
   sort?: SortOption, 
+  sortBy?: SortBy,
   from?: Date | number,
   threadKey?: string, 
   filter?: ReadFilter<T>,

package/src/tests/tests.ts

@@ -2465,6 +2465,95 @@ export const formsUnsubmittedTest = async () => {
   ])
 }
 
+export const formsSubmittedNoUnsubmittedTest = async () => {
+  log_header("formsSubmitted, with no unsubmitted branch, Tests")
+
+  const enduser = await sdk.api.endusers.createOne({ email: 'deletemeee@tellescope.com' })
+  const journey = await sdk.api.journeys.createOne({ title: 'test journey '})
+  const form = await sdk.api.forms.createOne({ title: 'test form' })
+  const field = await 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
+  const triggerStep = await 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' },
+    },
+  })
+
+  // test for all forms submitted triggering update
+  await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{ 
+      type: 'formResponses', 
+      info: { automationStepId: triggerStep.id } 
+    }],
+    action: {
+      type: 'setEnduserStatus',
+      info: { status: 'formsSubmitted' },
+    },
+  })
+
+  // simulates sending 2 outstanding forms to pt with expected follow-up
+  await sdk.api.templates.get_templated_message({
+    channel: 'Email',
+    enduserId: enduser.id,
+    message: `{{forms.${form.id}.link:title}} {{forms.${form.id}.link:title}}`,
+    userId: sdk.userInfo.id,
+    automationStepId: triggerStep.id,
+  })
+  
+  const form_responses = await sdk.api.form_responses.getSome()
+
+  // trigger submission
+  await sdk.api.form_responses.submit_form_response({ accessCode: form_responses[0].accessCode!, automationStepId: triggerStep.id, responses: [{
+    answer: {
+      type: 'string',
+      value: 'answer'
+    },
+    fieldId: field.id,
+    fieldTitle: field.title,
+  }] })
+  await wait(undefined, 5000) // allow background creation with generous pause
+
+  await async_test(
+    `formResponses not triggered yet after 1 form remaining`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e?.journeys?.[journey.id] !== 'formsSubmitted' }
+  )  
+
+  await sdk.api.form_responses.submit_form_response({ accessCode: form_responses[1].accessCode!, automationStepId: triggerStep.id, responses: [{
+    answer: {
+      type: 'string',
+      value: 'answer'
+    },
+    fieldId: field.id,
+    fieldTitle: field.title,
+  }] })
+
+  await wait(undefined, 5000) // allow background creation with generous pause
+
+  await async_test(
+    `formResponses triggered after both forms submitted`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e?.journeys?.[journey.id] === 'formsSubmitted' }
+  )  
+
+  await Promise.all([
+    sdk.api.forms.deleteOne(form.id),
+    sdk.api.journeys.deleteOne(journey.id),
+    sdk.api.endusers.deleteOne(enduser.id)
+  ])
+}
+
+
 // ensure child steps come from the same journey
 export const automationSameJourneyTests = async () => {
   log_header("automationSameJourney")
@@ -2533,6 +2622,14 @@ const addToJourneyTests = async () => {
 
   // add to journey and re-add
   await sdk.api.endusers.add_to_journey({ enduserIds: [enduser.id], journeyId: journey.id })
+
+  await wait (undefined, 250)
+  await async_test(
+    `Journey state correctly set by add_to_journey (to default state)`,
+    () => sdk.api.endusers.getOne(enduser.id),
+    { onResult: e => e.journeys?.[journey.id] === 'New' } 
+  )  
+
   await wait(undefined, 4000) // allow onJourneyStart step to trigger
   await sdk.api.endusers.add_to_journey({ enduserIds: [enduser.id], journeyId: journey.id })
   await wait(undefined, 4000) // allow onJourneyStart step to trigger
@@ -2555,6 +2652,7 @@ const addToJourneyTests = async () => {
 
 const automation_events_tests = async () => {
   log_header("Automation Events")
+  await formsSubmittedNoUnsubmittedTest()
   await automationSameJourneyTests()
   await formsUnsubmittedTest()
   await formsUnsubmittedCancelConditionTest() 
@@ -3795,11 +3893,11 @@ const auto_reply_tests = async () => {
 
 const NO_TEST = () => {}
 const tests: { [K in keyof ClientModelForName]: () => void } = {
+  automation_steps: automation_events_tests,
   background_errors: NO_TEST,
   enduser_views: NO_TEST,
   availability_blocks: NO_TEST,
   analytics_frames: NO_TEST,
-  automation_steps: automation_events_tests,
   products: NO_TEST,
   purchase_credits: NO_TEST,
   purchases: NO_TEST,

package/src/tests/webhooks_tests.ts

@@ -293,6 +293,74 @@ const sub_organization_tests = async (isSubscribed: boolean) => {
   await sdk.api.endusers.deleteOne(enduserSub.id)
 }
 
+
+const form_response_tests = async (isSubscribed: boolean) => {
+  log_header(`Form Response Tests, isSubscribed=${isSubscribed}`)
+
+  if (isSubscribed) {
+    await sdk.api.webhooks.update({ subscriptionUpdates: { 
+      ...emptySubscription, 
+      form_responses: { create: true },
+    }})
+  }
+
+  const form = await sdk.api.forms.createOne({ title: 'test form' })
+  const field = await sdk.api.form_fields.createOne({ 
+    title: 'test',
+    formId: form.id,
+    type: 'string',
+    previousFields: [],
+  })
+
+  const enduser = await sdk.api.endusers.createOne({ email: 'deleteme@tellescope.com' })
+  const { accessCode } = await sdk.api.form_responses.prepare_form_response({
+    enduserId: enduser.id,
+    formId: form.id,
+  })
+
+  const { formResponse } = await sdk.api.form_responses.submit_form_response({
+    accessCode,
+    responses: [
+      {
+        fieldId: field.id,
+        fieldTitle: 'test',
+        answer: {
+          type: 'string',
+          value: 'testing value',
+        }
+      }
+    ]
+  })
+
+  await check_next_webhook(
+    a => {
+      const hook = a.records[0]
+
+      return (
+        hook.id === formResponse.id
+        && hook.businessId === formResponse.businessId
+        && hook.enduserId === formResponse.enduserId
+        && objects_equivalent(formResponse.responses, hook.responses)
+      )
+    },
+    'Form response on submit error', 'Form response on submit', isSubscribed
+  ) 
+
+  // cleanup
+  if (isSubscribed) {
+    await sdk.api.webhooks.update({ subscriptionUpdates: { 
+      ...emptySubscription, 
+      chats: { create: true }, 
+      meetings: { create: true, update: true, delete: false },
+    }})
+  }
+
+  await Promise.all([
+    sdk.api.endusers.deleteOne(enduser.id),
+    sdk.api.forms.deleteOne(form.id),
+  ])
+}
+
 const AUTOMATION_POLLING_DELAY_MS = 3000 - CHECK_WEBHOOK_DELAY_MS
 const test_automation_webhooks = async () => {
   log_header("Automation Events")
@@ -437,6 +505,7 @@ const calendar_event_reminders_tests = async (isSubscribed: boolean) => {
 }
 
 const tests: { [K in WebhookSupportedModel  | 'calendarEventReminders' | 'sub']?: (isSubscribed: boolean) => Promise<void> } = {
+  form_responses: form_response_tests,
   sub: sub_organization_tests,
   endusers: endusers_tests,
   chats: chats_tests,