@alwaysmeticulous/sdk-bundles-api 2.161.0 → 2.163.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { RecordConfig, RecordSettings, RecordState } from "./record";
+export { RecordConfig, RecordSettings } from "./record";
 export { MeticulousWindowConfig, NetworkResponseSanitizer, } from "./record/record-settings";
 export * from "./record/middleware";
 export { ReplayAndStoreResultsOptions, ReplayTarget, SnapshottedAssetsReplayTarget, URLReplayTarget, OriginalRecordedURLReplayTarget, ReplayExecutionOptions, ReplayOrchestratorScreenshottingOptions, GeneratedBy, GeneratedByNotebookRun, GeneratedByTestRun, GeneratedByReplayCommand, ScreenshotComparisonOptions, ScreenshotComparisonEnabledOptions, CompareScreenshotsTo, CompareScreenshotsToSpecificReplay, CompareScreenshotsToTestRun, DoNotCompareScreenshots, OutOfDateClientError, BeforeUserEventOptions, AppUrlConfig, } from "./replay-orchestrator/sdk-to-bundle/execute-replay";
@@ -8,3 +8,5 @@ export { ExecuteTestRunResult, TestRunExecution, RunningTestRunExecution, Finish
 export { InProgressTestRun } from "./replay-orchestrator/bundle-to-sdk/execute-scheduled-test-run";
 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 { MeticulousPrivateApi } from "./window-api/private-window-api";

package/dist/record/index.d.ts

@@ -40,13 +40,6 @@ export interface RecordConfig extends DeepRequired<Omit<RecordSettings, "disable
     startTime: Date;
     windowHostname: string;
 }
-/**
- * Meticulous record state and functions
- */
-export interface RecordState {
-    /** Initialises and starts Meticulous recording */
-    initialiseRecorder?: () => void;
-}
 type DeepRequired<T> = T extends object ? {
     [P in keyof T]-?: DeepRequired<T[P]>;
 } : T;

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

@@ -0,0 +1,13 @@
+/**
+ * This API is exposed on the window under `window.__meticulous`.
+ *
+ * Please do NOT use. This is designed for internal usage only.
+ */
+export interface MeticulousPrivateApi {
+    earlyNetworkRecorder?: {
+        dispose?: () => Promise<void>;
+    };
+    /** Initialises and starts Meticulous recording */
+    initialiseRecorder?: () => void;
+    stopRecording?: () => void;
+}

package/dist/window-api/private-window-api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-window-api.js.map

package/dist/window-api/private-window-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-window-api.js","sourceRoot":"","sources":["../../src/window-api/private-window-api.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,51 @@
+/**
+ * This API is exposed on the window under `window.Meticulous`.
+ */
+export type MeticulousPublicApi = MeticulousPublicApiCommon & ({
+    isRunningAsTest: true;
+    replay: MeticulousPublicReplayApi;
+} | {
+    isRunningAsTest: false;
+    record: MeticulousPublicRecordApi;
+});
+export interface MeticulousPublicApiCommon {
+    isRunningAsTest?: boolean;
+}
+export interface MeticulousPublicReplayApi {
+    /**
+     * Call this method to pause the Meticulous replay while your code performs an asynchronous operation
+     * that Meticulous does not automatically pause for, such as communication with a Chrome extension.
+     *
+     * See https://app.meticulous.ai/docs/how-to/fix-false-positive-diffs#pausing-meticulous-replays
+     */
+    pause: () => void;
+    /**
+     * See https://app.meticulous.ai/docs/how-to/fix-false-positive-diffs#pausing-meticulous-replays
+     */
+    resume: () => void;
+    /**
+     * Call this method to retrieve custom data that was recorded during the test run.
+     */
+    retrieveCustomData(key: string): string | null;
+    /**
+     * Call this method to retrieve an array of custom data that was recorded during the test run.
+     */
+    retrieveCustomDataArray(arrayId: string): string[];
+}
+export interface MeticulousPublicRecordApi {
+    /**
+     * Call this method to record a single custom data value during the test run.
+     * Repeated calls to this method with the same key will overwrite the previous value.
+     */
+    recordCustomData(key: string, value: string): {
+        success: boolean;
+    };
+    /**
+     * Call this method to push a value to an array of custom data during the test run.
+     * If the array does not exist, it will be created.
+     * If the array already exists, the value will be appended to it.
+     */
+    pushToCustomDataArray(arrayId: string, valueToAppend: string): {
+        success: boolean;
+    };
+}

package/dist/window-api/public-window-api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=public-window-api.js.map

package/dist/window-api/public-window-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public-window-api.js","sourceRoot":"","sources":["../../src/window-api/public-window-api.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.161.0",
+  "version": "2.163.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "depcheck": "depcheck --ignore-patterns=dist"
   },
   "devDependencies": {
-    "@alwaysmeticulous/api": "^2.158.1"
+    "@alwaysmeticulous/api": "^2.163.0"
   },
   "peerDependencies": {
     "loglevel": "^1.8.0"
@@ -46,5 +46,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "64e42104344377fca631912b5447ec16a7b29d12"
+  "gitHead": "3433132494bcd861f837662603d25556521dbeac"
 }