@scayle/storefront-nuxt
Version:
Nuxt integration for the SCAYLE Commerce Engine and Storefront API
33 lines (32 loc) • 1.58 kB
TypeScript
/**
* Provides functions for managing user sessions, including login, registration, guest login, token refresh, revocation, password reset, and IDP login.
*
* This composable leverages `useRpcCall` to interact with corresponding RPC methods.
*
* @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/sessions
* @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration
*
* @returns An object containing functions for various session management operations.
*/
export declare function useSession(): {
login: (params: import("utility-types").Optional<import("@scayle/storefront-core").LoginRequest, "shop_id">) => Promise<void | undefined>;
register: (params: import("utility-types").Optional<import("@scayle/storefront-core").RegisterRequest, "shop_id">) => Promise<void | undefined>;
guestLogin: (params: import("utility-types").Optional<import("@scayle/storefront-core").GuestRequest, "shop_id">) => Promise<void | undefined>;
refreshToken: () => Promise<{
success: boolean;
}>;
revokeToken: () => Promise<{
result: boolean;
}>;
forgetPassword: (params: {
email: string;
}) => Promise<{
success: boolean;
}>;
resetPasswordByHash: (params: import("utility-types").Optional<import("@scayle/storefront-core").UpdatePasswordByHashRequest, "shop_id">) => Promise<void | undefined>;
loginWithIDP: (params: {
code: string;
}) => Promise<{
message: string;
}>;
};