Add client with workspaces.get

Author: razor-x

package-lock.json

@@ -71,7 +71,8 @@
     "npm": ">= 8.1.0"
   },
   "dependencies": {
-    "@seamapi/types": "^1.12.0"
+    "@seamapi/types": "^1.13.0",
+    "axios": "^1.5.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.18",

package.json

@@ -0,0 +1,68 @@
+import type {
+  SeamHttpOptionsWithApiKey,
+  SeamHttpOptionsWithClientSessionToken,
+} from './client-options.js'
+
+type Headers = Record<string, string>
+
+export const getAuthHeadersForApiKey = ({
+  apiKey,
+}: SeamHttpOptionsWithApiKey): Headers => {
+  if (isClientSessionToken(apiKey)) {
+    throw new InvalidSeamTokenError(
+      'A Client Session Token cannot be used as an apiKey',
+    )
+  }
+
+  if (isAccessToken(apiKey)) {
+    throw new InvalidSeamTokenError(
+      'An access token cannot be used as an apiKey without specifying a workspaceId',
+    )
+  }
+
+  if (isJwt(apiKey) || !isSeamToken(apiKey)) {
+    throw new InvalidSeamTokenError(
+      `Unknown or Invalid apiKey format, expected token to start with ${tokenPrefix}`,
+    )
+  }
+
+  return {
+    authorization: `Bearer ${apiKey}`,
+  }
+}
+
+export const getAuthHeadersForClientSessionToken = ({
+  clientSessionToken,
+}: SeamHttpOptionsWithClientSessionToken): Headers => {
+  if (!isClientSessionToken(clientSessionToken)) {
+    throw new InvalidSeamTokenError(
+      `Unknown or invalid clientSessionToken format, expected token to start with ${clientSessionTokenPrefix}`,
+    )
+  }
+
+  return {
+    authorization: `Bearer ${clientSessionToken}`,
+    'client-session-token': clientSessionToken,
+  }
+}
+
+export class InvalidSeamTokenError extends Error {
+  constructor(message: string) {
+    super(`SeamHttp received an authorization invalid token: ${message}`)
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor)
+  }
+}
+
+const tokenPrefix = 'seam_'
+
+const clientSessionTokenPrefix = 'seam_cst'
+
+const isClientSessionToken = (token: string): boolean =>
+  token.startsWith(clientSessionTokenPrefix)
+
+const isAccessToken = (token: string): boolean => token.startsWith('seam_at')
+
+const isJwt = (token: string): boolean => token.startsWith('ey')
+
+const isSeamToken = (token: string): boolean => token.startsWith(tokenPrefix)

src/lib/seam/connect/auth.ts

@@ -0,0 +1,55 @@
+import type { AxiosRequestConfig } from 'axios'
+
+export type SeamHttpOptions =
+  | SeamHttpOptionsWithApiKey
+  | SeamHttpOptionsWithClientSessionToken
+
+interface SeamHttpCommonOptions {
+  endpoint?: string
+  axiosOptions?: AxiosRequestConfig
+}
+
+export interface SeamHttpOptionsWithApiKey extends SeamHttpCommonOptions {
+  apiKey: string
+}
+
+export const isSeamHttpOptionsWithApiKey = (
+  options: SeamHttpOptions,
+): options is SeamHttpOptionsWithApiKey => {
+  if (!('apiKey' in options)) return false
+
+  if ('clientSessionToken' in options && options.clientSessionToken != null) {
+    throw new InvalidSeamHttpOptionsError(
+      'The clientSessionToken option cannot be used with the apiKey option.',
+    )
+  }
+
+  return true
+}
+
+export interface SeamHttpOptionsWithClientSessionToken
+  extends SeamHttpCommonOptions {
+  clientSessionToken: string
+}
+
+export const isSeamHttpOptionsWithClientSessionToken = (
+  options: SeamHttpOptions,
+): options is SeamHttpOptionsWithClientSessionToken => {
+  if (!('clientSessionToken' in options)) return false
+
+  if ('apiKey' in options && options.apiKey != null) {
+    throw new InvalidSeamHttpOptionsError(
+      'The clientSessionToken option cannot be used with the apiKey option.',
+    )
+  }
+
+  return true
+}
+
+export class InvalidSeamHttpOptionsError extends Error {
+  constructor(message: string) {
+    super(`SeamHttp received invalid options: ${message}`)
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor)
+  }
+}