@tellescope/sdk 0.0.14 → 0.0.18

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,
@@ -69,7 +71,7 @@ const userId = '60398b0231a295e64f084fd9'
 //   await sdk.api.endusers.deleteOne(enduser.id)
 // }
 
-const sdk = new Session()
+const sdk = new Session({ host })
 const sdkOther = new Session({ host, apiKey: "ba745e25162bb95a795c5fa1af70df188d93c4d3aac9c48b34a5c8c9dd7b80f7" })
 const enduserSDK = new EnduserSession({ host })
 // const sdkOtherEmail = "sebass@tellescope.com"
@@ -88,8 +90,6 @@ const setup_tests = async () => {
   await async_test('test_online', sdk.test_online, { expectedResult: 'API V1 Online' })
   await async_test('test_authenticated', sdk.test_authenticated, { expectedResult: 'Authenticated!' })
 
-  // console.log(await sdk.api.api_keys.createOne({}))
-
   await async_test(
     'test_authenticated (with API Key)', 
     (new Session({ host, apiKey: '3n5q0SCBT_iUvZz-b9BJtX7o7HQUVJ9v132PgHJNJsg.' /* local test key */  })).test_authenticated, 
@@ -98,7 +98,7 @@ const setup_tests = async () => {
 
   await sdk.logout()
   await async_test<string, string>('test_authenticated - (logout invalidates jwt)', sdk.test_authenticated, { shouldError: true, onError: e => e === 'Unauthenticated' })
-  await sdk.authenticate(email, password, host)
+  await sdk.authenticate(email, password)
   await async_test('test_authenticated (re-authenticated)', sdk.test_authenticated, { expectedResult: 'Authenticated!' })
 
   await async_test('reset_db', () => sdk.reset_db(), passOnVoid)
@@ -189,14 +189,39 @@ const threadKeyTests = async () => {
   ])
 }
 
+const badInputTests = async () => {
+  log_header("Bad Input Tests")
+  await async_test(
+    `_-prefixed fields are not allowed`, 
+    () => sdk.api.endusers.createOne({ email: 'failure@tellescope.com', fields: { "_notallowed": 'hello' } }), 
+    { shouldError: true, onError: e => e.message === "Error parsing field fields: Fields that start with '_' are not allowed" },
+  )
+  await async_test(
+    `_-prefixed fields are not allowed`, 
+    () => sdk.api.notes.createOne({ enduserId: PLACEHOLDER_ID, fields: { "_notallowed": 'hello' } }), 
+    { shouldError: true, onError: e => e.message === "Error parsing field fields: Fields that start with '_' are not allowed" },
+  )
+}
+
 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`, 
     () => sdk.api.endusers.getSome({ filter: { email: 'filtertests@tellescope.com' }}), 
     { onResult: es => es.length === 1 && es[0].id === enduser.id },
   )
+  await async_test(
+    `find enduser by _exists filter`, 
+    () => sdk.api.endusers.getSome({ filter: { fname: { _exists: true } }}), 
+    { onResult: es => es.length === 1 && es[0].id === enduser.id },
+  )
+  await async_test(
+    `find enduser by _exists filter (findOne)`, 
+    // () => sdk.api.endusers.getOne({ fname: { _exists: true } }), 
+    () => sdk.api.endusers.getOne({ fname: { _exists: true } }), 
+    { onResult: e => e.id === enduser.id },
+  )
   await async_test(
     `find enduser by compound filter`, 
     () => sdk.api.endusers.getSome({ filter: { email: 'filtertests@tellescope.com', fname: 'test' }}), 
@@ -212,6 +237,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 +288,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)
 }
 
@@ -367,7 +442,7 @@ const run_generated_tests = async <N extends ModelName>({ queries, model, name,
   }
   await async_test(
     `get-${singularName}`, 
-    () => queries.getOne(_id, filter), 
+    () => queries.getOne(_id), 
     { onResult: d => {
         if (!d?.id) return false
 
@@ -400,7 +475,7 @@ const run_generated_tests = async <N extends ModelName>({ queries, model, name,
   )
   await async_test(
     `get-${singularName} (verify delete)`, 
-    () => queries.getOne(_id, filter), 
+    () => queries.getOne(_id), 
     { shouldError: true, onError: e => e.message === 'Could not find a record for the given id' } 
   )
 }
@@ -608,7 +683,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
@@ -788,32 +863,22 @@ const chat_tests = async() => {
   const chat  = await sdk.api.chats.createOne({ roomId: room.id, message: "Hello!" })
   const chat2 = await sdk.api.chats.createOne({ roomId: room.id, message: "Hello..." })
 
-  await async_test(
-    `get-chat (without filter)`, 
-    () => sdk.api.chats.getOne(chat.id), 
-    { shouldError: true, onError: () => true }
-  )
+  // await async_test(
+  //   `get-chat (without filter)`, 
+  //   () => sdk.api.chats.getOne(chat.id), 
+  //   { shouldError: true, onError: () => true }
+  // )
   await async_test(
     `get-chats (without filter)`, 
     () => sdk.api.chats.getSome({}), 
     { shouldError: true, onError: () => true }
   )
-  await async_test(
-    `get-chat (with filter)`, 
-    () => sdk.api.chats.getOne(chat.id, { roomId: room.id }), 
-    { onResult: c => c?.id === chat.id }
-  )
   await async_test(
     `get-chats (with filter)`, 
     () => sdk.api.chats.getSome({ filter: { roomId: room.id } }), 
     { onResult: c => c?.length === 2 }
   )
 
-  await async_test(
-    `get-chat not allowed`, 
-    () => sdk2.api.chats.getOne(chat.id, { roomId: room.id }), 
-    { shouldError: true, onError: e => e.message === 'You do not have permission to access this resource' }
-  )
   await async_test(
     `get-chats not allowed`, 
     () => sdk2.api.chats.getSome({ filter: { roomId: room.id } }), 
@@ -842,12 +907,12 @@ const chat_tests = async() => {
   await wait(undefined, 25)
   await async_test(
     `get-chat (deleted as dependency of room 1)`,
-    () => sdk.api.chats.getOne(chat.id, { roomId: room.id }), 
+    () => sdk.api.chats.getOne(chat.id), 
     { shouldError: true, onError: e => e.message === 'Could not find a record for the given id' }
   )
   await async_test(
     `get-chat (deleted as dependency of room 2)`,
-    () => sdk.api.chats.getOne(chat2.id, { roomId: room.id }), 
+    () => sdk.api.chats.getOne(chat2.id), 
     { shouldError: true, onError: e => e.message === 'Could not find a record for the given id' }
   )
 
@@ -856,12 +921,12 @@ const chat_tests = async() => {
   const sharedChat2 = await sdk2.api.chats.createOne({ roomId: sharedRoom.id, message: "Hello there!", })
   await async_test(
     `get-chat (shared, user1)`,
-    () => sdk.api.chats.getOne(sharedChat.id, { roomId: sharedRoom.id }), 
+    () => sdk.api.chats.getOne(sharedChat.id), 
     { onResult: r => r.id === sharedChat.id }
   )
   await async_test(
     `get-chat (shared, user2)`,
-    () => sdk2.api.chats.getOne(sharedChat.id, { roomId: sharedRoom.id }), 
+    () => sdk2.api.chats.getOne(sharedChat.id), 
     { onResult: r => r.id === sharedChat.id }
   )
   await async_test(
@@ -884,7 +949,7 @@ const chat_tests = async() => {
   await sdk.api.chats.deleteOne(chatNull.id)
   await async_test(
     `get-chat (setNull working)`,
-    () => sdk.api.chats.getOne(chat2Null.id, { roomId: roomNull.id }), 
+    () => sdk.api.chats.getOne(chat2Null.id), 
     { onResult: c => c.replyId === null }
   )
 }
@@ -894,7 +959,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 +1038,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,19 +1064,20 @@ const tests: { [K in keyof ClientModelForName]: () => void } = {
   chat_rooms: chat_room_tests,
   users: () => {},
   templates: () => {},
-  files: () => {},
+  files: files_tests,
   tickets: () => {},
   meetings: () => {},
+  notes: () => {},
 };
 
 (async () => {
-  await sdk.authenticate(email, password, host)
-
   log_header("API")
-  
+
   try {
+    await sdk.authenticate(email, password)
     await setup_tests()
     await multi_tenant_tests() // should come right after setup tests
+    await badInputTests()
     await filterTests()
     await updatesTests()
     await threadKeyTests()