@radzor/auth-oauth

{
  "llm": {
    "constraints": "Requires OAuth client credentials (client ID + secret) for each provider. Server-side token exchange requires a backend route.",
    "usageExamples": "llm/examples.md",
    "integrationPrompt": "llm/integration.md"
  },
  "name": "@radzor/auth-oauth",
  "tags": [
    "oauth",
    "authentication",
    "login",
    "session",
    "jwt"
  ],
  "events": [
    {
      "name": "onLogin",
      "payload": {
        "userId": "string",
        "provider": "string"
      },
      "description": "Fired when a user successfully authenticates."
    },
    {
      "name": "onLogout",
      "payload": {
        "userId": "string"
      },
      "description": "Fired when a user logs out."
    },
    {
      "name": "onTokenRefresh",
      "payload": {
        "expiresAt": "number"
      },
      "description": "Fired when the access token is automatically refreshed."
    },
    {
      "name": "onError",
      "payload": {
        "code": "string",
        "message": "string"
      },
      "description": "Fired on authentication errors (invalid token, provider error, etc.)."
    }
  ],
  "inputs": [
    {
      "name": "providers",
      "type": "Array<'google' | 'github' | 'discord'>",
      "required": true,
      "description": "List of OAuth providers to enable."
    },
    {
      "name": "redirectUrl",
      "type": "string",
      "required": true,
      "description": "URL to redirect to after successful authentication."
    },
    {
      "name": "scopes",
      "type": "string[]",
      "default": [
        "openid",
        "profile",
        "email"
      ],
      "required": false,
      "description": "OAuth scopes to request from the provider."
    },
    {
      "name": "sessionDuration",
      "type": "number",
      "default": 86400,
      "required": false,
      "description": "Session duration in seconds (default: 24 hours)."
    }
  ],
  "radzor": "1.0.0",
  "actions": [
    {
      "name": "login",
      "params": [
        {
          "name": "provider",
          "type": "string",
          "description": "The OAuth provider to authenticate with."
        }
      ],
      "returns": "Promise<AuthSession>",
      "description": "Initiate the OAuth login flow with the specified provider."
    },
    {
      "name": "logout",
      "params": [],
      "returns": "Promise<void>",
      "description": "End the current session and revoke tokens."
    },
    {
      "name": "getSession",
      "params": [],
      "returns": "AuthSession | null",
      "description": "Get the current authentication session, or null if not authenticated."
    },
    {
      "name": "refreshToken",
      "params": [],
      "returns": "Promise<AuthSession>",
      "description": "Manually refresh the access token using the refresh token."
    }
  ],
  "outputs": [
    {
      "name": "session",
      "type": "AuthSession",
      "description": "Current authentication session containing access token, refresh token, and expiry."
    },
    {
      "name": "user",
      "type": "UserProfile",
      "description": "Authenticated user profile with id, email, name, and avatar."
    }
  ],
  "version": "0.1.0",
  "category": "auth",
  "languages": [
    "typescript",
    "python"
  ],
  "description": "OAuth 2.0 authentication flow supporting multiple providers (Google, GitHub, Discord). Handles token exchange, session management, and user profile retrieval.",
  "dependencies": {
    "packages": {
      "jose": "^5.0.0"
    }
  },
  "composability": {
    "connectsTo": [
      {
        "output": "session",
        "compatibleWith": [
          "@radzor/realtime-chat.input.authSession",
          "@radzor/stripe-checkout.input.authSession"
        ]
      },
      {
        "output": "user",
        "compatibleWith": [
          "@radzor/realtime-chat.input.userProfile",
          "@radzor/stripe-checkout.input.userProfile"
        ]
      }
    ]
  }
}