@alwaysmeticulous/sdk-bundles-api 2.276.2 → 2.277.0

package/dist/index.d.ts

@@ -10,5 +10,5 @@ export { InProgressTestRun } from "./replay-orchestrator/bundle-to-sdk/execute-s
 export { InProgressTestRunChunk, ExecuteTestRunChunkResult, TestRunChunkExecution, } from "./replay-orchestrator/bundle-to-sdk/execute-scheduled-test-run-chunk";
 export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, IndexedReplayableEvent, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
 export { ScreenshotDiffData } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
-export { MeticulousPublicApi } from "./window-api/public-window-api";
+export { MeticulousPublicApi, MeticulousPressureObserver, MeticulousPressureObserverConstructor, MeticulousPressureRecord, MeticulousPressureSource, MeticulousPressureState, } from "./window-api/public-window-api";
 export { MeticulousPrivateApi } from "./window-api/private-window-api";

package/dist/window-api/public-window-api.d.ts

@@ -133,6 +133,25 @@ export interface MeticulousPublicReplayApi {
          * @see https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver
          */
         PerformanceObserver: typeof window.PerformanceObserver;
+        /**
+         * The native PressureObserver constructor from the Compute Pressure API,
+         * captured before any stubbing. Use this to observe CPU (and, where
+         * supported by the browser, thermal) pressure during a replay.
+         *
+         * Only defined in browsers that implement the Compute Pressure API
+         * (Chromium-based browsers at the time of writing). Undefined in other
+         * browsers; always check before use.
+         *
+         * Note: the browser does not expose a direct CPU usage percentage. The
+         * observer callback receives categorical pressure records with a `state`
+         * of `"nominal" | "fair" | "serious" | "critical"`. The pressure signal
+         * reflects system-wide pressure, affected by other apps and other tabs,
+         * so treat it as a noisy signal and aggregate over many replays.
+         *
+         * @see https://developer.mozilla.org/en-US/docs/Web/API/PressureObserver
+         * @see https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API
+         */
+        PressureObserver?: MeticulousPressureObserverConstructor;
     };
     /**
      * Information about the commit being tested.
@@ -247,3 +266,54 @@ export interface MeticulousPublicContextApi {
         success: boolean;
     };
 }
+/**
+ * Source that a {@link MeticulousPressureObserver} can observe. The set of
+ * sources a browser supports is exposed on
+ * {@link MeticulousPressureObserverConstructor.knownSources}.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API
+ */
+export type MeticulousPressureSource = "cpu" | "thermals";
+/**
+ * Categorical pressure state reported by a {@link MeticulousPressureObserver}.
+ * The browser deliberately does not expose a numeric CPU usage percentage; this
+ * coarse state is the only pressure signal available to page JavaScript.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/PressureRecord/state
+ */
+export type MeticulousPressureState = "nominal" | "fair" | "serious" | "critical";
+/**
+ * A single pressure sample delivered to a {@link MeticulousPressureObserver}
+ * callback.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/PressureRecord
+ */
+export interface MeticulousPressureRecord {
+    source: MeticulousPressureSource;
+    state: MeticulousPressureState;
+    time: DOMHighResTimeStamp;
+}
+/**
+ * Minimal shape of a PressureObserver instance. Defined locally because the
+ * Compute Pressure API is not yet present in TypeScript's `lib.dom.d.ts`.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/PressureObserver
+ */
+export interface MeticulousPressureObserver {
+    observe(source: MeticulousPressureSource, options?: {
+        sampleInterval?: number;
+    }): Promise<void>;
+    unobserve(source: MeticulousPressureSource): void;
+    disconnect(): void;
+    takeRecords(): MeticulousPressureRecord[];
+}
+/**
+ * Minimal shape of the PressureObserver constructor. Defined locally because
+ * the Compute Pressure API is not yet present in TypeScript's `lib.dom.d.ts`.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/PressureObserver/PressureObserver
+ */
+export interface MeticulousPressureObserverConstructor {
+    new (callback: (records: MeticulousPressureRecord[], observer: MeticulousPressureObserver) => void): MeticulousPressureObserver;
+    readonly knownSources: readonly MeticulousPressureSource[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.276.2",
+  "version": "2.277.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -38,5 +38,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "01bc1fa14391f4a39322c7a70e5f51b5ebb45032"
+  "gitHead": "655c31cccaab8ad5c213bdee56ae25479e589ed9"
 }