@scayle/storefront-core/dist/rpc/methods/oauth/idp.d.ts

Collection of essential utilities to work with the Storefront API

import type { RpcHandler } from '../../../types';
/**
 * Retrieves external IDP redirect URLs.
 *
 * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration#overview
 *
 * @param params The parameters for retrieving the external IDP redirect.
 * @param params.queryParams Optional query parameters to include in the redirect URLs.
 * @param params.authUrlParameters Optional query parameters to provide to the IDP service.
 * @param context The RPC context.
 *
 * @returns A record mapping IDP keys to their corresponding redirect URLs,
 * or an ErrorResponse if an error occurs. It will return an `ErrorResponse`
 * if JWT signing fails or another unexpected error occurs.
 */
export declare const getExternalIdpRedirect: RpcHandler<{
    queryParams?: Record<string, string>;
    authUrlParameters?: Record<string, string>;
}, Record<string, string>>;
/**
 * Handles the IDP login callback.
 *
 * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration#overview
 *
 * @param payload The payload containing the authorization code.
 * @param payload.code The authorization code.
 * @param context The RPC context.
 *
 * @returns A success message, or an `ErrorResponse` an error during login occurs.
 */
export declare const handleIDPLoginCallback: RpcHandler<{
    code: string;
}, {
    message: string;
}>;