@discomedia/utils 1.0.10 → 1.0.11

package/dist/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.10",
+  "version": "1.0.11",
   "author": "Disco Media",
   "description": "Utility functions used in Disco Media apps",
   "always-build-npm": true,

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ import * as misc from './misc-utils';
 import * as polygon from './polygon';
 import * as llm from './llm-openai';
 import * as llmImages from './llm-images';
+import { PerformanceTimer } from './performance-timer';
 import * as ta from './technical-analysis';
 export * from './types';
 export { AlpacaTradingAPI } from './alpaca-trading-api';
@@ -121,6 +122,7 @@ export declare const disco: {
         logIfDebug: (message: string, data?: unknown, type?: "info" | "warn" | "error" | "debug" | "trace") => void;
         fetchWithRetry: typeof misc.fetchWithRetry;
         validatePolygonApiKey: typeof misc.validatePolygonApiKey;
+        Timer: typeof PerformanceTimer;
     };
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,cAAc,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAG1C,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAK3C,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;kBA6BX,CAAC;;;kBAkCkQ,CAAC;;;kBAA4zC,CAAC;;;kBAAkwC,CAAC;;;kBAAisD,CAAC;gBAAkB,CAAC;iBAAmB,CAAC;iBAAmB,CAAC;gBAAkB,CAAC;;;;;;;;;;;;;;;;;;kBA/CjlJ,CAAC;;;kBA+C2xS,CAAC;oBAAsB,CAAC;sBAAyB,CAAC;;;kBAAhxP,CAAC;;;kBAA6jc,CAAC;qBAAuB,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;iBAA4B,CAAC;iBAA2B,CAAC;gBAAkB,CAAC;;;;;eAAjgX,CAAC;;;iBAAiE,CAAC;;kBAAmC,CAAC;;;;;kBAA65Q,CAAC;oBAAsB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADn5Z,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,cAAc,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAK3C,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;kBA4Bd,CAAF;;;kBAoCmL,CAAC;;;kBAA4zC,CAAC;;;kBAAkwC,CAAC;;;kBAAisD,CAAC;gBAAkB,CAAC;iBAAmB,CAAC;iBAAmB,CAAC;gBAAkB,CAAC;;;;;;;;;;;;;;;;;;kBAjDl/I,CAAC;;;kBAiD4rS,CAAC;oBAAsB,CAAC;sBAAyB,CAAC;;;kBAAhxP,CAAC;;;kBAA6jc,CAAC;qBAAuB,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;iBAA4B,CAAC;iBAA2B,CAAC;gBAAkB,CAAC;;;;;eAAjgX,CAAC;;;iBAAiE,CAAC;;kBAAmC,CAAC;;;;;kBAA65Q,CAAC;oBAAsB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAD9zZ,CAAC"}

package/dist/types/performance-timer.d.ts

@@ -0,0 +1,73 @@
+/**
+ * A class to measure performance of code execution.
+ *
+ * This utility records elapsed time during execution and provides a detailed
+ * breakdown of elapsed time between checkpoints.
+ *
+ * Usage example:
+ *   const timer = new PerformanceTimer();
+ *   timer.checkpoint('Start Processing');
+ *   // ... code for processing
+ *   timer.checkpoint('After Task 1');
+ *   // ... additional processing code
+ *   timer.stop();
+ *   console.log(timer.generateReport());
+ *
+ * Methods:
+ *   - checkpoint(label: string): Record a timestamped checkpoint.
+ *   - stop(): Stop the timer and compute the total elapsed time.
+ *   - generateReport(): Return a performance report with total time and phases.
+ *   - formatPerformanceReport(): Return a formatted string of the performance report.
+ *   - getElapsedSeconds(): Get the current elapsed time in seconds.
+ */
+export declare class PerformanceTimer {
+    private startTime;
+    private checkpoints;
+    private totalTime;
+    constructor();
+    /**
+     * Gets the current elapsed time in seconds.
+     *
+     * @returns The elapsed time in seconds with 3 decimal places of precision.
+     */
+    getElapsedSeconds(): number;
+    /**
+     * Records a checkpoint with the given label.
+     *
+     * @param label - A descriptive label for the checkpoint.
+     */
+    checkpoint(label: string): void;
+    /**
+     * Stops the timer and sets the total elapsed time.
+     */
+    stop(): void;
+    /**
+     * Generates a performance report containing the total elapsed time and
+     * breakdown of phases between checkpoints.
+     *
+     * @returns A performance report object.
+     * @throws Error if the timer is not stopped before generating the report.
+     */
+    analyseReportData(): PerformanceReport;
+    /**
+     * Returns a formatted string of the performance report.
+     *
+     * @returns A string detailing the total execution time and phase breakdown.
+     */
+    generateReport(): string;
+}
+/**
+ * Interface representing a single phase of performance measurement.
+ */
+export interface PerformancePhase {
+    label: string;
+    duration: number;
+}
+/**
+ * Interface representing the full performance report.
+ */
+export interface PerformanceReport {
+    totalTime: number;
+    phases: PerformancePhase[];
+}
+//# sourceMappingURL=performance-timer.d.ts.map

package/dist/types/performance-timer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance-timer.d.ts","sourceRoot":"","sources":["../../src/performance-timer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,SAAS,CAAgB;;IAQjC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM;IAK3B;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;;OAMG;IACH,iBAAiB,IAAI,iBAAiB;IAuCtC;;;;OAIG;IACI,cAAc,IAAI,MAAM;CA4BhC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B"}

package/dist/types-frontend/index.d.ts

@@ -5,6 +5,7 @@ import * as misc from './misc-utils';
 import * as polygon from './polygon';
 import * as llm from './llm-openai';
 import * as llmImages from './llm-images';
+import { PerformanceTimer } from './performance-timer';
 import * as ta from './technical-analysis';
 export * from './types';
 export { AlpacaTradingAPI } from './alpaca-trading-api';
@@ -121,6 +122,7 @@ export declare const disco: {
         logIfDebug: (message: string, data?: unknown, type?: "info" | "warn" | "error" | "debug" | "trace") => void;
         fetchWithRetry: typeof misc.fetchWithRetry;
         validatePolygonApiKey: typeof misc.validatePolygonApiKey;
+        Timer: typeof PerformanceTimer;
     };
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/types-frontend/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,cAAc,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAG1C,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAK3C,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;kBA6BX,CAAC;;;kBAkCkQ,CAAC;;;kBAA4zC,CAAC;;;kBAAkwC,CAAC;;;kBAAisD,CAAC;gBAAkB,CAAC;iBAAmB,CAAC;iBAAmB,CAAC;gBAAkB,CAAC;;;;;;;;;;;;;;;;;;kBA/CjlJ,CAAC;;;kBA+C2xS,CAAC;oBAAsB,CAAC;sBAAyB,CAAC;;;kBAAhxP,CAAC;;;kBAA6jc,CAAC;qBAAuB,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;iBAA4B,CAAC;iBAA2B,CAAC;gBAAkB,CAAC;;;;;eAAjgX,CAAC;;;iBAAiE,CAAC;;kBAAmC,CAAC;;;;;kBAA65Q,CAAC;oBAAsB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADn5Z,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,cAAc,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAK3C,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;kBA4Bd,CAAF;;;kBAoCmL,CAAC;;;kBAA4zC,CAAC;;;kBAAkwC,CAAC;;;kBAAisD,CAAC;gBAAkB,CAAC;iBAAmB,CAAC;iBAAmB,CAAC;gBAAkB,CAAC;;;;;;;;;;;;;;;;;;kBAjDl/I,CAAC;;;kBAiD4rS,CAAC;oBAAsB,CAAC;sBAAyB,CAAC;;;kBAAhxP,CAAC;;;kBAA6jc,CAAC;qBAAuB,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;uBAAkC,CAAC;wBAAmC,CAAC;iBAA4B,CAAC;iBAA2B,CAAC;gBAAkB,CAAC;;;;;eAAjgX,CAAC;;;iBAAiE,CAAC;;kBAAmC,CAAC;;;;;kBAA65Q,CAAC;oBAAsB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAD9zZ,CAAC"}

package/dist/types-frontend/performance-timer.d.ts

@@ -0,0 +1,73 @@
+/**
+ * A class to measure performance of code execution.
+ *
+ * This utility records elapsed time during execution and provides a detailed
+ * breakdown of elapsed time between checkpoints.
+ *
+ * Usage example:
+ *   const timer = new PerformanceTimer();
+ *   timer.checkpoint('Start Processing');
+ *   // ... code for processing
+ *   timer.checkpoint('After Task 1');
+ *   // ... additional processing code
+ *   timer.stop();
+ *   console.log(timer.generateReport());
+ *
+ * Methods:
+ *   - checkpoint(label: string): Record a timestamped checkpoint.
+ *   - stop(): Stop the timer and compute the total elapsed time.
+ *   - generateReport(): Return a performance report with total time and phases.
+ *   - formatPerformanceReport(): Return a formatted string of the performance report.
+ *   - getElapsedSeconds(): Get the current elapsed time in seconds.
+ */
+export declare class PerformanceTimer {
+    private startTime;
+    private checkpoints;
+    private totalTime;
+    constructor();
+    /**
+     * Gets the current elapsed time in seconds.
+     *
+     * @returns The elapsed time in seconds with 3 decimal places of precision.
+     */
+    getElapsedSeconds(): number;
+    /**
+     * Records a checkpoint with the given label.
+     *
+     * @param label - A descriptive label for the checkpoint.
+     */
+    checkpoint(label: string): void;
+    /**
+     * Stops the timer and sets the total elapsed time.
+     */
+    stop(): void;
+    /**
+     * Generates a performance report containing the total elapsed time and
+     * breakdown of phases between checkpoints.
+     *
+     * @returns A performance report object.
+     * @throws Error if the timer is not stopped before generating the report.
+     */
+    analyseReportData(): PerformanceReport;
+    /**
+     * Returns a formatted string of the performance report.
+     *
+     * @returns A string detailing the total execution time and phase breakdown.
+     */
+    generateReport(): string;
+}
+/**
+ * Interface representing a single phase of performance measurement.
+ */
+export interface PerformancePhase {
+    label: string;
+    duration: number;
+}
+/**
+ * Interface representing the full performance report.
+ */
+export interface PerformanceReport {
+    totalTime: number;
+    phases: PerformancePhase[];
+}
+//# sourceMappingURL=performance-timer.d.ts.map

package/dist/types-frontend/performance-timer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance-timer.d.ts","sourceRoot":"","sources":["../../src/performance-timer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAsB;IACzC,OAAO,CAAC,SAAS,CAAgB;;IAQjC;;;;OAIG;IACH,iBAAiB,IAAI,MAAM;IAK3B;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/B;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;;OAMG;IACH,iBAAiB,IAAI,iBAAiB;IAuCtC;;;;OAIG;IACI,cAAc,IAAI,MAAM;CA4BhC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B"}

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.10",
+  "version": "1.0.11",
   "author": "Disco Media",
   "description": "Utility functions used in Disco Media apps",
   "always-build-npm": true,