@tellescope/sdk 0.0.11 → 0.0.15

package/src/sdk.ts

@@ -12,6 +12,7 @@ import {
   ClientModelForName_readonly,
   ClientModelForName_required,
   ClientModelForName_updatesDisabled,
+  ChatRoom,
   Enduser,
   File,
 } from "@tellescope/types-client"
@@ -23,6 +24,8 @@ import { Session as SessionManager, SessionOptions, Filter } from "./session"
 export * from "./public"
 export * from "./enduser"
 
+export type LoadFunction<T> = (o?: { lastId?: string, limit?: number, sort?: SortOption, threadKey?: string, filter?: Filter<Partial<T>> }) => Promise<T[]>
+
 export interface APIQuery<
   N extends keyof ClientModelForName, 
   T=ClientModelForName[N], 
@@ -34,7 +37,7 @@ export interface APIQuery<
   createOne: (t: CREATE) => Promise<T>;
   createSome: (ts: CREATE[]) => Promise<{ created: T[], errors: object[] }>;
   getOne: (id: string, filter?: Filter<Partial<T>>) => Promise<T>;
-  getSome: (o?: { lastId?: string, limit?: number, sort?: SortOption, threadKey?: string, filter?: Filter<Partial<T>> }) => Promise<T[]>
+  getSome: LoadFunction<T>;
   updateOne: (id: string, updates: UPDATE, options?: CustomUpdateOptions) => Promise<T>;
   deleteOne: (id: string) => Promise<void>;
 }
@@ -71,6 +74,7 @@ const loadDefaultQueries = (s: Session): { [K in keyof ClientModelForName] : API
   files: defaultQueries(s, 'files'),
   tickets: defaultQueries(s, 'tickets'),
   meetings: defaultQueries(s, 'meetings'),
+  notes: defaultQueries(s, 'notes'),
 })
 
 type Queries = { [K in keyof ClientModelForName]: APIQuery<K> } & {
@@ -80,6 +84,7 @@ type Queries = { [K in keyof ClientModelForName]: APIQuery<K> } & {
   endusers: {
     setPassword: (args: { id: string, password: string }) => Promise<void>,
     isAuthenticated: (args: { id: string, authToken: string }) => Promise<{ isAuthenticated: boolean, enduser: Enduser }>
+    generateAuthToken: (args: { id: string }) => Promise<{ authToken: string }>
   },
   users: {
     display_names: () => Promise<{ fname: string, lname: string, id: string }[]>,
@@ -89,12 +94,15 @@ type Queries = { [K in keyof ClientModelForName]: APIQuery<K> } & {
     file_download_URL: (args: { secureName: string }) => Promise<{ downloadURL: string }>,
   },
   meetings: {
-    start_meeting: () => Promise<{ id: string, meeting: { Meeting: MeetingInfo }, host: AttendeeInfo }>, 
+    start_meeting: () => Promise<{ id: string, meeting: { Meeting: MeetingInfo }, host: { Attendee: AttendeeInfo } }>, 
     end_meeting: (args: { id: string }) => Promise<void>, 
     add_attendees_to_meeting: (args: { id: string, attendees: UserIdentity[] }) => Promise<void>, 
     my_meetings: () => Promise<Meeting[]>,
     attendee_info: (args: { id: string }) => Promise<{ attendee: AttendeeInfo, others: UserIdentity[] }>,
   },
+  chat_rooms: {
+    join_room: (args: { id: string }) => Promise<{ room: ChatRoom }>,
+  },
 }
 
 export class Session extends SessionManager {
@@ -108,9 +116,11 @@ export class Session extends SessionManager {
     queries.journeys.updateState = ({id, name, updates}) => this._PATCH(`/v1/journey/${id}/state/${name}`, { updates })
     queries.endusers.setPassword = ({id, password}) => this._POST(`/v1/set-enduser-password`, { id, password })
     queries.endusers.isAuthenticated = ({id, authToken}) => this._GET(`/v1/enduser-is-authenticated`, { id, authToken })
+    queries.endusers.generateAuthToken = args => this._GET(`/v1/generate-enduser-auth-token`, args)
     queries.users.display_names = () => this._GET<{}, { fname: string, lname: string, id: string }[]>(`/v1/user-display-names`),
     queries.files.prepare_file_upload = (args) => this._POST(`/v1/prepare-file-upload`, args),
     queries.files.file_download_URL = a => this._GET('/v1/file-download-URL', a),
+    queries.chat_rooms.join_room = a => this._POST('/v1/join-chat-room', a),
 
     queries.meetings.start_meeting = () => this._POST('/v1/start-meeting')
     queries.meetings.end_meeting = a => this._POST('/v1/end-meeting', a)

package/src/session.ts

@@ -195,6 +195,11 @@ export class Session {
     catch(err) { console.error(err); throw err }
   }
 
+  DOWNLOAD = async (downloadURL: string) => { 
+    const content = await axios.get(downloadURL)
+    return content.data
+  }
+
   EMIT = async (route: string, args: object, authenticated=true, options={} as RequestOptions) => {
     this.socket?.emit(route, { ...args, ...authenticated ? { authToken: this.authToken } : {} } )
   }

package/src/tests/tests.ts

@@ -1,8 +1,9 @@
 require('source-map-support').install();
+import * as fs from "fs"
+import * as buffer from "buffer" // only node >=15.7.0
 
 import {
   Enduser,
-  ChatRoom,
   ClientModelForName,
   ClientModelForName_required,
 } from "@tellescope/types-client"
@@ -191,7 +192,7 @@ const threadKeyTests = async () => {
 }
 
 const filterTests = async () => {
-  const enduser = await sdk.api.endusers.createOne({ email: 'filtertests@tellescope.com', fname: 'test' })
+  const enduser = await sdk.api.endusers.createOne({ email: 'filtertests@tellescope.com', fname: 'test', fields: { field1: 'value1', field2: 'value2' } })
   const otherEnduser = await sdk.api.endusers.createOne({ email: 'other@tellescope.com' })
   await async_test(
     `find enduser by filter`, 
@@ -213,6 +214,36 @@ const filterTests = async () => {
     () => sdk.api.endusers.getSome({ filter: { email: 'doesnotexist@tellescope.com' }}), 
     { onResult: es => es.length === 0 },
   )
+  await async_test(
+    `find enduser by nested filter`, 
+    () => sdk.api.endusers.getSome({ filter: { fields: { field1: 'value1' } } }), 
+    { onResult: es => es.length === 1 && es[0].id === enduser.id },
+  )
+  await async_test(
+    `nothing found by invalid nested filter`, 
+    () => sdk.api.endusers.getSome({ filter: { fields: { field1: 'not a nested field value' } }}), 
+    { onResult: es => es.length === 0 },
+  )
+  await async_test(
+    `find enduser by compound nested filter`, 
+    () => sdk.api.endusers.getSome({ filter: { fields: { field1: 'value1', field2: 'value2' } } }), 
+    { onResult: es => es.length === 1 && es[0].id === enduser.id },
+  )
+  await async_test(
+    `nothing found by compound invalid nested filter`, 
+    () => sdk.api.endusers.getSome({ filter: { fields: { field1: 'not a nested field value', field2: 'value2' } }}), 
+    { onResult: es => es.length === 0 },
+  )
+  await async_test(
+    `find enduser by compound nested filter with non-nested field as well`, 
+    () => sdk.api.endusers.getSome({ filter: {email: 'filtertests@tellescope.com', fields: { field1: 'value1', field2: 'value2' } } }), 
+    { onResult: es => es.length === 1 && es[0].id === enduser.id },
+  )
+  await async_test(
+    `nothing found for compound nested filter with non-nested field as well`, 
+    () => sdk.api.endusers.getSome({ filter: {email: 'doesnotexist@tellescope.com', fields: { field1: 'value1', field2: 'value2' } } }), 
+    { onResult: es => es.length === 0 },
+  )
 
   await sdk.api.endusers.deleteOne(enduser.id)
   await sdk.api.endusers.deleteOne(otherEnduser.id)
@@ -232,6 +263,16 @@ const updatesTests = async () => {
   await sdk.api.endusers.deleteOne(enduser.id)
 }
 
+const generateEnduserAuthTests = async () => {
+  log_header("Generated Enduser authToken Tests")
+  const enduser = await sdk.api.endusers.createOne({ email: 'generated@tellescope.com'})
+  const { authToken } = await sdk.api.endusers.generateAuthToken({ id: enduser.id })
+  const { isAuthenticated } = await sdk.api.endusers.isAuthenticated({ id: enduser.id, authToken })
+  assert(isAuthenticated, 'invalid authToken generated for enduser', 'Generate authToken for enduser is valid')
+
+  await sdk.api.endusers.deleteOne(enduser.id)
+}
+
 const instanceForModel = <N extends ModelName, T=ClientModelForName[N], REQ=ClientModelForName_required[N]>(model: Model<T, N>, i=0) => {
   const instance = {} as Indexable
   const updates = {} as Indexable
@@ -744,8 +785,31 @@ const chat_room_tests = async () => {
     () => sdk2.api.chat_rooms.getOne(room.id), 
     { shouldError: true, onError: e => e.message === "Could not find a record for the given id" }
   )
+  await sdk.api.chat_rooms.deleteOne(room.id)
 
-  sdk.api.chat_rooms.deleteOne(room.id)
+  
+  const emptyRoom = await sdk.api.chat_rooms.createOne({ })
+  await async_test(
+    `get-chat-room (creator can access, even when not in userIds)`, 
+    () => sdk.api.chat_rooms.getOne(emptyRoom.id), 
+    { onResult: r => r.id === emptyRoom.id }
+  ) 
+  await async_test(
+    `get-chat-room (not in empty room)`, 
+    () => sdk2.api.chat_rooms.getOne(emptyRoom.id), 
+    { shouldError: true, onError: e => e.message === "Could not find a record for the given id" }
+  ) 
+  await async_test(
+    `join-room`, 
+    () => sdk2.api.chat_rooms.join_room({ id: emptyRoom.id }), 
+    { onResult: ({ room }) => room.id === emptyRoom.id }
+  ) 
+  await async_test(
+    `get-chat-room (join successful)`, 
+    () => sdk2.api.chat_rooms.getOne(emptyRoom.id), 
+    { onResult: r => r.id === emptyRoom.id }
+  ) 
+  await sdk.api.chat_rooms.deleteOne(emptyRoom.id)
 }
 
 const chat_tests = async() => {
@@ -941,6 +1005,20 @@ const enduserAccessTests = async () => {
   await sdk.api.endusers.deleteOne(enduser.id)
 }
 
+const files_tests = async () => {
+  const buff = buffer.Buffer.from('test file data')
+
+  const { presignedUpload, file } = await sdk.api.files.prepare_file_upload({ 
+    name: 'Test File', size: buff.byteLength, type: 'text/plain' 
+  })
+  await sdk.UPLOAD(presignedUpload, undefined, buff as any)
+
+  const { downloadURL } = await sdk.api.files.file_download_URL({ secureName: file.secureName })
+  const downloaded: string = await sdk.DOWNLOAD(downloadURL)
+
+  assert(downloaded === buff.toString(), 'downloaded file does not match uploaded file', 'upload, download comparison') 
+}
+
 const tests: { [K in keyof ClientModelForName]: () => void } = {
   chats: chat_tests,
   endusers: enduser_tests,
@@ -953,9 +1031,10 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   chat_rooms: chat_room_tests,
   users: () => {},
   templates: () => {},
-  files: () => {},
+  files: files_tests,
   tickets: () => {},
   meetings: () => {},
+  notes: () => {},
 };
 
 (async () => {
@@ -970,6 +1049,7 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
     await updatesTests()
     await threadKeyTests()
     await enduserAccessTests()
+    await generateEnduserAuthTests()
   } catch(err) {
     console.error("Failed during custom test")
     console.error(err)