vue-greenborn-sso-front

vue-greenborn-sso-front

Cliente de SSO (Single Sign-On) para aplicaciones Vue 3 que se integra con el servidor de autenticación de Greenborn (https://auth.greenborn.com.ar).

Replica el flujo de autenticación SSO del frontend de referencia (GFC-Front, Angular) y lo expone de forma idiomática para Vue:

• Login con Google (OAuth)
• Intercambio de token temporal por bearer token
• Verificación de sesión activa (verify)
• Cierre de sesión (logout)
• Componente callback reutilizable para vue-router
• WebSocket complementario (socket.io) con mensajes genéricos y callbacks por función

Sin dependencias de UI. JS plano (sin TypeScript), estados reactivos con ref/computed.

Instalación

npm install vue-greenborn-sso-front

Requiere vue@^3.3 y, si usas el componente SsoCallback, también vue-router@^4.

Configuración

Crea un cliente y exponlo a la app mediante installSso (un solo punto de configuración):

// main.js
import { createApp } from 'vue'
import { createRouter, createWebHashHistory } from 'vue-router'
import { installSso } from 'vue-greenborn-sso-front'
import App from './App.vue'

const router = createRouter({
  history: createWebHashHistory(),
  routes: [
    { path: '/', component: Home },
    { path: '/login-redirect', component: SsoCallbackPage },
  ],
})

const app = createApp(App)

installSso(app, {
  ssoBaseUrl: 'https://auth.greenborn.com.ar',
  ssoRedirect: '/login-redirect',
  nodeApiBaseUrl: 'https://gfc.api2.greenborn.com.ar/api/',
  wsUrl: 'http://localhost:5175',   // opcional: base del servidor para WebSocket
  wsPath: '/socket.io',             // opcional
})

app.use(router)
app.mount('#app')

Claves de localStorage personalizadas

Por defecto el paquete usa las claves sso_bearer_token, sso_user_data, sso_redirect_url y sso_client_unique_id. Si tu aplicación ya maneja sesiones con otras claves, puedes adaptarlas sin perder sesiones activas:

installSso(app, {
  ssoBaseUrl: 'https://auth.greenborn.com.ar',
  ssoRedirect: '/login-redirect',
  storagePrefix: 'app_mascotas_',          // reemplaza el prefijo sso_
  keyMap: {                                // anula clave por clave (prioridad sobre el prefijo)
    user: 'app_mascotas_user',
    uniqueId: 'app_mascotas_unique_id',
    redirectUrl: 'app_mascota_url_login_redirect',
  },
})

• Con storagePrefix: 'app_mascotas_', la clave del token pasa a ser app_mascotas_bearer_token, la de usuario app_mascotas_user_data, etc. (reemplaza sso_ por el prefijo).
• keyMap permite fijar el nombre exacto de cualquier clave individual.
• Sin ninguna de las dos opciones, el comportamiento es idéntico al de versiones previas (retrocompatible).

Uso básico

Iniciar sesión (login con Google)

import { useSsoAuth } from 'vue-greenborn-sso-front'

const sso = useSsoAuth()

function loginWithGoogle() {
  sso.login()
}

login() guarda la URL actual para redirigir de vuelta tras el callback y envía al usuario a {ssoBaseUrl}/auth/google?....

El login con Google es opcional. Si tu backend expone un login local (usuario/contraseña), puedes usarlo con loginLocal() en lugar de Google — ver más abajo.

Iniciar sesión local (usuario/contraseña) — opcional

Requiere que el backend exponga el endpoint de login local (en express-greenborn-sso-back, la opción localLogin):

const sso = useSsoAuth()

const result = await sso.loginLocal('miusuario', 'miclave')
// result: { success, user, bearer_token }

El front envía POST {nodeApiBaseUrl}{loginEndpoint} (default /login) con { username, password }, guarda el bearer token y el usuario, y dispara el estado reactivo. A partir de ahí sso.isAuthenticated, sso.user, sso.roles, sso.permisos, etc. funcionan igual que con Google.

<template>
  <form @submit.prevent="submit">
    <input v-model="username" placeholder="Usuario" />
    <input v-model="password" type="password" placeholder="Contraseña" />
    <button>Entrar</button>
  </form>
</template>

<script setup>
import { ref } from 'vue'
import { useSsoAuth } from 'vue-greenborn-sso-front'
const sso = useSsoAuth()
const username = ref('')
const password = ref('')
async function submit() {
  try {
    await sso.loginLocal(username.value, password.value)
  } catch (e) {
    alert(e.message)
  }
}
</script>

Página callback

SsoCallback lee automáticamente token y unique_id de la query, intercambia el token temporal por el bearer token y verifica el perfil local. Emite success, error y no-params.

<template>
  <SsoCallback @success="onSuccess" @error="onError" />
</template>

<script setup>
import { SsoCallback } from 'vue-greenborn-sso-front'

function onSuccess(result) {
  // result.exists: boolean
  // result.localUser / result.ssoEmail / result.bearer_token
  // Si exists es false, el usuario debe registrarse (se redirige a registerPath).
}
</script>

Propiedades del componente:

Verificar sesión

const result = await sso.verifySession()
// result: { authenticated, user?, extended?, requireReauth? }

Si el token es inválido o requiere reautenticación, se limpia la sesión.

Cerrar sesión

await sso.logout()

Estado reactivo

const sso = useSsoAuth()

sso.isAuthenticated.value // booleano reactivo
sso.currentUser.value     // objeto usuario reactivo (o null)
sso.accessToken.value     // bearer token reactivo (o null)

RBAC (roles y permisos)

Si el backend local usa el esquema de roles/permisos (por ejemplo, express-greenborn-sso-back con rbac: true, o el RBAC de sistema-gestion-interno), el front expone helpers reactivos derivados de user.roles/user.permisos:

const sso = useSsoAuth()

sso.roles.value                    // string[] — p. ej. ['USUARIO']
sso.permisos.value                 // string[] — p. ej. ['proyectos.ver']
sso.esAdmin.value                  // boolean — true si 'ADMIN' está en roles
sso.tienePermiso('proyectos.ver')  // boolean — comprueba un permiso

Los roles/permisos se capturan en el callback (vía user/sso-profile) y también puedes refrescar el perfil local para actualizarlos:

await sso.fetchMe()
// o, si el backend no usa la ruta default:
await sso.fetchMe('https://api.ejemplo.com/api/')

fetchMe hace GET {nodeApiBaseUrl}{meEndpoint} con el bearer token (default /user/me), actualiza sso.user y dispara refreshState().

Helpers

sso.getToken()                // string | null
sso.getUser()                 // object | null
sso.isSSOSession()            // boolean
sso.getUniqueId()             // id de cliente persistido en localStorage
sso.getAndClearRedirectUrl()  // URL guardada antes del login (y la limpia)

// RBAC
sso.roles.value               // string[]
sso.permisos.value            // string[]
sso.esAdmin.value             // boolean
sso.tienePermiso('x.ver')     // boolean
sso.fetchMe(baseUrl?)         // Promise<result> — refresca el perfil local

// Login local (opcional, alternativa a Google)
sso.loginLocal(username, password) // Promise<result>

WebSocket complementario (socket.io)

Conexión persistente y autenticada con el bearer token SSO, con mensajes genéricos y callbacks por función (Pub/Sub + ACK). Es opcional: si no se define wsUrl, no se establece ninguna conexión.

Uso

const sso = useSsoAuth();
// o, más directo:
import { useSsoSocket } from 'vue-greenborn-sso-front';
const socket = useSsoSocket();

• Auto conectar/desconectar: se conecta al autenticarse y se desconecta al hacer logout/expirar sesión. También puedes llamar connectSocket() / disconnectSocket() manualmente.
• Estado reactivo: socket.connected (ref booleana) y socket.socketError.
• Emitir con ack (invoca una función en el back y espera respuesta):

const res = await sso.socket.emit('echo', { hola: 'mundo' });
// con callback explícito:
sso.socket.emit('echo', { hola: 'mundo' }, (res) => console.log(res));

• Recibir (handler por función):

sso.socket.on('ping', (data) => console.log('ping', data));

• API del composable: emit, on, off, once, connect, disconnect, client.
• Contraparte de backend: express-greenborn-sso-back → sso.attachSocket(server).

Exports

Demo

npm install
npm run dev

La demo corre en el puerto 5175 (http://localhost:5175).

Build

npm run build

Genera dist/ con los formatos ES y UMD (listo para publicar en npm; prepublishOnly compila automáticamente).

Licencia

MIT