feat: Deprecate SeamHttpMultiWorkspace in favor of SeamHttpWithoutWorkspace

Author: razor-x

README.md

@@ -400,7 +400,7 @@ const devices = await pages.flattenToArray()
 ### Interacting with Multiple Workspaces
 
 Some Seam API endpoints interact with multiple workspaces.
-The `SeamHttpMultiWorkspace` client is not bound to a specific workspace
+The `SeamHttpWithoutWorkspace` client is not bound to a specific workspace
 and may use those endpoints with an appropriate authentication method.
 
 #### Personal Access Token
@@ -410,15 +410,15 @@ Obtain one from the Seam Console.
 
 ```ts
 // Set the `SEAM_PERSONAL_ACCESS_TOKEN` environment variable
-const seam = new SeamHttpMultiWorkspace()
+const seam = new SeamHttpWithoutWorkspace()
 
 // Pass as an option to the constructor
-const seam = new SeamHttpMultiWorkspace({
+const seam = new SeamHttpWithoutWorkspace({
   personalAccessToken: 'your-personal-access-token',
 })
 
 // Use the factory method
-const seam = SeamHttpMultiWorkspace.fromPersonalAccessToken(
+const seam = SeamHttpWithoutWorkspace.fromPersonalAccessToken(
   'some-console-session-token',
 )
 
@@ -433,12 +433,12 @@ This authentication method is only used by internal Seam applications.
 
 ```ts
 // Pass as an option to the constructor
-const seam = new SeamHttpMultiWorkspace({
+const seam = new SeamHttpWithoutWorkspace({
   consoleSessionToken: 'some-console-session-token',
 })
 
 // Use the factory method
-const seam = SeamHttpMultiWorkspace.fromConsoleSessionToken(
+const seam = SeamHttpWithoutWorkspace.fromConsoleSessionToken(
   'some-console-session-token',
 )
 

src/lib/seam/connect/auth.ts

@@ -1,17 +1,17 @@
 import {
-  isSeamHttpMultiWorkspaceOptionsWithConsoleSessionToken,
-  isSeamHttpMultiWorkspaceOptionsWithPersonalAccessToken,
   isSeamHttpOptionsWithApiKey,
   isSeamHttpOptionsWithClientSessionToken,
   isSeamHttpOptionsWithConsoleSessionToken,
   isSeamHttpOptionsWithPersonalAccessToken,
+  isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken,
+  isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken,
   SeamHttpInvalidOptionsError,
-  type SeamHttpMultiWorkspaceOptionsWithConsoleSessionToken,
-  type SeamHttpMultiWorkspaceOptionsWithPersonalAccessToken,
   type SeamHttpOptionsWithApiKey,
   type SeamHttpOptionsWithClientSessionToken,
   type SeamHttpOptionsWithConsoleSessionToken,
   type SeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken,
+  type SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken,
 } from './options.js'
 import type { Options } from './parse-options.js'
 import {
@@ -43,14 +43,14 @@ export const getAuthHeaders = (options: Options): Headers => {
   }
 
   if (
-    isSeamHttpMultiWorkspaceOptionsWithConsoleSessionToken(options) ||
+    isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken(options) ||
     isSeamHttpOptionsWithConsoleSessionToken(options)
   ) {
     return getAuthHeadersForConsoleSessionToken(options)
   }
 
   if (
-    isSeamHttpMultiWorkspaceOptionsWithPersonalAccessToken(options) ||
+    isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken(options) ||
     isSeamHttpOptionsWithPersonalAccessToken(options)
   ) {
     return getAuthHeadersForPersonalAccessToken(options)
@@ -142,7 +142,7 @@ const getAuthHeadersForConsoleSessionToken = ({
   consoleSessionToken,
   ...options
 }:
-  | SeamHttpMultiWorkspaceOptionsWithConsoleSessionToken
+  | SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken
   | SeamHttpOptionsWithConsoleSessionToken): Headers => {
   const workspaceId = 'workspaceId' in options ? options.workspaceId : undefined
 
@@ -180,7 +180,7 @@ const getAuthHeadersForPersonalAccessToken = ({
   personalAccessToken,
   ...options
 }:
-  | SeamHttpMultiWorkspaceOptionsWithPersonalAccessToken
+  | SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken
   | SeamHttpOptionsWithPersonalAccessToken): Headers => {
   const workspaceId = 'workspaceId' in options ? options.workspaceId : undefined
 

src/lib/seam/connect/index.ts

@@ -12,8 +12,8 @@ export {
 } from './resolve-action-attempt.js'
 export * from './routes/index.js'
 export * from './seam-http-error.js'
-export * from './seam-http-multi-workspace.js'
 export * from './seam-http-request.js'
+export * from './seam-http-without-workspace.js'
 export * from './seam-paginator.js'
 export * from './seam-paginator.js'
 export {

src/lib/seam/connect/options.ts

@@ -2,11 +2,11 @@ import type { Client, ClientOptions } from './client.js'
 import { isSeamHttpRequestOption } from './parse-options.js'
 import type { ResolveActionAttemptOptions } from './resolve-action-attempt.js'
 
-export type SeamHttpMultiWorkspaceOptions =
-  | SeamHttpMultiWorkspaceOptionsFromEnv
-  | SeamHttpMultiWorkspaceOptionsWithClient
-  | SeamHttpMultiWorkspaceOptionsWithConsoleSessionToken
-  | SeamHttpMultiWorkspaceOptionsWithPersonalAccessToken
+export type SeamHttpWithoutWorkspaceOptions =
+  | SeamHttpWithoutWorkspaceOptionsFromEnv
+  | SeamHttpWithoutWorkspaceOptionsWithClient
+  | SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken
+  | SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken
 
 export type SeamHttpOptions =
   | SeamHttpOptionsFromEnv
@@ -30,17 +30,17 @@ export interface SeamHttpFromPublishableKeyOptions
 
 export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {}
 
-export interface SeamHttpMultiWorkspaceOptionsFromEnv
+export interface SeamHttpWithoutWorkspaceOptionsFromEnv
   extends SeamHttpCommonOptions {}
 
-export interface SeamHttpMultiWorkspaceOptionsWithClient
+export interface SeamHttpWithoutWorkspaceOptionsWithClient
   extends SeamHttpCommonOptions {
   client: Client
 }
 
-export const isSeamHttpMultiWorkspaceOptionsWithClient = (
+export const isSeamHttpWithoutWorkspaceOptionsWithClient = (
   options: SeamHttpOptions,
-): options is SeamHttpMultiWorkspaceOptionsWithClient =>
+): options is SeamHttpWithoutWorkspaceOptionsWithClient =>
   isSeamHttpOptionsWithClient(options)
 
 export interface SeamHttpOptionsWithClient extends SeamHttpRequestOptions {
@@ -128,14 +128,14 @@ export const isSeamHttpOptionsWithClientSessionToken = (
   return true
 }
 
-export interface SeamHttpMultiWorkspaceOptionsWithConsoleSessionToken
+export interface SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken
   extends SeamHttpCommonOptions {
   consoleSessionToken: string
 }
 
-export const isSeamHttpMultiWorkspaceOptionsWithConsoleSessionToken = (
+export const isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken = (
   options: SeamHttpOptions,
-): options is SeamHttpMultiWorkspaceOptionsWithConsoleSessionToken => {
+): options is SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken => {
   if (!('consoleSessionToken' in options)) return false
   if (options.consoleSessionToken == null) return false
 
@@ -169,7 +169,7 @@ export interface SeamHttpOptionsWithConsoleSessionToken
 export const isSeamHttpOptionsWithConsoleSessionToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithConsoleSessionToken => {
-  if (!isSeamHttpMultiWorkspaceOptionsWithConsoleSessionToken(options)) {
+  if (!isSeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken(options)) {
     return false
   }
 
@@ -182,14 +182,14 @@ export const isSeamHttpOptionsWithConsoleSessionToken = (
   return true
 }
 
-export interface SeamHttpMultiWorkspaceOptionsWithPersonalAccessToken
+export interface SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken
   extends SeamHttpCommonOptions {
   personalAccessToken: string
 }
 
-export const isSeamHttpMultiWorkspaceOptionsWithPersonalAccessToken = (
+export const isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken = (
   options: SeamHttpOptions,
-): options is SeamHttpMultiWorkspaceOptionsWithPersonalAccessToken => {
+): options is SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken => {
   if (!('personalAccessToken' in options)) return false
   if (options.personalAccessToken == null) return false
 
@@ -223,7 +223,7 @@ export interface SeamHttpOptionsWithPersonalAccessToken
 export const isSeamHttpOptionsWithPersonalAccessToken = (
   options: SeamHttpOptions,
 ): options is SeamHttpOptionsWithPersonalAccessToken => {
-  if (!isSeamHttpMultiWorkspaceOptionsWithPersonalAccessToken(options)) {
+  if (!isSeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken(options)) {
     return false
   }
 
@@ -243,9 +243,9 @@ export class SeamHttpInvalidOptionsError extends Error {
   }
 }
 
-export class SeamHttpMultiWorkspaceInvalidOptionsError extends Error {
+export class SeamHttpWithoutWorkspaceInvalidOptionsError extends Error {
   constructor(message: string) {
-    super(`SeamHttpMultiWorkspace received invalid options: ${message}`)
+    super(`SeamHttpWithoutWorkspace received invalid options: ${message}`)
     this.name = this.constructor.name
   }
 }

src/lib/seam/connect/parse-options.ts

@@ -4,13 +4,13 @@ import version from 'lib/version.js'
 import { getAuthHeaders } from './auth.js'
 import type { Client, ClientOptions } from './client.js'
 import {
-  isSeamHttpMultiWorkspaceOptionsWithClient,
   isSeamHttpOptionsWithClient,
   isSeamHttpOptionsWithClientSessionToken,
+  isSeamHttpWithoutWorkspaceOptionsWithClient,
   SeamHttpInvalidOptionsError,
-  type SeamHttpMultiWorkspaceOptions,
   type SeamHttpOptions,
   type SeamHttpRequestOptions,
+  type SeamHttpWithoutWorkspaceOptions,
 } from './options.js'
 
 export const defaultEndpoint = 'https://connect.getseam.com'
@@ -22,7 +22,7 @@ export const sdkHeaders = {
 }
 
 export type Options =
-  | SeamHttpMultiWorkspaceOptions
+  | SeamHttpWithoutWorkspaceOptions
   | (SeamHttpOptions & { publishableKey?: string })
 
 type ParsedOptions = Required<
@@ -35,7 +35,7 @@ export const parseOptions = (
   const options = getNormalizedOptions(apiKeyOrOptions)
 
   if (isSeamHttpOptionsWithClient(options)) return options
-  if (isSeamHttpMultiWorkspaceOptionsWithClient(options)) return options
+  if (isSeamHttpWithoutWorkspaceOptionsWithClient(options)) return options
 
   return {
     ...options,