@tellescope/sdk 1.256.8 → 1.256.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/sdk",
-  "version": "1.256.8",
+  "version": "1.256.9",
   "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.256.7",
-    "@tellescope/schema": "1.256.8",
-    "@tellescope/testing": "1.256.7",
-    "@tellescope/types-client": "1.256.7",
-    "@tellescope/types-models": "1.256.7",
-    "@tellescope/types-utilities": "1.256.7",
-    "@tellescope/utilities": "1.256.7",
-    "@tellescope/validation": "1.256.7",
+    "@tellescope/constants": "1.256.9",
+    "@tellescope/schema": "1.256.9",
+    "@tellescope/testing": "1.256.9",
+    "@tellescope/types-client": "1.256.9",
+    "@tellescope/types-models": "1.256.9",
+    "@tellescope/types-utilities": "1.256.9",
+    "@tellescope/utilities": "1.256.9",
+    "@tellescope/validation": "1.256.9",
     "axios": "0.30.3",
     "dotenv": "14.3.2",
     "form-data": "4.0.4",
@@ -55,5 +55,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "194f5c52adb83f8950ad515f37a9c638b8233c90"
+  "gitHead": "8952d9b32afa842c1488e4eab27fe1dadc859cdb"
 }

package/src/tests/api_tests/appointment_link_expiration.test.ts

@@ -24,12 +24,17 @@ const decode_jwt_payload = (token: string) => {
 // The API returns a /r/<token> shortlink, not the destination — follow one hop and pull the
 // `token` query param out of the URL the patient actually lands on.
 const resolve_redirect_token = async (link: string) => {
-  const { status, headers } = await axios.get(link, {
+  // The server stamps the shortlink's host from its own config (organization.customPortalURL || API_URL),
+  // which is independent of the API port under test. Follow the /r/<token> path on our test `host` so this
+  // stays port-flexible like the rest of the suite (the redirect route is served by the same API server).
+  const { pathname, search } = new URL(link)
+  const followURL = `${host}${pathname}${search}`
+  const { status, headers } = await axios.get(followURL, {
     maxRedirects: 0,
     validateStatus: () => true,
   })
   const location = headers['location']
-  if (!location) throw new Error(`Expected a redirect from ${link}, got status ${status}`)
+  if (!location) throw new Error(`Expected a redirect from ${followURL}, got status ${status}`)
 
   const token = new URL(location).searchParams.get('token')
   if (!token) throw new Error(`No token query param in redirect destination: ${location}`)

package/src/tests/api_tests/create_note_action.test.ts

@@ -0,0 +1,168 @@
+require('source-map-support').install();
+
+import { Session } from "../../sdk"
+import { CreateNoteAutomationAction } from "@tellescope/types-models"
+import { log_header, async_test, assert } from "@tellescope/testing"
+import { setup_tests } from "../setup"
+
+const host = process.env.API_URL || "http://localhost:8080"
+
+// createNote journey action: creates a note on the enduser timeline with deterministic
+// (merge-field) text, or AI-generated text when aiSummaryConfiguration.enabled is set.
+// The deterministic path is fully covered here; the AI path asserts config round-trip and,
+// when the org lacks Bedrock enablement/credits (typical dev org), the error path instead.
+export const create_note_action_tests = async ({ sdk } : { sdk: Session, sdkNonAdmin: Session }) => {
+  log_header("Create Note Action Tests")
+
+  const journey = await sdk.api.journeys.createOne({ title: 'Create Note Test Journey' })
+  const createdEnduserIds: string[] = []
+
+  try {
+    /*************** Config validation round-trip ***************/
+    const validInfo = {
+      title: 'Note for {{enduser.fname}}',
+      text: 'Hi {{enduser.fname}}, this is a journey note.',
+      tags: ['auto-note'],
+    }
+
+    const step = await sdk.api.automation_steps.createOne({
+      journeyId: journey.id,
+      events: [{ type: 'onJourneyStart', info: {} }],
+      action: { type: 'createNote', info: validInfo },
+    })
+    assert(
+      step.action.type === 'createNote' && step.action.info.title === validInfo.title && step.action.info.text === validInfo.text,
+      'createNote step round-trip failed',
+      'createNote step round-trips',
+    )
+
+    await async_test('createNote without title is rejected',
+      () => sdk.api.automation_steps.createOne({
+        journeyId: journey.id,
+        events: [{ type: 'onJourneyStart', info: {} }],
+        action: { type: 'createNote', info: { ...validInfo, title: undefined } as any },
+      }),
+      { shouldError: true, onError: () => true },
+    )
+    await async_test('createNote with over-length title is rejected',
+      () => sdk.api.automation_steps.createOne({
+        journeyId: journey.id,
+        events: [{ type: 'onJourneyStart', info: {} }],
+        action: { type: 'createNote', info: { ...validInfo, title: 'x'.repeat(251) } },
+      }),
+      { shouldError: true, onError: () => true },
+    )
+
+    /*************** Runtime: the process endpoint ***************/
+    const processFor = async (enduserId: string, info: CreateNoteAutomationAction['info']) => {
+      const automatedAction = await sdk.api.automated_actions.createOne({
+        enduserId,
+        journeyId: journey.id,
+        automationStepId: step.id,
+        event: { type: 'onJourneyStart', info: {} },
+        action: { type: 'createNote', info },
+        status: 'active',
+        processAfter: Date.now(),
+      })
+      return sdk.api.automated_actions.process({ automatedActionId: automatedAction.id })
+    }
+
+    // deterministic path: merge fields resolve, tags + source set
+    const enduser = await sdk.api.endusers.createOne({ fname: 'NoteTest' })
+    createdEnduserIds.push(enduser.id)
+
+    const result = await processFor(enduser.id, validInfo)
+    assert(result.success === true, `deterministic createNote failed: ${result.error}`, 'deterministic createNote succeeds')
+
+    const notes = await sdk.api.notes.getSome({ filter: { enduserId: enduser.id } })
+    assert(notes.length === 1, `expected 1 note, got ${notes.length}`, 'exactly one note created')
+    assert(notes[0].title === 'Note for NoteTest', `title not templated: ${notes[0].title}`, 'title merge fields resolve')
+    assert(notes[0].text === 'Hi NoteTest, this is a journey note.', `text not templated: ${notes[0].text}`, 'text merge fields resolve')
+    assert(!!notes[0].tags?.includes('auto-note'), 'tags missing on note', 'tags set on note')
+    assert(notes[0].source === 'Journey', `wrong source: ${notes[0].source}`, 'note source is Journey')
+    assert(!notes[0].hiddenFromTimeline, 'note unexpectedly hidden', 'note visible on timeline by default')
+    assert(!notes[0].aiGenerated, 'deterministic note incorrectly flagged aiGenerated', 'deterministic note not flagged as AI-generated')
+
+    // hiddenFromTimeline + no text variant
+    const hiddenResult = await processFor(enduser.id, { title: 'Hidden note', hiddenFromTimeline: true })
+    assert(hiddenResult.success === true, `hidden createNote failed: ${hiddenResult.error}`, 'hidden createNote succeeds')
+    const allNotes = await sdk.api.notes.getSome({ filter: { enduserId: enduser.id } })
+    const hiddenNote = allNotes.find(n => n.title === 'Hidden note')
+    assert(
+      !!hiddenNote && hiddenNote.hiddenFromTimeline === true && !hiddenNote.text,
+      'hidden/textless note not created correctly',
+      'hiddenFromTimeline note created without text',
+    )
+
+    /*************** AI path ***************/
+    const aiInfo = {
+      title: 'AI note for {{enduser.fname}}',
+      aiSummaryConfiguration: {
+        enabled: true,
+        prompt: 'Write a one-sentence note stating this is a test patient.',
+      },
+    }
+    const aiStep = await sdk.api.automation_steps.createOne({
+      journeyId: journey.id,
+      events: [{ type: 'onJourneyStart', info: {} }],
+      action: { type: 'createNote', info: aiInfo },
+    })
+    assert(
+      aiStep.action.type === 'createNote' && aiStep.action.info.aiSummaryConfiguration?.enabled === true,
+      'AI createNote config round-trip failed',
+      'AI createNote config round-trips',
+    )
+
+    const aiEnduser = await sdk.api.endusers.createOne({ fname: 'AINoteTest' })
+    createdEnduserIds.push(aiEnduser.id)
+    const aiResult = await processFor(aiEnduser.id, aiInfo)
+    if (!aiResult.success) {
+      // bedrockAIAllowed/credits are org-level and unreadable here — accept the configuration error path
+      assert(
+        /bedrock|credit|enabled|ai/i.test(aiResult.error || ''),
+        `unexpected AI createNote error: ${aiResult.error}`,
+        'AI createNote reports a configuration error (Bedrock unavailable — runtime generation skipped)',
+      )
+    } else {
+      const aiNotes = await sdk.api.notes.getSome({ filter: { enduserId: aiEnduser.id } })
+      assert(
+        aiNotes.length === 1 && !!aiNotes[0].text && aiNotes[0].title === 'AI note for AINoteTest',
+        'AI-generated note missing or malformed',
+        'AI-generated note created with non-empty text',
+      )
+      assert(aiNotes[0].aiGenerated === true, 'AI note missing aiGenerated flag', 'AI note flagged as AI-generated')
+      const conversations = await sdk.api.ai_conversations.getSome({ filter: { enduserId: aiEnduser.id } })
+      assert(
+        conversations.some(c => c.type === 'AI Note'),
+        'no AI Note ai_conversations record',
+        'AI generation logged to ai_conversations with type AI Note',
+      )
+    }
+  } finally {
+    await sdk.api.journeys.deleteOne(journey.id).catch(() => {})
+    for (const id of createdEnduserIds) {
+      await sdk.api.endusers.deleteOne(id).catch(() => {})
+    }
+  }
+}
+
+// Allow running this test file independently
+if (require.main === module) {
+  const sdk = new Session({ host })
+  const sdkNonAdmin = new Session({ host })
+
+  const runTests = async () => {
+    await setup_tests(sdk, sdkNonAdmin)
+    await create_note_action_tests({ sdk, sdkNonAdmin })
+  }
+
+  runTests()
+    .then(() => {
+      console.log("✅ Create Note Action test suite completed successfully")
+      process.exit(0)
+    })
+    .catch((error) => {
+      console.error("❌ Create Note Action test suite failed:", error)
+      process.exit(1)
+    })
+}

package/src/tests/api_tests/webhook_raw_json_number.test.ts

@@ -0,0 +1,152 @@
+require('source-map-support').install();
+
+import { Session } from "../../sdk"
+import {
+  async_test,
+  log_header,
+  wait,
+} from "@tellescope/testing"
+import { setup_tests } from "../setup"
+
+const host = process.env.API_URL || 'http://localhost:8080' as const
+
+// Unreachable webhook target — the request will fail quickly but the API still writes
+// the resolved payload to webhook_logs, which is what we're verifying.
+const WEBHOOK_TARGET_URL = 'http://127.0.0.1:9'
+
+const find_log_for_url = async (sdk: Session, url: string) => {
+  const start = Date.now()
+  while (Date.now() - start < 10_000) {
+    const logs = await sdk.api.webhook_logs.getSome({ limit: 50, sort: 'newFirst' as any }) as Array<any>
+    const match = logs.find(l => l.url === url)
+    if (match) return match
+    await wait(undefined, 500)
+  }
+  return null
+}
+
+// Main test function that can be called independently
+export const webhook_raw_json_number_tests = async (
+  { sdk, sdkNonAdmin } : { sdk: Session, sdkNonAdmin: Session }
+) => {
+  log_header("Webhook Raw JSON Body Numeric Placeholder Tests")
+
+  const enduser = await sdk.api.endusers.createOne({ fname: 'RawJSON', lname: 'Number' })
+  const purchase = await sdk.api.purchases.createOne({
+    enduserId: enduser.id,
+    title: 'Raw JSON Number Test Purchase',
+    cost: { amount: 129.99, currency: 'USD' },
+    processor: 'Stripe',
+  })
+
+  // create an automation step to satisfy schema validation (automationStepId is required)
+  const journey = await sdk.api.journeys.createOne({
+    title: 'Webhook Raw JSON Number Tests',
+    defaultState: 'State 1',
+  })
+  const step = await sdk.api.automation_steps.createOne({
+    journeyId: journey.id,
+    events: [{ type: 'onJourneyStart', info: {} }],
+    action: {
+      type: 'sendWebhook',
+      info: {
+        message: 'placeholder',
+        url: WEBHOOK_TARGET_URL,
+      },
+    },
+  })
+
+  try {
+    await async_test(
+      'Send Webhook rawJSONBody sends unquoted {{purchase.cost.amount}} as a number and quoted as a string',
+      async () => {
+        const url = `${WEBHOOK_TARGET_URL}/raw-json-number/${purchase.id}`
+        await sdk.api.webhooks.send_automation_webhook({
+          message: 'placeholder',
+          enduserId: enduser.id,
+          automationStepId: step.id,
+          action: {
+            type: 'sendWebhook',
+            info: {
+              message: 'placeholder',
+              url,
+              rawJSONBody: '{"amount": {{purchase.cost.amount}}, "asString": "{{purchase.cost.amount}}"}',
+            },
+          },
+          context: { purchaseId: purchase.id },
+        }).catch(() => {}) // the unreachable URL is expected to error after logging
+
+        const log = await find_log_for_url(sdk, url)
+        if (!log) return false
+        const payload = log.payload as any
+        return (
+          typeof payload?.amount === 'number' && payload.amount === 129.99
+          && typeof payload?.asString === 'string' && payload.asString === '129.99'
+        )
+      },
+      { onResult: r => r === true }
+    )
+
+    await async_test(
+      'Send Webhook rawJSONBody with a MISSING unquoted placeholder degrades to null instead of dropping the whole body',
+      async () => {
+        const url = `${WEBHOOK_TARGET_URL}/raw-json-missing/${purchase.id}`
+        await sdk.api.webhooks.send_automation_webhook({
+          message: 'placeholder',
+          enduserId: enduser.id,
+          automationStepId: step.id,
+          action: {
+            type: 'sendWebhook',
+            info: {
+              message: 'placeholder',
+              url,
+              // enduser has no 'NoSuchNumber' field: the unquoted placeholder would otherwise leave a
+              // literal {{...}} in a value slot, invalidating the JSON and dropping the entire payload.
+              rawJSONBody: '{"missing": {{enduser.NoSuchNumber}}, "patient": "{{enduser.fname}}"}',
+            },
+          },
+          context: { purchaseId: purchase.id },
+        }).catch(() => {})
+
+        const log = await find_log_for_url(sdk, url)
+        if (!log) return false
+        const payload = log.payload as any
+        // body must still be sent (not null/empty), the missing value coerced to JSON null,
+        // and the resolvable placeholder still substituted
+        return (
+          payload && typeof payload === 'object'
+          && payload.missing === null
+          && payload.patient === 'RawJSON'
+        )
+      },
+      { onResult: r => r === true }
+    )
+  } finally {
+    try { await sdk.api.purchases.deleteOne(purchase.id) } catch {}
+    try { await sdk.api.automation_steps.deleteOne(step.id) } catch {}
+    try { await sdk.api.journeys.deleteOne(journey.id) } catch {}
+    try { await sdk.api.endusers.deleteOne(enduser.id) } catch {}
+  }
+}
+
+// Allow running this test file independently
+if (require.main === module) {
+  console.log(`🌐 Using API URL: ${host}`)
+  const sdk = new Session({ host })
+  const sdkNonAdmin = new Session({ host })
+
+  const runTests = async () => {
+    await setup_tests(sdk, sdkNonAdmin)
+    await webhook_raw_json_number_tests({ sdk, sdkNonAdmin })
+  }
+
+  runTests()
+    .then(() => {
+      console.log("✅ Webhook raw JSON number test suite completed successfully")
+      process.exit(0)
+    })
+    .catch((error) => {
+      console.error("❌ Webhook raw JSON number test suite failed:", error)
+      process.exit(1)
+    })
+}

package/src/tests/tests.ts

@@ -65,7 +65,7 @@ import { journey_delete_cancels_actions_tests } from "./api_tests/journey_delete
 import { afteraction_day_of_month_delay_tests } from "./api_tests/afteraction_day_of_month_delay.test"
 import { push_forms_to_portal_group_completion_tests } from "./api_tests/push_forms_to_portal_group_completion.test"
 import { authenticate_enduser_via_token, setup_tests } from "./setup"
-import { evaluate_conditional_logic_for_enduser_fields, FORM_LOGIC_CALCULATED_FIELDS, get_care_team_primary, get_flattened_fields, get_next_reminder_timestamp, object_is_empty, replace_enduser_template_values, replace_form_field_template_values, responses_satisfy_conditions, truncate_string, weighted_round_robin, YYYY_MM_DD_to_MM_DD_YYYY } from "@tellescope/utilities"
+import { evaluate_conditional_logic_for_enduser_fields, FORM_LOGIC_CALCULATED_FIELDS, get_care_team_primary, get_flattened_fields, get_next_reminder_timestamp, object_is_empty, replace_enduser_template_values, replace_form_field_template_values, replace_purchase_template_values, responses_satisfy_conditions, safeJSONParseTemplate, truncate_string, weighted_round_robin, YYYY_MM_DD_to_MM_DD_YYYY } from "@tellescope/utilities"
 import { DEFAULT_OPERATIONS, PLACEHOLDER_ID, ZENDESK_INTEGRATIONS_TITLE, ZOOM_TITLE } from "@tellescope/constants"
 import { 
   schema, 
@@ -144,6 +144,7 @@ import { form_started_trigger_tests } from "./api_tests/form_started_trigger.tes
 import { formsort_header_auth_tests } from "./api_tests/formsort_header_auth.test";
 import { form_submitted_trigger_tests } from "./api_tests/form_submitted_trigger.test";
 import { start_ai_conversation_tests } from "./api_tests/start_ai_conversation.test";
+import { create_note_action_tests } from "./api_tests/create_note_action.test";
 import { dont_sync_to_elation_form_submission_tests } from "./api_tests/dont_sync_to_elation_form_submission.test";
 import { medication_added_trigger_tests } from "./api_tests/medication_added_trigger.test";
 import { conditional_logic_medication_unit_tests } from "./unit_tests/conditional_logic_medication.test";
@@ -168,6 +169,7 @@ import { date_string_validation_tests } from "./api_tests/date_string_validation
 import { enduser_session_invalidation_tests } from "./api_tests/enduser_session_invalidation.test";
 import { enduser_cross_access_isolation_tests } from "./api_tests/enduser_cross_access_isolation.test";
 import { calendar_event_webhook_template_tests } from "./api_tests/calendar_event_webhook_template.test";
+import { webhook_raw_json_number_tests } from "./api_tests/webhook_raw_json_number.test";
 import { webhook_error_handling_tests } from "./api_tests/webhook_error_handling.test";
 import { phone_tree_enduser_condition_tests } from "./api_tests/phone_tree_enduser_condition.test";
 
@@ -13868,6 +13870,52 @@ const replace_enduser_template_values_tests = async () => {
   await sdk.api.endusers.deleteOne(enduser.id)
 }
 
+const safe_json_parse_template_tests = async () => {
+  log_header("Safe JSON Parse Template Tests")
+
+  // Unquoted placeholders are valid (normalized to 0 before parsing)
+  assert(
+    !!safeJSONParseTemplate('{"amount": {{purchase.cost.amount}}}'),
+    'fail unquoted placeholder', 'unquoted placeholder'
+  )
+  // Quoted placeholders remain valid (backward compatibility)
+  assert(
+    !!safeJSONParseTemplate('{"amount": "{{purchase.cost.amount}}"}'),
+    'fail quoted placeholder', 'quoted placeholder'
+  )
+  // Placeholders inside a larger string remain valid
+  assert(
+    !!safeJSONParseTemplate('{"greeting": "Hi {{enduser.fname}}!"}'),
+    'fail placeholder within string', 'placeholder within string'
+  )
+  // Mixed quoted and unquoted placeholders
+  assert(
+    !!safeJSONParseTemplate('{"amount": {{purchase.cost.amount}}, "asString": "{{purchase.cost.amount}}"}'),
+    'fail mixed placeholders', 'mixed placeholders'
+  )
+  // Genuinely malformed JSON still rejected
+  assert(
+    safeJSONParseTemplate('{"amount": {{purchase.cost.amount}}') === undefined,
+    'fail malformed template rejected', 'malformed template rejected'
+  )
+  assert(
+    safeJSONParseTemplate('not json at all') === undefined,
+    'fail non-json rejected', 'non-json rejected'
+  )
+  assert(safeJSONParseTemplate(undefined) === undefined, 'fail undefined template', 'undefined template')
+
+  // Round-trip: substitution of an unquoted placeholder yields a numeric JSON value,
+  // while the quoted placeholder still yields a string
+  const purchase = { title: 'Test Purchase', cost: { amount: 129.99, currency: 'USD' } } as any
+  const substituted = replace_purchase_template_values(
+    '{"amount": {{purchase.cost.amount}}, "asString": "{{purchase.cost.amount}}"}',
+    purchase,
+  )
+  const parsed = JSON.parse(substituted)
+  assert(typeof parsed.amount === 'number' && parsed.amount === 129.99, 'fail unquoted round-trip number', 'unquoted round-trip number')
+  assert(typeof parsed.asString === 'string' && parsed.asString === '129.99', 'fail quoted round-trip string', 'quoted round-trip string')
+}
+
 const replace_form_field_template_values_tests = async () => {
   log_header("Replace Form Field Template Values Tests")
 
@@ -15295,6 +15343,7 @@ const ip_address_form_tests = async () => {
     await conditional_logic_medication_unit_tests()
     await phone_validation_unit_tests()
     await replace_enduser_template_values_tests()
+    await safe_json_parse_template_tests()
     await replace_form_field_template_values_tests()
     await mfa_tests()
     await setup_tests(sdk, sdkNonAdmin)
@@ -15326,6 +15375,7 @@ const ip_address_form_tests = async () => {
     await invite_user_enumeration_tests({ sdk, sdkNonAdmin })
     await handle_incoming_communication_cross_tenant_tests({ sdk, sdkNonAdmin })
     await calendar_event_webhook_template_tests({ sdk, sdkNonAdmin })
+    await webhook_raw_json_number_tests({ sdk, sdkNonAdmin })
     await webhook_error_handling_tests({ sdk, sdkNonAdmin })
     await outbound_chat_sent_trigger_tests({ sdk })
     await enduser_login_rate_limits_tests({ sdk, sdkNonAdmin })
@@ -15352,6 +15402,7 @@ const ip_address_form_tests = async () => {
     await field_redaction_tests({ sdk, sdkNonAdmin })
     await form_submitted_trigger_tests({ sdk, sdkNonAdmin })
     await start_ai_conversation_tests({ sdk, sdkNonAdmin })
+    await create_note_action_tests({ sdk, sdkNonAdmin })
     await dont_sync_to_elation_form_submission_tests({ sdk, sdkNonAdmin })
     await date_string_validation_tests({ sdk, sdkNonAdmin })
     await phone_tree_enduser_condition_tests({ sdk, sdkNonAdmin })