@asgardeo/vue 0.0.10 → 0.2.0

package/dist/keys.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { InjectionKey } from 'vue';
+import type { AsgardeoContext, BrandingContextValue, FlowContextValue, FlowMetaContextValue, I18nContextValue, OrganizationContextValue, ThemeContextValue, UserContextValue } from './models/contexts';
+/**
+ * Injection key for the core Asgardeo authentication context.
+ */
+export declare const ASGARDEO_KEY: InjectionKey<AsgardeoContext>;
+/**
+ * Injection key for the User context (profile, schemas, update operations).
+ */
+export declare const USER_KEY: InjectionKey<UserContextValue>;
+/**
+ * Injection key for the Organization context (list, current org, switching).
+ */
+export declare const ORGANIZATION_KEY: InjectionKey<OrganizationContextValue>;
+/**
+ * Injection key for the Flow context (embedded flow UI state).
+ */
+export declare const FLOW_KEY: InjectionKey<FlowContextValue>;
+/**
+ * Injection key for the FlowMeta context (server-driven flow metadata).
+ */
+export declare const FLOW_META_KEY: InjectionKey<FlowMetaContextValue>;
+/**
+ * Injection key for the Theme context (color scheme, CSS variables, toggle).
+ */
+export declare const THEME_KEY: InjectionKey<ThemeContextValue>;
+/**
+ * Injection key for the Branding context (branding preferences from server).
+ */
+export declare const BRANDING_KEY: InjectionKey<BrandingContextValue>;
+/**
+ * Injection key for the I18n context (translation function, language switching).
+ */
+export declare const I18N_KEY: InjectionKey<I18nContextValue>;

package/dist/models/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.
+ */
+import { AsgardeoBrowserConfig } from '@asgardeo/browser';
+export type AsgardeoVueConfig = AsgardeoBrowserConfig;

package/dist/models/contexts.d.ts

@@ -0,0 +1,244 @@
+/**
+ * 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 { AllOrganizationsApiResponse, BrandingPreference, CreateOrganizationPayload, FlowMetadataResponse, HttpRequestConfig, HttpResponse, IdToken, Organization, Schema, SignInOptions, Theme, TokenExchangeRequestConfig, TokenResponse, UpdateMeProfileConfig, User, UserProfile } from '@asgardeo/browser';
+import type { I18nBundle } from '@asgardeo/i18n';
+import type { Ref } from 'vue';
+import type { AsgardeoVueConfig } from './config';
+import type AsgardeoVueClient from '../AsgardeoVueClient';
+/**
+ * Shape of the core Asgardeo context provided via `provide`/`inject`.
+ *
+ * Reactive refs are exposed as `Readonly<Ref<T>>` so consumers can read
+ * them in templates and `watch()` calls but cannot mutate them directly.
+ */
+export interface AsgardeoContext {
+    /** The `afterSignInUrl` from the config. */
+    afterSignInUrl: string | undefined;
+    /** The Asgardeo application ID from the config. */
+    applicationId: string | undefined;
+    /** The base URL of the Asgardeo tenant. */
+    baseUrl: string | undefined;
+    clearSession: (...args: any[]) => void;
+    /** The OAuth2 client ID. */
+    clientId: string | undefined;
+    exchangeToken: (config: TokenExchangeRequestConfig) => Promise<TokenResponse | Response>;
+    getAccessToken: () => Promise<string>;
+    getDecodedIdToken: () => Promise<IdToken>;
+    getIdToken: () => Promise<string>;
+    http: {
+        request: (requestConfig?: HttpRequestConfig) => Promise<HttpResponse<any>>;
+        requestAll: (requestConfigs?: HttpRequestConfig[]) => Promise<HttpResponse<any>[]>;
+    };
+    /** The instance ID for multi-instance support. */
+    instanceId: number;
+    /** Whether the SDK has finished initializing. */
+    isInitialized: Readonly<Ref<boolean>>;
+    /** Whether the SDK is performing a background operation. */
+    isLoading: Readonly<Ref<boolean>>;
+    /** Whether the user is currently signed in. */
+    isSignedIn: Readonly<Ref<boolean>>;
+    /** Flow metadata from the FlowMeta context, or `null` while loading/unavailable. */
+    meta?: Readonly<Ref<FlowMetadataResponse | null>>;
+    /** The current organization, or `null`. */
+    organization: Readonly<Ref<Organization | null>>;
+    organizationHandle: string | undefined;
+    platform: AsgardeoVueConfig['platform'] | undefined;
+    reInitialize: (config: Partial<AsgardeoVueConfig>) => Promise<boolean>;
+    /** Resolve `{{t(...)}}` and `{{meta(...)}}` template literals inside a string. */
+    resolveFlowTemplateLiterals?: (text: string | undefined) => string;
+    signIn: (...args: any[]) => Promise<any>;
+    signInOptions: SignInOptions | undefined;
+    signInSilently: (options?: SignInOptions) => Promise<any>;
+    signInUrl: string | undefined;
+    signOut: (...args: any[]) => Promise<any>;
+    signUp: (...args: any[]) => Promise<any>;
+    signUpUrl: string | undefined;
+    storage: AsgardeoVueConfig['storage'] | undefined;
+    switchOrganization: AsgardeoVueClient['switchOrganization'];
+    /** The current user object, or `null` if not signed in. */
+    user: Readonly<Ref<any | null>>;
+}
+/**
+ * Shape of the User context exposed by `useUser()`.
+ */
+export interface UserContextValue {
+    /** The flattened user profile (top-level attribute map). */
+    flattenedProfile: Readonly<Ref<User | null>>;
+    /** The raw nested user profile from the SCIM2/ME endpoint. */
+    profile: Readonly<Ref<UserProfile | null>>;
+    /** Refetch the user profile from the server. */
+    revalidateProfile: () => Promise<void>;
+    /** The SCIM2 schemas describing the user profile attributes. */
+    schemas: Readonly<Ref<Schema[] | null>>;
+    /**
+     * Update the user profile. Accepts the standard SCIM2 patch request config.
+     */
+    updateProfile: (requestConfig: UpdateMeProfileConfig, sessionId?: string) => Promise<{
+        data: {
+            user: User;
+        };
+        error: string;
+        success: boolean;
+    }>;
+}
+/**
+ * Shape of the Organization context exposed by `useOrganization()`.
+ */
+export interface OrganizationContextValue {
+    /** Optional function to create a new sub-organization. */
+    createOrganization?: (payload: CreateOrganizationPayload, sessionId: string) => Promise<Organization>;
+    /** The organization the user is currently operating in. */
+    currentOrganization: Readonly<Ref<Organization | null>>;
+    /** Last error message from an organization operation, if any. */
+    error: Readonly<Ref<string | null>>;
+    /** Fetch all organizations (paginated). */
+    getAllOrganizations: () => Promise<AllOrganizationsApiResponse>;
+    /** Whether an organization operation is in-flight. */
+    isLoading: Readonly<Ref<boolean>>;
+    /** The list of organizations the signed-in user is a member of. */
+    myOrganizations: Readonly<Ref<Organization[]>>;
+    /** Re-fetch the user's organization list from the server. */
+    revalidateMyOrganizations: () => Promise<Organization[]>;
+    /** Switch to the given organization (performs token exchange). */
+    switchOrganization: (organization: Organization) => Promise<void>;
+}
+/**
+ * Types of authentication flow steps that can be displayed.
+ */
+export type FlowStep = {
+    canGoBack?: boolean;
+    id: string;
+    metadata?: Record<string, any>;
+    subtitle?: string;
+    title: string;
+    type: 'signin' | 'signup' | 'organization-signin' | 'forgot-password' | 'reset-password' | 'verify-email' | 'mfa';
+} | null;
+/**
+ * A message that can be displayed inside an authentication flow UI.
+ */
+export interface FlowMessage {
+    dismissible?: boolean;
+    id?: string;
+    message: string;
+    type: 'success' | 'error' | 'warning' | 'info';
+}
+/**
+ * Shape of the Flow context exposed by `useFlow()`.
+ */
+export interface FlowContextValue {
+    addMessage: (message: FlowMessage) => void;
+    clearMessages: () => void;
+    currentStep: Readonly<Ref<FlowStep>>;
+    error: Readonly<Ref<string | null>>;
+    isLoading: Readonly<Ref<boolean>>;
+    messages: Readonly<Ref<FlowMessage[]>>;
+    navigateToFlow: (flowType: NonNullable<FlowStep>['type'], options?: {
+        metadata?: Record<string, any>;
+        subtitle?: string;
+        title?: string;
+    }) => void;
+    onGoBack: Readonly<Ref<(() => void) | undefined>>;
+    removeMessage: (messageId: string) => void;
+    reset: () => void;
+    setCurrentStep: (step: FlowStep) => void;
+    setError: (error: string | null) => void;
+    setIsLoading: (loading: boolean) => void;
+    setOnGoBack: (callback?: () => void) => void;
+    setShowBackButton: (show: boolean) => void;
+    setSubtitle: (subtitle?: string) => void;
+    setTitle: (title: string) => void;
+    showBackButton: Readonly<Ref<boolean>>;
+    subtitle: Readonly<Ref<string | undefined>>;
+    title: Readonly<Ref<string>>;
+}
+/**
+ * Shape of the FlowMeta context exposed by `useFlowMeta()`.
+ */
+export interface FlowMetaContextValue {
+    /** Error from the flow metadata fetch, if any. */
+    error: Readonly<Ref<Error | null>>;
+    /** Manually re-fetch flow metadata from the server. */
+    fetchFlowMeta: () => Promise<void>;
+    /** Whether the flow metadata is currently being fetched. */
+    isLoading: Readonly<Ref<boolean>>;
+    /** The fetched `FlowMetadataResponse`, or `null` while loading or on error. */
+    meta: Readonly<Ref<FlowMetadataResponse | null>>;
+    /**
+     * Fetch flow metadata for the given language and activate it in the i18n system.
+     * Use this to switch the UI language at runtime.
+     */
+    switchLanguage: (language: string) => Promise<void>;
+}
+/**
+ * Shape of the Theme context exposed by `useTheme()`.
+ */
+export interface ThemeContextValue {
+    /** Error from the branding theme fetch, if any. */
+    brandingError: Readonly<Ref<Error | null>>;
+    /** The current color scheme ('light' | 'dark'). */
+    colorScheme: Readonly<Ref<'light' | 'dark'>>;
+    /** The text direction for the UI. */
+    direction: Readonly<Ref<'ltr' | 'rtl'>>;
+    /** Whether the theme inherits from Asgardeo branding preferences. */
+    inheritFromBranding: boolean;
+    /** Whether the branding theme is currently loading. */
+    isBrandingLoading: Readonly<Ref<boolean>>;
+    /** The resolved Theme object used by all styled components. */
+    theme: Readonly<Ref<Theme>>;
+    /** Toggle between light and dark mode. */
+    toggleTheme: () => void;
+}
+/**
+ * Shape of the Branding context exposed by `useBranding()`.
+ */
+export interface BrandingContextValue {
+    /** The active theme from the branding preference ('light' | 'dark'), or null. */
+    activeTheme: Readonly<Ref<'light' | 'dark' | null>>;
+    /** The raw branding preference data from the server. */
+    brandingPreference: Readonly<Ref<BrandingPreference | null>>;
+    /** Error from the branding fetch, if any. */
+    error: Readonly<Ref<Error | null>>;
+    /** Trigger a branding preference fetch (deduplicated). */
+    fetchBranding: () => Promise<void>;
+    /** Whether the branding preference is currently loading. */
+    isLoading: Readonly<Ref<boolean>>;
+    /** Force a fresh branding preference fetch (bypasses dedup). */
+    refetch: () => Promise<void>;
+    /** The transformed `Theme` object derived from the branding preference. */
+    theme: Readonly<Ref<Theme | null>>;
+}
+/**
+ * Shape of the I18n context exposed by `useI18n()`.
+ */
+export interface I18nContextValue {
+    /** All available i18n bundles (default + injected + user-provided). */
+    bundles: Readonly<Ref<Record<string, I18nBundle>>>;
+    /** The current language code (e.g., 'en-US'). */
+    currentLanguage: Readonly<Ref<string>>;
+    /** The fallback language code. */
+    fallbackLanguage: string;
+    /**
+     * Inject additional bundles into the i18n system (e.g., from flow metadata).
+     * Injected bundles take precedence over defaults but are overridden by prop-provided bundles.
+     */
+    injectBundles: (bundles: Record<string, I18nBundle>) => void;
+    /** Change the current language. */
+    setLanguage: (language: string) => void;
+    /** Translate a key with optional named parameters. */
+    t: (key: string, params?: Record<string, string | number>) => string;
+}

package/dist/{esm/types/plugins → plugins}/AsgardeoPlugin.d.ts

@@ -16,7 +16,31 @@
  * 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;
+/**
+ * Vue plugin for Asgardeo authentication.
+ *
+ * Registers the `<AsgardeoProvider>` component globally so it can be used
+ * anywhere in the application without explicit imports.
+ *
+ * @example
+ * ```ts
+ * import { createApp } from 'vue';
+ * import { AsgardeoPlugin } from '@asgardeo/vue';
+ * import App from './App.vue';
+ *
+ * const app = createApp(App);
+ * app.use(AsgardeoPlugin);
+ * app.mount('#app');
+ * ```
+ *
+ * Then in your root component:
+ * ```vue
+ * <template>
+ *   <AsgardeoProvider :base-url="baseUrl" :client-id="clientId">
+ *     <router-view />
+ *   </AsgardeoProvider>
+ * </template>
+ * ```
+ */
+declare const AsgardeoPlugin: Plugin;
+export default AsgardeoPlugin;

package/dist/providers/AsgardeoProvider.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 Component } from 'vue';
+/**
+ * Root provider component for the Asgardeo Vue SDK.
+ *
+ * This component initializes the client, manages authentication state,
+ * and provides the Asgardeo context to child components via Vue's provide/inject.
+ *
+ * @example
+ * ```vue
+ * <template>
+ *   <AsgardeoProvider v-bind="config">
+ *     <router-view />
+ *   </AsgardeoProvider>
+ * </template>
+ * ```
+ */
+declare const AsgardeoProvider: Component;
+export default AsgardeoProvider;

package/dist/providers/BrandingProvider.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 Component } from 'vue';
+/**
+ * BrandingProvider manages branding preference state and makes branding data
+ * available to child components via `useBranding()`.
+ *
+ * It receives branding preferences from a parent component (typically
+ * `<AsgardeoProvider>`) and transforms them into `Theme` objects.
+ *
+ * @internal — This provider is mounted automatically by `<AsgardeoProvider>`.
+ */
+declare const BrandingProvider: Component;
+export default BrandingProvider;

package/dist/providers/FlowMetaProvider.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) 2026, 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 Component } from 'vue';
+declare const FlowMetaProvider: Component;
+export default FlowMetaProvider;

package/dist/providers/FlowProvider.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.
+ */
+import { type Component } from 'vue';
+declare const FlowProvider: Component;
+export default FlowProvider;

package/dist/providers/I18nProvider.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.
+ */
+import { type Component } from 'vue';
+declare const I18nProvider: Component;
+export default I18nProvider;

package/dist/providers/OrganizationProvider.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.
+ */
+import { type Component } from 'vue';
+declare const OrganizationProvider: Component;
+export default OrganizationProvider;

package/dist/providers/ThemeProvider.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.
+ */
+import { type Component } from 'vue';
+declare const ThemeProvider: Component;
+export default ThemeProvider;

package/dist/providers/UserProvider.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.
+ */
+import { type Component } from 'vue';
+declare const UserProvider: Component;
+export default UserProvider;

package/dist/router/callbackRoute.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { defineComponent } from 'vue';
+/**
+ * Options for creating a callback route.
+ */
+export interface CallbackRouteOptions {
+    /**
+     * The route name. If not provided, no name is set on the route record.
+     */
+    name?: string;
+    /**
+     * Optional error handler called when the OAuth callback encounters an error.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * The URL path for the callback route.
+     * @default '/callback'
+     */
+    path?: string;
+}
+/**
+ * A minimal route record type compatible with Vue Router's `RouteRecordRaw`.
+ *
+ * This avoids a hard dependency on `vue-router` while remaining structurally compatible.
+ */
+export interface AsgardeoRouteRecord {
+    component: ReturnType<typeof defineComponent>;
+    meta?: Record<string, unknown>;
+    name?: string;
+    path: string;
+}
+/**
+ * Creates a Vue Router route record for the OAuth2 callback.
+ *
+ * The generated route renders the `<Callback>` component which extracts OAuth parameters
+ * (code, state, error) from the URL and redirects the user back to the original path.
+ *
+ * **Requires `vue-router` as a peer dependency.**
+ *
+ * @param options - Callback route configuration.
+ * @returns A route record compatible with Vue Router's `RouteRecordRaw`.
+ *
+ * @example
+ * ```typescript
+ * import { createRouter, createWebHistory } from 'vue-router';
+ * import { createCallbackRoute } from '@asgardeo/vue';
+ *
+ * const router = createRouter({
+ *   history: createWebHistory(),
+ *   routes: [
+ *     createCallbackRoute({ path: '/callback' }),
+ *     { path: '/', component: Home },
+ *     { path: '/dashboard', component: Dashboard },
+ *   ],
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With error handling and Vue Router navigation
+ * import { useRouter } from 'vue-router';
+ *
+ * createCallbackRoute({
+ *   path: '/auth/callback',
+ *   name: 'oauth-callback',
+ *   onError: (error) => console.error('OAuth error:', error),
+ * });
+ * ```
+ */
+export declare const createCallbackRoute: (options?: CallbackRouteOptions) => AsgardeoRouteRecord;
+export default createCallbackRoute;