@asgardeo/vue 0.0.1 → 0.0.2

package/dist/esm/types/auth-api.d.ts

@@ -0,0 +1,231 @@
+/**
+ * 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.
+ */
+import { AsgardeoSPAClient, AuthClientConfig, BasicUserInfo, Config, IdToken, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/auth-spa';
+import { AuthStateInterface, AuthVueConfig } from './types';
+declare class AuthAPI {
+    static DEFAULT_STATE: AuthStateInterface;
+    private _authState;
+    private _client;
+    constructor(spaClient?: AsgardeoSPAClient);
+    /**
+     * Method to return Auth Client instance authentication state.
+     *
+     * @return {AuthStateInterface} Authentication State.
+     */
+    getState: () => AuthStateInterface;
+    /**
+     * Initializes the AuthClient instance with the given authentication configuration.
+     *
+     * @param {AuthClientConfig<Config>} config - The authentication configuration object
+     *        containing details such as client ID, redirect URLs, and base URL.
+     * @returns {Promise<boolean>} A promise that resolves to `true` if initialization is successful.
+     */
+    init: (config: AuthVueConfig) => Promise<boolean>;
+    /**
+     * Handles user sign-in by exchanging the authorization code for tokens
+     * and updating the authentication state if the user is authenticated.
+     *
+     * @param {SignInConfig} config - The sign-in configuration containing client-specific settings.
+     * @param {string} authorizationCode - The authorization code received from the authentication provider.
+     * @param {string} sessionState - The session state value to track the authentication session.
+     * @param {string} [authState] - An optional authentication state parameter for additional tracking.
+     * @param {{ params: Record<string, unknown> }} [tokenRequestConfig] - Optional token request parameters.
+     * @returns {Promise<BasicUserInfo>} A promise resolving to the authenticated user's basic information.
+     */
+    signIn: (config?: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: BasicUserInfo) => void, tokenRequestConfig?: {
+        params: Record<string, unknown>;
+    }) => Promise<BasicUserInfo>;
+    /**
+     * Signs the user out and resets the authentication state.
+     *
+     * @param {(response?: boolean) => void} callback - An optional callback function to execute after sign-out.
+     * @returns {Promise<boolean>} A promise resolving to `true` if sign-out is successful.
+     *
+     */
+    signOut: (callback?: (response?: boolean) => void) => Promise<boolean>;
+    /**
+     * Method to update Auth Client instance authentication state.
+     *
+     * @param {AuthStateInterface} state - State values to update in authentication state.
+     */
+    updateState(state: AuthStateInterface): void;
+    /**
+     * This method returns a Promise that resolves with the basic user information obtained from the ID token.
+     *
+     * @return {Promise<BasicUserInfo>} a promise that resolves with the user information.
+     */
+    getBasicUserInfo(): Promise<BasicUserInfo>;
+    /**
+     * This method sends an API request to a protected endpoint.
+     * The access token is automatically attached to the header of the request.
+     * This is the only way by which protected endpoints can be accessed
+     * when the web worker is used to store session information.
+     *
+     * @param {HttpRequestConfig} config - The config object containing attributes necessary to send a request.
+     *
+     * @return {Promise<Response>} - Returns a Promise that resolves with the response to the request.
+     */
+    httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
+    /**
+     * This method sends multiple API requests to a protected endpoint.
+     * The access token is automatically attached to the header of the request.
+     * This is the only way by which multiple requests can be sent to protected endpoints
+     * when the web worker is used to store session information.
+     *
+     * @param {HttpRequestConfig[]} configs - The config object containing attributes necessary to send a request.
+     *
+     * @return {Promise<Response>} a Promise that resolves with the responses to the requests.
+     */
+    httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
+    /**
+     * This method allows you to send a request with a custom grant.
+     *
+     * @param {CustomGrantRequestParams} config - The request parameters.
+     * @param {(response: BasicUserInfo | Response) => void} [callback] - An optional callback function.
+     *
+     * @return {Promise<Response | SignInResponse>} a promise that resolves with
+     * the value returned by the custom grant request.
+     */
+    exchangeToken(config: SPACustomGrantConfig, callback?: (response: BasicUserInfo | Response) => void): Promise<BasicUserInfo | Response>;
+    /**
+     * This method ends a user session. The access token is revoked and the session information is destroyed.
+     *
+     * @return {Promise<boolean>} - A promise that resolves with `true` if the process is successful.
+     */
+    revokeAccessToken(): Promise<boolean>;
+    /**
+     * This method returns a Promise that resolves with an object containing the service endpoints.
+     *
+     * @return {Promise<ServiceResourcesType>} - A Promise that resolves with an object containing the service endpoints.
+     */
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
+    /**
+     * This methods returns the Axios http client.
+     *
+     * @return {HttpClientInstance} - The Axios HTTP client.
+     */
+    getHttpClient(): Promise<HttpClientInstance>;
+    /**
+     * This method decodes the payload of the id token and returns it.
+     *
+     * @return {Promise<DecodedIDTokenPayloadInterface>} - A Promise that resolves with
+     * the decoded payload of the id token.
+     */
+    getDecodedIdToken(): Promise<IdToken>;
+    /**
+     * This method decodes the payload of the idp id token and returns it.
+     * @remarks
+     * This method is intended for retrieving the IdP ID token when extending a plugin.
+     *
+     * @return {Promise<DecodedIDTokenPayloadInterface>} - A Promise that resolves with
+     * the decoded payload of the idp id token.
+     */
+    getDecodedIDPIDToken(): Promise<IdToken>;
+    /**
+     * This method returns the ID token.
+     *
+     * @return {Promise<string>} - A Promise that resolves with the id token.
+     */
+    getIdToken(): Promise<string>;
+    /**
+     * This method return a Promise that resolves with the access token.
+     *
+     * @remarks
+     * This method will not return the access token if the storage type is set to `webWorker`.
+     *
+     * @return {Promise<string>} - A Promise that resolves with the access token.
+     */
+    getAccessToken: () => Promise<string>;
+    /**
+     * This method returns a Promise that resolves with the IDP access token.
+     *
+     * @remarks
+     * This method will not return the IDP access token if the storage type is set to `webWorker`.
+     * It can be used to access the IDP access token when custom authentication grant functionalities are used.
+     *
+     * @return {Promise<string>} A Promise that resolves with the IDP access token.
+     */
+    getIDPAccessToken(): Promise<string>;
+    /**
+     * This method refreshes the access token.
+     *
+     * @return {BasicUserInfo} - A Promise that resolves with an object containing
+     * information about the refreshed access token.
+     */
+    refreshAccessToken(): Promise<BasicUserInfo>;
+    /**
+     * This method specifies if the user is authenticated or not.
+     *
+     * @return {Promise<boolean>} - A Promise that resolves with `true` if the user is authenticated.
+     */
+    isSignedIn(): Promise<boolean>;
+    /**
+     * This method specifies if the session is active or not.
+     *
+     * @return {Promise<boolean>} - A Promise that resolves with `true` if there is an active session.
+     */
+    isSessionActive(): Promise<boolean>;
+    /**
+     * This method enables callback functions attached to the http client.
+     *
+     * @return {Promise<boolean>} - A promise that resolves with `true`.
+     */
+    enableHttpHandler(): Promise<boolean>;
+    /**
+     * This method disables callback functions attached to the http client.
+     *
+     * @return {Promise<boolean>} - A promise that resolves with `true`.
+     */
+    disableHttpHandler(): Promise<boolean>;
+    /**
+     * This method updates the configuration that was passed into the constructor when instantiating this class.
+     *
+     * @param {Partial<AuthClientConfig<T>>} config - A config object to update the SDK configurations with.
+     */
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    /**
+     * This method attaches a callback function to an event hook that fires the callback when the event happens.
+     *
+     * @param {Hooks.CustomGrant} hook - The name of the hook.
+     * @param {(response?: any) => void} callback - The callback function.
+     * @param {string} id- Optional id for the hook. This is used when multiple custom grants are used.
+     *
+     */
+    on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): Promise<void>;
+    on(hook: Exclude<Hooks, Hooks.CustomGrant>, callback: (response?: any) => void): Promise<void>;
+    /**
+     * This method allows you to sign in silently.
+     * First, this method sends a prompt-none request to check for an active user session in the identity provider.
+     * If a session exists, it retrieves the access token and stores it. Otherwise, it returns `false`.
+     *
+     * @param {Record<string, string | boolean>} [additionalParams] - Optional additional parameters to be sent with the request.
+     * @param {{ params: Record<string, unknown> }} [tokenRequestConfig] - Optional configuration for the token request.
+     *
+     * @returns {Promise<BasicUserInfo | boolean>} A Promise that resolves with the user information after signing in,
+     * or `false` if the user is not signed in.
+     *
+     * @example
+     * ```
+     * client.trySignInSilently();
+     * ```
+     */
+    trySignInSilently(additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
+        params: Record<string, unknown>;
+    }): Promise<BasicUserInfo | boolean>;
+}
+export default AuthAPI;

package/dist/esm/types/composables/useAsgardeo.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+import { AuthContextInterface } from '../types';
+/**
+ * Hook to access the Asgardeo authentication context.
+ *
+ * @returns {AuthContextInterface} The authentication context containing authentication methods and state.
+ */
+export declare function useAsgardeo(): AuthContextInterface;

package/dist/esm/types/composables/useAsgardeoContext.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+import { AuthContextInterface } from '../types';
+/**
+ * Retrieves the Asgardeo authentication context from Vue's dependency injection system.
+ *
+ * @throws {Error} Throws an error if the Vue plugin is not installed.
+ * @returns {AuthContextInterface} The authentication context containing authentication methods and state.
+ */
+export declare function useAsgardeoContext(): AuthContextInterface;

package/dist/esm/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+export * from './public-api';
+export * from './types';
+export * from '@asgardeo/auth-spa';

package/dist/esm/types/plugins/AsgardeoPlugin.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+import type { Plugin } from 'vue';
+import type { AuthVueConfig } from '../types';
+export type AsgardeoPluginOptions = AuthVueConfig;
+export declare const ASGARDEO_INJECTION_KEY: symbol;
+export declare const asgardeoPlugin: Plugin;

package/dist/esm/types/public-api.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+export { asgardeoPlugin } from './plugins/AsgardeoPlugin';
+export { useAsgardeo } from './composables/useAsgardeo';

package/dist/esm/types/tests/mocks/mocks.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+import { AsgardeoSPAClient } from '@asgardeo/auth-spa';
+import { Mock } from 'vitest';
+import { AuthContextInterface, AuthStateInterface, AuthVueConfig } from '../../types';
+export declare const mockAuthContext: Partial<AuthContextInterface>;
+export declare const mockState: AuthStateInterface;
+export type MockAuthAPI = {
+    disableHttpHandler: Mock;
+    enableHttpHandler: Mock;
+    getAccessToken: Mock;
+    getUser: Mock;
+    getDecodedIdToken: Mock;
+    getHttpClient: Mock;
+    getIdToken: Mock;
+    getOpenIDProviderEndpoints: Mock;
+    getState: Mock;
+    httpRequest: Mock;
+    httpRequestAll: Mock;
+    init: Mock;
+    isSignedIn: Mock;
+    isSessionActive: Mock;
+    on: Mock;
+    refreshAccessToken: Mock;
+    exchangeToken: Mock;
+    revokeAccessToken: Mock;
+    signIn: Mock;
+    signOut: Mock;
+    trySignInSilently: Mock;
+    reInitialize: Mock;
+    updateState: Mock;
+};
+export declare const mockAuthAPI: MockAuthAPI;
+export declare const mockAsgardeoSPAClient: Partial<AsgardeoSPAClient>;
+export declare class MockAsgardeoAuthException extends Error {
+    code: string | undefined;
+    name: string;
+    message: string;
+    constructor(code: string, name: string, message: string);
+}
+export declare const asgardeoAuthSPAMock: any;
+export declare const mockConfig: AuthVueConfig;

package/dist/esm/types/types.d.ts

@@ -0,0 +1,107 @@
+/**
+ * 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.
+ */
+import { AsgardeoAuthException, AuthClientConfig, AuthSPAClientConfig, BasicUserInfo, Config, TokenExchangeRequestConfig, IdToken, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig } from '@asgardeo/auth-spa';
+export 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;
+}
+export type AuthVueConfig = AuthSPAClientConfig & VueConfig;
+/**
+ * Interface for the Authenticated state of the user which is exposed
+ * via `state` object from `useAuthContext` hook.
+ */
+export 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;
+}
+export 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;
+    trySignInSilently: (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`.
+ */
+export interface AuthParams {
+    authorizationCode?: string;
+    sessionState?: string;
+    state?: string;
+}

package/dist/esm/types/vitest.config.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 _default: import("vite").UserConfig;
+export default _default;