Always use seam over client

Author: razor-x

examples/index.ts

@@ -19,16 +19,16 @@ export type Handler<Options = EmptyOptions> = DefaultHandler<Options, Context>
 type Context = DefaultContext & ClientContext
 
 interface ClientContext {
-  client: SeamHttp
+  seam: SeamHttp
 }
 
 const commands = [workspace]
 
 const createAppContext: MiddlewareFunction = async (argv) => {
   const apiKey = argv['api-key']
   if (typeof apiKey !== 'string') throw new Error('Missing Seam API key')
-  const client = SeamHttp.fromApiKey(apiKey)
-  argv['client'] = client
+  const seam = SeamHttp.fromApiKey(apiKey)
+  argv['seam'] = seam
 }
 
 const middleware = [...defaultMiddleware, createAppContext]

examples/workspace.ts

@@ -11,7 +11,7 @@ export const describe: Describe = 'Get workspace'
 
 export const builder: Builder = {}
 
-export const handler: Handler<Options> = async ({ client, logger }) => {
-  const workspace = await client.workspaces.get()
+export const handler: Handler<Options> = async ({ seam, logger }) => {
+  const workspace = await seam.workspaces.get()
   logger.info({ workspace }, 'workspace')
 }

test/seam/connect/api-key.test.ts

@@ -7,8 +7,8 @@ import { SeamHttpInvalidTokenError } from 'lib/seam/connect/auth.js'
 
 test('SeamHttp: fromApiKey returns instance authorized with apiKey', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
-  const device = await client.devices.get({
+  const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)
@@ -17,17 +17,17 @@ test('SeamHttp: fromApiKey returns instance authorized with apiKey', async (t) =
 
 test('SeamHttp: constructor returns instance authorized with apiKey', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
-  const device = await client.devices.get({
+  const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)
   t.is(device.device_id, seed.august_device_1)
 })
 
 test('SeamHttp: constructor interprets single string argument as apiKey', (t) => {
-  const client = new SeamHttp('seam_apikey_token')
-  t.truthy(client)
+  const seam = new SeamHttp('seam_apikey_token')
+  t.truthy(seam)
   t.throws(() => new SeamHttp('some-invalid-key-format'), {
     instanceOf: SeamHttpInvalidTokenError,
     message: /apiKey/,

test/seam/connect/client-session-token.test.ts

@@ -7,10 +7,10 @@ import { SeamHttpInvalidTokenError } from 'lib/seam/connect/auth.js'
 
 test('SeamHttp: fromClientSessionToken returns instance authorized with clientSessionToken', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromClientSessionToken(seed.seam_cst1_token, {
+  const seam = SeamHttp.fromClientSessionToken(seed.seam_cst1_token, {
     endpoint,
   })
-  const device = await client.devices.get({
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)
@@ -19,11 +19,11 @@ test('SeamHttp: fromClientSessionToken returns instance authorized with clientSe
 
 test('SeamHttp: constructor returns instance authorized with clientSessionToken', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = new SeamHttp({
+  const seam = new SeamHttp({
     clientSessionToken: seed.seam_cst1_token,
     endpoint,
   })
-  const device = await client.devices.get({
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)

test/seam/connect/client.test.ts

@@ -5,10 +5,10 @@ import { SeamHttp } from '@seamapi/http/connect'
 
 test('SeamHttp: fromClient returns instance that uses client', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromClient(
+  const seam = SeamHttp.fromClient(
     SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint }).client,
   )
-  const device = await client.devices.get({
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)
@@ -17,10 +17,10 @@ test('SeamHttp: fromClient returns instance that uses client', async (t) => {
 
 test('SeamHttp: constructor returns instance that uses client', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = new SeamHttp({
+  const seam = new SeamHttp({
     client: SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint }).client,
   })
-  const device = await client.devices.get({
+  const device = await seam.devices.get({
     device_id: seed.august_device_1,
   })
   t.is(device.workspace_id, seed.seed_workspace_1)

test/seam/connect/env.test.ts

@@ -21,8 +21,8 @@ test.serial(
   async (t) => {
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_KEY = seed.seam_apikey1_token
-    const client = new SeamHttp({ endpoint })
-    const device = await client.devices.get({
+    const seam = new SeamHttp({ endpoint })
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -35,8 +35,8 @@ test.serial(
   async (t) => {
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_KEY = 'some-invalid-api-key'
-    const client = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
-    const device = await client.devices.get({
+    const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -48,17 +48,17 @@ test.serial(
   'SeamHttp: apiKey option as first argument overrides environment variables',
   (t) => {
     env.SEAM_API_KEY = 'some-invalid-api-key'
-    const client = new SeamHttp('seam_apikey_token')
-    t.truthy(client)
+    const seam = new SeamHttp('seam_apikey_token')
+    t.truthy(seam)
   },
 )
 
 test.serial(
   'SeamHttp: constructor uses SEAM_API_KEY environment variable when passed no argument',
   (t) => {
     env.SEAM_API_KEY = 'seam_apikey_token'
-    const client = new SeamHttp()
-    t.truthy(client)
+    const seam = new SeamHttp()
+    t.truthy(seam)
   },
 )
 
@@ -89,8 +89,8 @@ test.serial(
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_URL = 'https://example.com'
     env.SEAM_ENDPOINT = endpoint
-    const client = new SeamHttp({ apiKey: seed.seam_apikey1_token })
-    const device = await client.devices.get({
+    const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token })
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -103,8 +103,8 @@ test.serial(
   async (t) => {
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_URL = endpoint
-    const client = new SeamHttp({ apiKey: seed.seam_apikey1_token })
-    const device = await client.devices.get({
+    const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token })
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -118,8 +118,8 @@ test.serial(
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_URL = 'https://example.com'
     env.SEAM_ENDPOINT = 'https://example.com'
-    const client = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
-    const device = await client.devices.get({
+    const seam = new SeamHttp({ apiKey: seed.seam_apikey1_token, endpoint })
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -133,8 +133,8 @@ test.serial(
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_URL = 'https://example.com'
     env.SEAM_ENDPOINT = endpoint
-    const client = SeamHttp.fromApiKey(seed.seam_apikey1_token)
-    const device = await client.devices.get({
+    const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token)
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)
@@ -148,8 +148,8 @@ test.serial(
     const { seed, endpoint } = await getTestServer(t)
     env.SEAM_API_URL = 'https://example.com'
     env.SEAM_ENDPOINT = endpoint
-    const client = SeamHttp.fromClientSessionToken(seed.seam_cst1_token)
-    const device = await client.devices.get({
+    const seam = SeamHttp.fromClientSessionToken(seed.seam_cst1_token)
+    const device = await seam.devices.get({
       device_id: seed.august_device_1,
     })
     t.is(device.workspace_id, seed.seed_workspace_1)

test/seam/connect/serialization.test.ts

@@ -5,26 +5,26 @@ import { SeamHttp } from '@seamapi/http/connect'
 
 test('serializes array params when undefined', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
-  const devices = await client.devices.list({
+  const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
+  const devices = await seam.devices.list({
     device_ids: undefined,
   })
   t.is(devices.length, 4)
 })
 
 test('serializes array params when empty', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
-  const devices = await client.devices.list({
+  const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
+  const devices = await seam.devices.list({
     device_ids: [],
   })
   t.is(devices.length, 0)
 })
 
 test('serializes array params when non-empty', async (t) => {
   const { seed, endpoint } = await getTestServer(t)
-  const client = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
-  const devices = await client.devices.list({
+  const seam = SeamHttp.fromApiKey(seed.seam_apikey1_token, { endpoint })
+  const devices = await seam.devices.list({
     device_ids: [seed.august_device_1, seed.ecobee_device_1],
   })
   t.is(devices.length, 2)