@automattic/mcp-wordpress-remote 0.2.11 → 0.2.12

package/dist/lib.d.ts

@@ -0,0 +1,205 @@
+/**
+ * WordPress API request parameters
+ */
+interface WordPressRequestParams {
+    method: string;
+    [key: string]: any;
+}
+/**
+ * WordPress API response
+ */
+interface WordPressResponse {
+    [key: string]: any;
+}
+
+declare const MCP_WORDPRESS_REMOTE_VERSION = "0.2.1";
+declare enum LogLevel {
+    ERROR = 0,
+    WARN = 1,
+    INFO = 2,
+    DEBUG = 3
+}
+/**
+ * Enhanced logging function with levels and categories
+ *
+ * @param message - The message to log
+ * @param level - Log level (default: INFO)
+ * @param category - Log category for filtering (default: 'GENERAL')
+ * @param args - Additional arguments to log
+ */
+declare function log(message: string, level?: LogLevel, category?: string, ...args: any[]): void;
+/**
+ * Convenience logging functions
+ */
+declare const logger: {
+    error: (message: string, category?: string, ...args: any[]) => void;
+    warn: (message: string, category?: string, ...args: any[]) => void;
+    info: (message: string, category?: string, ...args: any[]) => void;
+    debug: (message: string, category?: string, ...args: any[]) => void;
+    auth: (message: string, level?: LogLevel, ...args: any[]) => void;
+    oauth: (message: string, level?: LogLevel, ...args: any[]) => void;
+    api: (message: string, level?: LogLevel, ...args: any[]) => void;
+    config: (message: string, level?: LogLevel, ...args: any[]) => void;
+};
+
+/**
+ * Centralized configuration for MCP WordPress Remote
+ * All default values are defined here and can be overridden via environment variables
+ */
+declare const CONFIG: {
+    readonly WP_API_URL: string;
+    readonly OAUTH_ENABLED: boolean;
+    readonly OAUTH_CALLBACK_PORT: number | undefined;
+    readonly OAUTH_HOST: string;
+    readonly WP_OAUTH_CLIENT_ID: string;
+    readonly OAUTH_FLOW_TYPE: "authorization_code" | "implicit";
+    readonly OAUTH_USE_PKCE: boolean;
+    readonly OAUTH_DYNAMIC_REGISTRATION: boolean;
+    readonly OAUTH_AUTHORIZE_ENDPOINT: string;
+    readonly OAUTH_TOKEN_ENDPOINT: string;
+    readonly OAUTH_AUTHENTICATE_ENDPOINT: string;
+    readonly OAUTH_RESOURCE_INDICATOR: boolean;
+    readonly OAUTH_SCOPES: string;
+    readonly OAUTH_TIMEOUT: 30000;
+    readonly LOCK_TIMEOUT: 300000;
+    readonly WP_MCP_CONFIG_DIR: string;
+    readonly LOG_FILE: string | null;
+    readonly WP_API_USERNAME: string | undefined;
+    readonly WP_API_PASSWORD: string | undefined;
+    readonly JWT_TOKEN: string | undefined;
+    readonly WOO_CUSTOMER_KEY: string | undefined;
+    readonly WOO_CUSTOMER_SECRET: string | undefined;
+    readonly NODE_ENV: string;
+};
+/**
+ * Type-safe configuration access with JSDoc descriptions
+ */
+declare const getConfig: () => {
+    /** WordPress site API endpoint */
+    wpApiUrl: string;
+    /** Whether OAuth authentication is enabled */
+    oauthEnabled: boolean;
+    /** Port for OAuth callback server (undefined for auto-detection on self-hosted sites) */
+    oauthCallbackPort: number | undefined;
+    /** Hostname for OAuth callback */
+    oauthHost: string;
+    /** WordPress OAuth client ID */
+    wpOAuthClientId: string;
+    /** OAuth flow type (authorization_code recommended, implicit for legacy) */
+    oauthFlowType: "authorization_code" | "implicit";
+    /** Whether to use PKCE (required for OAuth 2.1) */
+    oauthUsePKCE: boolean;
+    /** Whether to support dynamic client registration */
+    oauthDynamicRegistration: boolean;
+    /** Whether to use resource indicators (RFC 8707) */
+    oauthResourceIndicator: boolean;
+    /** Custom OAuth scopes (comma-separated) */
+    oauthScopes: string;
+    /** OAuth operation timeout in milliseconds */
+    oauthTimeout: 30000;
+    /** Lock operation timeout in milliseconds */
+    lockTimeout: 300000;
+    /** Configuration directory path */
+    configDir: string;
+    /** Log file path (null if not set) */
+    logFile: string | null;
+    /** WordPress API username (legacy) */
+    wpApiUsername: string | undefined;
+    /** WordPress API password (legacy) */
+    wpApiPassword: string | undefined;
+    /** JWT token for authentication */
+    jwtToken: string | undefined;
+    /** WooCommerce customer key */
+    wooCustomerKey: string | undefined;
+    /** WooCommerce customer secret */
+    wooCustomerSecret: string | undefined;
+    /** Current environment */
+    nodeEnv: string;
+};
+/**
+ * Get default OAuth scopes
+ */
+declare function getDefaultOAuthScopes(): string[];
+/**
+ * Validation function for required configuration
+ */
+declare function validateConfig(): {
+    isValid: boolean;
+    errors: string[];
+};
+
+/**
+ * WordPress OAuth types and error definitions
+ * Updated for MCP Authorization specification 2025-06-18 compliance
+ */
+/**
+ * WordPress OAuth tokens structure
+ */
+interface WPTokens {
+    access_token: string;
+    token_type: string;
+    expires_in?: number;
+    scope?: string;
+    obtained_at: number;
+    refresh_token?: string;
+}
+/**
+ * WordPress OAuth client information
+ */
+interface WPClientInfo {
+    client_id: string;
+    client_secret?: string;
+    authorization_endpoint?: string;
+    token_endpoint?: string;
+    scope?: string;
+}
+/**
+ * Token validation result
+ */
+interface TokenValidationResult {
+    isValid: boolean;
+    expiresIn?: number;
+    error?: string;
+}
+/**
+ * Custom OAuth error class
+ */
+declare class OAuthError extends Error {
+    readonly code: string;
+    readonly details?: any;
+    constructor(message: string, code?: string, details?: any);
+}
+/**
+ * Custom configuration error class
+ */
+declare class ConfigError extends Error {
+    readonly field: string;
+    readonly value?: any;
+    constructor(message: string, field: string, value?: any);
+}
+/**
+ * Custom authentication error class
+ */
+declare class AuthError extends Error {
+    readonly method: string;
+    readonly statusCode?: number;
+    constructor(message: string, method: string, statusCode?: number);
+}
+/**
+ * Custom API error class
+ */
+declare class APIError extends Error {
+    readonly statusCode: number;
+    readonly endpoint: string;
+    readonly response?: any;
+    constructor(message: string, statusCode: number, endpoint: string, response?: any);
+}
+/**
+ * Error type guards
+ */
+declare function isOAuthError(error: any): error is OAuthError;
+declare function isConfigError(error: any): error is ConfigError;
+declare function isAuthError(error: any): error is AuthError;
+declare function isAPIError(error: any): error is APIError;
+
+export { APIError, AuthError, CONFIG, ConfigError, LogLevel, MCP_WORDPRESS_REMOTE_VERSION, OAuthError, type TokenValidationResult, type WPClientInfo, type WPTokens, type WordPressRequestParams, type WordPressResponse, getConfig, getDefaultOAuthScopes, isAPIError, isAuthError, isConfigError, isOAuthError, log, logger, validateConfig };