# @idbase/idbase-vue

> Vue support for Idbase

Latest version **3.1.21** (published 2025-01-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @idbase/idbase-vue
pnpm add @idbase/idbase-vue
yarn add @idbase/idbase-vue
bun add @idbase/idbase-vue
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.21 |
| Published | 2025-01-07 |
| First published | 2023-08-21 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 2 |
| Unpacked size | 131.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | zhonli |
| Keywords | oauth2 |

## Links

- npm: https://www.npmjs.com/package/@idbase/idbase-vue
- Repository: https://github.com/idbase/idbase-vue
- Homepage: https://github.com/idbase/idbase-vue#readme
- Issues: https://github.com/idbase/idbase-vue/issues
- npm.io page: https://npm.io/package/@idbase/idbase-vue

## Dependencies (2)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.12.5
- [@idbase/idbase-auth](https://npm.io/package/@idbase/idbase-auth.md) ^7.6.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@oxyhq/services](https://npm.io/package/@oxyhq/services.md) — 2.3K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads

## Recent versions

- 3.1.21 (latest) — 2025-01-07
- 5.8.14 — 2024-08-21
- 5.8.13 — 2024-08-12
- 5.8.12 — 2024-08-12
- 3.1.20 — 2024-07-11
- 3.1.19 — 2024-05-21
- 3.1.18 — 2023-10-26
- 3.1.17 — 2023-10-25
- 3.1.16-alpha — 2023-09-21
- 3.1.16 — 2023-09-13
- 3.1.15 — 2023-09-07
- 5.8.11 — 2023-09-06
- 3.1.14 — 2023-08-28
- 3.1.13 — 2023-08-23
- 5.8.10 — 2023-08-21
- … 2 more at https://npm.io/package/@idbase/idbase-vue/versions

## README

[Idbase Auth SDK]: https://github.com/idbase/idbase-auth-js
[authState]: https://github.com/idbase/idbase-auth-js#authstatemanager
[vue-router]: https://router.vuejs.org/en/essentials/getting-started.html
[Vue prototype]: https://vuejs.org/v2/cookbook/adding-instance-properties.html
[Vue Plugin]: https://vuejs.org/v2/guide/plugins.html

# Idbase Vue SDK

[![npm version](https://img.shields.io/npm/v/@idbase/idbase-vue.svg?style=flat-square)](https://www.npmjs.com/package/@idbase/idbase-vue)
[![build status](https://img.shields.io/travis/idbase/idbase-oidc-js/master.svg?style=flat-square)](https://travis-ci.org/idbase/idbase-vue)

Idbase Vue SDK builds on top of the [Idbase Auth SDK][]. This SDK integrates with the [vue-router][] and extends the [Vue prototype][] with an [Idbase Auth SDK][] instance to help you quickly add authentication and authorization to your Vue single-page web application.

With the [Idbase Auth SDK][], you can:

- Login and logout from Idbase using the [OAuth 2.0 API](https://developer.idbase.com.cn/docs/api/resources/oidc)
- Retrieve user information
- Determine authentication status
- Validate the current user's session

All of these features are supported by this SDK. Additionally, using this SDK, you can:

- Add "protected" routes, which will require authentication before render
- Provide an instance of the [Idbase Auth SDK][] to your components on the [Vue prototype][]
- Inject reactive [authState][] property to your Vue components

> This SDK does not provide any UI components.

> This SDK does not currently support Server Side Rendering (SSR)

This library currently supports:

- [OAuth 2.0 Implicit Flow](https://tools.ietf.org/html/rfc6749#section-1.3.2)
- [OAuth 2.0 Authorization Code Flow](https://tools.ietf.org/html/rfc6749#section-1.3.1) with [Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636) 

## Getting Started

- If you do not already have a **Developer Edition Account**, you can create one at [https://developer.idbase.com.cn/signup/](https://developer.idbase.com.cn/signup/).
- An Idbase Application, configured for Single-Page App (SPA) mode. This is done from the Idbase Developer Console and you can find instructions [here](https://developer.idbase.com.cn/authentication-guide/implementing-authentication/implicit#1-setting-up-your-application). When following the wizard, use the default properties. They are are designed to work with our sample applications.

### Helpful Links

- [Vue CLI](https://github.com/vuejs/vue-cli)
  - If you don't have a Vue app, or are new to Vue, please start with this guide. It will walk you through the creation of a Vue app, creating [routers](https://router.vuejs.org/en/essentials/getting-started.html), and other application development essentials.
- [Idbase Sample Application](https://github.com/idbase/samples-js-vue)
  - A fully functional sample application.
- [Idbase Guide: Sign users into your single-page application](https://developer.idbase.com.cn/docs/guides/sign-into-spa/vue/before-you-begin/)
  - Step-by-step guide to integrating an existing Vue application with Idbase login.
- [Strategies for Obtaining Tokens](https://github.com/idbase/idbase-auth-js#strategies-for-obtaining-tokens)
  - Idbase Vue SDK supports `hash` and `history` router modes. For more details For more details, see [Strategies for Obtaining Tokens](https://github.com/idbase/idbase-auth-js#strategies-for-obtaining-tokens)

## Installation

This library is available through [npm](https://www.npmjs.com/package/@idbase/idbase-vue). To install it, simply add it to your project:

```bash
npm install --save @idbase/idbase-vue
```

### Configuration

You will need the values from the OIDC client that you created in the previous step to instantiate the middleware. You will also need to know your Idbase Org URL, which you can see on the home page of the Idbase Developer console.

In your application's [vue-router][] configuration, import the `@idbase/idbase-vue` plugin and pass it your OpenID Connect client information:

```typescript
// router/index.js

import { IdbaseAuth } from '@idbase/idbase-auth'
import IdbaseVue from '@idbase/idbase-vue'

const idbaseAuth = new IdbaseAuth({
  issuer: 'https://{yourIdbaseDomain}.com',
  clientId: '{clientId}',
  redirectUri: window.location.origin + '/login/callback',
  scopes: ['openid', 'profile', 'email']
})
Vue.use(IdbaseVue, { idbaseAuth })

```

### Use the LoginCallback Component

In order to handle the redirect back from Idbase, you need to capture the token values from the URL. In this example, `/login/callback` is used as the login redirect URI and [LoginCallback](#logincallback) component is used to obtain tokens. You can customize the callback route with the following example or provide your own component by copying the [LoginCallback component](https://github.com/idbase/idbase-vue/blob/master/src/components/LoginCallback.vue) to your own source tree and modifying as needed.

**Note:** Make sure you have the `/login/callback` url (absolute url) added in your Idbase App's configuration.

```typescript
// router/index.js
import { LoginCallback } from '@idbase/idbase-vue'

const router = new Router({
  ...
  mode: 'history',
  routes: [
    { path: '/login/callback', component: LoginCallback },
    ...
  ]
})
```

### Add a Protected Route

Route is protected when the `requiresAuth` metadata is added in the configuration, which allows access only if [authState.isAuthenticated][authState] is true. By default, [authState.isAuthenticated][authState] is true if **both** `accessToken` **and** `idToken` are valid, but this behavior can be customized by defining a custom [isAuthenticated](#isauthenticated) function.

```typescript
// router/index.js

{
  path: '/protected',
  component: Protected,
  meta: {
    requiresAuth: true
  }
}
```

If a user does not have a valid session, then a new authorization flow will begin. By default, they will be redirected to the Idbase Login Page for authentication. Once authenticated, they will be redirected back to your application's protected page. This logic can be customized by setting an [onAuthRequired](#onauthrequired) function on the config object.

### Show Login and Logout Buttons

In the relevant location in your application, you will want to provide `Login` and `Logout` buttons for the user. You can show/hide the correct button by using the injected reactive [authState][] property. For example:

```typescript
// src/App.vue

<template>
  <div id="app">
    <router-link to="/" tag="button" id='home-button'> Home </router-link>
    <button v-if='authState.isAuthenticated' v-on:click='logout' id='logout-button'> Logout </button>
    <button v-else v-on:click='login' id='login-button'> Login </button>
    <router-view/>
  </div>
</template>

<script>
export default {
  name: 'app',
  methods: {
    async login () {
      await this.$idbaseAuth.signInWithRedirect()
    },
    async logout () {
      await this.$idbaseAuth.signOut()
    }
  }
}
</script>
```

### Use the Access Token

When your users are authenticated, your Vue application has an access token that was issued by your Idbase Authorization server. You can use this token to authenticate requests for resources on your server or API. As a hypothetical example, let's say you have an API that provides messages for a user. You could create a `MessageList` component that gets the access token and uses it to make an authenticated request to your server.

Here is what the Vue component could look like for this hypothentical example using [axios](https://github.com/axios/axios):

```typescript
// src/components/MessageList.vue

<template>
  <ul v-if="posts && posts.length">
    <li v-for="post in posts" :key='post.title'>
      <p><strong>{{post.title}}</strong></p>
      <p>{{post.body}}</p>
    </li>
  </ul>
</template>

<script>
import axios from 'axios'

export default {
  data () {
    return {
      posts: []
    }
  },
  async created () {
    axios.defaults.headers.common['Authorization'] = `Bearer ${this.$idbaseAuth.getAccessToken()}`
    try {
      const response = await axios.get(`http://localhost:{serverPort}/api/messages`)
      this.posts = response.data
    } catch (e) {
      console.error(`Errors! ${e}`)
    }
  }
}
</script>
```

### Using a custom login-page

The `idbase-vue` SDK supports the session token redirect flow for custom login pages. For more information, [see the basic Idbase Sign-in Widget functionality](https://github.com/idbase/idbase-signin-widget#new-idbasesigninconfig).

To implement a custom login page, set an [onAuthRequired](#onauthrequired) callback on the IdbaseConfig object:

```typescript
// router/index.js

import Vue from 'vue'
import Router from 'vue-router'
import IdbaseVue from '@idbase/idbase-vue'
import { IdbaseAuth } from '@idbase/idbase-auth'

const idbaseAuth = new IdbaseAuth(/* config */)
const router = new Router({
  mode: 'history',
  routes: [
    // other routes ...
    { path: '/login', component: Login }
  ]
})

Vue.use(Router)
Vue.use(IdbaseVue, {
  oAuth: idbaseAuth
  onAuthRequired: (idbaseAuth) => {
    router.push({ path: '/login' })
  }
})

export default router
```

## Reference

### `$idbaseAuth`

This SDK works as a [Vue Plugin][]. It provides an instance of the [Idbase Auth SDK][] to your components on the [Vue prototype][]. You can access the [Idbase Auth SDK][] instance by using `this.$idbaseAuth` in your components.

### `LoginCallback`

`LoginCallback` handles the callback after the redirect to and back from the Idbase-hosted login page. By default, it parses the tokens from the uri, stores them, then redirects to `/`. If a secure route caused the redirect, then the callback redirects to the secured route. For more advanced cases, this component can be copied to your own source tree and modified as needed.

#### Configuration Options

The base set of configuration options are defined by [Idbase Auth SDK][]. The following properties are required:

- `issuer` **(required)**: The OpenID Connect `issuer`
- `clientId` **(required)**: The OpenID Connect `client_id`
- `redirectUri` **(required)**: Where the callback is hosted

This SDK accepts all configuration options defined by [Idbase Auth SDK][] (see [Configuration Reference](https://github.com/idbase/idbase-auth-js#configuration-reference) for the supported options) and adds some additional options:

##### `onAuthRequired`

*(optional)* Callback function. Called when authentication is required. If not supplied, `idbase-vue` will redirect directly to Idbase for authentication. This is triggered when a secure route is accessed without authentication. A common use case for this callback is to redirect users to a custom login route when authentication is required for a SecureRoute.

See [Using a custom login-page](#using-a-custom-login-page) for the code sample.

## Usage with TypeScript

### Use types

Types are implicitly provided by this library through the types entry in package.json. Types can also be referenced explicitly by importing them.

```typescript
import { IdbaseVueOptions } from '@idbase/idbase-vue'
import { IdbaseAuth } from '@idbase/idbase-auth'

const idbaseAuth = new IdbaseAuth(/* configs */)
const options: IdbaseVueOptions = {
  idbaseAuth
}
```

### Use TypeScript with protected route

This SDK adds [In-Component Guards](https://router.vuejs.org/guide/advanced/navigation-guards.html#in-component-guards) via mixin to guard protected routes. You will need to extend your protected route components with `NavigationGuardMixin` instead of `Vue` to trigger the injected navigation guards properly.

```typescript
// src/components/Protected.vue

<template>
  <div class="protected">
    {{ message }}
    <pre class="userinfo">{{ user }}</pre>
  </div>
</template>

<script lang="ts">
import { NavigationGuardMixin } from '@idbase/idbase-vue'

export default NavigationGuardMixin.extend({
  name: 'Protected',
  data () {
    return {
      message: 'Protected!',
      user: ''
    }
  },
  created () {
    this.getUser()
  },
  methods: {
    async getUser () {
      const user = await this.$idbaseAuth.getUser()
      this.user = JSON.stringify(user, null, 4)
    }
  }
})
</script>
```

## Migrating

Each major version release introduces breaking changes, see [MIGRATING GUIDE](MIGRATING.md) to get your application properly updated.

## Contributing

We welcome contributions to all of our open-source packages. Please see the [contribution guide](https://github.com/idbase/idbase-oidc-js/blob/master/CONTRIBUTING.md) to understand how to structure a contribution.

### Installing dependencies for contributions

We use [yarn](https://yarnpkg.com) for dependency management when developing this package:

```bash
yarn install
```

### Commands

| Command        | Description                        |
| -------------- | ---------------------------------- |
| `yarn install` | Install all dependencies           |
| `yarn start`   | Start the sample app using the SDK |
| `yarn test`    | Run integration tests              |
| `yarn lint`    | Run eslint linting tests           |

---
_Source: https://npm.io/package/@idbase/idbase-vue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._