@mcp-consultant-tools/rest-api 32.0.0 → 34.0.0-beta.2

package/build/RestApiService.d.ts

@@ -1,226 +0,0 @@
-/**
- * REST API Service
- *
- * Provides HTTP request functionality with multiple authentication methods:
- * - Static Bearer Token
- * - Basic Authentication
- * - API Key (custom header)
- * - OAuth2 Client Credentials Flow (JWT generation)
- */
-/**
- * Endpoint definition for API discovery
- */
-export interface EndpointDefinition {
-    /** Endpoint path (e.g., "/users", "/sic_exams") */
-    path: string;
-    /** Supported HTTP methods */
-    methods: ("GET" | "POST" | "PUT" | "DELETE" | "PATCH")[];
-    /** Entity name (singular) if applicable */
-    entityName?: string;
-    /** Human-readable description */
-    description?: string;
-}
-/**
- * Field definition for entity schema
- */
-export interface FieldDefinition {
-    /** Field name */
-    name: string;
-    /** Data type (e.g., "string", "Guid", "int", "datetime", "decimal") */
-    type: string;
-    /** Whether the field is required for creation */
-    required: boolean;
-    /** Whether the field can be null */
-    nullable: boolean;
-    /** Maximum length for string fields */
-    maxLength?: number;
-    /** Human-readable description */
-    description?: string;
-    /** Foreign key reference */
-    foreignKey?: {
-        entity: string;
-        field: string;
-    };
-    /** Enum/option set values */
-    enumValues?: string[];
-}
-/**
- * Entity schema definition
- */
-export interface EntitySchema {
-    /** Entity name (singular) */
-    entityName: string;
-    /** Plural name for the endpoint */
-    pluralName: string;
-    /** Endpoint path */
-    endpoint: string;
-    /** Primary key field name */
-    primaryKey: string;
-    /** Field definitions */
-    fields: FieldDefinition[];
-    /** Example object for creating/updating */
-    example?: Record<string, any>;
-}
-export interface RestApiConfig {
-    /** Base URL for all requests (e.g., "https://api.example.com/v1") */
-    baseUrl: string;
-    /** Response size limit in bytes (default: 10000) */
-    responseSizeLimit?: number;
-    /** Enable SSL certificate verification (default: true) */
-    enableSslVerify?: boolean;
-    /** Static bearer token (mutually exclusive with oauth2) */
-    bearerToken?: string;
-    /** Basic auth credentials */
-    basicAuth?: {
-        username: string;
-        password: string;
-    };
-    /** API key authentication */
-    apiKey?: {
-        headerName: string;
-        value: string;
-    };
-    /** OAuth2 client credentials configuration */
-    oauth2?: {
-        /** Token endpoint URL (e.g., "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token") */
-        tokenUrl: string;
-        /** OAuth2 Client ID */
-        clientId: string;
-        /** OAuth2 Client Secret */
-        clientSecret: string;
-        /** OAuth2 Scope (e.g., "https://api.example.com/.default") */
-        scope: string;
-        /** Optional grant type (defaults to "client_credentials") */
-        grantType?: string;
-        /** Optional additional token request parameters */
-        additionalParams?: Record<string, string>;
-    };
-    /** Custom headers to include in all requests */
-    customHeaders?: Record<string, string>;
-    /** Request timeout in milliseconds (default: 30000) */
-    timeout?: number;
-    /** URL to fetch OpenAPI/Swagger spec for dynamic discovery */
-    openApiUrl?: string;
-}
-export interface RequestOptions {
-    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-    endpoint: string;
-    body?: any;
-    headers?: Record<string, string>;
-    /** Override base URL for this request only */
-    host?: string;
-}
-export interface RequestResult {
-    request: {
-        url: string;
-        method: string;
-        headers: Record<string, string>;
-        body?: any;
-        authMethod: string;
-    };
-    response: {
-        statusCode: number;
-        statusText: string;
-        timing: string;
-        headers: Record<string, any>;
-        body: any;
-    };
-    validation: {
-        isError: boolean;
-        messages: string[];
-        truncated?: {
-            originalSize: number;
-            returnedSize: number;
-            truncationPoint: number;
-            sizeLimit: number;
-        };
-    };
-}
-export declare class RestApiService {
-    private config;
-    private cachedToken;
-    private httpsAgent;
-    private cachedOpenApi;
-    private openApiFetchPromise;
-    /** OpenAPI cache TTL in milliseconds (default: 5 minutes) */
-    private static readonly OPENAPI_CACHE_TTL;
-    constructor(config: RestApiConfig);
-    /**
-     * Get the current authentication method name
-     */
-    getAuthMethod(): string;
-    /**
-     * Get OAuth2 access token using client credentials flow
-     * Caches token and refreshes when expired
-     */
-    private getOAuth2Token;
-    /**
-     * Get the Authorization header value based on configured auth method
-     */
-    private getAuthHeader;
-    /**
-     * Sanitize headers for display (redact sensitive values)
-     */
-    private sanitizeHeaders;
-    /**
-     * Execute an HTTP request
-     */
-    request(options: RequestOptions): Promise<RequestResult>;
-    /**
-     * Force refresh the OAuth2 token (clears cache)
-     */
-    clearTokenCache(): void;
-    /**
-     * Get configuration summary (safe to display)
-     */
-    getConfigSummary(): {
-        baseUrl: string;
-        authMethod: string;
-        sslVerification: boolean;
-        responseSizeLimit: number;
-        customHeaderCount: number;
-        oauth2TokenUrl?: string;
-        openApiUrl?: string;
-    };
-    /**
-     * Check if OpenAPI URL is configured
-     */
-    hasOpenApiConfig(): boolean;
-    /**
-     * Fetch and parse OpenAPI spec from configured URL
-     * Results are cached for OPENAPI_CACHE_TTL
-     */
-    private fetchOpenApiSpec;
-    /**
-     * Actually fetch and parse the OpenAPI spec
-     */
-    private doFetchOpenApiSpec;
-    /**
-     * Parse OpenAPI 3.x spec into our internal format
-     */
-    private parseOpenApiSpec;
-    /**
-     * Map OpenAPI type to simplified type string
-     */
-    private mapOpenApiType;
-    /**
-     * Clear OpenAPI cache (forces re-fetch on next call)
-     */
-    clearOpenApiCache(): void;
-    /**
-     * List all available API endpoints from OpenAPI spec
-     * @param filter Optional filter to match endpoint paths (case-insensitive contains match)
-     */
-    listEndpointsAsync(filter?: string): Promise<{
-        baseUrl: string;
-        endpointCount: number;
-        endpoints: EndpointDefinition[];
-        source: string;
-    }>;
-    /**
-     * Get schema for a specific entity from OpenAPI spec
-     * @param entity Entity name (singular or plural)
-     */
-    getSchemaAsync(entity: string): Promise<EntitySchema | null>;
-}
-//# sourceMappingURL=RestApiService.d.ts.map

package/build/RestApiService.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RestApiService.d.ts","sourceRoot":"","sources":["../src/RestApiService.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,OAAO,EAAE,CAAC,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC;IACzD,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,UAAU,CAAC,EAAE;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAEhB,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,0DAA0D;IAC1D,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,6BAA6B;IAC7B,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,6BAA6B;IAC7B,MAAM,CAAC,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,8CAA8C;IAC9C,MAAM,CAAC,EAAE;QACP,gGAAgG;QAChG,QAAQ,EAAE,MAAM,CAAC;QACjB,uBAAuB;QACvB,QAAQ,EAAE,MAAM,CAAC;QACjB,2BAA2B;QAC3B,YAAY,EAAE,MAAM,CAAC;QACrB,8DAA8D;QAC9D,KAAK,EAAE,MAAM,CAAC;QACd,6DAA6D;QAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,mDAAmD;QACnD,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC3C,CAAC;IAEF,gDAAgD;IAChD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE;QACR,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,IAAI,EAAE,GAAG,CAAC;KACX,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,SAAS,CAAC,EAAE;YACV,YAAY,EAAE,MAAM,CAAC;YACrB,YAAY,EAAE,MAAM,CAAC;YACrB,eAAe,EAAE,MAAM,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAYD,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,aAAa,CAAkC;IACvD,OAAO,CAAC,mBAAmB,CAA2C;IAEtE,6DAA6D;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAiB;gBAE9C,MAAM,EAAE,aAAa;IA+BjC;;OAEG;IACH,aAAa,IAAI,MAAM;IAQvB;;;OAGG;YACW,cAAc;IAoE5B;;OAEG;YACW,aAAa;IAuB3B;;OAEG;IACH,OAAO,CAAC,eAAe;IAoDvB;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAgI9D;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB;;OAEG;IACH,gBAAgB,IAAI;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,EAAE,OAAO,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAYD;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAI3B;;;OAGG;YACW,gBAAgB;IA6B9B;;OAEG;YACW,kBAAkB;IA4ChC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAwIxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAoCtB;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAKzB;;;OAGG;IACG,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QACjD,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,kBAAkB,EAAE,CAAC;QAChC,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IA6BF;;;OAGG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;CAqBnE"}