@sisense/sdk-ui 2.9.0 → 2.10.0

package/dist/packages/sdk-ui/src/utils/__development-utils__/input-output-collector.d.ts

@@ -1,125 +0,0 @@
-/**
- * Input/Output Collection Decorator for Runtime Test Data Generation
- *
- * This module provides a decorator that collects unique input/output snapshots
- * of function calls during runtime. This is useful for generating unit test data
- * from actual application usage.
- *
- * Usage:
- * 1. Wrap your function with the decorator:
- *    ```ts
- *    // With configuration:
- *    const myFunction = withInputOutputCollection({ maxSnapshots: 100 })(originalFunction);
- *
- *    // With custom function name:
- *    const myFunction = withInputOutputCollection({
- *      maxSnapshots: 100,
- *      functionName: 'myCustomName'
- *    })(originalFunction);
- *
-
- *    ```
- *
- * 2. Run your application and exercise the function with various inputs
- *
- * 3. In the browser console (development only), call:
- *    - `printCollectedInfo()` - to view all collected data
- *    - `getCollectedData()` - to get data programmatically
- *    - `exportCollectedDataAsJson()` - to export as JSON string with function serialization
- *    - `parseCollectedDataFromJson(jsonString)` - to parse exported JSON and get function placeholders
- *    - `clearCollectedData()` - to clear collected data
- *    - `cleanup()` - to completely clean up the collector
- *
- * Features:
- * - Intelligent deduplication prevents collecting identical input/output pairs
- * - Robust deep equality checking handles functions, dates, and complex objects
- * - Statistics tracking shows total calls vs unique snapshots
- * - Configurable maximum number of snapshots
- * - Deep cloning of inputs and outputs to avoid reference issues
- * - Proper function serialization for unit test generation
- * - Browser console integration for easy access (development only)
- * - Automatic cleanup when no collected data remains
- */
-interface CollectedData {
-    id: string;
-    timestamp: number;
-    args: any[];
-    result: any;
-}
-interface CollectionStore {
-    functionName: string;
-    data: CollectedData[];
-    totalCalls: number;
-    duplicateSkips: number;
-}
-/**
- * Decorator that collects unique input/output snapshots for a function during runtime.
- * Useful for generating unit test data from actual application usage.
- *
- * Uses currying pattern: withInputOutputCollection(config)(functionToDecorate)
- *
- * @param options - Configuration options for the collector
- * @returns Function that takes the function to decorate and returns the decorated function
- */
-export declare function withInputOutputCollection<TFunction extends (...args: any[]) => any>(options?: {
-    /** Maximum number of unique snapshots to collect (default: 100) */
-    maxSnapshots?: number;
-    /** Custom equality function for comparing arguments (default: deep equality) */
-    equalityFn?: (a: any[], b: any[]) => boolean;
-    /** Optional custom function name (defaults to function.name) */
-    functionName?: string;
-}): (originalFunction: TFunction) => TFunction;
-/**
- * Prints all collected input/output data to the console.
- * This function is attached to the window object for easy access in the browser.
- */
-export declare function printCollectedInfo(): void;
-/**
- * Returns all collected data as a serializable object.
- * Useful for exporting test data programmatically.
- */
-export declare function getCollectedData(): Record<string, CollectionStore>;
-/**
- * Clears all collected data.
- * Useful for resetting the collection state.
- * Removes window utilities if no data remains.
- */
-export declare function clearCollectedData(functionName?: string): void;
-/**
- * Completely cleans up the input/output collector.
- * Clears all data and removes window utilities.
- * Useful for cleanup in test environments or when the collector is no longer needed.
- */
-export declare function cleanup(): void;
-/**
- * Exports collected data as JSON string with proper function serialization.
- * Functions are represented as `[[Function - {functionName}]]` strings for easy replacement in unit tests.
- *
- * Example output:
- * ```json
- * {
- *   "buildHighchartsOptions": {
- *     "functionName": "buildHighchartsOptions",
- *     "data": [{
- *       "args": [{ "onBeforeRender": "[[Function - customRenderer]]" }],
- *       "result": { "chart": { "type": "line" } }
- *     }]
- *   }
- * }
- * ```
- *
- * Useful for saving test data to files.
- */
-export declare function exportCollectedDataAsJson(): string;
-/**
- * Parses JSON data exported by exportCollectedDataAsJson and provides a function map for mocking.
- * This is a utility function for unit tests to easily replace function placeholders with mocks.
- *
- * @param jsonData - The JSON string exported by exportCollectedDataAsJson
- * @returns Object containing parsed data and a list of function placeholders found
- */
-export declare function parseCollectedDataFromJson(jsonData: string): {
-    data: Record<string, CollectionStore>;
-    functionPlaceholders: string[];
-};
-export {};