@better-auth-ui/core/dist/plugins/oauth-provider/oauth-scope-metadata.d.ts

Authentication components and data utilities for [Better Auth](https://better-auth.com), available for React and Solid.

/**
 * Human-readable presentation for a single OAuth scope.
 */
export interface OAuthScopeMetadata {
    /** Short permission label displayed to the user. */
    label: string;
    /** Optional explanation of the data or access represented by the scope. */
    description?: string;
}
/**
 * A scope entry in list form. Useful when metadata is loaded from a database
 * or an API and arrives as an array rather than a keyed object.
 */
export interface OAuthScopeMetadataDefinition extends OAuthScopeMetadata {
    /** The raw scope value, e.g. `"calendar.read"`. */
    scope: string;
}
/**
 * Context handed to an {@link OAuthScopeMetadataResolver} so applications can
 * vary labels per requesting client or per scope set.
 */
export interface OAuthScopeMetadataContext {
    /** The OAuth client ID from the signed authorization request, if known. */
    clientId?: string;
    /** Every scope being displayed alongside this one. */
    requestedScopes: readonly string[];
}
/**
 * Synchronous lookup for a single scope.
 *
 * Returning `undefined` means "use the fallback" — the scope stays visible
 * with built-in or raw metadata. It never hides a scope.
 */
export type OAuthScopeMetadataResolver = (scope: string, context: OAuthScopeMetadataContext) => OAuthScopeMetadata | undefined;
/**
 * Keyed scope metadata. Kept as a named type for backwards compatibility with
 * the original record-only `scopeMetadata` option.
 */
export type OAuthScopeMetadataMap = Record<string, OAuthScopeMetadata>;
/**
 * Every shape `scopeMetadata` accepts: a keyed record, a static list, or a
 * resolver function.
 *
 * Resolvers stay synchronous so rendering is deterministic and identical
 * across SSR and every UI package. Applications that need remote metadata
 * should preload it and pass a record or list.
 */
export type OAuthScopeMetadataSource = OAuthScopeMetadataMap | readonly OAuthScopeMetadataDefinition[] | OAuthScopeMetadataResolver;
/** Built-in metadata for the scopes Better Auth supports out of the box. */
export declare const oauthProviderScopeMetadata: OAuthScopeMetadataMap;
/**
 * Resolve the label and description shown for a requested scope.
 *
 * Resolution order:
 *   1. The consumer-provided record, list, or resolver.
 *   2. Built-in metadata for the standard OpenID Connect scopes.
 *   3. The raw scope value as its own label.
 *
 * Every requested scope stays visible — there is no way to resolve to
 * "nothing", so a user always sees the complete set of permissions.
 */
export declare function resolveOAuthScopeMetadata(source: OAuthScopeMetadataSource | undefined, scope: string, context: OAuthScopeMetadataContext): OAuthScopeMetadata;