Skip to content
VentureKit

@venturekit/auth

Installation

Section titled “Installation”
Terminal window
npm install @venturekit/auth@dev

What It Provides

Section titled “What It Provides”

Cognito Configuration

Section titled “Cognito Configuration”
import { createCognitoConfig, buildUserPoolConfig, DEFAULT_COGNITO_CONFIG } from '@venturekit/auth';


const config = createCognitoConfig(securityConfig);
const userPoolConfig = buildUserPoolConfig(config);

Role-Based Access Control

Section titled “Role-Based Access Control”
import { hasScope, hasAnyScope, hasAllScopes, getScopesForRoles, validateRolesConfig } from '@venturekit/auth';


getScopesForRoles(['member'], rolesConfig);  // → ['users.read', 'users.write']
hasScope(['admin'], 'admin.users', config);  // → true

JWT / Session Utilities

Section titled “JWT / Session Utilities”
import { decodeToken, extractUserFromToken, isTokenExpired, getTokenExpiry } from '@venturekit/auth';


const claims = decodeToken(jwt);
const user = extractUserFromToken(jwt);
const expired = isTokenExpired(jwt);

Types

Section titled “Types”
  • User, Session, Role, Permission — auth domain types
  • RolesConfig — role definitions
  • UserPoolOutputs, UserPoolInfraConfig — Cognito infrastructure types

Dependencies

Section titled “Dependencies”
  • @venturekit/core — required
Section titled “Related”