@simpleapps-com/augur-api 0.2.0 → 0.2.1

package/dist/esm/core/response-capturer.js

@@ -1,130 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-/**
- * Utility class for capturing API responses to disk for schema validation improvement
- *
- * This utility helps developers capture real API responses to improve Zod schema definitions
- * by providing visibility into actual response structures that may differ from documentation.
- */
-export class ResponseCapturer {
-    /**
-     * Create a new ResponseCapturer instance
-     * @param enabled Whether response capture is enabled
-     * @param capturePath Directory path where responses should be saved
-     */
-    constructor(enabled = false, capturePath) {
-        this.enabled = enabled || process.env.CAPTURE_RESPONSES === 'true';
-        this.capturePath = capturePath || process.env.CAPTURE_PATH || './captured-responses';
-        if (this.enabled) {
-            this.ensureCaptureDirectory();
-        }
-    }
-    /**
-     * Capture an API response to disk if capture is enabled
-     * @param response Axios response object
-     * @param serviceName Name of the service making the request
-     */
-    async captureResponse(response, serviceName) {
-        if (!this.enabled) {
-            return;
-        }
-        try {
-            const capturedData = {
-                timestamp: new Date().toISOString(),
-                service: serviceName,
-                method: response.config.method?.toUpperCase() || 'UNKNOWN',
-                url: response.config.url || 'unknown',
-                status: response.status,
-                headers: this.extractHeaders(response),
-                response: response.data,
-            };
-            const filename = this.generateFilename(capturedData);
-            const filepath = path.join(this.capturePath, filename);
-            await fs.promises.writeFile(filepath, JSON.stringify(capturedData, null, 2), 'utf8');
-        }
-        catch (error) {
-            // Silently fail to avoid disrupting API calls
-            // In a production environment, you might want to log this error
-            console.warn('Failed to capture API response:', error);
-        }
-    }
-    /**
-     * Generate a safe filename for the captured response
-     * @param capturedData The captured response data
-     * @returns A filesystem-safe filename
-     */
-    generateFilename(capturedData) {
-        const timestamp = new Date(capturedData.timestamp)
-            .toISOString()
-            .replace(/:/g, '')
-            .replace(/\./g, '')
-            .replace(/T/, '_')
-            .replace(/Z/, '');
-        const endpoint = this.sanitizeEndpoint(capturedData.url);
-        const method = capturedData.method.toLowerCase();
-        return `${capturedData.service}_${endpoint}_${method}_${timestamp}.json`;
-    }
-    /**
-     * Sanitize endpoint URL to create a safe filename component
-     * @param url The API endpoint URL
-     * @returns A filesystem-safe string representing the endpoint
-     */
-    sanitizeEndpoint(url) {
-        try {
-            const urlObj = new URL(url);
-            let endpoint = urlObj.pathname;
-            // Remove leading slash and replace path separators
-            endpoint = endpoint.replace(/^\//, '').replace(/\//g, '_');
-            // Replace common characters that aren't filesystem safe
-            endpoint = endpoint.replace(/[^a-zA-Z0-9_-]/g, '_');
-            // Remove multiple underscores
-            endpoint = endpoint.replace(/_+/g, '_');
-            // Remove trailing underscores
-            endpoint = endpoint.replace(/_$/, '');
-            return endpoint || 'root';
-        }
-        catch {
-            return 'unknown_endpoint';
-        }
-    }
-    /**
-     * Extract relevant headers from the response
-     * @param response Axios response object
-     * @returns Simplified headers object
-     */
-    extractHeaders(response) {
-        const headers = {};
-        if (response.headers) {
-            // Extract commonly useful headers
-            const relevantHeaders = [
-                'content-type',
-                'content-length',
-                'cache-control',
-                'x-request-id',
-                'x-rate-limit-remaining',
-                'x-rate-limit-reset',
-            ];
-            for (const header of relevantHeaders) {
-                if (response.headers[header]) {
-                    headers[header] = String(response.headers[header]);
-                }
-            }
-        }
-        return headers;
-    }
-    /**
-     * Ensure the capture directory exists
-     */
-    ensureCaptureDirectory() {
-        try {
-            if (!fs.existsSync(this.capturePath)) {
-                fs.mkdirSync(this.capturePath, { recursive: true });
-            }
-        }
-        catch (error) {
-            console.warn('Failed to create capture directory:', error);
-            // Don't throw here as it would break the API client initialization
-        }
-    }
-}
-//# sourceMappingURL=response-capturer.js.map

package/dist/esm/core/response-capturer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"response-capturer.js","sourceRoot":"","sources":["../../../src/core/response-capturer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAe7B;;;;;GAKG;AACH,MAAM,OAAO,gBAAgB;IAI3B;;;;OAIG;IACH,YAAY,UAAmB,KAAK,EAAE,WAAoB;QACxD,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,KAAK,MAAM,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,sBAAsB,CAAC;QAErF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,QAAuB,EAAE,WAAmB;QAChE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,YAAY,GAAqB;gBACrC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,OAAO,EAAE,WAAW;gBACpB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,SAAS;gBAC1D,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,SAAS;gBACrC,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACtC,QAAQ,EAAE,QAAQ,CAAC,IAAI;aACxB,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAEvD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACvF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8CAA8C;YAC9C,gEAAgE;YAChE,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,YAA8B;QACrD,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;aAC/C,WAAW,EAAE;aACb,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;aACjB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;aAClB,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;aACjB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAEjD,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,QAAQ,IAAI,MAAM,IAAI,SAAS,OAAO,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,GAAW;QAClC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YAE/B,mDAAmD;YACnD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAE3D,wDAAwD;YACxD,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;YAEpD,8BAA8B;YAC9B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAExC,8BAA8B;YAC9B,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAEtC,OAAO,QAAQ,IAAI,MAAM,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,kBAAkB,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,QAAuB;QAC5C,MAAM,OAAO,GAA2B,EAAE,CAAC;QAE3C,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,kCAAkC;YAClC,MAAM,eAAe,GAAG;gBACtB,cAAc;gBACd,gBAAgB;gBAChB,eAAe;gBACf,cAAc;gBACd,wBAAwB;gBACxB,oBAAoB;aACrB,CAAC;YAEF,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;gBACrC,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC7B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,sBAAsB;QAC5B,IAAI,CAAC;YACH,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBACrC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;YAC3D,mEAAmE;QACrE,CAAC;IACH,CAAC;CACF"}

package/dist/types/core/response-capturer.d.ts

@@ -1,58 +0,0 @@
-import { AxiosResponse } from 'axios';
-/**
- * Metadata for captured API responses
- */
-export interface CapturedResponse {
-    timestamp: string;
-    service: string;
-    method: string;
-    url: string;
-    status: number;
-    headers: Record<string, string>;
-    response: unknown;
-}
-/**
- * Utility class for capturing API responses to disk for schema validation improvement
- *
- * This utility helps developers capture real API responses to improve Zod schema definitions
- * by providing visibility into actual response structures that may differ from documentation.
- */
-export declare class ResponseCapturer {
-    private readonly enabled;
-    private readonly capturePath;
-    /**
-     * Create a new ResponseCapturer instance
-     * @param enabled Whether response capture is enabled
-     * @param capturePath Directory path where responses should be saved
-     */
-    constructor(enabled?: boolean, capturePath?: string);
-    /**
-     * Capture an API response to disk if capture is enabled
-     * @param response Axios response object
-     * @param serviceName Name of the service making the request
-     */
-    captureResponse(response: AxiosResponse, serviceName: string): Promise<void>;
-    /**
-     * Generate a safe filename for the captured response
-     * @param capturedData The captured response data
-     * @returns A filesystem-safe filename
-     */
-    private generateFilename;
-    /**
-     * Sanitize endpoint URL to create a safe filename component
-     * @param url The API endpoint URL
-     * @returns A filesystem-safe string representing the endpoint
-     */
-    private sanitizeEndpoint;
-    /**
-     * Extract relevant headers from the response
-     * @param response Axios response object
-     * @returns Simplified headers object
-     */
-    private extractHeaders;
-    /**
-     * Ensure the capture directory exists
-     */
-    private ensureCaptureDirectory;
-}
-//# sourceMappingURL=response-capturer.d.ts.map

package/dist/types/core/response-capturer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"response-capturer.d.ts","sourceRoot":"","sources":["../../../src/core/response-capturer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAItC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IAErC;;;;OAIG;gBACS,OAAO,GAAE,OAAe,EAAE,WAAW,CAAC,EAAE,MAAM;IAS1D;;;;OAIG;IACG,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BlF;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAwBtB;;OAEG;IACH,OAAO,CAAC,sBAAsB;CAU/B"}