@uppy/companion-client/src/CompanionPluginOptions.ts

Client library for communication with Companion. Intended for use in Uppy plugins.

import type { UIPluginOptions, AsyncStore } from '@uppy/core'

export interface CompanionPluginOptions extends UIPluginOptions {
  storage?: AsyncStore
  companionUrl: string
  companionHeaders?: Record<string, string>
  companionKeysParams?: { key: string; credentialsName: string }
  companionCookiesRule?: 'same-origin' | 'include'
  companionAllowedHosts?: string | RegExp | (string | RegExp)[]
}