Registry / auth-security / energy-community-auth-sdk

energy-community-auth-sdk

JSON →
library0.3.2jsnpmunverified

Versión 0.3.2. SDK tipado en TypeScript/JavaScript para consumir el servicio de autenticación de Energy Community. Proporciona métodos para registro, login, refresh de tokens, validación, logout, gestión de sesiones, recuperación y restablecimiento de contraseñas. Empaqueta errores con códigos de estado HTTP. Incluye tipos completos para todas las peticiones y respuestas. Liberado en 2025, con versiones semver. Alternativa a implementar cliente HTTP propio.

npm install energy-community-auth-sdk
INSTALL
IMPORT
SIG · ENERGY-COMMUNITY-A
E
energy-community-auth-sdk
auth-securityjavascriptv0.3.2
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

AuthServiceSdk
import { AuthServiceSdk } from 'energy-community-auth-sdk'
const AuthServiceSdk = require('energy-community-auth-sdk')
ESM-only. Si usas CJS, debes usar await import() o configura tu bundler.
AuthServiceSdkError
import { AuthServiceSdkError } from 'energy-community-auth-sdk'
import AuthServiceSdkError from 'energy-community-auth-sdk'
Es una exportación nombrada, no default.
TokensResponse
import type { TokensResponse } from 'energy-community-auth-sdk'
import { TokensResponse } from 'energy-community-auth-sdk'
Es un tipo de TypeScript; usa 'import type' para evitar errores en runtime.
RegisterRequest
import type { RegisterRequest } from 'energy-community-auth-sdk'
import { RegisterRequest } from 'energy-community-auth-sdk'
Es un tipo, no un valor. Usa 'import type'.

Muestra registro, login, refresh, validación de token y logout usando el SDK con manejo de entorno para credenciales.

import { AuthServiceSdk } from 'energy-community-auth-sdk'; const sdk = new AuthServiceSdk({ appId: process.env.APP_ID ?? '', apiKey: process.env.API_KEY ?? '', }); async function main() { // Register const registration = await sdk.auth.register({ firstName: 'Ada', lastName: 'Lovelace', email: 'ada@example.com', password: 'StrongPass123!', }); console.log('Registered user:', registration.user.id); // Login const loginResult = await sdk.auth.login({ email: 'ada@example.com', password: 'StrongPass123!', }); console.log('Access token:', loginResult.tokens.accessToken); // Refresh const tokens = await sdk.auth.refresh({ refreshToken: loginResult.tokens.refreshToken, }); console.log('New access token:', tokens.accessToken); // Validate const validation = await sdk.auth.validate({ accessToken: tokens.accessToken, }); console.log('Token valid:', validation.valid); // Logout await sdk.auth.logout(tokens.accessToken); } main().catch(console.error);
Debug
Known issues
breakingv0.3.0 cambió el constructor de AuthServiceSdk: requiere objeto con appId y apiKey, no acepta argumentos posicionales ni baseUrl.
fix
Actualizar a new AuthServiceSdk({ appId: '...', apiKey: '...', baseUrl?: '...' }).
affects: <0.3.0
deprecatedLos métodos sdk.auth.validateToken() y sdk.auth.refreshToken() están obsoletos desde v0.3.0; usar sdk.auth.validate() y sdk.auth.refresh().
fix
Reemplazar por sdk.auth.validate({ accessToken }) y sdk.auth.refresh({ refreshToken }).
affects: >=0.3.0
gotchaNo soporta CommonJS require() directamente. Si usas require, debes usar await import('energy-community-auth-sdk') o activar esModuleInterop en tsconfig.
fix
Usa import o configura tu entorno para ESM.
affects: >=0.1.0
gotchaLos tipos (RegisterRequest, TokensResponse, etc.) son solo TypeScript; no existen en runtime. No se pueden usar en comparaciones instanceof.
fix
Importa solo como type: import type { TokensResponse } from 'energy-community-auth-sdk'.
affects: >=0.1.0
gotchaLos errores lanzados por el SDK son instancias de AuthServiceSdkError, no de Error genérico. No uses error.message sin verificar el tipo.
fix
Captura con 'error instanceof AuthServiceSdkError' para acceder a status y message.
affects: >=0.1.0
Errors
Common errors & fixes
error: Cannot find module 'energy-community-auth-sdk'
Paquete no instalado o instalado como devDependency en lugar de dependency.
fix
Ejecutar 'npm install energy-community-auth-sdk' o moverlo a dependencies en package.json.
TypeError: Class constructor AuthServiceSdk cannot be invoked without 'new'
Se llamó AuthServiceSdk() sin 'new' o se usó require en ESM sin transpilación.
fix
Usar 'new AuthServiceSdk(...)' y asegurar que se importe como ESM: import { AuthServiceSdk } from 'energy-community-auth-sdk'.
AuthServiceSdkError: Status: 403, Message: Forbidden
API key inválida o no autorizada para el recurso.
fix
Verificar la apiKey y appId en la configuración del SDK.
AuthServiceSdkError: Status: 401, Message: Invalid credentials
Credenciales incorrectas al hacer login o refresh token no válido.
fix
Verificar email y contraseña o renovar el refresh token.
AuthServiceSdkError: Status: 0, Message: Network Error
No se pudo conectar al servidor de autenticación (problema de red o DNS).
fix
Verificar conectividad a internet y que la URL base sea correcta.
Upgrade
Version history
0.3.2latest on npm
Audit
Dependencies
axiosrequiredCliente HTTP subyacente para realizar peticiones al servicio de autenticación.
Agent activity
13 hits · last 30 days
node
11
Amazon
1
OpenAI (training)
1
Resources
energy-community-auth-sdk — npm install energy-community-auth-sdk · libregistry