@tesouro/embedded-components-react 0.2.1

package/dist/lib/ReceivablesWidget.d.ts

@@ -0,0 +1,985 @@
+import * as React from 'react';
+import { ComponentType, AnchorHTMLAttributes, ReactNode, ErrorInfo } from 'react';
+import { FallbackProps } from 'react-error-boundary';
+
+type ALIGN_DIALOG_TYPES = 'left' | 'right';
+declare module '@mui/material/transitions' {
+    interface TransitionProps {
+        alignDialog?: ALIGN_DIALOG_TYPES;
+    }
+}
+
+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;
+}
+
+interface AddressFieldGroupLabels {
+    line1: string;
+    line2: string;
+    city: string;
+    state: string;
+    statePlaceholder: string;
+    postalCode: string;
+    country: string;
+    /** Fixed country display value (US-only locale in v1). */
+    countryValue: string;
+}
+interface CounterpartFormSheetLabels {
+    createTitleOrganization: string;
+    createTitleIndividual: string;
+    editTitleOrganization: string;
+    editTitleIndividual: string;
+    createTitleCustomer: string;
+    createTitleVendor: string;
+    editTitleCustomer: string;
+    editTitleVendor: string;
+    createDescriptionCustomer: string;
+    createDescriptionVendor: string;
+    customerTypeHeading: string;
+    vendorTypeHeading: string;
+    businessTypeOption: string;
+    businessTypeHint: string;
+    personTypeOption: string;
+    personTypeHint: string;
+    profileHeading: string;
+    addressHeading: string;
+    customerAddressDescription: string;
+    legalNameLabel: string;
+    businessNameLabel: string;
+    firstNameLabel: string;
+    lastNameLabel: string;
+    titleLabel: string;
+    emailLabel: string;
+    phoneLabel: string;
+    taxIdLabel: string;
+    customerTaxIdHelp: string;
+    vendorTaxIdHelp: string;
+    paymentRemindersLabel: string;
+    paymentRemindersDescription: string;
+    paymentMethodsHeading: string;
+    paymentMethodsDescription: string;
+    accountHolderNameLabel: string;
+    routingNumberLabel: string;
+    accountNumberLabel: string;
+    cancelButton: string;
+    createButton: string;
+    saveButton: string;
+    address: AddressFieldGroupLabels;
+}
+
+/**
+ * Overridable validation / error messages produced by the counterparts feature
+ * layer and surfaced through each form's `errors` prop. Consumers override via
+ * the widget's `messageLabels` prop, merged over {@link COUNTERPART_MESSAGE_LABELS_EN}.
+ */
+interface CounterpartMessageLabels {
+    legalNameRequired: string;
+    firstNameRequired: string;
+    lastNameRequired: string;
+    emailRequired: string;
+    emailInvalid: string;
+    addressLine1Required: string;
+    cityRequired: string;
+    stateRequired: string;
+    postalCodeRequired: string;
+    bankAccountNameRequired: string;
+    bankAccountIdentifierRequired: string;
+    bankAccountCurrencyRequired: string;
+    routingNumberInvalid: string;
+    accountNumberInvalid: string;
+    vatIdValueRequired: string;
+    /** Shown for a non-field-specific submit failure. */
+    genericError: string;
+    /** Delete confirmation title; `{name}` is replaced with the entity name. */
+    deleteTitle: string;
+    deleteCounterpartMessage: string;
+    deleteSubEntityMessage: string;
+}
+
+interface ProductFormSheetLabels {
+    createTitle: string;
+    /** Shown in the sheet description for the create form. */
+    headerDescription: string;
+    /** `{type}` is replaced with the product/service word. */
+    editTitle: string;
+    /** `{type}` is replaced with the product/service word. */
+    editingBanner: string;
+    nameLabel: string;
+    namePlaceholder: string;
+    descriptionLabel: string;
+    /** Appended to the description label to indicate it is optional. */
+    descriptionOptional: string;
+    descriptionPlaceholder: string;
+    /** `{count}` is replaced with the current character count. */
+    descriptionCount: string;
+    typeLabel: string;
+    typeProduct: string;
+    typeProductDescription: string;
+    typeService: string;
+    typeServiceDescription: string;
+    unitLabel: string;
+    unitPlaceholder: string;
+    /** Shown as the first option in the unit select to clear/leave blank. */
+    noUnit: string;
+    manageUnits: string;
+    priceLabel: string;
+    currencyLabel: string;
+    currencyPlaceholder: string;
+    cancelButton: string;
+    /** `{type}` is replaced with the product/service word. */
+    createButton: string;
+    saveButton: string;
+}
+interface MeasureUnitsManagerLabels {
+    title: string;
+    hiddenDescription: string;
+    searchPlaceholder: string;
+    columnLabel: string;
+    columnDescription: string;
+    namePlaceholder: string;
+    descriptionPlaceholder: string;
+    addButton: string;
+    doneButton: string;
+    editAction: string;
+    deleteAction: string;
+    saveAction: string;
+    cancelAction: string;
+    emptyText: string;
+}
+interface MeasureUnitDeleteDialogLabels {
+    /** `{name}` is replaced with the unit name. */
+    titleNoItems: string;
+    /** `{name}` is replaced with the unit name. */
+    titleWithItems: string;
+    messageNoItems: string;
+    messageNoItemsHint: string;
+    messageWithItems: string;
+    messageWithItemsHint: string;
+    confirmButton: string;
+    cancelButton: string;
+}
+
+/**
+ * Overridable validation / error messages produced by the products feature
+ * layer and surfaced through the form's `errors` prop and the measure-units
+ * manager. Consumers override via the widget's `messageLabels` prop, merged
+ * over {@link PRODUCT_MESSAGE_LABELS_EN}.
+ */
+interface ProductMessageLabels {
+    nameRequired: string;
+    /** Shown when a name exceeds the 100-character limit. */
+    nameTooLong: string;
+    typeRequired: string;
+    priceInvalid: string;
+    currencyRequired: string;
+    /** Shown when a description exceeds the 255-character limit. */
+    descriptionTooLong: string;
+    unitNameRequired: string;
+    /** Shown for a non-field-specific product submit failure. */
+    genericError: string;
+    /** Fallback when creating a measure unit fails without a server message. */
+    createMeasureUnitError: string;
+    /** Fallback when updating a measure unit fails without a server message. */
+    updateMeasureUnitError: string;
+}
+
+interface ReceivableStatusBadgeLabels {
+    draft: string;
+    issuing: string;
+    issued: string;
+    failed: string;
+    accepted: string;
+    expired: string;
+    declined: string;
+    recurring: string;
+    partially_paid: string;
+    paid: string;
+    overdue: string;
+    uncollectible: string;
+    canceled: string;
+    deleted: string;
+    unknown: string;
+}
+interface ReceivablesScreenLabels {
+    title: string;
+    createButton: string;
+    templateSettingsButton: string;
+    searchPlaceholder: string;
+    statusFilterAll: string;
+    tabInvoices: string;
+    tabQuotes: string;
+    tabCreditNotes: string;
+    columnDocument: string;
+    columnCustomer: string;
+    columnStatus: string;
+    columnIssueDate: string;
+    columnDueDate: string;
+    columnTotal: string;
+    columnAmountDue: string;
+    columnActions: string;
+    sortByDocument: string;
+    sortByCustomer: string;
+    sortByIssueDate: string;
+    sortByDueDate: string;
+    sortByTotal: string;
+    actionEdit: string;
+    actionIssue: string;
+    actionSend: string;
+    actionRecordPayment: string;
+    actionMarkPaid: string;
+    actionMarkUncollectible: string;
+    actionAccept: string;
+    actionDecline: string;
+    actionCancel: string;
+    actionClone: string;
+    actionDelete: string;
+    emptyTitle: string;
+    emptyDescription: string;
+    emptyAction: string;
+    filterEmptyTitle: string;
+    filterEmptyDescription: string;
+    errorTitle: string;
+    errorDescription: string;
+    errorRetry: string;
+    statusBadge: ReceivableStatusBadgeLabels;
+}
+type ReceivablesScreenLabelOverrides = Partial<Omit<ReceivablesScreenLabels, 'statusBadge'>> & {
+    statusBadge?: Partial<ReceivableStatusBadgeLabels>;
+};
+interface ReceivableFormSheetLabels {
+    createTitle: string;
+    editTitle: string;
+    hiddenDescription: string;
+    documentTypeLabel: string;
+    typeInvoice: string;
+    typeQuote: string;
+    customerLabel: string;
+    customerHint: string;
+    currencyLabel: string;
+    issueDateLabel: string;
+    dueDateLabel: string;
+    memoLabel: string;
+    paymentTermsLabel: string;
+    paymentTermsPlaceholder: string;
+    paymentTermsNone: string;
+    lineItemsHeading: string;
+    productLabel: string;
+    quantityLabel: string;
+    addLineItemButton: string;
+    removeLineItemButton: string;
+    cancelButton: string;
+    createButton: string;
+    updateButton: string;
+}
+interface ReceivableDetailsSheetLabels {
+    hiddenDescription: string;
+    loadingTitle: string;
+    errorTitle: string;
+    errorDescription: string;
+    summaryHeading: string;
+    lineItemsHeading: string;
+    activityHeading: string;
+    mailsHeading: string;
+    noLineItems: string;
+    noActivity: string;
+    noMails: string;
+    quantityColumn: string;
+    unitPriceColumn: string;
+    totalColumn: string;
+    closeButton: string;
+    downloadPdfButton: string;
+    editButton: string;
+    issueButton: string;
+    sendButton: string;
+    acceptButton: string;
+    declineButton: string;
+    recordPaymentButton: string;
+    markPaidButton: string;
+    markUncollectibleButton: string;
+    cancelButton: string;
+    cloneButton: string;
+    deleteButton: string;
+    statusBadge: ReceivableStatusBadgeLabels;
+}
+type ReceivableDetailsSheetLabelOverrides = Partial<Omit<ReceivableDetailsSheetLabels, 'statusBadge'>> & {
+    statusBadge?: Partial<ReceivableStatusBadgeLabels>;
+};
+interface ReceivableSendDialogLabels {
+    title: string;
+    description: string;
+    toLabel: string;
+    ccLabel: string;
+    bccLabel: string;
+    subjectLabel: string;
+    bodyLabel: string;
+    cancelButton: string;
+    sendButton: string;
+}
+interface ReceivablePaymentDialogLabels {
+    title: string;
+    description: string;
+    modeLabel: string;
+    fullPayment: string;
+    partialPayment: string;
+    amountPaidLabel: string;
+    paidAtLabel: string;
+    commentLabel: string;
+    cancelButton: string;
+    submitButton: string;
+}
+interface ReceivableActionDialogLabels {
+    cancelButton: string;
+    confirmButton: string;
+}
+
+type ReceivableDocumentType = 'invoice' | 'quote' | 'credit_note';
+type ReceivablesWidgetTab = 'invoices' | 'quotes' | 'credit_notes';
+
+interface ReceivableMessageLabels {
+    customerRequired: string;
+    customerAddressRequired: string;
+    currencyRequired: string;
+    lineItemProductRequired: string;
+    lineItemQuantityInvalid: string;
+    sendToRequired: string;
+    sendSubjectRequired: string;
+    sendBodyRequired: string;
+    paymentAmountInvalid: string;
+    genericError: string;
+    untitledDocument: string;
+    unknownCustomer: string;
+    notAvailable: string;
+    invoiceType: string;
+    quoteType: string;
+    creditNoteType: string;
+    summaryDocumentType: string;
+    summaryDocumentNumber: string;
+    summaryCustomer: string;
+    summaryIssued: string;
+    summaryDue: string;
+    summaryCreated: string;
+    summaryUpdated: string;
+    summaryTotal: string;
+    summaryAmountDue: string;
+    activityStatusChanged: string;
+    activityReceivableCreated: string;
+    activityReceivableUpdated: string;
+    activityPaymentReceived: string;
+    activityMailSent: string;
+    activityUnknown: string;
+    recipientsNone: string;
+    sendSubjectDefault: string;
+    sendBodyDefault: string;
+    issueTitle: string;
+    issueDescription: string;
+    issueConfirm: string;
+    acceptTitle: string;
+    acceptDescription: string;
+    acceptConfirm: string;
+    declineTitle: string;
+    declineDescription: string;
+    declineConfirm: string;
+    cancelTitle: string;
+    cancelDescription: string;
+    cancelConfirm: string;
+    cloneTitle: string;
+    cloneDescription: string;
+    cloneConfirm: string;
+    deleteTitle: string;
+    deleteDescription: string;
+    deleteConfirm: string;
+    markPaidTitle: string;
+    markPaidDescription: string;
+    markPaidConfirm: string;
+    markUncollectibleTitle: string;
+    markUncollectibleDescription: string;
+    markUncollectibleConfirm: string;
+}
+
+interface ReceivablesWidgetOwnProps {
+    defaultTab?: ReceivablesWidgetTab;
+    enabledTabs?: ReceivablesWidgetTab[];
+    pageSizeOptions?: number[];
+    onReceivableCreated?: (id: string, type: ReceivableDocumentType) => void;
+    onReceivableOpened?: (id: string, type: ReceivableDocumentType) => void;
+    onTemplateSettingsClick?: () => void;
+    screenLabels?: ReceivablesScreenLabelOverrides;
+    formLabels?: Partial<ReceivableFormSheetLabels>;
+    detailsLabels?: ReceivableDetailsSheetLabelOverrides;
+    sendLabels?: Partial<ReceivableSendDialogLabels>;
+    paymentLabels?: Partial<ReceivablePaymentDialogLabels>;
+    actionLabels?: Partial<ReceivableActionDialogLabels>;
+    productFormLabels?: Partial<ProductFormSheetLabels>;
+    counterpartFormLabels?: Partial<CounterpartFormSheetLabels>;
+    measureUnitsLabels?: Partial<MeasureUnitsManagerLabels>;
+    measureUnitDeleteLabels?: Partial<MeasureUnitDeleteDialogLabels>;
+    messageLabels?: Partial<ReceivableMessageLabels>;
+    productMessageLabels?: Partial<ProductMessageLabels>;
+    counterpartMessageLabels?: Partial<CounterpartMessageLabels>;
+}
+type ReceivablesWidgetProps = WidgetProviderProps & ReceivablesWidgetOwnProps;
+
+declare function ReceivablesWidget({ baseUrl, widgetToken, organizationId, configClient, linkComponent, implementation, uiFramework, errorFallback, onError, analytics, ...innerProps }: ReceivablesWidgetProps): React.JSX.Element;
+
+export { ReceivablesWidget };
+export type { CounterpartFormSheetLabels, CounterpartMessageLabels, MeasureUnitDeleteDialogLabels, MeasureUnitsManagerLabels, ProductFormSheetLabels, ProductMessageLabels, ReceivableActionDialogLabels, ReceivableDetailsSheetLabelOverrides, ReceivableDetailsSheetLabels, ReceivableDocumentType, ReceivableFormSheetLabels, ReceivableMessageLabels, ReceivablePaymentDialogLabels, ReceivableSendDialogLabels, ReceivableStatusBadgeLabels, ReceivablesScreenLabelOverrides, ReceivablesScreenLabels, ReceivablesWidgetProps, ReceivablesWidgetTab };