@stripe/ui-extension-sdk/utils/context.d.ts

The suite of functionality available to UI extensions in Stripe apps

import type { NestableJSONValue } from '../types/util';
export type RoleDefinition = {
    name: string;
    type: 'builtIn' | 'custom';
};
export type ExtensionContextValue = {
    userContext: {
        id?: string;
        name?: string | null;
        account: {
            country: string;
            id: string;
            name?: string | null;
            isSandbox: boolean;
        };
        locale: string;
        roles?: RoleDefinition[];
    };
    environment: {
        constants?: NestableJSONValue;
        mode: 'live' | 'test';
        viewportID: string;
        objectContext?: {
            id: string;
            object: string;
        } | null;
        platform?: {
            id: string;
            name: string | null;
        };
    };
    oauthContext?: {
        code?: string;
        error?: string;
        state?: string;
        verifier?: string;
    };
    appContext: {
        authorizedPermissions?: string[];
        authorizedContentSecurityPolicy?: {
            connectSrc: string[] | null;
            imageSrc: string[] | null;
        };
    };
};
export declare const useRefreshDashboardData: () => (() => Promise<void>);