@rekog/mcp-nest 1.9.10 → 2.0.0-alpha.0

package/src/authz/stores/oauth-store.interface.ts

@@ -1,131 +0,0 @@
-import type {
-  OAuthSession,
-  OAuthUserProfile,
-} from '../interfaces/oauth-common.interface';
-
-export const MCP_OAUTH_TOKEN = 'MCP_OAUTH_TOKEN';
-
-export interface OAuthClient {
-  client_id: string;
-  client_secret?: string;
-  client_name: string;
-  client_description?: string;
-  logo_uri?: string;
-  client_uri?: string;
-  developer_name?: string;
-  developer_email?: string;
-  redirect_uris: string[];
-  grant_types: string[];
-  response_types: string[];
-  token_endpoint_auth_method: string;
-  created_at: Date;
-  updated_at: Date;
-}
-
-export interface AuthorizationCode {
-  code: string;
-  user_id: string;
-  client_id: string;
-  redirect_uri: string;
-  code_challenge: string;
-  code_challenge_method: string;
-  resource?: string;
-  scope?: string;
-  expires_at: number;
-  used_at?: Date;
-  // Link to stored user profile (if available)
-  user_profile_id?: string;
-}
-
-export interface ClientRegistrationDto {
-  client_name: string;
-  client_description?: string;
-  logo_uri?: string;
-  client_uri?: string;
-  developer_name?: string;
-  developer_email?: string;
-  redirect_uris: string[];
-  grant_types?: string[];
-  response_types?: string[];
-  token_endpoint_auth_method?: string;
-}
-
-/**
- * Interface for OAuth store implementations.
- *
- * Implement this interface to create custom storage solutions (e.g., Redis, Database, etc.).
- * The default implementation is an in-memory store suitable for development.
- *
- * @example
- * ```typescript
- * class RedisOAuthStore implements IOAuthStore {
- *   constructor(private redisClient: RedisClient) {}
- *
- *   async storeClient(client: OAuthClient): Promise<void> {
- *     await this.redisClient.set(`client:${client.client_id}`, JSON.stringify(client));
- *   }
- *
- *   async getClient(client_id: string): Promise<OAuthClient | undefined> {
- *     const data = await this.redisClient.get(`client:${client_id}`);
- *     return data ? JSON.parse(data) : undefined;
- *   }
- *
- *   async findClient(client_name: string): Promise<OAuthClient | undefined> {
- *     const data = await this.redisClient.get(`client_name:${client_name}`);
- *     return data ? JSON.parse(data) : undefined;
- *   }
- *
- *   generateClientId(client: OAuthClient): string {
- *     // Custom client ID generation logic
- *     const normalizedName = client.client_name.toLowerCase().replace(/[^a-z0-9]/g, '');
- *     const timestamp = Date.now().toString(36);
- *     return `${normalizedName}_${timestamp}`;
- *   }
- *
- *   // ... implement other methods
- * }
- *
- * // Usage in module:
- * McpOAuthModule.forRoot({
- *   provider: GoogleOAuthProvider,
- *   clientId: process.env.GOOGLE_CLIENT_ID!,
- *   clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
- *   jwtSecret: process.env.JWT_SECRET!,
- *   memoryStore: new RedisOAuthStore(redisClient), // Custom implementation
- * })
- * ```
- */
-export interface IOAuthStore {
-  // Client management
-  storeClient(client: OAuthClient): Promise<OAuthClient>;
-  getClient(client_id: string): Promise<OAuthClient | undefined>;
-  findClient(client_name: string): Promise<OAuthClient | undefined>;
-  generateClientId(client: OAuthClient): string;
-
-  // Authorization code management
-  storeAuthCode(code: AuthorizationCode): Promise<void>;
-  getAuthCode(code: string): Promise<AuthorizationCode | undefined>;
-  removeAuthCode(code: string): Promise<void>;
-
-  // OAuth session management
-  storeOAuthSession(sessionId: string, session: OAuthSession): Promise<void>;
-  getOAuthSession(sessionId: string): Promise<OAuthSession | undefined>;
-  removeOAuthSession(sessionId: string): Promise<void>;
-
-  // User profile management
-  /**
-   * Upsert a user profile from an OAuth provider and return a stable profile_id.
-   * The profile_id should be stable across logins for the same provider+user.
-   */
-  upsertUserProfile(
-    profile: OAuthUserProfile,
-    provider: string,
-  ): Promise<string>;
-
-  /** Retrieve a stored user profile by its profile_id */
-  getUserProfileById(
-    profileId: string,
-  ): Promise<
-    (OAuthUserProfile & { profile_id: string; provider: string }) | undefined
-  >;
-}

package/src/authz/stores/typeorm/README.md

@@ -1,140 +0,0 @@
-# TypeORM OAuth Store Implementation
-
-This directory contains a TypeORM implementation of the `IOAuthStore` interface for persistent OAuth data storage.
-
-## Features
-
-- **Persistent Storage**: Unlike the in-memory store, data survives server restarts
-- **Database Support**: Works with any database supported by TypeORM (PostgreSQL, MySQL, SQLite, etc.)
-- **Automatic Schema Management**: Entities automatically create the required database tables
-- **Expiration Handling**: Automatic cleanup of expired sessions and authorization codes
-
-## Entities
-
-### OAuthClientEntity
-Stores OAuth client information including:
-- Client credentials and metadata
-- Redirect URIs and grant types
-- Creation and update timestamps
-
-### AuthorizationCodeEntity
-Stores authorization codes with:
-- Code challenge and method for PKCE
-- Expiration and usage tracking
-- Associated user and client information
-
-### OAuthSessionEntity
-Stores OAuth session data including:
-- Session state and parameters
-- Expiration handling
-- Client association
-
-### OAuthUserProfileEntity
-Stores normalized user profile information per provider:
-- Stable `profile_id` primary key
-- `provider_user_id` and `provider`
-- `username`, `email`, `displayName`, `avatarUrl`
-- `raw` stringified provider payload
-
-## Usage
-
-### Basic SQLite Configuration
-
-```typescript
-McpOAuthModule.forRoot({
-  provider: GoogleOAuthProvider,
-  clientId: process.env.GOOGLE_CLIENT_ID!,
-  clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
-  jwtSecret: process.env.JWT_SECRET!,
-  typeormOptions: {
-    type: 'sqlite',
-    database: 'oauth.db',
-    synchronize: true,
-    logging: false,
-  },
-})
-```
-
-### PostgreSQL Configuration
-
-```typescript
-McpOAuthModule.forRoot({
-  provider: GoogleOAuthProvider,
-  clientId: process.env.GOOGLE_CLIENT_ID!,
-  clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
-  jwtSecret: process.env.JWT_SECRET!,
-  typeormOptions: {
-    type: 'postgres',
-    host: process.env.DB_HOST || 'localhost',
-    port: parseInt(process.env.DB_PORT) || 5432,
-    username: process.env.DB_USERNAME || 'postgres',
-    password: process.env.DB_PASSWORD || 'password',
-    database: process.env.DB_NAME || 'oauth_db',
-    synchronize: process.env.NODE_ENV !== 'production',
-    logging: process.env.NODE_ENV === 'development',
-  },
-})
-```
-
-### MySQL Configuration
-
-```typescript
-McpOAuthModule.forRoot({
-  provider: GoogleOAuthProvider,
-  clientId: process.env.GOOGLE_CLIENT_ID!,
-  clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
-  jwtSecret: process.env.JWT_SECRET!,
-  typeormOptions: {
-    type: 'mysql',
-    host: process.env.DB_HOST || 'localhost',
-    port: parseInt(process.env.DB_PORT) || 3306,
-    username: process.env.DB_USERNAME || 'root',
-    password: process.env.DB_PASSWORD || 'password',
-    database: process.env.DB_NAME || 'oauth_db',
-    synchronize: process.env.NODE_ENV !== 'production',
-    logging: process.env.NODE_ENV === 'development',
-  },
-})
-```
-
-## Configuration Options
-
-All standard TypeORM options are supported:
-
-- `type`: Database type (sqlite, postgres, mysql, etc.)
-- `host`: Database host
-- `port`: Database port
-- `username`: Database username
-- `password`: Database password
-- `database`: Database name or file path (for SQLite)
-- `synchronize`: Auto-create tables (disable in production)
-- `logging`: Enable query logging
-- `entities`: Additional entities (OAuth entities are automatically included)
-- `migrations`: Database migrations
-- `ssl`: SSL configuration for production databases
-
-## Production Considerations
-
-1. **Disable synchronize**: Use migrations instead of auto-sync in production
-2. **Enable SSL**: Configure SSL for production database connections
-3. **Connection Pooling**: Configure appropriate connection pool settings
-4. **Logging**: Disable query logging in production for performance
-5. **Backup Strategy**: Implement regular database backups
-
-## Migrations
-
-For production use, create migrations instead of using `synchronize: true`:
-
-```bash
-npx typeorm migration:generate -n CreateOAuthTables
-npx typeorm migration:run
-```
-
-## Interface Compatibility
-
-The TypeORM implementation provides both synchronous and asynchronous methods:
-
-- Synchronous methods (for IOAuthStore compatibility): Log warnings and use fire-and-forget async operations
-- Asynchronous methods (recommended): `*Async` versions that return promises
-
-Consider updating your application to use the async methods for better error handling and performance.

package/src/authz/stores/typeorm/constants.ts

@@ -1,6 +0,0 @@
-// Unique TypeORM connection name used by the OAuth store to avoid
-// collisions with an application's own connections.
-export const OAUTH_TYPEORM_CONNECTION_NAME = '@rekog/mcp-nest:oauth';
-
-// Table name prefix to avoid collisions with application tables.
-export const OAUTH_TABLE_PREFIX = 'rekog_mcp_auth_';

package/src/authz/stores/typeorm/entities/authorization-code.entity.ts

@@ -1,41 +0,0 @@
-import { Entity, Column, PrimaryColumn, CreateDateColumn } from 'typeorm';
-import { OAUTH_TABLE_PREFIX } from '../constants';
-
-@Entity(`${OAUTH_TABLE_PREFIX}authorization_codes`)
-export class AuthorizationCodeEntity {
-  @PrimaryColumn()
-  code: string;
-
-  @Column()
-  user_id: string;
-
-  @Column()
-  client_id: string;
-
-  @Column()
-  redirect_uri: string;
-
-  @Column()
-  code_challenge: string;
-
-  @Column()
-  code_challenge_method: string;
-
-  @Column('bigint')
-  expires_at: number;
-
-  @Column()
-  resource: string;
-
-  @Column({ nullable: true })
-  scope?: string;
-
-  @Column({ nullable: true })
-  used_at?: Date;
-
-  @Column({ nullable: true })
-  user_profile_id?: string;
-
-  @CreateDateColumn()
-  created_at: Date;
-}

package/src/authz/stores/typeorm/entities/index.ts

@@ -1,4 +0,0 @@
-export { OAuthClientEntity } from './oauth-client.entity';
-export { AuthorizationCodeEntity } from './authorization-code.entity';
-export { OAuthSessionEntity } from './oauth-session.entity';
-export { OAuthUserProfileEntity } from './user-profile.entity';

package/src/authz/stores/typeorm/entities/oauth-client.entity.ts

@@ -1,53 +0,0 @@
-import {
-  Entity,
-  Column,
-  PrimaryColumn,
-  CreateDateColumn,
-  UpdateDateColumn,
-} from 'typeorm';
-import { OAUTH_TABLE_PREFIX } from '../constants';
-
-@Entity(`${OAUTH_TABLE_PREFIX}clients`)
-export class OAuthClientEntity {
-  @PrimaryColumn()
-  client_id: string;
-
-  @Column({ nullable: true })
-  client_secret?: string;
-
-  @Column()
-  client_name: string;
-
-  @Column({ nullable: true })
-  client_description?: string;
-
-  @Column({ nullable: true })
-  logo_uri?: string;
-
-  @Column({ nullable: true })
-  client_uri?: string;
-
-  @Column({ nullable: true })
-  developer_name?: string;
-
-  @Column({ nullable: true })
-  developer_email?: string;
-
-  @Column('simple-array')
-  redirect_uris: string[];
-
-  @Column('simple-array')
-  grant_types: string[];
-
-  @Column('simple-array')
-  response_types: string[];
-
-  @Column()
-  token_endpoint_auth_method: string;
-
-  @CreateDateColumn()
-  created_at: Date;
-
-  @UpdateDateColumn()
-  updated_at: Date;
-}

package/src/authz/stores/typeorm/entities/oauth-session.entity.ts

@@ -1,38 +0,0 @@
-import { Entity, Column, PrimaryColumn, CreateDateColumn } from 'typeorm';
-import { OAUTH_TABLE_PREFIX } from '../constants';
-
-@Entity(`${OAUTH_TABLE_PREFIX}sessions`)
-export class OAuthSessionEntity {
-  @PrimaryColumn()
-  sessionId: string;
-
-  @Column()
-  state: string;
-
-  @Column({ nullable: true })
-  clientId?: string;
-
-  @Column({ nullable: true })
-  redirectUri?: string;
-
-  @Column({ nullable: true })
-  codeChallenge?: string;
-
-  @Column({ nullable: true })
-  codeChallengeMethod?: string;
-
-  @Column({ nullable: true })
-  oauthState?: string;
-
-  @Column({ nullable: true })
-  resource?: string;
-
-  @Column({ nullable: true })
-  scope?: string;
-
-  @Column('bigint')
-  expiresAt: number;
-
-  @CreateDateColumn()
-  created_at: Date;
-}

package/src/authz/stores/typeorm/entities/user-profile.entity.ts

@@ -1,46 +0,0 @@
-import {
-  Entity,
-  Column,
-  PrimaryColumn,
-  CreateDateColumn,
-  UpdateDateColumn,
-  Index,
-} from 'typeorm';
-import { OAUTH_TABLE_PREFIX } from '../constants';
-
-@Entity(`${OAUTH_TABLE_PREFIX}user_profiles`)
-export class OAuthUserProfileEntity {
-  // Stable profile id we return to callers
-  @PrimaryColumn()
-  profile_id: string;
-
-  // Provider-unique user id (e.g., GitHub id)
-  @Index('idx_provider_user')
-  @Column()
-  provider_user_id: string;
-
-  @Column()
-  provider: string;
-
-  @Column()
-  username: string;
-
-  @Column({ nullable: true })
-  email?: string;
-
-  @Column({ nullable: true })
-  displayName?: string;
-
-  @Column({ nullable: true })
-  avatarUrl?: string;
-
-  // Store raw provider profile for completeness/debugging
-  @Column({ type: 'text', nullable: true })
-  raw?: string;
-
-  @CreateDateColumn()
-  created_at: Date;
-
-  @UpdateDateColumn()
-  updated_at: Date;
-}