@seamapi/http 2.1.0 → 2.3.0

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

@@ -1,187 +0,0 @@
-import { seamApiLtsVersion } from 'lib/lts-version.js'
-import version from 'lib/version.js'
-
-import { getAuthHeaders } from './auth.js'
-import type { Client, ClientOptions } from './client.js'
-import {
-  isSeamHttpOptionsWithClient,
-  isSeamHttpOptionsWithClientSessionToken,
-  isSeamHttpWithoutWorkspaceOptionsWithClient,
-  SeamHttpInvalidOptionsError,
-  type SeamHttpOptions,
-  type SeamHttpRequestOptions,
-  type SeamHttpWithoutWorkspaceOptions,
-} from './options.js'
-
-export const defaultEndpoint = 'https://connect.getseam.com'
-
-export const sdkHeaders = {
-  'seam-sdk-name': 'seamapi/javascript-http',
-  'seam-sdk-version': version,
-  'seam-lts-version': seamApiLtsVersion,
-}
-
-export type Options =
-  | SeamHttpWithoutWorkspaceOptions
-  | (SeamHttpOptions & { publishableKey?: string })
-
-type ParsedOptions = Required<
-  (ClientOptions | { client: Client }) & SeamHttpRequestOptions
->
-
-export const parseOptions = (
-  apiKeyOrOptions: string | Options,
-): ParsedOptions => {
-  const options = getNormalizedOptions(apiKeyOrOptions)
-
-  if (isSeamHttpOptionsWithClient(options)) return options
-  if (isSeamHttpWithoutWorkspaceOptionsWithClient(options)) return options
-
-  return {
-    ...options,
-    axiosOptions: {
-      baseURL: options.endpoint ?? getEndpointFromEnv() ?? defaultEndpoint,
-      withCredentials: isSeamHttpOptionsWithClientSessionToken(options),
-      ...options.axiosOptions,
-      headers: {
-        ...getAuthHeaders(options),
-        ...options.axiosOptions?.headers,
-        ...sdkHeaders,
-      },
-    },
-    axiosRetryOptions: {
-      ...options.axiosRetryOptions,
-    },
-  }
-}
-
-const getNormalizedOptions = (
-  apiKeyOrOptions: string | Options,
-): SeamHttpOptions & Required<SeamHttpRequestOptions> => {
-  const options =
-    typeof apiKeyOrOptions === 'string'
-      ? { apiKey: apiKeyOrOptions }
-      : apiKeyOrOptions
-
-  const requestOptions = {
-    waitForActionAttempt: options.waitForActionAttempt ?? true,
-  }
-
-  if (isSeamHttpOptionsWithClient(options)) {
-    return {
-      ...options,
-      ...requestOptions,
-    }
-  }
-
-  const apiKey =
-    'apiKey' in options ? options.apiKey : getApiKeyFromEnv(options)
-
-  const personalAccessToken =
-    'personalAccessToken' in options
-      ? options.personalAccessToken
-      : getPersonalAccessTokenFromEnv(options)
-
-  const workspaceId =
-    'workspaceId' in options ? options.workspaceId : getWorkspaceIdFromEnv()
-
-  if (
-    apiKey != null &&
-    personalAccessToken != null &&
-    !('apiKey' in options) &&
-    !('personalAccessToken' in options)
-  ) {
-    throw new SeamHttpInvalidOptionsError(
-      'Both SEAM_API_KEY and SEAM_PERSONAL_ACCESS_TOKEN environment variables are defined. Please use only one authentication method.',
-    )
-  }
-
-  return {
-    ...options,
-    ...(apiKey != null ? { apiKey } : {}),
-    ...(workspaceId != null ? { workspaceId } : {}),
-    ...(personalAccessToken != null ? { personalAccessToken } : {}),
-    ...requestOptions,
-  }
-}
-
-const getApiKeyFromEnv = (
-  options: SeamHttpOptions,
-): string | null | undefined => {
-  if ('clientSessionToken' in options && options.clientSessionToken != null) {
-    return null
-  }
-  if ('consoleSessionToken' in options && options.consoleSessionToken != null) {
-    return null
-  }
-  if ('personalAccessToken' in options && options.personalAccessToken != null) {
-    return null
-  }
-  return globalThis.process?.env?.SEAM_API_KEY
-}
-
-const getPersonalAccessTokenFromEnv = (
-  options: SeamHttpOptions,
-): string | null | undefined => {
-  if ('apiKey' in options && options.apiKey != null) {
-    return null
-  }
-  if ('clientSessionToken' in options && options.clientSessionToken != null) {
-    return null
-  }
-  if ('consoleSessionToken' in options && options.consoleSessionToken != null) {
-    return null
-  }
-  return globalThis.process?.env?.SEAM_PERSONAL_ACCESS_TOKEN
-}
-
-const getWorkspaceIdFromEnv = (): string | null | undefined => {
-  return globalThis.process?.env?.SEAM_WORKSPACE_ID
-}
-
-const getEndpointFromEnv = (): string | null | undefined => {
-  if (globalThis.process?.env?.SEAM_API_URL != null) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'Using the SEAM_API_URL environment variable is deprecated. Support will be remove in a later major version. Use SEAM_ENDPOINT instead.',
-    )
-  }
-
-  if (
-    globalThis.process?.env?.SEAM_API_URL != null &&
-    globalThis.process?.env?.SEAM_ENDPOINT != null
-  ) {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'Detected both the SEAM_API_URL and SEAM_ENDPOINT environment variables. Using SEAM_ENDPOINT.',
-    )
-  }
-
-  return (
-    globalThis.process?.env?.SEAM_ENDPOINT ??
-    globalThis.process?.env?.SEAM_API_URL
-  )
-}
-
-export const limitToSeamHttpRequestOptions = (
-  options: Required<SeamHttpRequestOptions>,
-): Required<SeamHttpRequestOptions> => {
-  return Object.keys(options)
-    .filter(isSeamHttpRequestOption)
-    .reduce(
-      (obj, key) => ({
-        ...obj,
-        [key]: options[key],
-      }),
-      {},
-    ) as Required<SeamHttpRequestOptions>
-}
-
-export const isSeamHttpRequestOption = (
-  key: string,
-): key is keyof SeamHttpRequestOptions => {
-  const keys: Record<keyof SeamHttpRequestOptions, true> = {
-    waitForActionAttempt: true,
-  }
-  return Object.keys(keys).includes(key)
-}

package/src/lib/seam/connect/resolve-action-attempt.ts

@@ -1,126 +0,0 @@
-import type { ActionAttempt } from './resources/action-attempt.js'
-import type { SeamHttpActionAttempts } from './routes/index.js'
-
-export interface ResolveActionAttemptOptions {
-  timeout?: number
-  pollingInterval?: number
-}
-
-export const resolveActionAttempt = async <T extends ActionAttempt>(
-  actionAttempt: T,
-  actionAttempts: SeamHttpActionAttempts,
-  { timeout = 10_000, pollingInterval = 1_000 }: ResolveActionAttemptOptions,
-): Promise<SucceededActionAttempt<T>> => {
-  let timeoutRef
-  const timeoutPromise = new Promise<SucceededActionAttempt<T>>(
-    (_resolve, reject) => {
-      timeoutRef = globalThis.setTimeout(() => {
-        reject(new SeamActionAttemptTimeoutError<T>(actionAttempt, timeout))
-      }, timeout)
-    },
-  )
-
-  try {
-    return await Promise.race([
-      pollActionAttempt<T>(actionAttempt, actionAttempts, { pollingInterval }),
-      timeoutPromise,
-    ])
-  } finally {
-    if (timeoutRef != null) globalThis.clearTimeout(timeoutRef)
-  }
-}
-
-const pollActionAttempt = async <T extends ActionAttempt>(
-  actionAttempt: T,
-  actionAttempts: SeamHttpActionAttempts,
-  options: Pick<ResolveActionAttemptOptions, 'pollingInterval'>,
-): Promise<SucceededActionAttempt<T>> => {
-  if (isSuccessfulActionAttempt(actionAttempt)) {
-    return actionAttempt
-  }
-
-  if (isFailedActionAttempt(actionAttempt)) {
-    throw new SeamActionAttemptFailedError(actionAttempt)
-  }
-
-  await new Promise((resolve) => setTimeout(resolve, options.pollingInterval))
-
-  const nextActionAttempt = await actionAttempts.get({
-    action_attempt_id: actionAttempt.action_attempt_id,
-  })
-
-  return await pollActionAttempt(
-    nextActionAttempt as unknown as T,
-    actionAttempts,
-    options,
-  )
-}
-
-export const isSeamActionAttemptError = <T extends ActionAttempt>(
-  error: unknown,
-): error is SeamActionAttemptError<T> => {
-  return error instanceof SeamActionAttemptError
-}
-
-export class SeamActionAttemptError<T extends ActionAttempt> extends Error {
-  actionAttempt: T
-
-  constructor(message: string, actionAttempt: T) {
-    super(message)
-    this.name = this.constructor.name
-    this.actionAttempt = actionAttempt
-  }
-}
-
-export const isSeamActionAttemptFailedError = <T extends ActionAttempt>(
-  error: unknown,
-): error is SeamActionAttemptFailedError<T> => {
-  return error instanceof SeamActionAttemptFailedError
-}
-
-export class SeamActionAttemptFailedError<
-  T extends ActionAttempt,
-> extends SeamActionAttemptError<T> {
-  code: string
-
-  constructor(actionAttempt: FailedActionAttempt<T>) {
-    super(actionAttempt.error.message, actionAttempt)
-    this.name = this.constructor.name
-    this.code = actionAttempt.error.type
-  }
-}
-
-export const isSeamActionAttemptTimeoutError = <T extends ActionAttempt>(
-  error: unknown,
-): error is SeamActionAttemptTimeoutError<T> => {
-  return error instanceof SeamActionAttemptTimeoutError
-}
-
-export class SeamActionAttemptTimeoutError<
-  T extends ActionAttempt,
-> extends SeamActionAttemptError<T> {
-  constructor(actionAttempt: T, timeout: number) {
-    super(
-      `Timed out waiting for action action attempt after ${timeout}ms`,
-      actionAttempt,
-    )
-    this.name = this.constructor.name
-  }
-}
-
-const isSuccessfulActionAttempt = <T extends ActionAttempt>(
-  actionAttempt: T,
-): actionAttempt is SucceededActionAttempt<T> =>
-  actionAttempt.status === 'success'
-
-const isFailedActionAttempt = <T extends ActionAttempt>(
-  actionAttempt: T,
-): actionAttempt is FailedActionAttempt<T> => actionAttempt.status === 'error'
-
-export type SucceededActionAttempt<T extends ActionAttempt> = T & {
-  status: 'success'
-}
-
-export type FailedActionAttempt<T extends ActionAttempt> = T & {
-  status: 'error'
-}

package/src/lib/seam/connect/resources/access-code.ts

@@ -1,404 +0,0 @@
-/*
- * Automatically generated by codegen/smith.ts.
- * Do not edit this file.
- */
-
-export type AccessCode = {
-  access_code_id: string
-
-  code: string | null
-  common_code_key: string | null
-  created_at: string
-
-  device_id: string
-
-  dormakaba_oracode_metadata?:
-    | {
-        is_cancellable?: boolean | undefined
-        is_early_checkin_able?: boolean | undefined
-        is_extendable?: boolean | undefined
-        is_overridable?: boolean | undefined
-        site_name?: string | undefined
-        stay_id?: number | undefined
-        user_level_id?: string | undefined
-        user_level_name?: string | null | undefined
-      }
-    | null
-    | undefined
-  ends_at?: string | null | undefined
-  errors: Array<
-    | {
-        created_at?: string | undefined
-        error_code: 'provider_issue'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'failed_to_set_on_device'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'failed_to_remove_from_device'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'duplicate_code_on_device'
-
-        is_access_code_error: boolean
-
-        managed_access_code_id?: string | undefined
-        message: string
-
-        unmanaged_access_code_id?: string | undefined
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'no_space_for_access_code_on_device'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        change_type?: 'modified' | 'removed' | undefined
-        created_at?: string | undefined
-        error_code: 'conflicting_external_modification'
-
-        is_access_code_error: boolean
-
-        message: string
-
-        modified_fields?:
-          | Array<{
-              field: string
-
-              from: string | null
-              to: string | null
-            }>
-          | undefined
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'access_code_inactive'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        created_at?: string | undefined
-        error_code: 'insufficient_permissions'
-
-        is_access_code_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'account_disconnected'
-
-        is_connected_account_error: boolean
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'salto_ks_subscription_limit_exceeded'
-
-        is_connected_account_error: boolean
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'dormakaba_sites_disconnected'
-
-        is_connected_account_error: boolean
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'device_offline'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'device_removed'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'hub_disconnected'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'device_disconnected'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'empty_backup_access_code_pool'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'august_lock_not_authorized'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'missing_device_credentials'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'auxiliary_heat_running'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'subscription_required'
-
-        is_device_error: boolean
-
-        message: string
-      }
-    | {
-        created_at: string
-
-        error_code: 'bridge_disconnected'
-
-        is_bridge_error?: boolean | undefined
-        is_connected_account_error?: boolean | undefined
-        message: string
-      }
-  >
-
-  is_backup?: boolean | undefined
-  is_backup_access_code_available: boolean
-
-  is_external_modification_allowed: boolean
-
-  is_managed: boolean
-
-  is_offline_access_code: boolean
-
-  is_one_time_use: boolean
-
-  is_scheduled_on_device?: boolean | undefined
-  is_waiting_for_code_assignment?: boolean | undefined
-  name: string | null
-  pending_mutations: Array<
-    | {
-        created_at: string
-
-        message: string
-
-        mutation_code: 'creating'
-      }
-    | {
-        created_at: string
-
-        message: string
-
-        mutation_code: 'deferring_creation'
-
-        scheduled_at: string
-      }
-    | {
-        created_at: string
-
-        message: string
-
-        mutation_code: 'deleting'
-      }
-    | {
-        created_at: string
-
-        from: {
-          code: string | null
-        }
-
-        message: string
-
-        mutation_code: 'updating_code'
-
-        to: {
-          code: string | null
-        }
-      }
-    | {
-        created_at: string
-
-        from: {
-          name: string | null
-        }
-
-        message: string
-
-        mutation_code: 'updating_name'
-
-        to: {
-          name: string | null
-        }
-      }
-    | {
-        created_at: string
-
-        from: {
-          ends_at: string | null
-          starts_at: string | null
-        }
-
-        message: string
-
-        mutation_code: 'updating_time_frame'
-
-        to: {
-          ends_at: string | null
-          starts_at: string | null
-        }
-      }
-  >
-
-  pulled_backup_access_code_id?: string | null | undefined
-  starts_at?: string | null | undefined
-  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
-
-  type: 'time_bound' | 'ongoing'
-
-  warnings: Array<
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'code_rotates_periodically'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'time_frame_adjusted_for_unknown_time_zone'
-      }
-    | {
-        change_type?: 'modified' | 'removed' | undefined
-        created_at?: string | undefined
-        message: string
-
-        modified_fields?:
-          | Array<{
-              field: string
-
-              from: string | null
-              to: string | null
-            }>
-          | undefined
-        warning_code: 'external_modification_in_effect'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'delay_in_setting_on_device'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'delay_in_removing_from_device'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'third_party_integration_detected'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'igloo_algopin_must_be_used_within_24_hours'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'management_transferred'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'using_backup_access_code'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'being_deleted'
-      }
-    | {
-        created_at?: string | undefined
-        message: string
-
-        warning_code: 'unknown_issue_with_access_code'
-      }
-  >
-
-  workspace_id: string
-}