bitwarden/browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser synced 2026-02-09 05:00:10 +00:00
Code Issues Releases Wiki Activity

deprecate legacy forwarder types

Browse Source
This commit is contained in:
✨ Audrey ✨
2025-04-21 13:17:17 -04:00
parent 74496d49ce
commit be5d4e5f9c
1 changed files with 46 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
libs/tools/generator/core/src/types/forwarder-options.ts
View File

@@ -7,26 +7,65 @@ import {
import { EmailDomainSettings, EmailPrefixSettings } from "../engine";
// FIXME: this type alias is in place for legacy support purposes;
// when replacing the forwarder implementation, eliminate `ForwarderId` and
// `IntegrationId`. The proper type is `VendorId`.
/** Identifiers for email forwarding services.
* @remarks These are used to select forwarder-specific options.
* The must be kept in sync with the forwarder implementations.
*/
export type ForwarderId = IntegrationId;
/** Options common to all forwarder APIs */
/** Options common to all forwarder APIs
* @deprecated use {@link ForwarderOptions} instead.
*/
export type ApiOptions = ApiSettings & IntegrationRequest;
/** Api configuration for forwarders that support self-hosted installations. */
/** Api configuration for forwarders that support self-hosted installations.
* @deprecated use {@link ForwarderOptions} instead.
*/
export type SelfHostedApiOptions = SelfHostedApiSettings & IntegrationRequest;
/** Api configuration for forwarders that support custom domains. */
/** Api configuration for forwarders that support custom domains.
* @deprecated use {@link ForwarderOptions} instead.
*/
export type EmailDomainOptions = EmailDomainSettings;
/** Api configuration for forwarders that support custom email parts. */
/** Api configuration for forwarders that support custom email parts.
* @deprecated use {@link ForwarderOptions} instead.
*/
export type EmailPrefixOptions = EmailDomainSettings & EmailPrefixSettings;
// These options are used by all forwarders; each forwarder uses a different set,
// as defined by `GeneratorMetadata<T>.capabilities.fields`.
/** These options are used by all forwarders; each forwarder uses a different set,
* as defined by `GeneratorMetadata<T>.capabilities.fields`.
*/
export type ForwarderOptions = Partial<
EmailDomainSettings & EmailPrefixSettings & SelfHostedApiSettings
{
/** bearer token that authenticates bitwarden to the forwarder.
* This is required to issue an API request.
*/
token: string;
/** The base URL of the forwarder's API.
* When this is undefined or empty, the forwarder's default production API is used.
*/
baseUrl: string;
/** The domain part of the generated email address.
* @remarks The domain should be authorized by the forwarder before
* submitting a request through bitwarden.
* @example If the domain is `domain.io` and the generated username
* is `jd`, then the generated email address will be `jd@domain.io`
*/
domain: string;
/** A prefix joined to the generated email address' username.
* @example If the prefix is `foo`, the generated username is `bar`,
* and the domain is `domain.io`, then the generated email address is
* `foobar@domain.io`.
*/
prefix: string;
} & EmailDomainSettings &
EmailPrefixSettings &
SelfHostedApiSettings
>;