@tellescope/schema 1.254.0 → 1.255.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/schema",
-  "version": "1.254.0",
+  "version": "1.255.0",
   "description": "Schema definition for Tellescope models",
   "main": "./lib/cjs/schema.js",
   "module": "./lib/esm/schema.js",
@@ -23,13 +23,13 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "1.254.0",
-    "@tellescope/types-client": "1.254.0",
-    "@tellescope/types-models": "1.254.0",
-    "@tellescope/types-server": "1.254.0",
-    "@tellescope/types-utilities": "1.254.0",
-    "@tellescope/utilities": "1.254.0",
-    "@tellescope/validation": "1.254.0",
+    "@tellescope/constants": "1.255.0",
+    "@tellescope/types-client": "1.255.0",
+    "@tellescope/types-models": "1.255.0",
+    "@tellescope/types-server": "1.255.0",
+    "@tellescope/types-utilities": "1.255.0",
+    "@tellescope/utilities": "1.255.0",
+    "@tellescope/validation": "1.255.0",
     "validator": "13.11.0"
   },
   "devDependencies": {
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c1b4f17fc6da0f03c0abeebf958a7b0c4fd4217c"
+  "gitHead": "9031bd85cf05c301b4079444cb8eeb0ae354154f"
 }

package/src/schema.ts

@@ -82,6 +82,7 @@ import {
   CanvasCoding,
   StripeKeyDetail,
   MetriportIntegrationDetail,
+  ChargebeeBusinessEntity,
   EnduserDevice,
   AIConversationMessage,
   AICOnversationMessageContent,
@@ -92,6 +93,7 @@ import {
   TimeTrackTimestamp,
   TimeTrackReviewHistoryItem,
   BelugaPharmacyMapping,
+  CompoundFilter,
   BelugaAutomationMappingEntry,
   BelugaUpdateVisitPatientPreferenceItem,
   TimeTrack,
@@ -685,6 +687,8 @@ export type CustomActions = {
   },
   api_keys: {
     create: CustomAction<{}, { id: string, key: string}>,
+    get_organization_api_keys: CustomAction<{}, { apiKeys: { id: string, creator: string, businessId: string, updatedAt: Date }[] }>,
+    delete_organization_api_key: CustomAction<{ id: string }, { }>,
   },
   templates: {
     get_templated_message: CustomAction<
@@ -1718,6 +1722,12 @@ export const schema: SchemaV1 = build_schema({
       useDefaultFromPhoneInAutomations: { validator: booleanValidator },
       stripeCustomerId: { validator: stringValidator100, redactions: ['enduser'], enduserUpdatesDisabled: true },
       stripeKey: { validator: stringValidator250, redactions: ['enduser'], enduserUpdatesDisabled: true },
+      // Chargebee linkage fields. Normally written server-side at customer creation, but exposed as
+      // staff-editable (enduserUpdatesDisabled) for manual correction — e.g. reflecting a Chargebee-side
+      // customer transfer between business entities, for which Chargebee emits no webhook. Empty clears.
+      chargebeeId: { validator: stringValidatorOptionalEmptyOkay, redactions: ['enduser'], enduserUpdatesDisabled: true },
+      chargebeeEnvironment: { validator: stringValidatorOptionalEmptyOkay, redactions: ['enduser'], enduserUpdatesDisabled: true },
+      chargebeeBusinessEntityId: { validator: stringValidatorOptionalEmptyOkay, redactions: ['enduser'], enduserUpdatesDisabled: true },
       diagnoses: {
         validator: listValidatorOptionalOrEmptyOk(enduserDiagnosisValidator),
         redactions: ['enduser'],
@@ -2285,10 +2295,30 @@ export const schema: SchemaV1 = build_schema({
             validator: mongoIdStringValidator,
           },
           key: {
-            validator: stringValidator, 
+            validator: stringValidator,
           }
         }
-      }
+      },
+      get_organization_api_keys: {
+        op: 'custom', access: 'read', method: 'get', adminOnly: true,
+        name: 'Get Organization ApiKeys',
+        path: '/organization-api-keys',
+        description: "Returns metadata (id, creator, businessId, updatedAt) for all ApiKeys in the admin's organization. Never returns the secret key.",
+        parameters: {},
+        returns: {
+          apiKeys: { validator: listOfObjectAnyFieldsAnyValuesValidator as any, required: true },
+        },
+      },
+      delete_organization_api_key: {
+        op: 'custom', access: 'delete', method: 'delete', adminOnly: true,
+        name: 'Delete Organization ApiKey',
+        path: '/organization-api-key/:id',
+        description: "Deletes an ApiKey in the admin's organization by id, regardless of which user created it.",
+        parameters: {
+          id: { validator: mongoIdStringValidator, required: true },
+        },
+        returns: { },
+      },
     }
   },
   integrations: {
@@ -3189,9 +3219,21 @@ export const schema: SchemaV1 = build_schema({
   },
   chat_rooms: {
     info: {},
-    constraints: { 
+    constraints: {
       unique: [{ array: 'userIds' }, { array: 'enduserIds' }],
-      relationship: [],
+      relationship: [
+        {
+          // Patient-initiated rooms targeting specific care-team staff (userIds) are an intended
+          // portal feature and are left unrestricted. An enduser may only add THEMSELVES to a room
+          // they create — they cannot add other patients (cross-patient PHI broadcast).
+          explanation: 'Endusers can only add their own id to enduserIds on chat rooms they create',
+          evaluate: (doc, _, session) => {
+            if (session.type !== ENDUSER_SESSION_TYPE) return
+            if ((doc.enduserIds ?? []).some(id => id !== session.id))
+              return "enduserIds may only contain your own id for enduser session"
+          }
+        },
+      ],
       access: [
         { type: 'filter', field: 'userIds' },
         { type: 'filter', field: 'enduserIds' },
@@ -4846,8 +4888,9 @@ export const schema: SchemaV1 = build_schema({
       },
       belugaCombineMatchingPharmacyMappings: { validator: booleanValidator },
       mdiCaseOfferings: {
-        validator: listValidatorOptionalOrEmptyOk(objectValidator<{ offering_id: string }>({
+        validator: listValidatorOptionalOrEmptyOk(objectValidator<{ offering_id: string, conditions?: CompoundFilter<string> }>({
           offering_id: stringValidator100,
+          conditions: compoundFilterValidator,
         }))
       },
       autoMergeOnSubmission: { validator: booleanValidator },
@@ -6457,8 +6500,16 @@ export const schema: SchemaV1 = build_schema({
   enduser_observations: {
     info: {},
     constraints: {
-      unique: [], 
-      relationship: [],
+      unique: [],
+      relationship: [
+        {
+          explanation: 'When created by an enduser, enduserId must match their id',
+          evaluate: ({ enduserId },_,session) => {
+          if (session.type === ENDUSER_SESSION_TYPE && session.id !== enduserId)
+            return "enduserId does not match creator id for enduser session"
+          }
+        },
+      ],
     },
     defaultActions: {
       ...DEFAULT_OPERATIONS,
@@ -6559,11 +6610,23 @@ export const schema: SchemaV1 = build_schema({
   managed_content_records: {
     info: {},
     constraints: {
-      unique: [], 
-      relationship: [],
+      unique: [],
+      relationship: [
+        {
+          explanation: 'Endusers cannot self-publish managed content or bind it to another enduser',
+          evaluate: (doc, _, session) => {
+            if (session.type !== ENDUSER_SESSION_TYPE) return
+            if (doc.publicRead) return "publicRead cannot be set by endusers"
+            if (doc.allowUnauthenticatedAccess) return "allowUnauthenticatedAccess cannot be set by endusers"
+            if (doc.forInternalUse) return "forInternalUse cannot be set by endusers"
+            if (doc.enduserId !== undefined && doc.enduserId !== session.id)
+              return "enduserId does not match creator id for enduser session"
+          }
+        },
+      ],
     },
     defaultActions: DEFAULT_OPERATIONS,
-    customActions: { 
+    customActions: {
       update_indexes: {
         op: "custom", access: 'update', method: "patch",
         name: 'Update Indexes',
@@ -7240,6 +7303,13 @@ export const schema: SchemaV1 = build_schema({
           environment: stringValidator1000Optional,
         }))
       },
+      chargebeeBusinessEntities: {
+        validator: listValidatorOptionalOrEmptyOk(objectValidator<ChargebeeBusinessEntity>({
+          environment: stringValidator1000,
+          businessEntityId: stringValidator1000,
+          name: stringValidator1000Optional,
+        }))
+      },
       name: {
         validator: stringValidator100,
         required: true,
@@ -9368,8 +9438,17 @@ If a voicemail is left, it is indicated by recordingURI, transcription, or recor
     info: {
       description: 'Lab, medication, and device orders'
     },
-    constraints: { 
-      unique: [], relationship: [], 
+    constraints: {
+      unique: [],
+      relationship: [
+        {
+          explanation: 'When created by an enduser, enduserId must match their id',
+          evaluate: ({ enduserId },_,session) => {
+          if (session.type === ENDUSER_SESSION_TYPE && session.id !== enduserId)
+            return "enduserId does not match creator id for enduser session"
+          }
+        },
+      ],
       access: [{ type: 'filter', field: 'userId' }]
     },
     defaultActions: DEFAULT_OPERATIONS,
@@ -9973,8 +10052,9 @@ If a voicemail is left, it is indicated by recordingURI, transcription, or recor
           enduserId: { validator: mongoIdStringValidator, required: true },
           automationStepId: { validator: mongoIdStringValidator, required: true },
           outcomes: { validator: listOfStringsValidator, required: true },
-          prompt: { validator: stringValidator5000, required: true },
-          sources: { validator: listValidator(AIDecisionSourceValidator), required: true },
+          prompt: { validator: stringValidator5000OptionalEmptyOkay },                 // legacy, now optional
+          sources: { validator: listValidator(AIDecisionSourceValidator) },            // legacy, now optional
+          aiSummaryConfiguration: { validator: aiSummaryConfigurationValidator },       // new shared config
           journeyContext: { validator: journeyContextValidator },
         },
         returns: {},