# passport-client

> Passport client for authentication with PassportJS, Passport Laravel, Passport Django, Passport dotNET

Latest version **1.1.1** (published 2023-11-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install passport-client
pnpm add passport-client
yarn add passport-client
bun add passport-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-11-15 |
| First published | 2023-11-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | passport-oauth |

## Links

- npm: https://www.npmjs.com/package/passport-client
- npm.io page: https://npm.io/package/passport-client

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.6.2
- [js-cookie](https://npm.io/package/js-cookie.md) ^3.0.5
- [@types/js-cookie](https://npm.io/package/@types/js-cookie.md) ^3.0.6

## Recent versions

- 1.1.1 (latest) — 2023-11-15
- 1.1.0 — 2023-11-15
- 1.0.5 — 2023-11-15
- 1.0.4 — 2023-11-15
- 1.0.3 — 2023-11-15
- 1.0.2 — 2023-11-15
- 1.0.1 — 2023-11-15
- 1.0.0 — 2023-11-15

## README

# Librería de Autenticación para Passport

Esta librería proporciona funciones para la gestión de autenticación de usuarios, incluyendo métodos para iniciar sesión, almacenar y recuperar sesiones de autenticación, y obtener autorización para realizar peticiones a servidores protegidos.

## Instalación

Para utilizar esta librería, puedes instalarla a través de npm o yarn:

```bash
npm install passport-client

ó

yarn add passport-client
```

## Uso

```ts
import {
  getAuthorization,
  clearAuth,
  getAuth,
  setAuth,
  login
} from 'passport-client';
```

## Métodos

**`getAuth(): Promise<string | null>`**

Obtiene la sesión de autenticación almacenada.

_Retorna_: Una cadena que representa la sesión de autenticación si está presente, de lo contrario, retorna null.

**`setAuth(session: string): Promise<boolean>`**

Almacena la sesión de autenticación en las cookies.

_Parámetros_:

- session: Una cadena que representa la sesión de autenticación a almacenar.

_Retorna_: true si la sesión se almacenó correctamente, de lo contrario, retorna false.

**`clearAuth(): boolean`**

Elimina la sesión de autenticación almacenada.

_Retorna_: true si la sesión se eliminó correctamente, de lo contrario, retorna false.

**`login(email: string, password: string, server: string): Promise<string | null>`**

Inicia sesión utilizando las credenciales proporcionadas y almacena la sesión de autenticación.

_Parámetros_:

- email: El correo electrónico del usuario.
- password: La contraseña del usuario.
- server: La URL del servidor para la autenticación.

_Retorna_: Una cadena que representa el token de autenticación si el inicio de sesión fue exitoso, de lo contrario, retorna null.

**`getAuthorization(): Promise<{ Authorization: string } | null>`**

Obtiene la autorización en formato de objeto para utilizar en las cabeceras de las peticiones a servidores protegidos.

_Retorna_: Un objeto que contiene la autorización en el formato adecuado para las cabeceras HTTP. Retorna null si no hay sesión de autenticación disponible.

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