@asgardeo/vue 0.0.10 → 0.1.0

package/README.md

@@ -8,6 +8,141 @@
   <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
 </div>
 
+## Overview
+
+The Asgardeo Vue SDK provides a streamlined way to integrate secure authentication and user management into your Vue.js applications. Built for Vue 3, it offers a comprehensive set of composables, components, and utilities to handle authentication flows, user profiles, and multi-tenancy features.
+
+## Key Features
+
+- **Easy Integration**: Simple setup with the `AsgardeoPlugin` and provider components
+- **Composable API**: Vue 3 composables for reactive authentication state management
+- **Pre-built Components**: Ready-to-use components for sign-in, sign-up, user profiles, and more
+- **Multi-Tenancy Support**: Built-in organization/workspace management capabilities
+- **Customizable UI**: Primitive components and styling options for seamless integration
+- **International Support**: Multi-language support with easy localization
+- **Type-Safe**: Full TypeScript support for better developer experience
+
+## Quick Start
+
+Get started with Asgardeo in your Vue application in minutes. Follow our [Vue Quick Start Guide](./QUICKSTART.md) for step-by-step instructions on integrating authentication into your app.
+
+## Installation
+
+```bash
+# Using npm
+npm install @asgardeo/vue
+
+# Using pnpm
+pnpm add @asgardeo/vue
+
+# Using yarn
+yarn add @asgardeo/vue
+```
+
+## Basic Usage
+
+```vue
+<script setup lang="ts">
+import { useUser } from '@asgardeo/vue'
+
+const { user, isLoading } = useUser()
+</script>
+
+<template>
+  <div>
+    <p v-if="isLoading">Loading...</p>
+    <p v-else-if="user">Welcome, {{ user.username }}</p>
+    <p v-else>Not signed in</p>
+  </div>
+</template>
+```
+
+## API Documentation
+
+For complete API documentation including all components, composables, and customization options, see the [Vue SDK Documentation](https://wso2.com/asgardeo/docs/sdks/vue/overview).
+
+## Supported Features
+
+### Composables
+- `useAsgardeo()` - Main SDK client access
+- `useUser()` - User profile and authentication state
+- `useOrganization()` - Organization/workspace management
+- `useI18n()` - Internationalization
+- `useTheme()` - Theme customization
+- `useBranding()` - Branding customization
+- `useFlow()` - Authentication flow control
+- `useFlowMeta()` - Flow metadata access
+
+### Components
+
+#### Control
+- `SignedIn` - Renders children only when user is authenticated
+- `SignedOut` - Renders children only when user is not authenticated
+- `Loading` - Renders children while authentication state is loading
+- `UserComponent` - Access user information with scoped slot pattern
+- `OrganizationComponent` - Access organization context with scoped slot pattern
+
+#### Actions
+- `SignInButton` / `BaseSignInButton` - Sign-in button (styled and unstyled)
+- `SignOutButton` / `BaseSignOutButton` - Sign-out button (styled and unstyled)
+- `SignUpButton` / `BaseSignUpButton` - Sign-up button (styled and unstyled)
+
+#### Presentation
+- `SignIn` / `BaseSignIn` - Embedded sign-in form
+- `SignUp` / `BaseSignUp` - Embedded sign-up form
+- `UserProfileComponent` / `BaseUserProfile` - User profile display
+- `UserDropdown` / `BaseUserDropdown` - User menu dropdown
+- `OrganizationList` / `BaseOrganizationList` - Organization listing
+- `OrganizationSwitcher` / `BaseOrganizationSwitcher` - Organization switcher
+- `OrganizationProfile` / `BaseOrganizationProfile` - Organization profile
+- `CreateOrganization` / `BaseCreateOrganization` - Organization creation form
+- `AcceptInvite` / `BaseAcceptInvite` - Invitation acceptance
+- `InviteUser` / `BaseInviteUser` - User invitation form
+- `LanguageSwitcher` / `BaseLanguageSwitcher` - Language selection
+
+#### Auth Flow
+- `Callback` - Handle OAuth callback redirect
+
+#### Social Login Adapters
+- `GoogleButton` - Sign in with Google
+- `FacebookButton` - Sign in with Facebook
+- `GitHubButton` - Sign in with GitHub
+- `MicrosoftButton` - Sign in with Microsoft
+
+#### Primitives
+- `Button`, `Card`, `Alert`, `TextField`, `PasswordField`, `Select`, `Checkbox`, `DatePicker`, `OtpField`, `Typography`, `Divider`, `Logo`, `Spinner`
+
+### Utilities
+- `createAsgardeoGuard` - Vue Router navigation guard for protected routes
+- `createCallbackRoute` - Generate a callback route record for Vue Router
+- `handleWebAuthnAuthentication` - WebAuthn/passkey support
+- `hasAuthParamsInUrl` - Detect OAuth parameters in URL
+- `navigate` - Programmatic navigation helper
+- `http` - HTTP client with token management
+
+## Examples
+
+Check out our [example applications](../../samples/) to see the Vue SDK in action:
+- [Vue SDK Playground](../../samples/vue-sdk-playground/) - Example application
+
+## Documentation
+
+- [Getting Started](https://wso2.com/asgardeo/docs/get-started/)
+- [Vue SDK Guide](https://wso2.com/asgardeo/docs/sdks/vue/)
+- [Configuration Options](https://wso2.com/asgardeo/docs/sdks/vue/configuration/)
+- [Composables & Components](https://wso2.com/asgardeo/docs/sdks/vue/api/)
+
+## Support
+
+For support and questions:
+- [Asgardeo Documentation](https://wso2.com/asgardeo/docs/)
+- [GitHub Issues](https://github.com/asgardeo/asgardeo-auth-vue-sdk/issues)
+- [WSO2 Community Forum](https://wso2.com/community/)
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for more details.
+
 ## License
 
-Licenses this source under the Apache License, Version 2.0 [LICENSE](./LICENSE), You may not use this file except in compliance with the License.
+Licenses this source under the Apache License, Version 2.0 [LICENSE](./LICENSE), You may not use this file except in compliance with the License.

package/dist/AsgardeoVueClient.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { AsgardeoBrowserClient, UserProfile, SignInOptions, SignOutOptions, User, EmbeddedFlowExecuteResponse, SignUpOptions, EmbeddedFlowExecuteRequestPayload, EmbeddedSignInFlowHandleRequestPayload, Organization, IdToken, EmbeddedFlowExecuteRequestConfig, AllOrganizationsApiResponse, TokenResponse, HttpRequestConfig, HttpResponse, TokenExchangeRequestConfig } from '@asgardeo/browser';
+import { AsgardeoVueConfig } from './models/config';
+/**
+ * Client for implementing Asgardeo in Vue applications.
+ * This class provides the core functionality for managing user authentication and sessions.
+ *
+ * @typeParam T - Configuration type that extends AsgardeoVueConfig.
+ */
+declare class AsgardeoVueClient<T extends AsgardeoVueConfig = AsgardeoVueConfig> extends AsgardeoBrowserClient<T> {
+    private asgardeo;
+    private loadingState;
+    private clientInstanceId;
+    constructor(instanceId?: number);
+    getInstanceId(): number;
+    private setLoading;
+    private withLoading;
+    initialize(config: AsgardeoVueConfig): Promise<boolean>;
+    reInitialize(config: Partial<AsgardeoVueConfig>): Promise<boolean>;
+    updateUserProfile(): Promise<User>;
+    getUser(options?: any): Promise<User>;
+    getDecodedIdToken(sessionId?: string): Promise<IdToken>;
+    getIdToken(): Promise<string>;
+    getUserProfile(options?: any): Promise<UserProfile>;
+    getMyOrganizations(options?: any): Promise<Organization[]>;
+    getAllOrganizations(options?: any): Promise<AllOrganizationsApiResponse>;
+    getCurrentOrganization(): Promise<Organization | null>;
+    switchOrganization(organization: Organization): Promise<TokenResponse | Response>;
+    isLoading(): boolean;
+    isInitialized(): Promise<boolean>;
+    isSignedIn(): Promise<boolean>;
+    getConfiguration(): T;
+    exchangeToken(config: TokenExchangeRequestConfig): Promise<TokenResponse | Response>;
+    signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: EmbeddedFlowExecuteRequestConfig, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    signInSilently(options?: SignInOptions): Promise<User | boolean>;
+    signOut(options?: SignOutOptions, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    signUp(options?: SignUpOptions): Promise<void>;
+    signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
+    request(requestConfig?: HttpRequestConfig): Promise<HttpResponse<any>>;
+    requestAll(requestConfigs?: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
+    getAccessToken(sessionId?: string): Promise<string>;
+    clearSession(sessionId?: string): void;
+    setSession(sessionData: Record<string, unknown>, sessionId?: string): Promise<void>;
+    decodeJwtToken<TResult = Record<string, unknown>>(token: string): Promise<TResult>;
+}
+export default AsgardeoVueClient;

package/dist/__temp__/api.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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, User, LegacyConfig as Config, IdToken, Hooks, HttpClientInstance, HttpRequestConfig, HttpResponse, OIDCEndpoints, SignInConfig, SPACustomGrantConfig } from '@asgardeo/browser';
+import { AuthStateInterface } from './models';
+declare class AuthAPI {
+    static DEFAULT_STATE: AuthStateInterface;
+    private authState;
+    private client;
+    private apiInstanceId;
+    private loadingState;
+    constructor(spaClient?: AsgardeoSPAClient, instanceId?: number);
+    getInstanceId(): number;
+    setLoadingState(isLoading: boolean): void;
+    getLoadingState(): boolean;
+    isLoading(): boolean;
+    getState(): AuthStateInterface;
+    init(config: AuthClientConfig<Config>): Promise<boolean>;
+    getConfigData(): Promise<AuthClientConfig<Config>>;
+    getStorageManager(): Promise<any>;
+    isInitialized(): Promise<boolean>;
+    signIn(config: SignInConfig, authorizationCode?: string, sessionState?: string, authState?: string, callback?: (response: User) => void, tokenRequestConfig?: {
+        params: Record<string, unknown>;
+    }): Promise<any>;
+    signOut(callback?: (response?: boolean) => void): Promise<boolean>;
+    updateState(state: AuthStateInterface): void;
+    getUser(): Promise<User>;
+    httpRequest(config: HttpRequestConfig): Promise<HttpResponse<any>>;
+    httpRequestAll(configs: HttpRequestConfig[]): Promise<HttpResponse<any>[]>;
+    exchangeToken(config: SPACustomGrantConfig, callback: (response: User | Response) => void): Promise<User | Response>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
+    getHttpClient(): Promise<HttpClientInstance>;
+    decodeJwtToken<T = Record<string, unknown>>(token: string): Promise<T>;
+    getDecodedIdToken(sessionId?: string): Promise<IdToken>;
+    getIdToken(): Promise<string>;
+    getAccessToken(sessionId?: string): Promise<string>;
+    refreshAccessToken(): Promise<User>;
+    isSignedIn(): Promise<boolean>;
+    enableHttpHandler(): Promise<boolean>;
+    disableHttpHandler(): Promise<boolean>;
+    reInitialize(config: Partial<AuthClientConfig<Config>>): Promise<void>;
+    on(hook: Hooks.CustomGrant, callback: (response?: any) => void, id: string): Promise<void>;
+    on(hook: Exclude<Hooks, Hooks.CustomGrant>, callback: (response?: any) => void): Promise<void>;
+    signInSilently(additionalParams?: Record<string, string | boolean>, tokenRequestConfig?: {
+        params: Record<string, unknown>;
+    }): Promise<User | boolean | undefined>;
+    clearSession(sessionId?: string): void;
+}
+export default AuthAPI;

package/dist/__temp__/models.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 for the Authenticated state of the user which is exposed
+ * via `state` object from the auth context.
+ */
+export interface AuthStateInterface {
+    /**
+     * The display name of the user.
+     */
+    displayName?: string;
+    /**
+     * The email address of the user.
+     */
+    email?: string;
+    /**
+     * Are the Auth requests loading.
+     */
+    isLoading: boolean;
+    /**
+     * Specifies if the user is authenticated or not.
+     */
+    isSignedIn: boolean;
+    /**
+     * The username of the user.
+     */
+    username?: string;
+}

package/dist/api/getAllOrganizations.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 { GetAllOrganizationsConfig as BaseGetAllOrganizationsConfig, AllOrganizationsApiResponse } from '@asgardeo/browser';
+export interface GetAllOrganizationsConfig extends Omit<BaseGetAllOrganizationsConfig, 'fetcher'> {
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+    instanceId?: number;
+}
+declare const getAllOrganizations: ({ fetcher, instanceId, ...requestConfig }: GetAllOrganizationsConfig) => Promise<AllOrganizationsApiResponse>;
+export default getAllOrganizations;

package/dist/api/getMeOrganizations.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 { Organization, GetMeOrganizationsConfig as BaseGetMeOrganizationsConfig } from '@asgardeo/browser';
+export interface GetMeOrganizationsConfig extends Omit<BaseGetMeOrganizationsConfig, 'fetcher'> {
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+    instanceId?: number;
+}
+declare const getMeOrganizations: ({ fetcher, instanceId, ...requestConfig }: GetMeOrganizationsConfig) => Promise<Organization[]>;
+export default getMeOrganizations;

package/dist/api/getSchemas.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 { Schema, GetSchemasConfig as BaseGetSchemasConfig } from '@asgardeo/browser';
+export interface GetSchemasConfig extends Omit<BaseGetSchemasConfig, 'fetcher'> {
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+    instanceId?: number;
+}
+declare const getSchemas: ({ fetcher, instanceId, ...requestConfig }: GetSchemasConfig) => Promise<Schema[]>;
+export default getSchemas;

package/dist/api/getScim2Me.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 { User, GetScim2MeConfig as BaseGetScim2MeConfig } from '@asgardeo/browser';
+export interface GetScim2MeConfig extends Omit<BaseGetScim2MeConfig, 'fetcher'> {
+    fetcher?: (url: string, config: RequestInit) => Promise<Response>;
+    instanceId?: number;
+}
+declare const getScim2Me: ({ fetcher, instanceId, ...requestConfig }: GetScim2MeConfig) => Promise<User>;
+export default getScim2Me;