@memlab/e2e 1.0.0

package/dist/lib/operations/Operations.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export { default as CachePageContent } from './CachePageContent';
+export { default as ClickOperation } from './ClickOperation';
+export { default as CompoundOperation } from './CompoundOperation';
+export { default as EnterOperation } from './EnterOperation';
+export { default as EscOperation } from './EscOperation';
+export { default as BackOperation } from './BackOperation';
+export { default as BackspaceOperation } from './BackspaceOperation';
+export { default as HoverOperation } from './HoverOperation';
+export { default as RunJSCode } from './RunJSCode';
+export { default as ScrollOperation } from './ScrollOperation';
+export { default as TypeOperation } from './TypeOperation';
+export { default as UploadOperation } from './UploadOperation';
+export { default as WaitForElementOperation } from './WaitForElementOperation';
+export { default as WaitOperation } from './WaitOperation';
+export { default as WithCachedPageContent } from './WithCachedPageContent';
+//# sourceMappingURL=Operations.d.ts.map

package/dist/lib/operations/Operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operations.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/Operations.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAC,OAAO,IAAI,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,OAAO,IAAI,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,aAAa,CAAC;AACjD,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAC,OAAO,IAAI,uBAAuB,EAAC,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAC,OAAO,IAAI,qBAAqB,EAAC,MAAM,yBAAyB,CAAC"}

package/dist/lib/operations/Operations.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WithCachedPageContent = exports.WaitOperation = exports.WaitForElementOperation = exports.UploadOperation = exports.TypeOperation = exports.ScrollOperation = exports.RunJSCode = exports.HoverOperation = exports.BackspaceOperation = exports.BackOperation = exports.EscOperation = exports.EnterOperation = exports.CompoundOperation = exports.ClickOperation = exports.CachePageContent = void 0;
+var CachePageContent_1 = require("./CachePageContent");
+Object.defineProperty(exports, "CachePageContent", { enumerable: true, get: function () { return __importDefault(CachePageContent_1).default; } });
+var ClickOperation_1 = require("./ClickOperation");
+Object.defineProperty(exports, "ClickOperation", { enumerable: true, get: function () { return __importDefault(ClickOperation_1).default; } });
+var CompoundOperation_1 = require("./CompoundOperation");
+Object.defineProperty(exports, "CompoundOperation", { enumerable: true, get: function () { return __importDefault(CompoundOperation_1).default; } });
+var EnterOperation_1 = require("./EnterOperation");
+Object.defineProperty(exports, "EnterOperation", { enumerable: true, get: function () { return __importDefault(EnterOperation_1).default; } });
+var EscOperation_1 = require("./EscOperation");
+Object.defineProperty(exports, "EscOperation", { enumerable: true, get: function () { return __importDefault(EscOperation_1).default; } });
+var BackOperation_1 = require("./BackOperation");
+Object.defineProperty(exports, "BackOperation", { enumerable: true, get: function () { return __importDefault(BackOperation_1).default; } });
+var BackspaceOperation_1 = require("./BackspaceOperation");
+Object.defineProperty(exports, "BackspaceOperation", { enumerable: true, get: function () { return __importDefault(BackspaceOperation_1).default; } });
+var HoverOperation_1 = require("./HoverOperation");
+Object.defineProperty(exports, "HoverOperation", { enumerable: true, get: function () { return __importDefault(HoverOperation_1).default; } });
+var RunJSCode_1 = require("./RunJSCode");
+Object.defineProperty(exports, "RunJSCode", { enumerable: true, get: function () { return __importDefault(RunJSCode_1).default; } });
+var ScrollOperation_1 = require("./ScrollOperation");
+Object.defineProperty(exports, "ScrollOperation", { enumerable: true, get: function () { return __importDefault(ScrollOperation_1).default; } });
+var TypeOperation_1 = require("./TypeOperation");
+Object.defineProperty(exports, "TypeOperation", { enumerable: true, get: function () { return __importDefault(TypeOperation_1).default; } });
+var UploadOperation_1 = require("./UploadOperation");
+Object.defineProperty(exports, "UploadOperation", { enumerable: true, get: function () { return __importDefault(UploadOperation_1).default; } });
+var WaitForElementOperation_1 = require("./WaitForElementOperation");
+Object.defineProperty(exports, "WaitForElementOperation", { enumerable: true, get: function () { return __importDefault(WaitForElementOperation_1).default; } });
+var WaitOperation_1 = require("./WaitOperation");
+Object.defineProperty(exports, "WaitOperation", { enumerable: true, get: function () { return __importDefault(WaitOperation_1).default; } });
+var WithCachedPageContent_1 = require("./WithCachedPageContent");
+Object.defineProperty(exports, "WithCachedPageContent", { enumerable: true, get: function () { return __importDefault(WithCachedPageContent_1).default; } });

package/dist/lib/operations/RevertOperation.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import BaseOperation from './BaseOperation';
+import type { Page } from 'puppeteer';
+import type { OperationArgs } from '@memlab/core';
+export default class RevertOperation extends BaseOperation {
+    kind: string;
+    constructor();
+    act(page: Page, opArgs?: OperationArgs): Promise<void>;
+}
+//# sourceMappingURL=RevertOperation.d.ts.map

package/dist/lib/operations/RevertOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RevertOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/RevertOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAEpC,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAIhD,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,aAAa;IACxD,IAAI,EAAE,MAAM,CAAC;;IAOP,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBjE"}

package/dist/lib/operations/RevertOperation.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseOperation_1 = __importDefault(require("./BaseOperation"));
+const EscOperation_1 = __importDefault(require("./EscOperation"));
+const BackOperation_1 = __importDefault(require("./BackOperation"));
+const InteractionUtils_1 = __importDefault(require("./InteractionUtils"));
+class RevertOperation extends BaseOperation_1.default {
+    constructor() {
+        super();
+        this.kind = 'revert';
+    }
+    act(page, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let historyLen = opArgs.pageHistoryLength;
+            if (Array.isArray(historyLen) && historyLen.length > 1) {
+                historyLen = historyLen;
+                const len = historyLen.length;
+                const count = historyLen[len - 1];
+                const prevCount = historyLen[len - 2];
+                let navCountFromPreviousOp = (count | 0) - (prevCount | 0);
+                if (navCountFromPreviousOp > 0) {
+                    while (navCountFromPreviousOp > 0) {
+                        yield new BackOperation_1.default().act(page);
+                        yield InteractionUtils_1.default.waitFor(2000);
+                        --navCountFromPreviousOp;
+                    }
+                    return;
+                }
+            }
+            yield new EscOperation_1.default().act(page);
+        });
+    }
+}
+exports.default = RevertOperation;

package/dist/lib/operations/RunJSCode.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import { Page } from 'puppeteer';
+import type { AnyFunction, AnyOptions, AnyValue } from '@memlab/core';
+import BaseOperation from './BaseOperation';
+declare class RunJSCode extends BaseOperation {
+    kind: string;
+    private callback;
+    private repeat;
+    private args;
+    constructor(callback: AnyFunction, opt?: AnyOptions & {
+        repeat?: number;
+        args?: AnyValue[];
+    });
+    act(page: Page): Promise<void>;
+}
+export default RunJSCode;
+//# sourceMappingURL=RunJSCode.d.ts.map

package/dist/lib/operations/RunJSCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunJSCode.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/RunJSCode.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,OAAO,KAAK,EAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AACpE,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAI5C,cAAM,SAAU,SAAQ,aAAa;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,IAAI,CAAa;gBAGvB,QAAQ,EAAE,WAAW,EACrB,GAAG,GAAE,UAAU,GAAG;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAA;KAAM;IASvD,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAWrC;AAED,eAAe,SAAS,CAAC"}

package/dist/lib/operations/RunJSCode.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const BaseOperation_1 = __importDefault(require("./BaseOperation"));
+const InteractionUtils_1 = __importDefault(require("./InteractionUtils"));
+// Run a JS callback in web console
+class RunJSCode extends BaseOperation_1.default {
+    constructor(callback, opt = {}) {
+        super();
+        this.kind = 'run-js-code';
+        this.callback = callback;
+        this.repeat = opt.repeat != null && opt.repeat > 0 ? opt.repeat : 1;
+        this.args = opt.args || [];
+    }
+    act(page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let n = this.repeat;
+                while (n-- > 0) {
+                    yield page.evaluate(this.callback, ...this.args);
+                    yield InteractionUtils_1.default.waitFor(1000);
+                }
+            }
+            catch (e) {
+                core_1.info.warning(core_1.utils.getError(e).message);
+            }
+        });
+    }
+}
+exports.default = RunJSCode;

package/dist/lib/operations/ScrollOperation.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import { Page } from 'puppeteer';
+import type { OperationArgs } from '@memlab/core';
+import BaseOperation from './BaseOperation';
+declare type ScrollOptions = {
+    scrollUp?: boolean;
+    scrollBack?: boolean;
+};
+declare class ScrollOperation extends BaseOperation {
+    kind: string;
+    strideLength: number;
+    repeat: number;
+    scrollDirection: number;
+    scrollBack: boolean;
+    constructor(strideLength: number, repeat?: number, opt?: ScrollOptions);
+    act(page: Page, opArgs?: OperationArgs): Promise<void>;
+}
+export default ScrollOperation;
+//# sourceMappingURL=ScrollOperation.d.ts.map

package/dist/lib/operations/ScrollOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScrollOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/ScrollOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAEhD,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,aAAK,aAAa,GAAG;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,cAAM,eAAgB,SAAQ,aAAa;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;gBACR,YAAY,EAAE,MAAM,EAAE,MAAM,SAAI,EAAE,GAAG,GAAE,aAAkB;IAY/D,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBjE;AA4BD,eAAe,eAAe,CAAC"}

package/dist/lib/operations/ScrollOperation.js

@@ -0,0 +1,85 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const BaseOperation_1 = __importDefault(require("./BaseOperation"));
+const InteractionUtils_1 = __importDefault(require("./InteractionUtils"));
+class ScrollOperation extends BaseOperation_1.default {
+    constructor(strideLength, repeat = 1, opt = {}) {
+        super();
+        this.kind = 'scroll';
+        this.strideLength = strideLength;
+        this.repeat = repeat;
+        // by default scroll down (1 means down, -1 means up)
+        this.scrollDirection = opt.scrollUp ? -1 : 1;
+        // by default scrollback to the beginning
+        this.scrollBack =
+            typeof opt.scrollBack === 'boolean' ? opt.scrollBack : true;
+    }
+    act(page, opArgs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (core_1.config.disableScroll || !core_1.config.runningMode.shouldScroll()) {
+                return;
+            }
+            let repeat = this.repeat;
+            let i = 0;
+            let totalScrollDistance = 0;
+            const direction = this.scrollDirection > 0 ? 'down' : 'up';
+            core_1.info.lowLevel(`scrolling ${direction} ${repeat} times...`);
+            const strideLength = this.scrollDirection * this.strideLength;
+            while (repeat-- > 0) {
+                totalScrollDistance += strideLength;
+                yield scroll(page, strideLength, ++i, opArgs);
+            }
+            if (this.scrollBack && totalScrollDistance > 0) {
+                // scroll back to the top
+                yield scroll(page, -1 * totalScrollDistance, -1, opArgs);
+            }
+            return;
+        });
+    }
+}
+function scroll(page, dist, idx = 0, opArgs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        core_1.info.beginSection('scroll');
+        yield InteractionUtils_1.default.waitUntilLoaded(page, opArgs);
+        if (idx > 1) {
+            core_1.info.overwrite(`(${idx}x) scrolling ${dist}px...`);
+        }
+        else {
+            core_1.info.overwrite(`scrolling ${dist}px...`);
+        }
+        yield page.evaluate(dist => {
+            try {
+                window.scrollBy({ top: dist });
+            }
+            catch (_e) {
+                // to nothing
+            }
+        }, dist);
+        yield InteractionUtils_1.default.waitUntilLoaded(page, opArgs);
+        yield InteractionUtils_1.default.waitFor(core_1.config.waitAfterScrolling);
+        core_1.info.endSection('scroll');
+    });
+}
+exports.default = ScrollOperation;

package/dist/lib/operations/TargetExtraOperation.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import BaseOperation from './BaseOperation';
+import CompoundOperation from './CompoundOperation';
+declare class TargetExtraOperation extends CompoundOperation {
+    kind: string;
+    operations: BaseOperation[];
+    constructor(operations?: never[]);
+}
+export default TargetExtraOperation;
+//# sourceMappingURL=TargetExtraOperation.d.ts.map

package/dist/lib/operations/TargetExtraOperation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TargetExtraOperation.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/TargetExtraOperation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAGpD,cAAM,oBAAqB,SAAQ,iBAAiB;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,aAAa,EAAE,CAAC;gBAChB,UAAU,UAAK;CAW5B;AAED,eAAe,oBAAoB,CAAC"}

package/dist/lib/operations/TargetExtraOperation.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const CompoundOperation_1 = __importDefault(require("./CompoundOperation"));
+const ScrollOperation_1 = __importDefault(require("./ScrollOperation"));
+class TargetExtraOperation extends CompoundOperation_1.default {
+    constructor(operations = []) {
+        super(operations);
+        this.kind = 'target-extra';
+        if (core_1.config.runningMode.shouldRunExtraTargetOperations()) {
+            // scroll the window by certain amount of pixels
+            this.operations.push(new ScrollOperation_1.default(core_1.config.windowHeight, core_1.config.scrollRepeat));
+        }
+    }
+}
+exports.default = TargetExtraOperation;

package/dist/lib/operations/TestPlanner.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { AnyOptions, Cookies, IE2EScenarioSynthesizer, IE2EScenarioVisitPlan, Nullable } from '@memlab/core';
+import type { MemLabConfig } from '@memlab/core';
+declare type TestPlanOptions = {
+    config?: MemLabConfig;
+};
+export declare class TestPlanner {
+    private synthesizers;
+    private visitPlan;
+    private cookies;
+    private scenario;
+    private origin;
+    private synthesizer;
+    private config;
+    constructor(options?: TestPlanOptions);
+    private initSynthesizers;
+    getVisitPlan(): IE2EScenarioVisitPlan;
+    getCookies(): Cookies;
+    getOrigin(): Nullable<string>;
+    getSynthesizer(options?: AnyOptions): IE2EScenarioSynthesizer;
+    preloadSynthesizer(): IE2EScenarioSynthesizer;
+    private init;
+    private prepareSynthesizer;
+    private generateVisitPlan;
+    loadCookies(visitPlan: IE2EScenarioVisitPlan, synthesizer: IE2EScenarioSynthesizer): Cookies;
+    private populateDomainInCookies;
+    private setSnapshotMode;
+    private assignSnapshotIds;
+    getAppNames(): string[];
+    getTargetNames(appName: string, options?: AnyOptions): string[];
+    getAllTargets(options?: AnyOptions): {
+        app: string;
+        interaction: string;
+    }[];
+}
+declare const _default: TestPlanner;
+export default _default;
+//# sourceMappingURL=TestPlanner.d.ts.map

package/dist/lib/operations/TestPlanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestPlanner.d.ts","sourceRoot":"","sources":["../../../src/lib/operations/TestPlanner.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,uBAAuB,EACvB,qBAAqB,EAIrB,QAAQ,EACT,MAAM,cAAc,CAAC;AAKtB,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAS/C,aAAK,eAAe,GAAG;IACrB,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF,qBAAa,WAAW;IACtB,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,SAAS,CAAwB;IACzC,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,MAAM,CAAe;gBAEjB,OAAO,GAAE,eAAoB;IAMzC,OAAO,CAAC,gBAAgB;IAYxB,YAAY,IAAI,qBAAqB;IAKrC,UAAU,IAAI,OAAO;IAMrB,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC;IAK7B,cAAc,CAAC,OAAO,GAAE,UAAe,GAAG,uBAAuB;IAOjE,kBAAkB,IAAI,uBAAuB;IAS7C,OAAO,CAAC,IAAI;IASZ,OAAO,CAAC,kBAAkB;IA8B1B,OAAO,CAAC,iBAAiB;IAczB,WAAW,CACT,SAAS,EAAE,qBAAqB,EAChC,WAAW,EAAE,uBAAuB,GACnC,OAAO;IA0BV,OAAO,CAAC,uBAAuB;IAgB/B,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,iBAAiB;IAQzB,WAAW,IAAI,MAAM,EAAE;IASvB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe,GAAG,MAAM,EAAE;IAWnE,aAAa,CACX,OAAO,GAAE,UAAe,GACvB;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAC,EAAE;CAYxC;;AAED,wBAAiC"}

package/dist/lib/operations/TestPlanner.js

@@ -0,0 +1,182 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestPlanner = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const core_1 = require("@memlab/core");
+const TestRunnerLoader_1 = __importDefault(require("../../TestRunnerLoader"));
+const E2EUtils_1 = __importDefault(require("../E2EUtils"));
+class TestPlanner {
+    constructor(options = {}) {
+        var _a;
+        this.config = (_a = options.config) !== null && _a !== void 0 ? _a : core_1.config;
+        this.synthesizers = new Map();
+        this.scenario = null;
+    }
+    initSynthesizers() {
+        if (this.synthesizers.size > 0) {
+            return;
+        }
+        this.synthesizers = new Map();
+        const runners = TestRunnerLoader_1.default.load();
+        runners.forEach((Constructor) => {
+            const synthesizer = new Constructor(this.config);
+            this.synthesizers.set(synthesizer.getAppName(), synthesizer);
+        });
+    }
+    getVisitPlan() {
+        this.init();
+        return this.visitPlan;
+    }
+    getCookies() {
+        this.init();
+        return this.cookies;
+    }
+    // get origin defined in config
+    getOrigin() {
+        this.init();
+        return this.origin;
+    }
+    getSynthesizer(options = {}) {
+        this.init(options);
+        return this.synthesizer;
+    }
+    // preload synthesizer before other meta data is ready
+    // this is mainly used for getting synthesizer settings
+    preloadSynthesizer() {
+        const targetApp = this.config.targetApp;
+        this.initSynthesizers();
+        if (!this.synthesizers.has(targetApp)) {
+            core_1.utils.haltOrThrow(`unknown app: ${targetApp}`);
+        }
+        return this.synthesizers.get(targetApp);
+    }
+    init(options = {}) {
+        this.initSynthesizers();
+        const { visitPlan, cookies, synthesizer } = this.generateVisitPlan(options);
+        this.visitPlan = visitPlan;
+        this.cookies = cookies;
+        this.origin = synthesizer.getOrigin();
+        this.synthesizer = synthesizer;
+    }
+    prepareSynthesizer() {
+        if (this.config.scenario) {
+            this.scenario = this.config.scenario;
+        }
+        else {
+            // otherwise no action since no scenario definition provided
+            // config.targetTab and config.targetApp should be set
+        }
+        if (this.scenario) {
+            this.config.targetTab = core_1.utils.getScenarioName(this.scenario);
+            this.config.targetApp = E2EUtils_1.default.getScenarioAppName(this.scenario);
+        }
+        if (!this.synthesizers.has(this.config.targetApp)) {
+            core_1.utils.haltOrThrow(`unknown app: ${this.config.targetApp}`);
+        }
+        const synthesizer = this.synthesizers.get(this.config.targetApp);
+        // if running from a scenario file, register this
+        // new scenario in the synthesizer
+        if (this.scenario) {
+            synthesizer.injectPlan(this.config.targetTab, this.scenario);
+        }
+        return synthesizer;
+    }
+    generateVisitPlan(options = {}) {
+        const synthesizer = this.prepareSynthesizer();
+        const visitPlan = synthesizer.synthesisForTarget(this.config.targetTab);
+        this.assignSnapshotIds(visitPlan);
+        this.setSnapshotMode(visitPlan);
+        const cookies = options.needCookies === false
+            ? []
+            : this.loadCookies(visitPlan, synthesizer);
+        return { visitPlan, cookies, synthesizer };
+    }
+    loadCookies(visitPlan, synthesizer) {
+        var _a;
+        if (this.scenario && this.scenario.cookies) {
+            return this.scenario.cookies();
+        }
+        let cookieFile = synthesizer.getCookieFile(visitPlan);
+        // if no cookie file is specified
+        if (cookieFile == null && this.config.externalCookiesFile == null) {
+            return [];
+        }
+        cookieFile =
+            (_a = this.config.externalCookiesFile) !== null && _a !== void 0 ? _a : path_1.default.join(this.config.persistentDataDir, cookieFile);
+        if (!fs_1.default.existsSync(cookieFile)) {
+            core_1.utils.haltOrThrow(`cookie file doesn't exist: ${cookieFile}`);
+        }
+        const cookies = JSON.parse(fs_1.default.readFileSync(cookieFile, 'UTF-8'));
+        return this.populateDomainInCookies(cookies, synthesizer.getDomain(), synthesizer.getDomainPrefixes());
+    }
+    populateDomainInCookies(cookies, domain, domainPrefixes) {
+        const cookiesTemplate = cookies;
+        const ret = [];
+        const prefixes = new Set(['', ...domainPrefixes]);
+        for (const prefix of prefixes) {
+            for (const cookie of cookiesTemplate) {
+                ret.push(Object.assign(Object.assign({}, cookie), { domain: `${prefix}${domain}` }));
+            }
+        }
+        return ret;
+    }
+    setSnapshotMode(visitPlan) {
+        if (!this.config.isFullRun) {
+            return;
+        }
+        const tabsOrder = visitPlan.tabsOrder;
+        for (const tab of tabsOrder) {
+            tab.snapshot = true;
+        }
+    }
+    assignSnapshotIds(visitPlan) {
+        const tabsOrder = visitPlan.tabsOrder;
+        let snapshotId = 1;
+        for (const tab of tabsOrder) {
+            tab.idx = snapshotId++;
+        }
+    }
+    getAppNames() {
+        this.initSynthesizers();
+        const names = [];
+        for (const synthesizer of this.synthesizers.values()) {
+            names.push(synthesizer.getAppName());
+        }
+        return names;
+    }
+    getTargetNames(appName, options = {}) {
+        this.initSynthesizers();
+        if (!this.synthesizers.has(appName)) {
+            core_1.utils.haltOrThrow(`unknown app: ${appName}`);
+        }
+        const synthesizer = this.synthesizers.get(appName);
+        return synthesizer.getAvailableTargetNames(options);
+    }
+    getAllTargets(options = {}) {
+        this.initSynthesizers();
+        const ret = [];
+        const apps = this.getAppNames();
+        for (const app of apps) {
+            const interactions = this.getTargetNames(app, options);
+            for (const interaction of interactions) {
+                ret.push({ app, interaction });
+            }
+        }
+        return ret;
+    }
+}
+exports.TestPlanner = TestPlanner;
+exports.default = new TestPlanner();