@stonyx/oauth 0.1.1-beta.9 → 0.1.1-beta.90

package/README.md

@@ -1,3 +1,7 @@
+[![CI](https://github.com/abofs/stonyx-oauth/actions/workflows/ci.yml/badge.svg)](https://github.com/abofs/stonyx-oauth/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@stonyx/oauth.svg)](https://www.npmjs.com/package/@stonyx/oauth)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 # @stonyx/oauth
 
 OAuth2 authentication module for the Stonyx framework. Provides a generic OAuth2 Authorization Code flow with a provider pattern — ship with Discord support, extensible to any OAuth2 provider.

package/dist/auth-request.d.ts

@@ -0,0 +1,35 @@
+import { Request } from '@stonyx/rest-server';
+interface OAuthInstance {
+    frontendCallbackUrl?: string;
+    getSession(sessionId: string): unknown;
+    getAuthorizationUrl(providerName: string): string;
+    handleCallback(providerName: string, code: string, stateToken: string): Promise<{
+        sessionId: string;
+        expiresAt: number;
+    }>;
+    logout(sessionId: string): void;
+}
+interface RouteRequest {
+    headers: Record<string, string | undefined>;
+    params: Record<string, string>;
+    query: Record<string, string>;
+}
+interface RouteState {
+    redirect?: string;
+}
+export default class AuthRequest extends Request {
+    oauth: OAuthInstance;
+    constructor(oauth: OAuthInstance);
+    handlers: {
+        get: {
+            '/': ({ headers }: RouteRequest) => {};
+            '/login/:provider': (req: RouteRequest, state: RouteState) => 404 | undefined;
+            '/callback/:provider': (req: RouteRequest, state: RouteState) => Promise<{
+                sessionId: string;
+                expiresAt: number;
+            } | 400 | 500 | undefined>;
+            '/logout': ({ headers }: RouteRequest) => void;
+        };
+    };
+}
+export {};

package/dist/auth-request.js

@@ -0,0 +1,68 @@
+import { Request } from '@stonyx/rest-server';
+export default class AuthRequest extends Request {
+    oauth;
+    constructor(oauth) {
+        super();
+        this.oauth = oauth;
+    }
+    handlers = {
+        get: {
+            '/': ({ headers }) => {
+                const sessionId = headers['session-id'];
+                if (!sessionId)
+                    return 401;
+                const user = this.oauth.getSession(sessionId);
+                if (!user)
+                    return 401;
+                return user;
+            },
+            '/login/:provider': (req, state) => {
+                const { provider: providerName } = req.params;
+                try {
+                    const url = this.oauth.getAuthorizationUrl(providerName);
+                    state.redirect = url;
+                }
+                catch {
+                    return 404;
+                }
+            },
+            '/callback/:provider': async (req, state) => {
+                const { provider: providerName } = req.params;
+                const { code, state: stateToken, error } = req.query;
+                if (error) {
+                    if (this.oauth.frontendCallbackUrl) {
+                        state.redirect = `${this.oauth.frontendCallbackUrl}?error=${encodeURIComponent(error)}`;
+                        return;
+                    }
+                    return 400;
+                }
+                if (!code)
+                    return 400;
+                try {
+                    const session = await this.oauth.handleCallback(providerName, code, stateToken);
+                    if (this.oauth.frontendCallbackUrl) {
+                        const params = new URLSearchParams({
+                            sessionId: session.sessionId,
+                            expiresAt: String(session.expiresAt),
+                        });
+                        state.redirect = `${this.oauth.frontendCallbackUrl}?${params}`;
+                        return;
+                    }
+                    return session;
+                }
+                catch {
+                    if (this.oauth.frontendCallbackUrl) {
+                        state.redirect = `${this.oauth.frontendCallbackUrl}?error=auth_failed`;
+                        return;
+                    }
+                    return 500;
+                }
+            },
+            '/logout': ({ headers }) => {
+                const sessionId = headers['session-id'];
+                if (sessionId)
+                    this.oauth.logout(sessionId);
+            },
+        }
+    };
+}

package/dist/main.d.ts

@@ -0,0 +1,22 @@
+import TokenManager from './token-manager.js';
+import SessionManager from './session-manager.js';
+import type OAuthFlow from './oauth-flow.js';
+interface ProviderEntry {
+    flow: OAuthFlow;
+    tokenManager: TokenManager;
+}
+export default class OAuth {
+    static instance: OAuth | null;
+    providers: Map<string, ProviderEntry>;
+    pendingStates: Map<string, number>;
+    sessionManager: SessionManager;
+    frontendCallbackUrl?: string;
+    constructor();
+    init(): Promise<void>;
+    getProvider(name: string): ProviderEntry;
+    getAuthorizationUrl(providerName: string): string;
+    handleCallback(providerName: string, code: string, stateToken: string): Promise<import("./session-manager.js").SessionResult>;
+    getSession(sessionId: string): unknown;
+    logout(sessionId: string): void;
+}
+export {};

package/dist/main.js

@@ -0,0 +1,79 @@
+import config from 'stonyx/config';
+import log from 'stonyx/log';
+import { waitForModule } from 'stonyx';
+import { setup, emit } from '@stonyx/events';
+import RestServer from '@stonyx/rest-server';
+import TokenManager from './token-manager.js';
+import SessionManager from './session-manager.js';
+import AuthRequest from './auth-request.js';
+setup(['authenticate']);
+export default class OAuth {
+    static instance;
+    providers = new Map();
+    pendingStates = new Map();
+    sessionManager;
+    frontendCallbackUrl;
+    constructor() {
+        if (OAuth.instance)
+            return OAuth.instance;
+        OAuth.instance = this;
+    }
+    async init() {
+        // Self-register so log.oauth works even when @stonyx/oauth is in the
+        // consumer's `dependencies` (stonyx loader only merges devDependencies).
+        const { logColor = 'magenta', logMethod = 'oauth' } = config.oauth;
+        log.defineType(logMethod, logColor);
+        const oauthConfig = config.oauth;
+        const { providers, sessionDuration, frontendCallbackUrl } = oauthConfig;
+        this.frontendCallbackUrl = frontendCallbackUrl;
+        for (const [name, providerConfig] of Object.entries(providers)) {
+            const modulePath = providerConfig.module
+                ? `${config.rootPath}/${providerConfig.module}`
+                : `./providers/${name}.js`;
+            const { default: Provider } = await import(modulePath);
+            const flow = new Provider(providerConfig);
+            this.providers.set(name, { flow, tokenManager: new TokenManager(flow) });
+        }
+        this.sessionManager = new SessionManager(sessionDuration);
+        await waitForModule('rest-server');
+        RestServer.instance.mountRoute(AuthRequest, { name: 'auth', options: this });
+        log.oauth?.('OAuth module initialized');
+    }
+    getProvider(name) {
+        const provider = this.providers.get(name);
+        if (!provider)
+            throw new Error(`OAuth provider "${name}" is not configured`);
+        return provider;
+    }
+    getAuthorizationUrl(providerName) {
+        const { flow } = this.getProvider(providerName);
+        const stateToken = crypto.randomUUID();
+        this.pendingStates.set(stateToken, Date.now());
+        return flow.buildAuthorizationUrl(stateToken);
+    }
+    async handleCallback(providerName, code, stateToken) {
+        if (!stateToken || !this.pendingStates.has(stateToken)) {
+            throw new Error('Invalid or missing state token');
+        }
+        const stateCreatedAt = this.pendingStates.get(stateToken);
+        if (stateCreatedAt === undefined)
+            throw new Error('State token not found in pending states');
+        this.pendingStates.delete(stateToken);
+        const TEN_MINUTES = 10 * 60 * 1000;
+        if (Date.now() - stateCreatedAt > TEN_MINUTES) {
+            throw new Error('State token has expired');
+        }
+        const { flow, tokenManager } = this.getProvider(providerName);
+        const tokens = await tokenManager.getTokens(code);
+        const rawUser = await flow.fetchUserInfo(tokens.accessToken);
+        const user = flow.normalizeUser(rawUser);
+        await emit('authenticate', user);
+        return this.sessionManager.create(user, tokens);
+    }
+    getSession(sessionId) {
+        return this.sessionManager.validate(sessionId);
+    }
+    logout(sessionId) {
+        this.sessionManager.destroy(sessionId);
+    }
+}

package/dist/oauth-flow.d.ts

@@ -0,0 +1,30 @@
+export interface OAuthConfig {
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    scopes?: string[];
+    authorizationUrl: string;
+    tokenUrl: string;
+    userInfoUrl: string;
+}
+export interface TokenResult {
+    accessToken: string;
+    refreshToken: string | null;
+    expiresIn: number;
+}
+export default class OAuthFlow {
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    scopes: string[];
+    authorizationUrl: string;
+    tokenUrl: string;
+    userInfoUrl: string;
+    constructor({ clientId, clientSecret, redirectUri, scopes, authorizationUrl, tokenUrl, userInfoUrl }: OAuthConfig);
+    buildAuthorizationUrl(stateToken: string): string;
+    exchangeCode(code: string): Promise<TokenResult>;
+    refreshAccessToken(refreshToken: string): Promise<TokenResult>;
+    fetchUserInfo(accessToken: string): Promise<unknown>;
+    normalizeUser(rawUser: unknown): unknown;
+    revokeToken(_accessToken: string): Promise<void>;
+}

package/dist/oauth-flow.js

@@ -0,0 +1,83 @@
+export default class OAuthFlow {
+    clientId;
+    clientSecret;
+    redirectUri;
+    scopes;
+    authorizationUrl;
+    tokenUrl;
+    userInfoUrl;
+    constructor({ clientId, clientSecret, redirectUri, scopes, authorizationUrl, tokenUrl, userInfoUrl }) {
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
+        this.redirectUri = redirectUri;
+        this.scopes = scopes || [];
+        this.authorizationUrl = authorizationUrl;
+        this.tokenUrl = tokenUrl;
+        this.userInfoUrl = userInfoUrl;
+    }
+    buildAuthorizationUrl(stateToken) {
+        const params = new URLSearchParams({
+            client_id: this.clientId,
+            redirect_uri: this.redirectUri,
+            response_type: 'code',
+            scope: this.scopes.join(' '),
+            state: stateToken,
+        });
+        return `${this.authorizationUrl}?${params.toString()}`;
+    }
+    async exchangeCode(code) {
+        const response = await fetch(this.tokenUrl, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                client_id: this.clientId,
+                client_secret: this.clientSecret,
+                grant_type: 'authorization_code',
+                code,
+                redirect_uri: this.redirectUri,
+            }),
+        });
+        if (!response.ok)
+            throw new Error(`Token exchange failed: ${response.status}`);
+        const data = await response.json();
+        return {
+            accessToken: data.access_token,
+            refreshToken: data.refresh_token || null,
+            expiresIn: data.expires_in,
+        };
+    }
+    async refreshAccessToken(refreshToken) {
+        const response = await fetch(this.tokenUrl, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                client_id: this.clientId,
+                client_secret: this.clientSecret,
+                grant_type: 'refresh_token',
+                refresh_token: refreshToken,
+            }),
+        });
+        if (!response.ok)
+            throw new Error(`Token refresh failed: ${response.status}`);
+        const data = await response.json();
+        return {
+            accessToken: data.access_token,
+            refreshToken: data.refresh_token || refreshToken,
+            expiresIn: data.expires_in,
+        };
+    }
+    async fetchUserInfo(accessToken) {
+        const response = await fetch(this.userInfoUrl, {
+            headers: { Authorization: `Bearer ${accessToken}` },
+        });
+        if (!response.ok)
+            throw new Error(`User info fetch failed: ${response.status}`);
+        return response.json();
+    }
+    normalizeUser(rawUser) {
+        return { raw: rawUser };
+    }
+    async revokeToken(_accessToken) {
+        // Optional — providers override if supported
+    }
+}

package/dist/providers/discord.d.ts

@@ -0,0 +1,30 @@
+import OAuthFlow from '../oauth-flow.js';
+import type { TokenResult } from '../oauth-flow.js';
+interface DiscordProviderConfig {
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    scopes?: string[];
+    [key: string]: unknown;
+}
+interface DiscordUser {
+    id: string;
+    username: string;
+    global_name?: string;
+    avatar: string | null;
+    email?: string | null;
+}
+interface NormalizedDiscordUser {
+    id: string;
+    username: string;
+    displayName: string;
+    avatar: string | null;
+    email: string | null;
+    raw: DiscordUser;
+}
+export default class DiscordProvider extends OAuthFlow {
+    constructor(config: DiscordProviderConfig);
+    exchangeCode(code: string): Promise<TokenResult>;
+    normalizeUser(rawUser: DiscordUser): NormalizedDiscordUser;
+}
+export {};

package/dist/providers/discord.js

@@ -0,0 +1,43 @@
+import OAuthFlow from '../oauth-flow.js';
+export default class DiscordProvider extends OAuthFlow {
+    constructor(config) {
+        super({
+            ...config,
+            authorizationUrl: 'https://discord.com/oauth2/authorize',
+            tokenUrl: 'https://discord.com/api/oauth2/token',
+            userInfoUrl: 'https://discord.com/api/users/@me',
+        });
+    }
+    async exchangeCode(code) {
+        const response = await fetch(this.tokenUrl, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            body: new URLSearchParams({
+                client_id: this.clientId,
+                client_secret: this.clientSecret,
+                grant_type: 'authorization_code',
+                code,
+                redirect_uri: this.redirectUri,
+            }),
+        });
+        if (!response.ok)
+            throw new Error(`Token exchange failed: ${response.status}`);
+        const data = await response.json();
+        return {
+            accessToken: data.access_token,
+            refreshToken: data.refresh_token || null,
+            expiresIn: data.expires_in,
+        };
+    }
+    normalizeUser(rawUser) {
+        const { id, username, global_name, avatar, email } = rawUser;
+        return {
+            id,
+            username,
+            displayName: global_name || username,
+            avatar: avatar ? `https://cdn.discordapp.com/avatars/${id}/${avatar}.png` : null,
+            email: email || null,
+            raw: rawUser,
+        };
+    }
+}

package/dist/session-manager.d.ts

@@ -0,0 +1,20 @@
+interface SessionData {
+    user: unknown;
+    tokens: unknown;
+    expiresAt: number;
+}
+export interface SessionResult {
+    sessionId: string;
+    user: unknown;
+    expiresAt: number;
+}
+export default class SessionManager {
+    sessions: Map<string, SessionData>;
+    duration: number;
+    constructor(duration: number);
+    create(user: unknown, tokens: unknown): SessionResult;
+    get(sessionId: string): SessionData | null;
+    destroy(sessionId: string): void;
+    validate(sessionId: string): unknown;
+}
+export {};

package/dist/session-manager.js

@@ -0,0 +1,30 @@
+import { randomUUID } from 'node:crypto';
+export default class SessionManager {
+    sessions = new Map();
+    duration;
+    constructor(duration) {
+        this.duration = duration;
+    }
+    create(user, tokens) {
+        const sessionId = randomUUID();
+        const expiresAt = Date.now() + (this.duration * 1000);
+        this.sessions.set(sessionId, { user, tokens, expiresAt });
+        return { sessionId, user, expiresAt };
+    }
+    get(sessionId) {
+        return this.sessions.get(sessionId) || null;
+    }
+    destroy(sessionId) {
+        this.sessions.delete(sessionId);
+    }
+    validate(sessionId) {
+        const session = this.get(sessionId);
+        if (!session)
+            return null;
+        if (Date.now() >= session.expiresAt) {
+            this.destroy(sessionId);
+            return null;
+        }
+        return session.user;
+    }
+}

package/dist/token-manager.d.ts

@@ -0,0 +1,15 @@
+import type OAuthFlow from './oauth-flow.js';
+import type { TokenResult } from './oauth-flow.js';
+export interface TokenData extends TokenResult {
+    expiresAt: number;
+}
+export default class TokenManager {
+    flow: OAuthFlow;
+    constructor(flow: OAuthFlow);
+    getTokens(code: string): Promise<TokenData>;
+    refresh(refreshToken: string): Promise<TokenData>;
+    revoke(accessToken: string): Promise<void>;
+    isExpired(tokenData: {
+        expiresAt?: number;
+    } | null | undefined): boolean;
+}

package/dist/token-manager.js

@@ -0,0 +1,24 @@
+export default class TokenManager {
+    flow;
+    constructor(flow) {
+        this.flow = flow;
+    }
+    async getTokens(code) {
+        const tokens = await this.flow.exchangeCode(code);
+        tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
+        return tokens;
+    }
+    async refresh(refreshToken) {
+        const tokens = await this.flow.refreshAccessToken(refreshToken);
+        tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
+        return tokens;
+    }
+    async revoke(accessToken) {
+        return this.flow.revokeToken(accessToken);
+    }
+    isExpired(tokenData) {
+        if (!tokenData?.expiresAt)
+            return true;
+        return Date.now() >= tokenData.expiresAt;
+    }
+}

package/package.json

@@ -4,39 +4,76 @@
     "stonyx-async",
     "stonyx-module"
   ],
-  "version": "0.1.1-beta.9",
+  "version": "0.1.1-beta.90",
   "description": "OAuth2 authentication module for the Stonyx framework",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/abofs/stonyx-oauth.git"
   },
-  "main": "src/main.js",
+  "main": "dist/main.js",
   "type": "module",
   "exports": {
-    ".": "./src/main.js"
+    ".": {
+      "types": "./dist/main.d.ts",
+      "default": "./dist/main.js"
+    },
+    "./oauth-flow": {
+      "types": "./dist/oauth-flow.d.ts",
+      "default": "./dist/oauth-flow.js"
+    },
+    "./auth-request": {
+      "types": "./dist/auth-request.d.ts",
+      "default": "./dist/auth-request.js"
+    },
+    "./session-manager": {
+      "types": "./dist/session-manager.d.ts",
+      "default": "./dist/session-manager.js"
+    },
+    "./token-manager": {
+      "types": "./dist/token-manager.d.ts",
+      "default": "./dist/token-manager.js"
+    },
+    "./providers/discord": {
+      "types": "./dist/providers/discord.d.ts",
+      "default": "./dist/providers/discord.js"
+    }
   },
   "author": "Stone Costa",
   "license": "Apache-2.0",
   "contributors": [
     "Stone Costa <stone.costa@synamicd.com>"
   ],
+  "files": [
+    "dist",
+    "src",
+    "config",
+    "README.md"
+  ],
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
   "dependencies": {
-    "stonyx": "0.2.3-beta.6"
+    "@stonyx/events": "0.1.1-beta.48",
+    "stonyx": "0.2.3-beta.64"
   },
   "peerDependencies": {
     "@stonyx/rest-server": ">=0.2.1-beta.11"
   },
   "devDependencies": {
-    "@stonyx/rest-server": "0.2.1-beta.16",
-    "@stonyx/utils": "0.2.3-beta.5",
+    "@stonyx/rest-server": "0.2.1-beta.62",
+    "@stonyx/utils": "0.2.3-beta.23",
+    "@stonyx/logs": "1.0.1-beta.16",
+    "@types/qunit": "^2.19.13",
+    "@types/sinon": "^21.0.1",
     "qunit": "^2.24.1",
-    "sinon": "^21.0.0"
+    "sinon": "^21.0.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.8.3"
   },
   "scripts": {
-    "test": "stonyx test"
+    "build": "tsc",
+    "build:test": "tsc -p tsconfig.test.json",
+    "test": "pnpm build && NODE_ENV=test node --import tsx/esm --import ./test/setup.ts node_modules/qunit/bin/qunit.js 'test/**/*-test.ts'"
   }
 }

package/src/{auth-request.js → auth-request.ts}

@@ -1,14 +1,34 @@
 import { Request } from '@stonyx/rest-server';
 
+interface OAuthInstance {
+  frontendCallbackUrl?: string;
+  getSession(sessionId: string): unknown;
+  getAuthorizationUrl(providerName: string): string;
+  handleCallback(providerName: string, code: string, stateToken: string): Promise<{ sessionId: string; expiresAt: number }>;
+  logout(sessionId: string): void;
+}
+
+interface RouteRequest {
+  headers: Record<string, string | undefined>;
+  params: Record<string, string>;
+  query: Record<string, string>;
+}
+
+interface RouteState {
+  redirect?: string;
+}
+
 export default class AuthRequest extends Request {
-  constructor(oauth) {
+  oauth: OAuthInstance;
+
+  constructor(oauth: OAuthInstance) {
     super();
     this.oauth = oauth;
   }
 
   handlers = {
     get: {
-      '/': ({ headers }) => {
+      '/': ({ headers }: RouteRequest) => {
         const sessionId = headers['session-id'];
         if (!sessionId) return 401;
 
@@ -18,7 +38,7 @@ export default class AuthRequest extends Request {
         return user;
       },
 
-      '/login/:provider': (req, state) => {
+      '/login/:provider': (req: RouteRequest, state: RouteState) => {
         const { provider: providerName } = req.params;
 
         try {
@@ -29,7 +49,7 @@ export default class AuthRequest extends Request {
         }
       },
 
-      '/callback/:provider': async (req, state) => {
+      '/callback/:provider': async (req: RouteRequest, state: RouteState) => {
         const { provider: providerName } = req.params;
         const { code, state: stateToken, error } = req.query;
 
@@ -49,7 +69,7 @@ export default class AuthRequest extends Request {
           if (this.oauth.frontendCallbackUrl) {
             const params = new URLSearchParams({
               sessionId: session.sessionId,
-              expiresAt: session.expiresAt,
+              expiresAt: String(session.expiresAt),
             });
             state.redirect = `${this.oauth.frontendCallbackUrl}?${params}`;
             return;
@@ -65,7 +85,7 @@ export default class AuthRequest extends Request {
         }
       },
 
-      '/logout': ({ headers }) => {
+      '/logout': ({ headers }: RouteRequest) => {
         const sessionId = headers['session-id'];
         if (sessionId) this.oauth.logout(sessionId);
       },