@tellescope/sdk 0.0.13 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/sdk",
-  "version": "0.0.13",
+  "version": "0.0.17",
   "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.13",
-    "@tellescope/schema": "^0.0.13",
-    "@tellescope/testing": "^0.0.13",
-    "@tellescope/types-client": "^0.0.13",
-    "@tellescope/types-models": "^0.0.13",
-    "@tellescope/types-utilities": "^0.0.13",
-    "@tellescope/utilities": "^0.0.13",
-    "@tellescope/validation": "^0.0.13",
+    "@tellescope/constants": "^0.0.17",
+    "@tellescope/schema": "^0.0.17",
+    "@tellescope/testing": "^0.0.17",
+    "@tellescope/types-client": "^0.0.17",
+    "@tellescope/types-models": "^0.0.17",
+    "@tellescope/types-utilities": "^0.0.17",
+    "@tellescope/utilities": "^0.0.17",
+    "@tellescope/validation": "^0.0.17",
     "axios": "^0.21.1",
     "form-data": "^4.0.0",
     "socket.io-client": "^4.2.0",
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1eb38568bd39b941e6b4a2bad9e3b33841c26b39"
+  "gitHead": "4f6785b4e580de4f3fceb9bc3d455cc7191cd094"
 }

package/src/enduser.ts

@@ -42,7 +42,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 +76,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),

package/src/sdk.ts

@@ -24,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], 
@@ -35,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>;
 }
@@ -72,16 +74,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 +113,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),

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/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 }
   )
 }

package/src/tests/socket_tests.ts

@@ -133,7 +133,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)

package/src/tests/tests.ts

@@ -1,4 +1,6 @@
 require('source-map-support').install();
+import * as fs from "fs"
+import * as buffer from "buffer" // only node >=15.7.0
 
 import {
   Enduser,
@@ -190,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`, 
@@ -212,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)
@@ -233,11 +265,31 @@ const updatesTests = async () => {
 
 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 })
+  const e = await sdk.api.endusers.createOne({ email: 'generated@tellescope.com', phone: '+15555555555', externalId: '1029f9v9sjd0as' })
+  const { authToken, enduser } = await sdk.api.endusers.generate_auth_token({ id: e.id })
+  assert(!!authToken && !!enduser, 'invalid returned values', 'Generate authToken and get enduser')
+
+  const { isAuthenticated } = await sdk.api.endusers.is_authenticated({ id: enduser.id, authToken })
   assert(isAuthenticated, 'invalid authToken generated for enduser', 'Generate authToken for enduser is valid')
 
+  await async_test(
+    `auth by externalId`, () => sdk.api.endusers.generate_auth_token({ externalId: e.externalId }), passOnVoid,
+  ) 
+  await async_test(
+    `auth by email`, () => sdk.api.endusers.generate_auth_token({ email: e.email }), passOnVoid,
+  ) 
+  await async_test(
+    `auth by phone`, () => sdk.api.endusers.generate_auth_token({ phone: e.phone }), passOnVoid,
+  ) 
+  await async_test(
+    `auth by nothing throws error`, () => sdk.api.endusers.generate_auth_token({ phone: undefined }), 
+    { shouldError: true, onError: e => e.message === "One of id, externalId, email, or phone is required" },
+  ) 
+  await async_test(
+    `auth by bad field throws error`, () => sdk.api.endusers.generate_auth_token({ email: "notavalidemail@tellescope.com" }), 
+    { shouldError: true, onError: e => e.message === "Could not find a corresponding enduser" },
+  ) 
+
   await sdk.api.endusers.deleteOne(enduser.id)
 }
 
@@ -608,7 +660,7 @@ const journey_tests = async (queries=sdk.api.journeys) => {
 
   await async_test(
     `journey-updateState`, 
-    () => queries.updateState({ id: journey.id, name: 'Added', updates: { name: 'Updated', priority: 'N/A' }}),
+    () => queries.update_state({ id: journey.id, name: 'Added', updates: { name: 'Updated', priority: 'N/A' }}),
     passOnVoid,
   )
   await wait(undefined, 25) // wait for side effects to update endusers
@@ -894,7 +946,7 @@ const enduserAccessTests = async () => {
   const password = 'testpassword'
 
   const enduser = await sdk.api.endusers.createOne({ email })
-  await sdk.api.endusers.setPassword({ id: enduser.id, password }).catch(console.error)
+  await sdk.api.endusers.set_password({ id: enduser.id, password }).catch(console.error)
   await enduserSDK.authenticate(email, password).catch(console.error)
 
   for (const n in schema) {
@@ -973,6 +1025,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,
@@ -985,9 +1051,10 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   chat_rooms: chat_room_tests,
   users: () => {},
   templates: () => {},
-  files: () => {},
+  files: files_tests,
   tickets: () => {},
   meetings: () => {},
+  notes: () => {},
 };
 
 (async () => {