@tellescope/sdk 0.0.14 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/sdk",
-  "version": "0.0.14",
+  "version": "0.0.18",
   "description": "Code for interacting with the Tellescope API",
   "main": "./lib/cjs/sdk.js",
   "module": "./lib/esm/sdk.js",
@@ -30,14 +30,14 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "^0.0.14",
-    "@tellescope/schema": "^0.0.14",
-    "@tellescope/testing": "^0.0.14",
-    "@tellescope/types-client": "^0.0.14",
-    "@tellescope/types-models": "^0.0.14",
-    "@tellescope/types-utilities": "^0.0.14",
-    "@tellescope/utilities": "^0.0.14",
-    "@tellescope/validation": "^0.0.14",
+    "@tellescope/constants": "^0.0.18",
+    "@tellescope/schema": "^0.0.18",
+    "@tellescope/testing": "^0.0.18",
+    "@tellescope/types-client": "^0.0.18",
+    "@tellescope/types-models": "^0.0.18",
+    "@tellescope/types-utilities": "^0.0.18",
+    "@tellescope/utilities": "^0.0.18",
+    "@tellescope/validation": "^0.0.18",
     "axios": "^0.21.1",
     "form-data": "^4.0.0",
     "socket.io-client": "^4.2.0",
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b57352502a35237c417fa4d5f571f0bb0aa07be2"
+  "gitHead": "8019bedb3e6f90e2d26ee71ee989bd05fc1b7ee6"
 }

package/src/enduser.ts

@@ -1,6 +1,7 @@
 import { io } from 'socket.io-client'
 
-import { Session, SessionOptions, APIQuery } from "./session"
+import { Session, SessionOptions } from "./session"
+import { APIQuery } from "./sdk"
 import { url_safe_path } from "@tellescope/utilities"
 
 import { S3PresignedPost, UserIdentity } from "@tellescope/types-utilities"
@@ -14,7 +15,6 @@ import {
   Enduser,
   File,
 } from "@tellescope/types-client"
-import { stringValidator } from "@tellescope/validation";
 
 export interface EnduserSessionOptions extends SessionOptions {}
 
@@ -30,8 +30,9 @@ export const defaultQueries = <N extends keyof ClientModelForName>(
   return {
     createOne: o => s._POST(`/v1/${singularName}`, o),
     createSome: os => s._POST(`/v1/${safeName}`, { create: os }),
-    getOne: (id, filter) => s._GET(`/v1/${singularName}/${id}`, { filter }),
-    getSome: (o) => s._GET(`/v1/${safeName}`, o),
+    getOne: (argument) => typeof argument === 'string' ? s._GET(`/v1/${singularName}/${argument}`)
+                                                       : s._GET(`/v1/${singularName}`, { filter: argument}),
+    getSome: o => s._GET(`/v1/${safeName}`, o),
     updateOne: (id, updates, options) => s._PATCH(`/v1/${singularName}/${id}`, { updates, options }),
     deleteOne: id => s._DELETE(`/v1/${singularName}/${id}`),
   }
@@ -42,7 +43,7 @@ type EnduserQueries = { [K in EnduserAccessibleModels]: APIQuery<K> } & {
     logout: () => Promise<void>;
   },
   users: {
-    display_names: () => Promise<{ fname: string, lname: string, id: string }[]>
+    display_info: () => Promise<{ fname?: string, lname?: string, id: string, lastActive?: Date, lastLogout?: Date }[]>
   },
   files: {
     prepare_file_upload: (args: { name: string, size: number, type: string }) => Promise<{ presignedUpload: S3PresignedPost, file: File }>,
@@ -76,7 +77,7 @@ export class EnduserSession extends Session {
       logout: () => this._POST('/v1/logout-enduser'),
     }
     this.api.users = { 
-      display_names: () => this._GET<{}, { fname: string, lname: string, id: string }[] >(`/v1/user-display-names`),
+      display_info: () => this._GET<{}, { fname: string, lname: string, id: string }[] >(`/v1/user-display-info`),
     }
     this.api.meetings = { 
       attendee_info: a => this._GET('/v1/attendee-info', a),
@@ -124,8 +125,11 @@ export class EnduserSession extends Session {
     return { authToken, enduser }
   }
 
-  authenticate = async (email: string, password: string) => this.handle_new_session(
-    await this.POST<{email: string, password: string }, { authToken: string, enduser: Enduser }>('/v1/login-enduser', { email, password })
+  authenticate = async (email: string, password: string, o?: { expirationInSeconds?: number }) => this.handle_new_session(
+    await this.POST<
+      {email: string, password: string, expirationInSeconds?: number }, 
+      { authToken: string, enduser: Enduser }
+    >('/v1/login-enduser', { email, password, ...o })
   )
 
   refresh_session = async () => {

package/src/sdk.ts

@@ -1,10 +1,10 @@
 import {
   AttendeeInfo,
   JourneyState, 
-  MeetingStatus, 
   Meeting,
   UserSession,
   MeetingInfo,
+  ReadFilter,
 } from "@tellescope/types-models"
 
 import {
@@ -19,11 +19,19 @@ import {
 import { CustomUpdateOptions, SortOption, S3PresignedPost, UserIdentity } from "@tellescope/types-utilities"
 import { url_safe_path } from "@tellescope/utilities"
 
-import { Session as SessionManager, SessionOptions, Filter } from "./session"
+import { Session as SessionManager, SessionOptions } from "./session"
 
 export * from "./public"
 export * from "./enduser"
 
+export type LoadFunction<T> = (o?: { 
+    lastId?: string, 
+    limit?: number, 
+    sort?: SortOption, 
+    threadKey?: string, 
+    filter?: ReadFilter<T>,
+  }) => Promise<T[]>
+
 export interface APIQuery<
   N extends keyof ClientModelForName, 
   T=ClientModelForName[N], 
@@ -34,8 +42,8 @@ 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[]>
+  getOne: (argument: string | ReadFilter<T>) => Promise<T>;
+  getSome: LoadFunction<T>;
   updateOne: (id: string, updates: UPDATE, options?: CustomUpdateOptions) => Promise<T>;
   deleteOne: (id: string) => Promise<void>;
 }
@@ -50,7 +58,8 @@ export const defaultQueries = <N extends keyof ClientModelForName>(
   return {
     createOne: o => s._POST(`/v1/${singularName}`, o),
     createSome: os => s._POST(`/v1/${safeName}`, { create: os }),
-    getOne: (id, filter) => s._GET(`/v1/${singularName}/${id}`, { filter }),
+    getOne: (argument) => typeof argument === 'string' ? s._GET(`/v1/${singularName}/${argument}`)
+                                                       : s._GET(`/v1/${singularName}`, { filter: argument }),
     getSome: (o) => s._GET(`/v1/${safeName}`, o),
     updateOne: (id, updates, options) => s._PATCH(`/v1/${singularName}/${id}`, { updates, options }),
     deleteOne: id => s._DELETE(`/v1/${singularName}/${id}`),
@@ -72,16 +81,17 @@ 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> } & {
   journeys: {
-    updateState: (args: { id: string, name: string, updates: JourneyState }) => Promise<void>
+    update_state: (args: { id: string, name: string, updates: JourneyState }) => Promise<void>
   },
   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 }>
+    set_password: (args: { id: string, password: string }) => Promise<void>,
+    is_authenticated: (args: { id: string, authToken: string }) => Promise<{ isAuthenticated: boolean, enduser: Enduser }>
+    generate_auth_token: (args: { id?: string, phone?: string, email?: string, externalId?: string }) => Promise<{ authToken: string, enduser: Enduser }>
   },
   users: {
     display_names: () => Promise<{ fname: string, lname: string, id: string }[]>,
@@ -110,10 +120,10 @@ export class Session extends SessionManager {
     super({ ...o, cacheKey: o?.cacheKey || "tellescope_user" })
     const queries = loadDefaultQueries(this) as Queries
 
-    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.journeys.update_state = ({id, name, updates}) => this._PATCH(`/v1/journey/${id}/state/${name}`, { updates })
+    queries.endusers.set_password = ({id, password}) => this._POST(`/v1/set-enduser-password`, { id, password })
+    queries.endusers.is_authenticated = ({id, authToken}) => this._GET(`/v1/enduser-is-authenticated`, { id, authToken })
+    queries.endusers.generate_auth_token = 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),
@@ -170,13 +180,14 @@ export class Session extends SessionManager {
     if (this.AUTO_REFRESH_MS < elapsedSessionMS) { return await this.refresh_session()}
   }
 
-  authenticate = async (email: string, password: string, url?: string) => {
-    if (url) this.host = url
-
-    return this.handle_new_session(
-      await this.POST<{email: string, password: string },  UserSession & { authToken: string }>('/submit-login', { email, password })
-    ) 
-  }
+  authenticate = async (email: string, password: string, o?: { expirationInSeconds?: number }) => (
+    this.handle_new_session(
+      await this.POST<
+        {email: string, password: string, expirationInSeconds?: number }, 
+        UserSession & { authToken: string }
+      >('/submit-login', { email, password, ...o })
+    )
+  ) 
   logout = async () => {
     this.clearState()
     await this.POST('/logout-api').catch(console.error)

package/src/session.ts

@@ -22,6 +22,7 @@ export interface SessionOptions {
   authToken?: string;
   host?: string;
   cacheKey?: string;
+  expirationInSeconds?: number,
   handleUnauthenticated?: () => Promise<void>;
 }
 
@@ -29,24 +30,6 @@ interface RequestOptions {
   refresh_session?: () => Promise<any>,
 }
 
-export type Filter<T> = { [K in keyof T]: T[K] }
-
-export interface APIQuery<
-  N extends keyof ClientModelForName, 
-  T=ClientModelForName[N], 
-  Req=ClientModelForName_required[N], 
-  CREATE=Omit<Req & Partial<T>, keyof ClientModelForName_readonly[N]>, 
-  UPDATE=Omit<Partial<T>, keyof (ClientModelForName_readonly[N] & ClientModelForName_updatesDisabled[N])>,
-> 
-{
-  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 }, f?: Filter<Partial<T>>) => Promise<T[]>
-  updateOne: (id: string, updates: UPDATE, options?: CustomUpdateOptions) => Promise<T>;
-  deleteOne: (id: string) => Promise<void>;
-}
-
 const generateBearer = (authToken: string) => `Bearer ${authToken}`
 
 const parseError = (err: any) => {
@@ -71,6 +54,7 @@ export class Session {
   apiKey?: string;
   socket?: Socket;
   handleUnauthenticated?: SessionOptions['handleUnauthenticated']
+  expirationInSeconds?: number;
   socketAuthenticated: boolean;
   userInfo: { businessId?: string };
   sessionStart = Date.now();
@@ -81,6 +65,7 @@ export class Session {
   constructor(o={} as SessionOptions & RequestOptions) {
     this.host= o.host ?? DEFAULT_HOST
     this.apiKey = o.apiKey ?? '';
+    this.expirationInSeconds = o.expirationInSeconds
     this.socket = undefined as Socket | undefined
     this.socketAuthenticated = false
     this.handleUnauthenticated = o.handleUnauthenticated
@@ -195,6 +180,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/public_endpoint_tests.ts

@@ -32,14 +32,14 @@ const enduser_login_tests = async () => {
   )
   await async_test(
     'setPassword', 
-    () => sdk.api.endusers.setPassword({ id: e.id, password }),
+    () => sdk.api.endusers.set_password({ id: e.id, password }),
     { onResult: _ => true }
   )
 
   let authToken = 'placeholder'
   await async_test(
     'isAuthenticated (no)', 
-    () => sdk.api.endusers.isAuthenticated({ id: e.id, authToken }),
+    () => sdk.api.endusers.is_authenticated({ id: e.id, authToken }),
     { onResult: ({ isAuthenticated, enduser }) => isAuthenticated === false && enduser === null }
   )
   await async_test(
@@ -49,7 +49,7 @@ const enduser_login_tests = async () => {
   )
   await async_test(
     'isAuthenticated (yes)', 
-    () => sdk.api.endusers.isAuthenticated({ id: e.id, authToken }),
+    () => sdk.api.endusers.is_authenticated({ id: e.id, authToken }),
     { onResult: ({ isAuthenticated, enduser }) => isAuthenticated === true && enduser?.id === e.id }
   )
 }
@@ -58,7 +58,7 @@ const enduser_login_tests = async () => {
   log_header("Public Endpoints")
 
   try {
-    await sdk.authenticate(email, password, host)
+    await sdk.authenticate(email, password)
     await sdk.reset_db()
 
     await enduser_login_tests()

package/src/tests/socket_tests.ts

@@ -1,3 +1,4 @@
+import { createHash } from "crypto"
 import {
   assert,
   async_test,
@@ -17,6 +18,7 @@ import { EnduserSession } from "../enduser"
 import { Session, /* APIQuery */ } from "../sdk"
 import { PLACEHOLDER_ID } from "@tellescope/constants"
 
+export const get_sha256 = (s='') => createHash('sha256').update(s).digest('hex')
 
 const host = process.env.TEST_URL || 'http://localhost:8080'
 const [email, password] = [process.env.TEST_EMAIL, process.env.TEST_PASSWORD]
@@ -133,7 +135,7 @@ const access_tests = async () => {
 
 const enduser_tests = async () => {
   const enduser = await user1.api.endusers.createOne({ email: "enduser@tellescope.com" })
-  await user1.api.endusers.setPassword({ id: enduser.id, password: 'enduserPassword!' })
+  await user1.api.endusers.set_password({ id: enduser.id, password: 'enduserPassword!' })
 
   await enduserSDK.authenticate(enduser.email as string, 'enduserPassword!')
   await wait(undefined, 25)
@@ -198,28 +200,89 @@ const enduser_tests = async () => {
   // await user1.api.chats.deleteOne(messageToUser.id)
 }
 
+const TEST_SESSION_DURATION = 2 // seconds
+const SESSION_TIMEOUT_DELAY = 2000 // ms
+const deauthentication_tests = async (byTimeout=false) => {
+  log_header(`Unauthenticated Tests ${byTimeout ? '- With Timeout, requires Worker' : '- With Manual Logout' }`)
+  
+  const enduser = await user1.api.endusers.createOne({ email: "socketenduser@tellescope.com" })
+  await user1.api.endusers.set_password({ id: enduser.id, password: 'enduserPassword!' })
+  await enduserSDK.authenticate(enduser.email as string, 'enduserPassword!', { expirationInSeconds: byTimeout ? TEST_SESSION_DURATION : undefined })
+  await wait(undefined, 25)
+  
+  const room  = await user1.api.chat_rooms.createOne({ 
+    type: 'external', 
+    userIds: [user1.userInfo.id],
+    enduserIds: [enduser.id],
+  })
+
+  const userEvents = [] as ChatMessage[]
+  const enduserEvents = [] as ChatMessage[]
+  user1.subscribe({ [room.id]: 'chats' })
+  enduserSDK.subscribe({ [room.id]: 'chats' }) 
+  user1.handle_events({ 'created-chats': rs => userEvents.push(...rs) }) 
+  enduserSDK.handle_events({ 'created-chats': rs => enduserEvents.push(...rs) }) 
+  await wait(undefined, 10)
+
+  if (!byTimeout) {
+    await enduserSDK.api.endusers.logout()
+  } else {
+    await wait(undefined, TEST_SESSION_DURATION * 1000 + SESSION_TIMEOUT_DELAY) 
+  }
+  await user1.api.chats.createOne({ roomId: room.id, message: "Hello!" })
+  await wait(undefined, 25)
+  assert(objects_equivalent(enduserEvents[0], undefined), 'enduser got message after logout on socket', 'enduser logged out')
+
+  // re-authenticate enduser to send message to user
+  await enduserSDK.authenticate(enduser.email as string, 'enduserPassword!')
+
+  // ensure user logged out appropriately for not receiving message
+  await user1.logout()
+  if (byTimeout) {
+    await user1.authenticate(email, password, { expirationInSeconds: byTimeout ? TEST_SESSION_DURATION : undefined } )
+    await wait(undefined, TEST_SESSION_DURATION * 1000 + SESSION_TIMEOUT_DELAY) 
+  }
+  await enduserSDK.api.chats.createOne({ roomId: room.id, message: "Hello right back!" })
+  await wait(undefined, 25)
+  assert(objects_equivalent(userEvents[0], undefined), 'user got message after logout', 'user logged out')
+
+  // must come before cleanup, so cleanup works
+  await user1.authenticate(email, password), // reauthenticate for later tests as needed
+
+  // cleanup
+  await Promise.all([
+    user1.api.endusers.deleteOne(enduser.id),
+    user1.api.chat_rooms.deleteOne(room.id), // deletes chats as side effect
+  ])
+}
+
 (async () => {
   log_header("Sockets")
 
   try {
-    await user1.authenticate(email, password, host)
+    await user1.authenticate(email, password)
     await user1.reset_db()
-    await user2.authenticate(email2, password2, host) // generate authToken + socket connection for API keyj
+    await user2.authenticate(email2, password2) // generate authToken + socket connection for API keyj
     await wait(undefined, 25)
 
     let loopCount = 0
     while (!(user1.socketAuthenticated && user2.socketAuthenticated) && ++loopCount < 10) {
-      user2.authenticate_socket()
+      if (!user1.socketAuthenticated) user1.authenticate_socket()
+      if (!user2.socketAuthenticated) user2.authenticate_socket()
       await wait(undefined, 100)
     }
     if (loopCount === 10) {
       console.log("Failed to authenticate")
       process.exit()
     }
-    
+
     await enduser_tests()
     await basic_tests()
     await access_tests()
+
+    await deauthentication_tests() // should come last!
+    await deauthentication_tests(true) // should come last!
+
   } catch(err) {
     console.error(err)
   }