@clerk/shared/dist/types/multiDomain.d.mts

Internal package utils used by the Clerk SDKs

import { ClerkOptions } from "./clerk.mjs";

//#region src/types/multiDomain.d.ts
/**
 * You can configure proxy and satellite domains in a few ways:
 *
 * 1) none of them are set
 * 2) only `proxyUrl` is set
 * 3) `isSatellite` and `proxyUrl` are set
 * 4) `isSatellite` and `domain` are set
 */
type MultiDomainAndOrProxy = {
  /**
   * Indicates whether the application is a satellite application.
   */
  isSatellite?: never;
  /**
   * **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https://<your-domain>/__clerk`).
   */
  proxyUrl?: never | string | ((url: URL) => string);
  /**
   * **Required if your application is a satellite application**. Sets the domain of the satellite application.
   */
  domain?: never;
} | {
  isSatellite: Exclude<ClerkOptions['isSatellite'], undefined>;
  proxyUrl?: never;
  domain: string | ((url: URL) => string);
} | {
  isSatellite: Exclude<ClerkOptions['isSatellite'], undefined>;
  proxyUrl: string | ((url: URL) => string);
  domain?: never;
};
type MultiDomainAndOrProxyPrimitives = {
  /**
   * Indicates whether the application is a satellite application.
   */
  isSatellite?: never;
  /**
   * **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https://<your-domain>/__clerk`).
   */
  proxyUrl?: never | string;
  /**
   * **Required if your application is a satellite application**. Sets the domain of the satellite application.
   */
  domain?: never;
} | {
  isSatellite: boolean;
  proxyUrl?: never;
  domain: string;
} | {
  isSatellite: boolean;
  proxyUrl: string;
  domain?: never;
};
/**
 * If both `proxyUrl` and `domain` are set, the `proxyUrl` will be used.
 */
type DomainOrProxyUrl = {
  /**
   * **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https://<your-domain>/__clerk`), or a function that will be called with a `URL` made from `window.location.href`.
   */
  proxyUrl?: string | ((url: URL) => string);
  /**
   * **Required if your application is a satellite application**. Sets the domain of the satellite application. Can be either a relative path (`/__clerk`) or a full URL (`https://<your-domain>/__clerk`), or a function that will be called with a `URL` made from `window.location.href`.
   */
  domain?: string | ((url: URL) => string);
};
//#endregion
export { DomainOrProxyUrl, MultiDomainAndOrProxy, MultiDomainAndOrProxyPrimitives };