@tellescope/sdk 0.0.24 → 0.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/sdk",
-  "version": "0.0.24",
+  "version": "0.0.28",
   "description": "Code for interacting with the Tellescope API",
   "main": "./lib/cjs/sdk.js",
   "module": "./lib/esm/sdk.js",
@@ -32,14 +32,14 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "^0.0.24",
-    "@tellescope/schema": "^0.0.24",
-    "@tellescope/testing": "^0.0.24",
-    "@tellescope/types-client": "^0.0.24",
-    "@tellescope/types-models": "^0.0.24",
-    "@tellescope/types-utilities": "^0.0.24",
-    "@tellescope/utilities": "^0.0.24",
-    "@tellescope/validation": "^0.0.24",
+    "@tellescope/constants": "^0.0.28",
+    "@tellescope/schema": "^0.0.28",
+    "@tellescope/testing": "^0.0.28",
+    "@tellescope/types-client": "^0.0.28",
+    "@tellescope/types-models": "^0.0.28",
+    "@tellescope/types-utilities": "^0.0.28",
+    "@tellescope/utilities": "^0.0.28",
+    "@tellescope/validation": "^0.0.28",
     "axios": "^0.21.1",
     "express": "^4.17.1",
     "form-data": "^4.0.0",
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b43edb136f319f3afac336237c7bcb030bb3c60d"
+  "gitHead": "90f22163cadb40fbba2c44561a56fd4ea6530c16"
 }

package/src/enduser.ts

@@ -4,10 +4,9 @@ import { Session, SessionOptions } from "./session"
 import { APIQuery } from "./sdk"
 import { url_safe_path } from "@tellescope/utilities"
 
-import { S3PresignedPost, UserIdentity } from "@tellescope/types-utilities"
+import { FileBlob, FileBuffer, FileDetails, ReactNativeFile, S3PresignedPost, UserIdentity } from "@tellescope/types-utilities"
 import { 
   Attendee,
-  AttendeeInfo, 
 } from "@tellescope/types-models"
 import {
   ClientModelForName,
@@ -20,7 +19,7 @@ import {
 
 export interface EnduserSessionOptions extends SessionOptions {}
 
-type EnduserAccessibleModels = "chat_rooms" | 'chats' | 'files' | 'tickets'
+type EnduserAccessibleModels = 'endusers' | "chat_rooms" | 'chats' | 'files' | 'tickets' 
 
 export const defaultQueries = <N extends keyof ClientModelForName>(
   s: EnduserSession, n: keyof ClientModelForName_required
@@ -48,7 +47,7 @@ type EnduserQueries = { [K in EnduserAccessibleModels]: APIQuery<K> } & {
     display_info: () => Promise<UserDisplayInfo[]>
   },
   files: {
-    prepare_file_upload: (args: { name: string, size: number, type: string }) => Promise<{ presignedUpload: S3PresignedPost, file: File }>,
+    prepare_file_upload: (args: FileDetails) => Promise<{ presignedUpload: S3PresignedPost, file: File }>,
     file_download_URL: (args: { secureName: string }) => Promise<{ downloadURL: string }>,
   },
   meetings: {
@@ -61,6 +60,7 @@ type EnduserQueries = { [K in EnduserAccessibleModels]: APIQuery<K> } & {
 const loadDefaultQueries = (s: EnduserSession): { [K in EnduserAccessibleModels] : APIQuery<K> } => ({
   chat_rooms: defaultQueries(s, 'chat_rooms'),
   chats: defaultQueries(s, 'chats'),
+  endusers: defaultQueries(s, 'endusers'),
   files: defaultQueries(s, 'files'),
   tickets: defaultQueries(s, 'tickets'),
 })
@@ -76,9 +76,8 @@ export class EnduserSession extends Session {
     
     this.api = loadDefaultQueries(this) as EnduserQueries 
 
-    this.api.endusers = {
-      logout: () => this._POST('/v1/logout-enduser'),
-    }
+    this.api.endusers.logout = () => this._POST('/v1/logout-enduser'),
+
     this.api.users = { 
       display_info: () => this._GET<{}, UserDisplayInfo[] >(`/v1/user-display-info`),
     }
@@ -114,6 +113,13 @@ export class EnduserSession extends Session {
     return await this.DELETE<A,R>(endpoint, args, authenticated)
   }
 
+  prepare_and_upload_file = async (details: FileDetails, file: Blob | Buffer | ReactNativeFile) => {
+    const { name, size, type } = details
+    const { presignedUpload, file: { secureName } } = await this.api.files.prepare_file_upload({ name, size, type })
+    await this.UPLOAD(presignedUpload, file)
+    return { secureName }
+  }
+
   handle_new_session = async ({ authToken, enduser }: { authToken: string, enduser: Enduser }) => {
     this.sessionStart = Date.now()
     this.setAuthToken(authToken)

package/src/sdk.ts

@@ -1,5 +1,4 @@
 import {
-  AttendeeInfo,
   JourneyState, 
   UserSession,
   MeetingInfo,
@@ -18,7 +17,7 @@ import {
   File,
   Meeting,
 } from "@tellescope/types-client"
-import { CustomUpdateOptions, SortOption, S3PresignedPost, UserIdentity } from "@tellescope/types-utilities"
+import { CustomUpdateOptions, SortOption, S3PresignedPost, UserIdentity, FileBlob, FileBuffer, FileDetails, ReactNativeFile } from "@tellescope/types-utilities"
 import { url_safe_path } from "@tellescope/utilities"
 
 import { Session as SessionManager, SessionOptions } from "./session"
@@ -93,14 +92,14 @@ type Queries = { [K in keyof ClientModelForName]: APIQuery<K> } & {
   },
   endusers: {
     set_password: (args: { id: string, password: string }) => Promise<void>,
-    is_authenticated: (args: { id: string, authToken: string }) => Promise<{ isAuthenticated: boolean, enduser: Enduser }>
+    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 }[]>,
   },
   files: {
-    prepare_file_upload: (args: { name: string, size: number, type: string }) => Promise<{ presignedUpload: S3PresignedPost, file: File }>,
+    prepare_file_upload: (args: FileDetails) => Promise<{ presignedUpload: S3PresignedPost, file: File }>,
     file_download_URL: (args: { secureName: string }) => Promise<{ downloadURL: string }>,
   },
   meetings: {
@@ -148,8 +147,6 @@ export class Session extends SessionManager {
     queries.webhooks.update = a => this._PATCH('/v1/update-webhooks', a)
 
     this.api = queries
-
-    // if (this.userInfo) this.refresh_session()
   }
 
   _POST = async <A,R=void>(endpoint: string, args?: A, authenticated=true) => {
@@ -205,6 +202,13 @@ export class Session extends SessionManager {
     await this.POST('/logout-api').catch(console.error)
   }
 
+  prepare_and_upload_file = async (details: FileDetails, file: Blob | Buffer | ReactNativeFile) => {
+    const { name, size, type } = details
+    const { presignedUpload, file: { secureName } } = await this.api.files.prepare_file_upload({ name, size, type })
+    await this.UPLOAD(presignedUpload, file)
+    return { secureName }
+  }
+
   reset_db = () => this.POST('/reset-demo')
   test_online = () => this.GET<{}, string>('/v1')
   test_authenticated = () => this.GET<{}, string>('/v1/test-authenticated')

package/src/session.ts

@@ -4,6 +4,7 @@ import { Socket, io } from 'socket.io-client'
 
 import { 
   FileBlob,
+  ReactNativeFile,
   S3PresignedPost,
 } from "@tellescope/types-utilities"
 import { 
@@ -152,27 +153,17 @@ export class Session {
     } catch(err) { throw await this.errorHandler(err) }
   }
 
-  UPLOAD = async (presigned: S3PresignedPost, file?: FileBlob, buffer?: FileBlob) => {
-    const formData = IN_BROWSER ? new FormData() : new NodeFormData();
+  UPLOAD = async (presigned: S3PresignedPost, file: Blob | Buffer | ReactNativeFile) => {
+    const formData = new NodeFormData();
     Object.keys(presigned.fields).forEach(key => {
-      formData.append(key, presigned.fields[key]);
+      formData.append(key, presigned.fields[key as keyof S3PresignedPost['fields']]);
     });
+    formData.append("file", file) // must be appended last
 
-    // has to be appended last 
-    if (!IN_BROWSER) file = buffer || file // use raw buffer if file is Node Blob
-    formData.append("file", file as Blob)
+    const headers = formData.getHeaders ? { ...formData.getHeaders(), 'Content-Length' : (formData as any).maxDataSize  }
+                  : { 'Content-Type': 'multipart/form-data' }
 
-    try {
-      await axios.post(presigned.url, formData,  {
-        headers: IN_BROWSER 
-          ? { 'Content-Type': 'multipart/form-data'} 
-          : { 
-              ...(formData as NodeFormData).getHeaders(), 
-              'Content-Length' : (formData as any).maxDataSize 
-            }
-      })
-    }
-    catch(err) { console.error(err); throw err }
+    await axios.post(presigned.url, formData,  { headers })
   }
 
   DOWNLOAD = async (downloadURL: string) => { 
@@ -181,6 +172,9 @@ export class Session {
   }
 
   EMIT = async (route: string, args: object, authenticated=true, options={} as RequestOptions) => {
+    if (!this.socket) {
+      this.authenticate_socket() // sets namespace correctly
+    }
     this.socket?.emit(route, { ...args, ...authenticated ? { authToken: this.authToken } : {} } )
   }
 
@@ -199,6 +193,7 @@ export class Session {
   removeAllSocketListeners = (s: string) => this.socket?.removeAllListeners(s)
 
   authenticate_socket = () => {
+    if (!this.userInfo?.businessId) return
     this.socket = io(`${this.host}/${this.userInfo.businessId}`, { transports: ['websocket'] }); // supporting polling requires sticky session at load balancer
     this.socket.on('disconnect', () => { this.socketAuthenticated = false })
     this.socket.on('authenticated', () => { this.socketAuthenticated = true })

package/src/tests/tests.ts

@@ -49,6 +49,7 @@ import {
 const host = process.env.TEST_URL || 'http://localhost:8080'
 const [email, password] = [process.env.TEST_EMAIL, process.env.TEST_PASSWORD]
 const [email2, password2] = [process.env.TEST_EMAIL_2, process.env.TEST_PASSWORD_2]
+const [nonAdminEmail, nonAdminPassword] = [process.env.NON_ADMIN_EMAIL, process.env.NON_ADMIN_PASSWORD]
 
 const userId = '60398b0231a295e64f084fd9'
 
@@ -73,10 +74,11 @@ const userId = '60398b0231a295e64f084fd9'
 
 const sdk = new Session({ host })
 const sdkOther = new Session({ host, apiKey: "ba745e25162bb95a795c5fa1af70df188d93c4d3aac9c48b34a5c8c9dd7b80f7" })
+const sdkNonAdmin = new Session({ host })
 const enduserSDK = new EnduserSession({ host })
 // const sdkOtherEmail = "sebass@tellescope.com"
 
-if (!(email && password && email2 && password2)) {
+if (!(email && password && email2 && password2 && nonAdminEmail && nonAdminPassword)) {
   console.error("Set TEST_EMAIL and TEST_PASSWORD")
   process.exit()
 }
@@ -293,8 +295,13 @@ const generateEnduserAuthTests = async () => {
 
   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 })
+  let { isAuthenticated } = await sdk.api.endusers.is_authenticated({ id: enduser.id, authToken })
   assert(isAuthenticated, 'invalid authToken generated for enduser', 'Generate authToken for enduser is valid')
+  assert(
+    (await sdk.api.endusers.is_authenticated({ authToken })).isAuthenticated,
+    'id omitted results in failed authentication',
+    'id optional for is_authenticated'
+  )
 
   const { authToken: authTokenUID, enduser: enduser2 } = await sdk.api.endusers.generate_auth_token({ externalId })
   assert(!!authTokenUID && !!enduser2, 'invalid returned values eid', 'Generate authToken and get enduser eid')
@@ -967,6 +974,7 @@ const enduserAccessTests = async () => {
   const password = 'testpassword'
 
   const enduser = await sdk.api.endusers.createOne({ email })
+  const enduser2 = await sdk.api.endusers.createOne({ email: 'hi' + email })
   await sdk.api.endusers.set_password({ id: enduser.id, password }).catch(console.error)
   await enduserSDK.authenticate(email, password).catch(console.error)
 
@@ -1019,6 +1027,17 @@ const enduserAccessTests = async () => {
     } 
   }
 
+  await async_test(
+    `enduser can update self`,
+    () => enduserSDK.api.endusers.updateOne(enduser.id, { fname: "Sebastian", lname: "Coates" }), 
+    { onResult: e => e.id === enduser.id && e.fname === 'Sebastian' && e.lname === "Coates" }
+  )
+  await async_test(
+    `enduser can't update other enduser`,
+    () => enduserSDK.api.endusers.updateOne(enduser2.id, { fname: "Shouldn't Work"}), 
+    { shouldError: true, onError: e => e.message === "Could not find a record for the given id" }
+  )
+
   const ticketAccessible = await sdk.api.tickets.createOne({ enduserId: enduser.id, title: "Accessible ticket" })
   const ticketInaccessible = await sdk.api.tickets.createOne({ enduserId: PLACEHOLDER_ID, title: "Inaccessible ticket" })
   await async_test(
@@ -1045,6 +1064,7 @@ const enduserAccessTests = async () => {
   await sdk.api.tickets.deleteOne(ticketAccessible.id)
   await sdk.api.tickets.deleteOne(ticketInaccessible.id)
   await sdk.api.endusers.deleteOne(enduser.id)
+  await sdk.api.endusers.deleteOne(enduser2.id)
 }
 
 const files_tests = async () => {
@@ -1053,7 +1073,7 @@ const files_tests = async () => {
   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)
+  await sdk.UPLOAD(presignedUpload, buff)
 
   const { downloadURL } = await sdk.api.files.file_download_URL({ secureName: file.secureName })
   const downloaded: string = await sdk.DOWNLOAD(downloadURL)
@@ -1075,6 +1095,44 @@ const enduser_session_tests = async () => {
   await sdk.api.endusers.deleteOne(enduser.id)
 }
 
+const users_tests = async () => {
+  log_header("Users Tests")
+  /* Update user tests */
+  await async_test(
+    `update user (non-admin, other user)`,
+    () => sdkNonAdmin.api.users.updateOne(sdk.userInfo.id, { fname: 'Failure' }),
+    { shouldError: true, onError: e => e.message === "Only admin users can update others' profiles" }
+  )
+  await async_test(
+    `update user (non-admin, self)`,
+    () => sdkNonAdmin.api.users.updateOne(sdkNonAdmin.userInfo.id, { fname: 'Updated' }),
+    { onResult: u => u.id === sdkNonAdmin.userInfo.id && u.fname === "Updated" }
+  )
+  await async_test(
+    `verify user update with admin get`,
+    () => sdk.api.users.getOne(sdkNonAdmin.userInfo.id), 
+    { onResult: u => u.id === sdkNonAdmin.userInfo.id && u.fname === "Updated" }
+  )
+
+  // reset fname to "Non" if this test throws, otherwise will falsely pass on next run
+  // NOT Supported behavior any more
+  // assert(sdkNonAdmin.userInfo.fname === 'Updated', 'refresh_session not called on self after update', 'sdk updated on user update')
+
+  await async_test(
+    `update user (admin, other user)`,
+    () => sdk.api.users.updateOne(sdkNonAdmin.userInfo.id, { fname: 'Non' }), // change back
+    { onResult: u => u.id === sdkNonAdmin.userInfo.id && u.fname === "Non" }
+  )
+  // sdkNonAdmin.userInfo.fname = 'Non' // update back in sdk instance as well
+
+  await async_test(
+    `verify user update with admin get`,
+    () => sdk.api.users.getOne(sdkNonAdmin.userInfo.id), 
+    { onResult: u => u.id === sdkNonAdmin.userInfo.id && u.fname === "Non" }
+  )
+
+}
+
 const tests: { [K in keyof ClientModelForName]: () => void } = {
   chats: chat_tests,
   endusers: enduser_tests,
@@ -1085,7 +1143,7 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   emails: email_tests,
   sms_messages: sms_tests,
   chat_rooms: chat_room_tests,
-  users: () => {},
+  users: users_tests,
   templates: () => {},
   files: files_tests,
   tickets: () => {},
@@ -1098,7 +1156,10 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   log_header("API")
 
   try {
-    await sdk.authenticate(email, password)
+    await Promise.all([
+      sdk.authenticate(email, password),
+      sdkNonAdmin.authenticate(nonAdminEmail, nonAdminPassword),
+    ])
     await setup_tests()
     await multi_tenant_tests() // should come right after setup tests
     await badInputTests()