Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/descope/vue-sdk

Vue.js library used to integrate with Descope
https://github.com/descope/vue-sdk

authentication descope sdk sdk-vuejs vue vuejs

Last synced: 3 months ago
JSON representation

Vue.js library used to integrate with Descope

Awesome Lists containing this project

README 

        
# IMPORTANT NOTE: This repository is _DEPRECATED_.



Descope Vue SDK has been moved to the [descope-js](https://github.com/descope/descope-js/tree/main/packages/sdks/vue-sdk) repoistory.



---



# Descope Vue SDK



The Descope Vue SDK provides convenient access to the Descope for an application written on top of Vue.  

You can read more on the [Descope Website](https://descope.com).



## Requirements



- The SDK supports Vue version 3 and above.

- A Descope `Project ID` is required for using the SDK. Find it on the [project page in the Descope Console](https://app.descope.com/settings/project).



## Installing the SDK



Install the package with:



```bash

npm i --save @descope/vue-sdk

```



## Usage



### Add Descope plugin to your application



```js

import { createApp } from 'vue';

import App from './App.vue';

import descope from '@descope/vue-sdk';



const app = createApp(App);

app.use(descope, {

	projectId: 'my-project-id'

	// If the Descope project manages the token response in cookies, a custom domain

	// must be configured (e.g., https://auth.app.example.com)

	// and should be set as the baseUrl property.

	// baseUrl: https://auth.app.example.com'

});

app.mount('#app');

```



### Use Descope to render specific flow



```vue



	
Loading...


	

	

	

	

	

	

	

	

	

	

	

	



import { Descope } from '@descope/vue-sdk';

import { ref } from 'vue';



const isFlowLoading = ref(true);



const handleSuccess = (e) => {

	console.log('Logged in!', e);

};



const handleError = (e) => {

	console.log('Could not log in', e);

};



const handleReady = () => {

	isFlowLoading.value = false;

};



// let tenantId = '<tenantId>'; // replace with your tenant ID

// let redirectUrl = '<redirectUrl>'; // replace with your redirect URL



// const errorTransformer = (error) => {

//   const translationMap = {

//     SAMLStartFailed: 'Failed to start SAML flow'

//   };

//   return translationMap[error.type] || error.text;

// };



```



### Use the `useDescope`, `useSession` and `useUser` functions in your components in order to get authentication state, user details and utilities



This can be helpful to implement application-specific logic. Examples:



- Render different components if current session is authenticated

- Render user's content

- Logout button



```js



	


		
Loading ...


		


			
Hello {{ user?.name }}


			Logout

		


		
You are not logged in


	



import { useDescope, useSession, useUser } from '@descope/vue-sdk';



const { isAuthenticated, isSessionLoading } = useSession();

const { user, isUserLoading } = useUser();

const { logout } = useDescope();



```



Note: `useSession` triggers a single request to the Descope backend to attempt to refresh the session. If you **don't** `useSession` on your app, the session will not be refreshed automatically. If your app does not require `useSession`, you can trigger the refresh manually by calling `refresh` from `useDescope` hook.



**For more SDK usage examples refer to [docs](https://docs.descope.com/build/guides/client_sdks/)**



### Session token server validation (pass session token to server API)



When developing a full-stack application, it is common to have private server API which requires a valid session token:



![session-token-validation-diagram](https://docs.descope.com/static/SessionValidation-cf7b2d5d26594f96421d894273a713d8.png)



Note: Descope also provides server-side SDKs in various languages (NodeJS, Go, Python, etc). Descope's server SDKs have out-of-the-box session validation API that supports the options described bellow. To read more about session validation, Read [this section](https://docs.descope.com/build/guides/gettingstarted/#session-validation) in Descope documentation.



There are 2 ways to achieve that:



1. Using `getSessionToken` to get the token, and pass it on the `Authorization` Header (Recommended)

2. Passing `sessionTokenViaCookie` boolean option when initializing the plugin (Use cautiously, session token may grow, especially in cases of using authorization, or adding custom claim)



#### 1. Using `getSessionToken` to get the token



An example for api function, and passing the token on the `Authorization` header:



```js

import { getSessionToken } from '@descope/vue-sdk';



// fetch data using back

// Note: Descope backend SDKs support extracting session token from the Authorization header

export const fetchData = async () => {

	const sessionToken = getSessionToken();

	const res = await fetch('/path/to/server/api', {

		headers: {

			Authorization: `Bearer ${sessionToken}`

		}

	});

	// ... use res

};

```



#### 2. Passing `sessionTokenViaCookie` option when initializing the plugin



When doing so, Descope SDK will automatically store session token on the `DS` cookie.



Note: Use this option if session token will stay small (less than 1k). Session token can grow, especially in cases of using authorization, or adding custom claims



Example:



```js

import { createApp } from 'vue';

import App from './components/App.vue';

import descope from '@descope/vue-sdk';



const app = createApp(App);



app.use(descope, {

	projectId: 'project-id',

	sessionTokenViaCookie: true

});

```



Now, whenever you call `fetch`, the cookie will automatically be sent with the request.  

Descope backend SDKs also support extracting the token from the `DS` cookie.



### Get the Descope SDK instance



In case you need the SDK instance outside the Vue application, you can use the `getSdk` function



**Make sure to call it only after initializing the descope plugin, this is where the SDK instance is actually created, otherwise you will no instance.**



For example:



```js

import { createApp } from 'vue';

import App from './components/App.vue';

import descope, { getSdk } from '../src';



const app = createApp(App);



app.use(descope, {

	projectId: 'project-id'

});



const sdk = getSdk();



sdk?.onSessionTokenChange((newSession) => {

	// here you can implement custom logic when the session is changing

});

```



### Helper Functions



You can also use the following functions to assist with various actions managing your JWT.



`getSessionToken()` - Get current session token.

`getRefreshToken()` - Get current refresh token.

`refresh(token = getRefreshToken())` - Force a refresh on current session token using an existing valid refresh token.

`isSessionTokenExpired(token = getSessionToken())` - Check whether the current session token is expired. Provide a session token if is not persisted.

`isRefreshTokenExpired(token = getRefreshToken())` - Check whether the current refresh token is expired. Provide a refresh token if is not persisted.

`getJwtRoles(token = getSessionToken(), tenant = '')` - Get current roles from an existing session token. Provide tenant id for specific tenant roles.

`getJwtPermissions(token = getSessionToken(), tenant = '')` - Fet current permissions from an existing session token. Provide tenant id for specific tenant permissions.



### Refresh token lifecycle



Descope SDK is automatically refreshes the session token when it is about to expire. This is done in the background using the refresh token, without any additional configuration.



If the Descope project settings are configured to manage tokens in cookies.

you must also configure a custom domain, and set it as the `baseUrl` to the `descope` plugin. See the above [`plugin` usage](#add-descope-plugin-to-your-application) for usage example.



### Token Persistence



Descope stores two tokens: the session token and the refresh token.



- The refresh token is either stored in local storage or an `httpOnly` cookie. This is configurable in the Descope console.

- The session token is stored in either local storage or a JS cookie. This behavior is configurable via the `sessionTokenViaCookie` prop in the Descope plugin.



However, for security reasons, you may choose not to store tokens in the browser. In this case, you can pass `persistTokens: false` to the Descope plugin. This prevents the SDK from storing the tokens in the browser.



Notes:



- You must configure the refresh token to be stored in an `httpOnly` cookie in the Descope console. Otherwise, the refresh token will not be stored, and when the page is refreshed, the user will be logged out.

- You can still retrieve the session token using the `useSession` hook.



### Last User Persistence



Descope stores the last user information in local storage. If you wish to disable this feature, you can pass `storeLastAuthenticatedUser: false` to the Descope plugin. Please note that some features related to the last authenticated user may not function as expected if this behavior is disabled.



### Widgets



Widgets are components that allow you to expose management features for tenant-based implementation. In certain scenarios, your customers may require the capability to perform managerial actions independently, alleviating the necessity to contact you. Widgets serve as a feature enabling you to delegate these capabilities to your customers in a modular manner.



Important Note:



- For the user to be able to use the widget, they need to be assigned the `Tenant Admin` Role.



#### User Management



The `UserManagement` widget lets you embed a user table in your site to view and take action.



The widget lets you:



- Create a new user

- Edit an existing user

- Activate / disable an existing user

- Reset an existing user's password

- Remove an existing user's passkey

- Delete an existing user



Note:



- Custom fields also appear in the table.



###### Usage



```vue



	



import { UserManagement } from '@descope/vue-sdk';



```



Example:

[Manage Users](./example/components/ManageUsers.vue)



#### Role Management



The `RoleManagement` widget lets you embed a role table in your site to view and take action.



The widget lets you:



- Create a new role

- Change an existing role's fields

- Delete an existing role



Note:



- The `Editable` field is determined by the user's access to the role - meaning that project-level roles are not editable by tenant level users.

- You need to pre-define the permissions that the user can use, which are not editable in the widget.



###### Usage



```vue



	



import { RoleManagement } from '@descope/vue-sdk';



```



Example:

[Manage Roles](./example/components/ManageRoles.vue)



#### Access Key Management



The `AccessKeyManagement` widget lets you embed an access key table in your site to view and take action.



The widget lets you:



- Create a new access key

- Activate / deactivate an existing access key

- Delete an exising access key



###### Usage



```vue



	

	



	

	



import { AccessKeyManagement } from '@descope/vue-sdk';



```



Example:

[Manage Access Keys](./example/components/ManageAccessKeys.vue)



#### Audit Management



The `AuditManagement` widget lets you embed an audit table in your site.



###### Usage



```vue



	



import { AuditManagement } from '@descope/vue-sdk';



```



Example:

[Manage Audit](./example/components/ManageAudit.vue)



#### User Profile



The `UserProfile` widget lets you embed a user profile component in your app and let the logged in user update his profile.



The widget lets you:



- Update user profile picture

- Update user personal information

- Update authentication methods

- Logout



###### Usage



```vue



	



import { UserProfile } from '@descope/vue-sdk';



const onLogout = () => (window.location.href = '/login');



```



Example:

[User Profile](./example/components/MyUserProfile.vue)



## Code Example



You can find an example Vue app in the [example folder](./example).



### Setup



To run the examples, set your `Project ID` by setting the `VUE_APP_DESCOPE_PROJECT_ID` env var or directly

in the sample code.

Find your Project ID in the [Descope console](https://app.descope.com/settings/project).



```bash

export VUE_APP_DESCOPE_PROJECT_ID=

```



Alternatively, put the environment variable in `.env.local` file in the project root directory.

See bellow for an `.env.local` file template with more information.



### Run Example



Run the following command in the root of the project to build and run the example:



```bash

npm i && npm start

```



Open your browser and navigate to [http://localhost:3000](http://localhost:3000).



### Example Optional Env Variables



See the following table for customization environment variables for the example app:



| Env Variable                    | Description                            | Default value     |

| ------------------------------- | -------------------------------------- | ----------------- |

| VUE_APP_DESCOPE_FLOW_ID         | Which flow ID to use in the login page | **sign-up-or-in** |

| VUE_APP_DESCOPE_BASE_URL        | Custom Descope base URL                | None              |

| VUE_APP_DESCOPE_BASE_STATIC_URL | Custom Descope base static URL         | None              |



Example for `.env.local` file template:



```

# Your project ID

VUE_APP_DESCOPE_PROJECT_ID=""

# Login flow ID

VUE_APP_DESCOPE_FLOW_ID=""

# Descope base URL

VUE_APP_DESCOPE_BASE_URL=""

# Descope base static URL

VUE_APP_DESCOPE_BASE_STATIC_URL=""

```



## Q & A



### I updated the user in my backend, but the user / session token are not updated in the frontend



// adjust the answer to vue sdk

The Descope SDK caches the user and session token in the frontend. If you update the user in your backend (using Descope Management SDK/API for example), you can call `me` / `refresh` from `useDescope` hook to refresh the user and session token. Example:



```js

const sdk = useDescope();



const handleUpdateUser = () => {

	myBackendUpdateUser().then(() => {

		sdk.me();

		// or

		sdk.refresh();

	});

};

```



## Learn More



To learn more please see the [Descope Documentation and API reference page](https://docs.descope.com/).



## Contact Us



If you need help you can email [Descope Support](mailto:[email protected])



## License



The Descope SDK for React is licensed for use under the terms and conditions of the [MIT license Agreement](./LICENSE).