@tesouro/embedded-components-react 0.2.1

package/dist/lib/BillPayWidget.d.ts

@@ -0,0 +1,743 @@
+import * as React from 'react';
+import { ReactNode, ComponentType, AnchorHTMLAttributes, ErrorInfo } from 'react';
+import { FallbackProps } from 'react-error-boundary';
+
+/**
+ * Action handlers for custom payment flows in payable operations.
+ *
+ * These handlers provide fine-grained control over payment workflows, allowing customers to:
+ * - Integrate external payment providers
+ * - Implement custom approval processes or multi-step authentication
+ * - Add specialized banking solutions or enterprise payment workflows
+ * - Control UI feedback and data refresh timing after payment completion
+ *
+ * @example Custom payment provider integration:
+ * ```typescript
+ * const onPay = (id: string, _data?: unknown, actions?: PayActionHandlers) => {
+ *   // Start custom payment flow
+ *   initiatePayment(id)
+ *     .then(() => {
+ *       // Payment successful - update SDK state and show success message
+ *       actions?.resolve({ showToast: true });
+ *     })
+ *     .catch((error) => {
+ *       // Payment failed - update SDK state and show error message
+ *       actions?.reject(error, { showToast: true });
+ *     });
+ * };
+ * ```
+ */
+type PayActionHandlers = {
+    /**
+     * Call when a custom payment flow has been successfully initiated/completed.
+     * This triggers SDK's built-in state management: refreshes payable data,
+     * payment records, and optionally displays success feedback to the user.
+     *
+     * @param options.showToast - Whether to display a success toast notification
+     */
+    resolve: (options?: {
+        showToast?: boolean;
+    }) => void;
+    /**
+     * Call when a custom payment flow failed or was cancelled by the user.
+     * This triggers SDK's built-in state management: refreshes payable data,
+     * payment records, and optionally displays error feedback to the user.
+     *
+     * @param error - Optional error details from the failed payment attempt
+     * @param options.showToast - Whether to display an error toast notification
+     */
+    reject: (error?: unknown, options?: {
+        showToast?: boolean;
+    }) => void;
+};
+
+type UsePayableDetailsProps = {
+    /**
+     * The ID of the payable
+     */
+    id?: string;
+    /** when provided it takes precedence over component settings */
+    enableGLCodes?: boolean;
+    /** when provided it makes the payable open in edit mode */
+    shouldOpenInEditMode?: boolean;
+    /**
+     * Callback function that is called when the payable is saved
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onSaved?: (id: string) => void;
+    /**
+     * Callback function that is called when the payable is canceled
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onCanceled?: (id: string) => void;
+    /**
+     * Callback function that is called when the payable is submitted
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onSubmitted?: (id: string) => void;
+    /**
+     * Callback function that is called when the payable is rejected
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onRejected?: (id: string) => void;
+    /**
+     * Callback function that is called when the payable is approved
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onApproved?: (id: string) => void;
+    /** Callback function that is called when the payable is reopened
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onReopened?: (id: string) => void;
+    /** Callback function that is called when the payable is deleted
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onDeleted?: (id: string) => void;
+    /**
+     * Callback function that is called when the user press the Pay button
+     *
+     * @param {string} id - The ID of the payable
+     *
+     * @returns {void}
+     */
+    onPay?: (id: string, _data?: unknown, actions?: PayActionHandlers) => void;
+};
+
+type PayablesProps = {
+    pageTitleComponent: (children: ReactNode) => ReactNode;
+    /**
+     * Enable GL code selection for payable line items.
+     * When true, users can assign GL codes to individual line items.
+     * GL codes are fetched from the connected accounting system.
+     */
+    enableGLCodes?: boolean;
+} & Partial<Pick<UsePayableDetailsProps, 'onSaved' | 'onCanceled' | 'onSubmitted' | 'onRejected' | 'onApproved' | 'onReopened' | 'onDeleted' | 'onPay'>>;
+
+type ALIGN_DIALOG_TYPES = 'left' | 'right';
+declare module '@mui/material/transitions' {
+    interface TransitionProps {
+        alignDialog?: ALIGN_DIALOG_TYPES;
+    }
+}
+
+interface FinopsThemeColors {
+    primary?: string;
+    primaryForeground?: string;
+}
+interface MoniteWrapperProps {
+    finopsThemeColors?: FinopsThemeColors;
+}
+
+type AuthToken = string | undefined;
+interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
+    in?: 'header' | 'query' | 'cookie';
+    /**
+     * A unique identifier for the security scheme.
+     *
+     * Defined only when there are multiple security schemes whose `Auth`
+     * shape would otherwise be identical.
+     */
+    key?: string;
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
+    name?: string;
+    scheme?: 'basic' | 'bearer';
+    type: 'apiKey' | 'http';
+}
+
+interface SerializerOptions<T> {
+    /**
+     * @default true
+     */
+    explode: boolean;
+    style: T;
+}
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type ObjectStyle = 'form' | 'deepObject';
+
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
+    allowReserved?: boolean;
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+
+type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    getConfig: () => Config;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+} & {
+    [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? {
+    sse?: never;
+} : {
+    sse: {
+        [K in HttpMethod]: SseFn;
+    };
+});
+interface Config$1 {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: Uppercase<HttpMethod>;
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g., converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+    /**
+     * Callback invoked when a network or parsing error occurs during streaming.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param error The error that occurred.
+     */
+    onSseError?: (error: unknown) => void;
+    /**
+     * Callback invoked when an event is streamed from the server.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param event Event streamed from the server.
+     * @returns Nothing (void).
+     */
+    onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit['body'];
+    /**
+     * Default retry delay in milliseconds.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 3000
+     */
+    sseDefaultRetryDelay?: number;
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    sseMaxRetryAttempts?: number;
+    /**
+     * Maximum retry delay in milliseconds.
+     *
+     * Applies only when exponential backoff is used.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 30000
+     */
+    sseMaxRetryDelay?: number;
+    /**
+     * Optional sleep function for retry backoff.
+     *
+     * Defaults to using `setTimeout`.
+     */
+    sseSleepFn?: (ms: number) => Promise<void>;
+    url: string;
+};
+interface StreamEvent<TData = unknown> {
+    data: TData;
+    event?: string;
+    id?: string;
+    retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+    stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+
+type ResponseStyle = 'data' | 'fields';
+interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    headers: Headers;
+    serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
+}>;
+interface ClientOptions$1 {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+
+type ClientOptions = {
+    baseUrl: 'https://api.stage.tesouro.com' | 'https://api.sandbox.stage.tesouro.com' | 'https://api.stage.business-banking.app' | 'https://api.tesouro.com' | 'https://api.sandbox.tesouro.com' | 'https://api.business-banking.app' | (string & {});
+};
+
+type EmbeddedClient = Client;
+type ExtractLiterals<T> = T extends string ? string extends T ? never : T : never;
+type BaseUrl = ExtractLiterals<ClientOptions['baseUrl']>;
+
+type LinkComponentProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    children?: ReactNode;
+};
+type LinkComponent = ComponentType<LinkComponentProps>;
+/**
+ * The UI frameworks a widget's UI layer can render with.
+ *
+ * - `shadcn` — the shadcn/Tailwind implementation. This is the default and the
+ *   implicit fallback, so existing consumers that select nothing keep rendering
+ *   shadcn.
+ * - `tecton` — the Tecton implementation.
+ *
+ * Declared as an `as const` object (not a TypeScript `enum`) per repo
+ * convention.
+ */
+declare const UIFramework: {
+    readonly Shadcn: "shadcn";
+    readonly Tecton: "tecton";
+};
+type UIFramework = (typeof UIFramework)[keyof typeof UIFramework];
+
+/**
+ * The implementation a widget renders with.
+ *
+ * - `native` — the Tesouro-native implementation. This is the default and the
+ *   implicit fallback, so consumers that select nothing keep rendering native.
+ * - `monite` — the Monite SDK implementation.
+ *
+ * Declared as an `as const` object (not a TypeScript `enum`) per repo
+ * convention.
+ */
+declare const Implementation: {
+    readonly Native: "native";
+    readonly Monite: "monite";
+};
+type Implementation = (typeof Implementation)[keyof typeof Implementation];
+/**
+ * The settable fields of the widget config cascade.
+ *
+ * This is the type accepted by {@link setGlobalWidgetConfig} and all provider props.
+ * It intentionally excludes `initResponse`, which is populated automatically by the
+ * provider after a successful fetch and must never be set manually.
+ *
+ * The `null` vs `undefined` distinction on `widgetToken` and `organizationId` is intentional:
+ * - `undefined` — not set at this level; inherit from the nearest ancestor or global store.
+ * - `null` — explicitly cleared; downstream sees "no value" even if an ancestor had one
+ *   (e.g. after logout or deliberate de-scoping).
+ *
+ * @see {@link WidgetConfig} for the resolved output type (includes `initResponse`)
+ * @see {@link RootWidgetProvider}
+ * @see {@link WidgetProvider}
+ * @see {@link setGlobalWidgetConfig}
+ */
+interface WidgetConfigInput {
+    /**
+     * Base URL of the Tesouro embedded API (e.g. `"https://api.tesouro.com"`).
+     *
+     * When omitted the nearest ancestor's `baseUrl` or the global store value is used.
+     * Changing this recreates the underlying HTTP client so all subsequent requests
+     * go to the new host.
+     */
+    baseUrl?: BaseUrl;
+    /**
+     * Bearer token used to authenticate widget requests.
+     *
+     * Injected as `Authorization: Bearer <token>` on every outgoing request via an
+     * interceptor on the scoped HTTP client. Token updates are picked up immediately
+     * without recreating the client.
+     *
+     * - `string` — send this token on all requests from this level downward.
+     * - `null` — explicitly cleared; no auth header is sent and fetching is suppressed.
+     * - `undefined` — not set at this level; inherit from the nearest ancestor or global store.
+     */
+    widgetToken?: string | null;
+    /**
+     * Organization ID forwarded as the `x-organization-id` request header.
+     *
+     * Passed through {@link EmbedApiProvider} context rather than the auth interceptor,
+     * so individual data-access hooks can opt in per-request.
+     *
+     * - `string` — use this organization for downstream data requests.
+     * - `null` — explicitly cleared; queries that require an org ID will be disabled.
+     * - `undefined` — not set at this level; inherit from the nearest ancestor or global store.
+     *
+     * When `undefined` across the **whole** cascade (no prop, no ancestor, no global
+     * value), the resolved org defaults to the loaded `initResponse.organizationId`
+     * (see {@link WidgetConfig.initResponse}) once the widget-init fetch settles. This
+     * is the lowest-priority fallback — any explicit `string` or `null` at any cascade
+     * level wins, and an explicit `null` is preserved and never falls back.
+     *
+     * Only an **explicit** ancestor org is inherited. An ancestor's *init-derived*
+     * default does not propagate into a descendant that owns its own fetch (its own
+     * `baseUrl`/`widgetToken`); such a descendant defaults to its own
+     * `initResponse.organizationId` instead, so it never sends an ancestor's org with
+     * its own token.
+     */
+    organizationId?: string | null;
+    /**
+     * Optional post-creation hook for the scoped HTTP client.
+     *
+     * Called once after the provider creates its scoped {@link EmbeddedClient} and
+     * applies the built-in `Authorization: Bearer` interceptor. Receives the
+     * fully-configured client and must return the client to be used for the lifetime of
+     * this provider level — either the same instance (with additional interceptors
+     * attached) or a new client entirely.
+     *
+     * **Order:** The built-in auth interceptor is always applied first. `configClient`
+     * is called on top of it, so any interceptors you add here run after auth is set.
+     *
+     * **Any prop triggers a scoped client.** A {@link WidgetProvider} creates its own
+     * scoped client whenever any prop is set — including `configClient` alone, without
+     * `baseUrl` or `widgetToken`. Only a fully props-free pass-through provider skips
+     * client creation and never calls this function.
+     *
+     * **Stability:** The function reference is included in the client creation memo's
+     * dependency array. Passing an unstable (inline) function recreates the client on
+     * every render. Stabilize with `useCallback` or define the function outside the
+     * component.
+     *
+     * **Cascade:** Inherits from the nearest ancestor when `undefined`. A child
+     * {@link WidgetProvider} that creates its own scoped client will use the resolved
+     * `configClient` from the cascade unless it provides its own override.
+     *
+     * @example
+     * ```tsx
+     * const addLogging = useCallback(
+     *   (client: EmbeddedClient) => {
+     *     client.interceptors.request.use((req) => {
+     *       console.log('[widget]', req.method, req.url);
+     *       return req;
+     *     });
+     *     return client;
+     *   },
+     *   [],
+     * );
+     *
+     * <RootWidgetProvider
+     *   baseUrl="https://api.tesouro.com"
+     *   widgetToken={token}
+     *   configClient={addLogging}
+     * >
+     *   <App />
+     * </RootWidgetProvider>
+     * ```
+     */
+    configClient?: (client: EmbeddedClient) => EmbeddedClient;
+    /**
+     * Component the embedded widgets should render in place of plain `<a>` tags.
+     *
+     * Pass e.g. Next.js's `Link` to make in-app navigation use the host router.
+     * Cascades like other config: provider prop > nearest ancestor > global store.
+     * When no value is set anywhere, widgets fall back to a plain `<a>` element.
+     */
+    linkComponent?: LinkComponent;
+    /**
+     * Which UI framework the widget UI layer should render with.
+     *
+     * Lets a consuming context bind widgets to either the shadcn/Tailwind or the
+     * Tecton implementation behind the same outward-facing API. The selection is
+     * a presentation concern only — it cascades through the provider tree exactly
+     * like {@link linkComponent} and is read by UI libraries via `useUIFramework`;
+     * it never appears in any widget's feature-library or component props.
+     *
+     * - `'shadcn'` — the shadcn/Tailwind implementation.
+     * - `'tecton'` — the Tecton implementation.
+     * - `null` / `undefined` — not set at this level; inherit from the nearest
+     *   ancestor or global store, falling back to `shadcn` when unset everywhere.
+     *   `shadcn` is the implicit default, so existing consumers need no changes.
+     */
+    uiFramework?: UIFramework | null;
+    /**
+     * Which implementation a widget renders with.
+     *
+     * Lets a consuming context bind widgets to either the Tesouro-native or the
+     * Monite SDK implementation behind the same outward-facing API. It cascades
+     * through the provider tree exactly like {@link linkComponent} and
+     * {@link uiFramework} — provider prop > nearest ancestor > global store — and
+     * is read via `useImplementation`.
+     *
+     * - `'native'` — the Tesouro-native implementation.
+     * - `'monite'` — the Monite SDK implementation.
+     * - `null` / `undefined` — not set at this level; inherit from the nearest
+     *   ancestor or global store, falling back to `native` when unset everywhere.
+     *   `native` is the implicit default, so existing consumers need no changes.
+     */
+    implementation?: Implementation | null;
+}
+/**
+ * Props shared by every analytics-owner-capable widget provider.
+ *
+ * Combines the full settable cascade ({@link WidgetConfigInput}) with the
+ * analytics opt-out honored by analytics owners. Both {@link RootWidgetProvider}
+ * and {@link WidgetProvider} build their public props on top of this; the latter
+ * adds error-boundary props of its own.
+ *
+ * @see {@link WidgetConfigInput} for per-field cascade and `null` vs omitted semantics
+ */
+interface WidgetProviderBaseProps extends WidgetConfigInput {
+    /**
+     * Opt out of all analytics capture and prevent PostHog from loading. Default `true`.
+     *
+     * Honored only by an analytics **owner** — a {@link RootWidgetProvider} or a
+     * standalone {@link WidgetProvider} with no parent provider. When `false`,
+     * owner-bound `track` calls in this subtree become no-ops and the PostHog
+     * installer is never dynamically imported for this owner's environment.
+     * Setting it on a nested {@link WidgetProvider} is ignored in v1 (a one-time
+     * `console.warn` is emitted to make the no-op discoverable).
+     */
+    analytics?: boolean;
+}
+
+/**
+ * Props for {@link WidgetProvider}.
+ *
+ * All fields are optional. When **all** are omitted the provider is a transparent
+ * pass-through: no fetch is issued and all resolved values cascade unchanged from
+ * the nearest ancestor.
+ */
+interface WidgetProviderProps extends WidgetProviderBaseProps {
+    /**
+     * Fallback rendered when a render-time exception is caught inside this
+     * provider's subtree. Pass either a `ReactNode` (rendered directly) or a
+     * render-prop receiving `{ error, resetErrorBoundary }` from
+     * `react-error-boundary`. Default is a plain `role="alert"` div with
+     * generic copy from `DEFAULT_LABELS.errorBoundaryFallback`.
+     */
+    errorFallback?: ReactNode | ((props: FallbackProps) => ReactNode);
+    /**
+     * Called once when the boundary catches an error, before the fallback
+     * renders. Use for telemetry / Sentry / partner logging. Exceptions
+     * thrown from `onError` propagate per `react-error-boundary` semantics.
+     */
+    onError?: (error: unknown, info: ErrorInfo) => void;
+}
+
+type MoniteRegionProviderProps = WidgetProviderProps & MoniteWrapperProps;
+
+type BillPayWidgetMoniteProps = MoniteRegionProviderProps & Omit<PayablesProps, 'pageTitleComponent'> & {
+    pageTitleComponent?: PayablesProps['pageTitleComponent'];
+};
+
+type BillPayWidgetProps = BillPayWidgetMoniteProps;
+/**
+ * BillPay widget entry point — selects the rendering implementation.
+ *
+ * BillPay is deliberately **pinned to `monite`** until the Tesouro-native
+ * (shadcn) build reaches parity (epic EMBD-2171;
+ * `docs/billpay-usification-shadcn/technical-design.md` §2). `native` is the
+ * global default across widgets, so BillPay applies its own `monite` fallback
+ * whenever *nothing* selects an implementation — this is what keeps the native
+ * build off by default.
+ *
+ * An explicit selection is still honored, whether it comes from this widget's
+ * `implementation` prop or from the provider/global cascade
+ * (`RootWidgetProvider implementation="native"`, `setGlobalWidgetConfig`). We
+ * read the *raw* cascade value (undefined when unset) rather than the resolved
+ * one so the global `native` default does not leak past the pin. The cutover is
+ * a one-line change: drop the `monite` fallback once native is at parity.
+ */
+declare function BillPayWidget({ implementation, ...props }: BillPayWidgetProps): React.JSX.Element;
+
+export { BillPayWidget };
+export type { BillPayWidgetProps };