startgg-oauth2-full 0.2.0 → 0.2.2

package/examples/node/package.json

@@ -1,17 +0,0 @@
-{
-  "name": "startgg-oauth2-node-example",
-  "version": "0.0.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "tsx src/index.ts",
-    "oauth-server": "tsx src/server.ts"
-  },
-  "dependencies": {
-    "startgg-oauth2-full": "file:../.."
-  },
-  "devDependencies": {
-    "tsx": "^4.19.0",
-    "typescript": "^5.6.3"
-  }
-}

package/examples/node/src/index.ts

@@ -1,57 +0,0 @@
-import { randomUUID } from 'node:crypto';
-import { createInterface } from 'node:readline/promises';
-import { stdin as input, stdout as output } from 'node:process';
-import { fileURLToPath } from 'node:url';
-import {
-  BearerToken,
-  StartGGScope,
-  buildAuthorizeUrl,
-  createStartGGAuth2Handler,
-} from 'startgg-oauth2-full/src/auth/StartGGOAuth2';
-
-async function main() {
-  const cfg = {
-    clientId: process.env.STARTGG_CLIENT_ID ?? 'YOUR_CLIENT_ID',
-    authEndpoint: process.env.STARTGG_AUTH_URL ?? 'https://api.start.gg/oauth/authorize',
-    tokenEndpoint: process.env.STARTGG_TOKEN_URL ?? 'https://api.start.gg/oauth/token',
-    redirectUri: 'http://localhost:3000/callback',
-  };
-
-  const { url, codeVerifier } = await buildAuthorizeUrl(cfg, {
-    scopes: [StartGGScope.USER_IDENTITY],
-    state: randomUUID(),
-  });
-
-  console.log('\nOpen this URL in your browser to authorize:\n');
-  console.log(`${url}\n`);
-
-  const rl = createInterface({ input, output });
-  const code = (await rl.question('Paste the "code" query parameter once redirected: ')).trim();
-  rl.close();
-
-  if (!code) {
-    console.error('No code supplied. Exiting.');
-    process.exit(1);
-  }
-
-  const handler = createStartGGAuth2Handler(cfg);
-  const tokenResponse = await handler.exchangeToken(code, codeVerifier, [StartGGScope.USER_IDENTITY]);
-  const bearer = BearerToken.fromOAuthResponse(tokenResponse);
-
-  const masked = (t?: string) => (t ? `${t.slice(0, 6)}…${t.slice(-4)}` : undefined);
-  console.log('\n✅ Token exchange complete');
-  console.log('access_token:', masked(tokenResponse.access_token));
-  console.log('refresh_token:', masked(tokenResponse.refresh_token));
-  console.log('token_type:', tokenResponse.token_type);
-  console.log('expires_in:', tokenResponse.expires_in ?? 'n/a');
-  console.log('\nAuthorization header:', bearer.toAuthHeader());
-}
-
-const isMainModule = process.argv[1] === fileURLToPath(import.meta.url);
-
-if (isMainModule) {
-  main().catch(err => {
-    console.error(err);
-    process.exit(1);
-  });
-}

package/examples/node/src/server.ts

@@ -1,120 +0,0 @@
-import { randomUUID } from 'node:crypto';
-import http from 'node:http';
-import { URL, fileURLToPath } from 'node:url';
-import { spawn } from 'node:child_process';
-import {
-  buildAuthorizeUrl,
-  createStartGGAuth2Handler,
-  StartGGScope,
-  BearerToken,
-} from 'startgg-oauth2-full/src/auth/StartGGOAuth2';
-
-const PORT = Number(process.env.PORT ?? 3000);
-const REDIRECT = `http://localhost:${PORT}/callback`;
-
-const cfg = {
-  clientId: process.env.STARTGG_CLIENT_ID ?? 'YOUR_CLIENT_ID',
-  authEndpoint: process.env.STARTGG_AUTH_URL ?? 'https://api.start.gg/oauth/authorize',
-  tokenEndpoint: process.env.STARTGG_TOKEN_URL ?? 'https://api.start.gg/oauth/token',
-  redirectUri: REDIRECT,
-};
-
-const REQUIRED_SCOPES = [StartGGScope.USER_IDENTITY, StartGGScope.USER_EMAIL];
-
-function openInBrowser(url: string): void {
-  const platform = process.platform;
-  try {
-    if (platform === 'darwin') spawn('open', [url], { stdio: 'ignore', detached: true }).unref();
-    else if (platform === 'win32') spawn('cmd', ['/c', 'start', '', url], { stdio: 'ignore', detached: true }).unref();
-    else spawn('xdg-open', [url], { stdio: 'ignore', detached: true }).unref();
-  } catch {
-    console.log('Please open this URL manually:\\n', url);
-  }
-}
-
-async function main() {
-  const state = randomUUID();
-  const { url: authorizeUrl, codeVerifier } = await buildAuthorizeUrl(
-    { clientId: cfg.clientId, authEndpoint: cfg.authEndpoint, redirectUri: cfg.redirectUri },
-    { scopes: REQUIRED_SCOPES, state, extras: { access_type: 'offline' } }
-  );
-
-  const server = http.createServer(async (req, res) => {
-    try {
-      const reqUrl = new URL(req.url || '', `http://localhost:${PORT}`);
-      if (reqUrl.pathname !== '/callback') {
-        res.writeHead(200, { 'Content-Type': 'text/plain' });
-        res.end('OK');
-        return;
-      }
-
-      const code = reqUrl.searchParams.get('code');
-      const gotState = reqUrl.searchParams.get('state');
-
-      if (!code || !gotState || gotState !== state) {
-        res.writeHead(400, { 'Content-Type': 'text/plain' });
-        res.end('Invalid OAuth callback (missing/invalid code or state).');
-        console.error('Invalid callback:', { code, state: gotState });
-        server.close();
-        process.exitCode = 1;
-        return;
-      }
-
-      const handler = createStartGGAuth2Handler(cfg);
-
-      try {
-        const tokenResponse = await handler.exchangeToken(code, codeVerifier, REQUIRED_SCOPES);
-        const bearer = BearerToken.fromOAuthResponse(tokenResponse);
-        const masked = (t?: string) => (t ? `${t.slice(0, 6)}…${t.slice(-4)}` : undefined);
-        console.log('\\n✅ OAuth2 token exchange successful!\\n');
-        console.log('access_token:', masked(tokenResponse.access_token));
-        console.log('refresh_token:', masked(tokenResponse.refresh_token));
-        console.log('token_type:', tokenResponse.token_type);
-        console.log('expires_in:', tokenResponse.expires_in);
-        console.log('scope:', tokenResponse.scope ?? '(omitted → unchanged)');
-        console.log('\\nAuthorization header:', bearer.toAuthHeader());
-
-        res.writeHead(200, { 'Content-Type': 'text/html' });
-        res.end(`
-<!doctype html>
-<title>OAuth Success</title>
-<meta name="viewport" content="width=device-width, initial-scale=1">
-<body style="font-family: system-ui; margin: 2rem;">
-  <h1>Success ✅</h1>
-  <p>You can close this window and return to the terminal.</p>
-</body>`);
-
-        server.close(() => process.exit(0));
-      } catch (err) {
-        console.error('Token exchange failed:', err);
-        res.writeHead(500, { 'Content-Type': 'text/html' });
-        res.end(`<h1>Token exchange failed</h1><pre>${String(err)}</pre>`);
-        server.close(() => process.exit(1));
-      }
-    } catch (err) {
-      console.error('Callback error:', err);
-      try {
-        res.writeHead(500, { 'Content-Type': 'text/plain' });
-        res.end('Internal error');
-      } catch {}
-      server.close(() => process.exit(1));
-    }
-  });
-
-  server.listen(PORT, () => {
-    console.log(`\\nListening on http://localhost:${PORT}`);
-    console.log('\\nOpening browser for OAuth authorization…');
-    console.log('(If this does not open automatically, paste this URL manually.)\\n');
-    console.log(authorizeUrl, '\\n');
-    openInBrowser(authorizeUrl);
-  });
-}
-
-const isMainModule = process.argv[1] === fileURLToPath(import.meta.url);
-
-if (isMainModule) {
-  main().catch((e) => {
-    console.error('Fatal:', e);
-    process.exit(1);
-  });
-}

package/examples/node/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "strict": true,
-    "esModuleInterop": true,
-    "types": ["node"],
-    "resolveJsonModule": true
-  },
-  "include": ["src"]
-}

package/examples/vite/README.md

@@ -1,22 +0,0 @@
-# Vite Demo
-
-This example shows how to use `startgg-oauth2-full` inside a Vite application to build PKCE-capable authorize URLs.
-
-## Getting Started
-
-```bash
-cd examples/vite
-npm install
-npm run dev
-```
-
-The dev server opens on `http://localhost:5174`. Provide your Start.gg OAuth client credentials, submit the form, and copy the generated authorize URL into your browser. The console prints the matching `code_verifier` and `code_challenge` for use during the token exchange.
-
-## Build & Preview
-
-```bash
-npm run build
-npm run preview
-```
-
-`npm run build` produces a production bundle under `dist/`, and `npm run preview` serves it locally for smoke testing.

package/examples/vite/index.html

@@ -1,41 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Start.gg OAuth2 Vite Demo</title>
-  </head>
-  <body>
-    <main id="app">
-      <h1>Start.gg OAuth2 Vite Demo</h1>
-      <form id="auth-form">
-        <label>
-          Client ID
-          <input name="clientId" value="CHANGE_ME" required />
-        </label>
-        <label>
-          Auth Endpoint
-          <input
-            name="authEndpoint"
-            value="https://start.gg/oauth/authorize"
-            required
-          />
-        </label>
-        <label>
-          Redirect URI
-          <input name="redirectUri" value="http://localhost:5174/callback" required />
-        </label>
-        <button type="submit">Generate Authorize URL</button>
-      </form>
-      <section id="output">
-        <h2>Authorize URL</h2>
-        <pre id="authorize-url">Fill the form and submit.</pre>
-        <h2>Code Verifier</h2>
-        <pre id="code-verifier">Generated verifier will appear here.</pre>
-        <h2>Code Challenge</h2>
-        <pre id="code-challenge">Generated challenge will appear here.</pre>
-      </section>
-    </main>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/examples/vite/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "startgg-oauth2-vite-example",
-  "version": "0.0.0",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "vite build",
-    "preview": "vite preview"
-  },
-  "dependencies": {
-    "startgg-oauth2-full": "file:../.."
-  },
-  "devDependencies": {
-    "typescript": "^5.6.3",
-    "vite": "^5.4.8"
-  }
-}

package/examples/vite/src/main.ts

@@ -1,38 +0,0 @@
-import { buildAuthorizeUrl, StartGGScope } from 'startgg-oauth2-full/src/auth/StartGGOAuth2';
-
-const form = document.querySelector<HTMLFormElement>('#auth-form');
-const urlOutput = document.querySelector<HTMLPreElement>('#authorize-url');
-const verifierOutput = document.querySelector<HTMLPreElement>('#code-verifier');
-const challengeOutput = document.querySelector<HTMLPreElement>('#code-challenge');
-
-if (!form || !urlOutput || !verifierOutput || !challengeOutput) {
-  throw new Error('Demo markup not found');
-}
-
-form.addEventListener('submit', async event => {
-  event.preventDefault();
-  const data = new FormData(form);
-  const clientId = String(data.get('clientId') ?? '');
-  const authEndpoint = String(data.get('authEndpoint') ?? '');
-  const redirectUri = String(data.get('redirectUri') ?? '');
-
-  try {
-    const result = await buildAuthorizeUrl(
-      { clientId, authEndpoint, redirectUri },
-      {
-        scopes: [StartGGScope.USER_IDENTITY, StartGGScope.USER_EMAIL],
-        state: crypto.randomUUID(),
-        extras: { prompt: 'consent' },
-      }
-    );
-
-    urlOutput.textContent = result.url;
-    verifierOutput.textContent = result.codeVerifier;
-    challengeOutput.textContent = result.codeChallenge;
-  } catch (err) {
-    const message = err instanceof Error ? err.message : String(err);
-    urlOutput.textContent = `Failed to build URL: ${message}`;
-    verifierOutput.textContent = '—';
-    challengeOutput.textContent = '—';
-  }
-});

package/examples/vite/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "strict": true,
-    "esModuleInterop": true,
-    "types": ["vite/client"]
-  },
-  "include": ["src"]
-}

package/examples/vite/vite.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({
-  server: {
-    port: 5174,
-    open: true,
-  },
-});

package/jest.config.ts

@@ -1,15 +0,0 @@
-import type { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tsconfig.json' }],
-  },
-  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
-  testMatch: ['**/__tests__/**/*.test.ts'],
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'json'],
-  clearMocks: true,
-  coverageDirectory: 'coverage'
-};
-
-export default config;

package/jest.setup.ts

@@ -1,29 +0,0 @@
-import { webcrypto as nodeWebcrypto } from 'node:crypto';
-import { TextEncoder, TextDecoder } from 'node:util';
-
-// WebCrypto
-// @ts-ignore
-if (!global.crypto) global.crypto = nodeWebcrypto as unknown as Crypto;
-
-// TextEncoder/Decoder
-// @ts-ignore
-if (!global.TextEncoder) global.TextEncoder = TextEncoder as any;
-// @ts-ignore
-if (!global.TextDecoder) global.TextDecoder = TextDecoder as any;
-
-// Response/Headers/Request (Node)
-// @ts-ignore
-if (typeof Response === 'undefined') {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const { Response, Headers, Request } = require('node-fetch');
-  // @ts-ignore
-  global.Response = Response;
-  // @ts-ignore
-  global.Headers = Headers;
-  // @ts-ignore
-  global.Request = Request;
-}
-
-// Default fetch mock (tests override per suite)
-// @ts-ignore
-if (!global.fetch) global.fetch = jest.fn();