@tellescope/schema 0.0.12 → 0.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/schema",
-  "version": "0.0.12",
+  "version": "0.0.16",
   "description": "Schema definition for Tellescope models",
   "main": "./lib/cjs/schema.js",
   "module": "./lib/esm/schema.js",
@@ -23,11 +23,11 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "^0.0.12",
-    "@tellescope/types-models": "^0.0.12",
-    "@tellescope/types-server": "^0.0.12",
-    "@tellescope/types-utilities": "^0.0.12",
-    "@tellescope/validation": "^0.0.12",
+    "@tellescope/constants": "^0.0.16",
+    "@tellescope/types-models": "^0.0.16",
+    "@tellescope/types-server": "^0.0.16",
+    "@tellescope/types-utilities": "^0.0.16",
+    "@tellescope/validation": "^0.0.16",
     "validator": "^13.1.17"
   },
   "devDependencies": {
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5d67de4721a3cbc3537a870281f2c657099e07b4"
+  "gitHead": "06e581f4d3a6c5b57fd0cfcc22103b94125f9da4"
 }

package/src/schema.ts

@@ -18,7 +18,7 @@ import {
 } from "@tellescope/types-utilities"
 import {
   EnduserSession,
-  ConfiguredSession,
+  ChatRoom,
   JourneyState,
   UserSession,
   AttendeeInfo,
@@ -257,12 +257,16 @@ export type CustomActions = {
       { isAuthenticated: true, enduser: Enduser } | { isAuthenticated: false, enduser: null }
     >,
     refresh_session: CustomAction<{}, { enduser: Enduser, authToken: string }>,
+    generate_auth_token: CustomAction<{ id?: string, phone?: string, email?: string, externalId?: string }, { authToken: string, enduser: Enduser }>,
     logout: CustomAction<{ }, { }>,
   },
   users: {
-    display_names: CustomAction<{ }, { fname: string, lname: string, id: string }[]>,
+    display_info: CustomAction<{ }, { fname: string, lname: string, id: string }[]>,
     refresh_session: CustomAction<{}, { user: UserSession, authToken: string }>,
   },
+  chat_rooms: {
+    join_room: CustomAction<{ id: string }, { room: ChatRoom }>,
+  },
   meetings: {
     start_meeting: CustomAction<{ }, { id: string, meeting: object, host: AttendeeInfo }>, 
     end_meeting: CustomAction<{ id: string }, { }>, 
@@ -344,6 +348,9 @@ export const schema: SchemaV1 = {
       lname: { 
         validator: nameValidator,
       },
+      dateOfBirth: { 
+        validator: dateValidator,
+      },
       journeys: { 
         validator: journeysValidator,
         dependencies: [
@@ -428,9 +435,25 @@ export const schema: SchemaV1 = {
         enduserOnly: true,
         returns: { 
           authToken: { validator: stringValidator, required: true }, 
-          enduser: { validator: 'enduser' }, 
+          enduser: { validator: 'enduser', required: true }, 
         } as any // todo: add enduser eventually, when validator defined
       },
+      generate_auth_token: {
+        op: "custom", access: 'create', method: "get",
+        name: 'Generate authToken',
+        path: '/generate-enduser-auth-token',
+        description: "Generates an authToken for use by an enduser. Useful for integrating a 3rd-party authentication process or creating a session for an enduser without a set password in Tellescope.",
+        parameters: { 
+          id: { validator: mongoIdStringValidator }, 
+          externalId: { validator: stringValidator250 },
+          email: { validator: emailValidator }, 
+          phone: { validator: phoneValidator },
+        },
+        returns: { 
+          authToken: { validator: stringValidator100, required: true },
+          enduser: { validator: 'enduser' as any, required: true },
+        },
+      },
       logout: {
         op: "custom", access: 'update', method: "post",
         name: 'Logout enduser',
@@ -853,8 +876,8 @@ export const schema: SchemaV1 = {
       },
       userIds: {
         validator: listOfMongoIdStringValidator,
-        required: true,
         examples: [[PLACEHOLDER_ID]], 
+        // required: true, // no longer required
         // add pull dependency for user deletion?
       },
       enduserIds: {
@@ -877,10 +900,24 @@ export const schema: SchemaV1 = {
       endedAt: {
         validator: dateValidator,
       },
+      tags: {
+        validator: listOfStringsValidator,
+      },
     },
     defaultActions: DEFAULT_OPERATIONS,
     enduserActions: { create: {}, read: {}, readMany: {} },
-    customActions: {},
+    customActions: {
+      join_room: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Join chat room',
+        path: '/join-chat-room',
+        description: "Allows a user to join a chat room with no other users, for use in accepting support chats.",
+        parameters: { id: { validator: mongoIdStringValidator, required: true } },
+        returns: { 
+          room: { validator:  'Room' }, 
+        } as any // add room eventually, when validator defined
+      },
+    },
   },
   chats: {
     info: {
@@ -916,7 +953,7 @@ export const schema: SchemaV1 = {
       senderId: { 
         validator: mongoIdStringValidator,
         readonly: true, // create a separate endpoint for storing enduser chats
-        initializer: (a, s) => (s as UserSession).id ?? (s as EnduserSession).id,
+        initializer: (a, s) => s.id,
         examples: [PLACEHOLDER_ID],
         dependencies: [{ // can be userId or enduserId
           dependsOn: ['users', 'endusers'],
@@ -954,11 +991,11 @@ export const schema: SchemaV1 = {
     },
     defaultActions: { read: {}, readMany: {} },
     customActions: {
-      display_names: {
+      display_info: {
         op: "custom", access: 'read', method: "get",
-        name: 'User Display Names',
-        path: '/user-display-names',
-        description: "Gets display names for users, accessible by endusers",
+        name: 'User Display Info',
+        path: '/user-display-info',
+        description: "Gets display info for users, accessible by endusers",
         parameters: {},
         returns: { 
           validator: listOfDisplayNameInfo
@@ -975,7 +1012,6 @@ export const schema: SchemaV1 = {
           enduser: { validator:  'user' }, 
         } as any // add enduser eventually, when validator defined
       },
-
     },
     enduserActions: { display_names: {} },
     fields: {
@@ -1075,6 +1111,9 @@ export const schema: SchemaV1 = {
         validator: fileTypeValidator,
         required: true
       },
+      enduserId: {
+        validator: mongoIdStringValidator,
+      },
       secureName: {
         validator: stringValidator250,
         readonly: true,
@@ -1113,7 +1152,7 @@ export const schema: SchemaV1 = {
       file_download_URL: {
         op: "custom", access: 'read', method: "get",
         name: 'Generate File Download',
-        path: '/file-download-link',
+        path: '/file-download-URL',
         description: "Generates a temporary download link for a file.",
         parameters: { 
           secureName: { validator: stringValidator250 },
@@ -1153,6 +1192,9 @@ export const schema: SchemaV1 = {
         required: true,
         examples: [PLACEHOLDER_ID],
       },
+      chatRoomId: {
+        validator: mongoIdStringValidator,
+      },
       closedAt: {
         validator: dateValidator,
       },
@@ -1202,7 +1244,7 @@ export const schema: SchemaV1 = {
         name: "End Meeting",
         path: '/end-meeting',
         description: "Ends a video meeting",
-        parameters: { id: { validator: mongoIdStringValidator } },
+        parameters: { id: { validator: mongoIdStringValidator, required: true } },
         returns: { },
       },
       add_attendees_to_meeting: { 
@@ -1211,8 +1253,8 @@ export const schema: SchemaV1 = {
         path: '/add-attendees-to-meeting',
         description: "Adds other attendees to a meeting",
         parameters: { 
-          id: { validator: mongoIdStringValidator },
-          attendees: { validator: listOfUserIndentitiesValidator },
+          id: { validator: mongoIdStringValidator, required: true },
+          attendees: { validator: listOfUserIndentitiesValidator, required: true },
         },
         returns: { },
       },
@@ -1222,11 +1264,11 @@ export const schema: SchemaV1 = {
         path: '/attendee-info',
         description: "Gets meeting info for the current user, and details about other attendees",
         parameters: { 
-          id: { validator: mongoIdStringValidator },
+          id: { validator: mongoIdStringValidator, required: true },
         },
         returns: { 
-          attendee: { validator: attendeeInfoValidator },
-          others: { validator: listOfUserIndentitiesValidator },
+          attendee: { validator: attendeeInfoValidator, required: true },
+          others: { validator: listOfUserIndentitiesValidator, required: true },
         },
       },
       my_meetings: {
@@ -1234,10 +1276,8 @@ export const schema: SchemaV1 = {
         name: 'Get list of meetings',
         path: '/my-meetings',
         description: "Gets meetings for the current user.",
-        parameters: { 
-          id: { validator: mongoIdStringValidator },
-        },
-        returns: { validator: meetingsListValidator },
+        parameters: {},
+        returns: { validator: meetingsListValidator, required: true },
       }
     },
     enduserActions: { my_meetings: {} },
@@ -1259,4 +1299,36 @@ export const schema: SchemaV1 = {
       }
     }
   },
+  notes: {
+    info: {},
+    constraints: {
+      unique: [], 
+      relationship: [],
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: {},
+    enduserActions: {},
+    fields: {
+      ...BuiltInFields, 
+      enduserId: {
+        validator: mongoIdStringValidator,
+        required: true,
+        examples: [PLACEHOLDER_ID],
+      },
+      ticketId: {
+        validator: mongoIdStringValidator,
+      },
+      text: {
+        validator: stringValidator5000,
+        examples: ["Text"],
+      },
+      title: {
+        validator: stringValidator250,
+        examples: ["Text"],
+      },
+      fields: {
+        validator: fieldsValidator,
+      }
+    }
+  },
 }