@asgardeo/vue/dist/index.d.ts

Vue SDK for Asgardeo - Authentication and Identity Management

import { Plugin } from 'vue';
import { AuthSPAClientConfig, AsgardeoAuthException, BasicUserInfo, IdToken, HttpClientInstance, OIDCEndpoints, HttpRequestConfig, HttpResponse, Hooks, TokenExchangeRequestConfig, SignInConfig, AuthClientConfig, Config } from '@asgardeo/auth-spa';
export * from '@asgardeo/auth-spa';

/**
 * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

interface VueConfig {
    /**
     * Prevents the SDK from automatically signing in the user if an active session exists.
     */
    disableAutoSignIn?: boolean;
    /**
     * The SDK attempts to check for an active session on the server and update
     * session state automatically. This option allows disabling that behavior.
     */
    disableTrySignInSilently?: boolean;
    /**
     * The SDK's `AuthProvider` by default listens to route changes
     * to detect `code` & `session_state` parameters and perform a token exchange.
     * This option allows disabling that behavior.
     */
    skipRedirectCallback?: boolean;
}
type AuthVueConfig = AuthSPAClientConfig & VueConfig;
/**
 * Interface for the Authenticated state of the user which is exposed
 * via `state` object from `useAuthContext` hook.
 */
interface AuthStateInterface {
    /**
     * The scopes that are allowed for the user.
     */
    allowedScopes: string;
    /**
     * The display name of the user.
     */
    displayName?: string;
    /**
     * The email address of the user.
     */
    email?: string;
    /**
     * Specifies if the user is authenticated or not.
     */
    isSignedIn: boolean;
    /**
     * Are the Auth requests loading.
     */
    isLoading: boolean;
    /**
     * The uid corresponding to the user who the ID token belonged to.
     */
    sub?: string;
    /**
     * The username of the user.
     */
    username?: string;
}
interface AuthContextInterface {
    disableHttpHandler(): Promise<boolean>;
    enableHttpHandler(): Promise<boolean>;
    error: AsgardeoAuthException;
    getAccessToken(): Promise<string>;
    getUser(): Promise<BasicUserInfo>;
    getDecodedIdToken(): Promise<IdToken>;
    getHttpClient(): Promise<HttpClientInstance>;
    getIdToken(): Promise<string>;
    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
    httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
    httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
    isSignedIn(): Promise<boolean>;
    on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): void;
    on(hook: Exclude<Hooks, Hooks.CustomGrant>, callback: (response?: any) => void): void;
    on(hook: Hooks, callback: (response?: any) => void, id?: string): void;
    refreshAccessToken(): Promise<BasicUserInfo>;
    exchangeToken(config: TokenExchangeRequestConfig, callback?: (response: BasicUserInfo | Response) => void): void;
    revokeAccessToken(): Promise<boolean>;
    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, state?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
        params: Record<string, unknown>;
    }) => Promise<BasicUserInfo>;
    signOut: (callback?: (response: boolean) => void) => Promise<boolean>;
    state: AuthStateInterface;
    signInSilently: (additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
        params: Record<string, unknown>;
    }) => Promise<boolean | BasicUserInfo>;
    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
}
/**
 * The model of the object returned by the `getAuthParams` prop method of the `AuthProvider`.
 */
interface AuthParams {
    authorizationCode?: string;
    sessionState?: string;
    state?: string;
}

/**
 * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

declare const asgardeoPlugin: Plugin;

/**
 * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * Hook to access the Asgardeo authentication context.
 *
 * @returns {AuthContextInterface} The authentication context containing authentication methods and state.
 */
declare function useAsgardeo(): AuthContextInterface;

export { type AuthContextInterface, type AuthParams, type AuthStateInterface, type AuthVueConfig, type VueConfig, asgardeoPlugin, useAsgardeo };