storybook-addon-playwright 4.19.2 → 4.20.0

package/.vscode/tasks.json

@@ -18,7 +18,7 @@
       "type": "shell",
       "command": "npm run start:storybook",
       "presentation": {
-        "reveal": "silent",
+        "reveal": "always",
         "revealProblems": "onProblem",
         "close": true
       },

package/dist/api/server/data/action-schema.json

@@ -24,6 +24,45 @@
         ],
         "description": "This method fetches an element with `selector`, waits for actionability checks, focuses the element, clear it and triggers an input event. If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error."
     },
+    "clearInputAndType": {
+        "kind": "function",
+        "type": "Promise",
+        "parameters": {
+            "selector": {
+                "type": "string"
+            },
+            "text": {
+                "type": "string"
+            },
+            "options": {
+                "type": "object",
+                "properties": {
+                    "delay": {
+                        "type": "number",
+                        "description": "Time to wait between key presses in milliseconds. Defaults to 0."
+                    },
+                    "noWaitAfter": {
+                        "type": "boolean",
+                        "description": "Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`."
+                    },
+                    "strict": {
+                        "type": "boolean",
+                        "description": "When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception."
+                    },
+                    "timeout": {
+                        "type": "number",
+                        "description": "Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the [browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout) or [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods."
+                    }
+                },
+                "additionalProperties": false
+            }
+        },
+        "required": [
+            "selector",
+            "text"
+        ],
+        "description": "This method fetches an element with `selector`, waits for actionability checks, focuses the element, clear it and type text and triggers an input event. If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error."
+    },
     "dragDropSelector": {
         "kind": "function",
         "type": "Promise",

package/dist/api/server/scripts/generate-action-schema.js

@@ -23,6 +23,7 @@ const selectedPageKeys = [
     'takeScreenshotOptions',
     'setSelectorSize',
     'clearInput',
+    'clearInputAndType',
     'mouseDownOnSelector',
     'mouseMoveToSelector',
     'selectorMouseWheel',

package/dist/api/server/scripts/generate-action-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-action-schema.js","sourceRoot":"","sources":["../../../../src/api/server/scripts/generate-action-schema.ts"],"names":[],"mappings":";;;AAEA,uDAAmD;AAKnD,MAAM,gBAAgB,GAAqB;IACzC,OAAO;IACP,UAAU;IACV,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,iBAAiB;IACjB,gBAAgB;IAChB,kBAAkB;IAClB,uBAAuB;IACvB,gBAAgB;IAChB,mBAAmB;IACnB,uBAAuB;IACvB,iBAAiB;IACjB,YAAY;IACZ,qBAAqB;IACrB,qBAAqB;IACrB,oBAAoB;IACpB,UAAU;IACV,WAAW;IACX,YAAY;IACZ,aAAa;IACb,UAAU;IACV,aAAa;IACb,aAAa;CACd,CAAC;AAEF,MAAM,iBAAiB,GAAgB;IACrC,OAAO;IACP,UAAU;IACV,MAAM;IACN,MAAM;IACN,IAAI;CACL,CAAC;AAEF,MAAM,iBAAiB,GAAsB,CAAC,KAAK,CAAC,CAAC;AAErD,MAAM,YAAY,GAAG;IACnB,GAAG,gBAAgB;IACnB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC7C,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,GAAG,CAAC,CAAC;CACxC,CAAC;AAEP,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,IAAA,gCAAc,EAAC;QAC5B,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,gBAAgB;KACvB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}
+{"version":3,"file":"generate-action-schema.js","sourceRoot":"","sources":["../../../../src/api/server/scripts/generate-action-schema.ts"],"names":[],"mappings":";;;AAEA,uDAAmD;AAKnD,MAAM,gBAAgB,GAAqB;IACzC,OAAO;IACP,UAAU;IACV,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,gBAAgB;IAChB,iBAAiB;IACjB,gBAAgB;IAChB,kBAAkB;IAClB,uBAAuB;IACvB,gBAAgB;IAChB,mBAAmB;IACnB,uBAAuB;IACvB,iBAAiB;IACjB,YAAY;IACZ,mBAAmB;IACnB,qBAAqB;IACrB,qBAAqB;IACrB,oBAAoB;IACpB,UAAU;IACV,WAAW;IACX,YAAY;IACZ,aAAa;IACb,UAAU;IACV,aAAa;IACb,aAAa;CACd,CAAC;AAEF,MAAM,iBAAiB,GAAgB;IACrC,OAAO;IACP,UAAU;IACV,MAAM;IACN,MAAM;IACN,IAAI;CACL,CAAC;AAEF,MAAM,iBAAiB,GAAsB,CAAC,KAAK,CAAC,CAAC;AAErD,MAAM,YAAY,GAAG;IACnB,GAAG,gBAAgB;IACnB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC7C,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,GAAG,CAAC,CAAC;CACxC,CAAC;AAEP,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,IAAA,gCAAc,EAAC;QAC5B,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,gBAAgB;KACvB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAPW,QAAA,oBAAoB,wBAO/B"}

package/dist/page-extra/clear-input-and-type.d.ts

@@ -0,0 +1,3 @@
+import { Page } from 'playwright';
+import { ClearInputAndTypeOptions } from './typings';
+export declare function clearInputAndType(this: Page, selector: string, text: string, options?: ClearInputAndTypeOptions): Promise<void>;

package/dist/page-extra/clear-input-and-type.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearInputAndType = void 0;
+const tslib_1 = require("tslib");
+const clear_input_1 = require("./clear-input");
+function clearInputAndType(selector, text, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield clear_input_1.clearInput.call(this, selector);
+        yield this.type(selector, text, options);
+    });
+}
+exports.clearInputAndType = clearInputAndType;
+//# sourceMappingURL=clear-input-and-type.js.map

package/dist/page-extra/clear-input-and-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clear-input-and-type.js","sourceRoot":"","sources":["../../src/page-extra/clear-input-and-type.ts"],"names":[],"mappings":";;;;AAEA,+CAA2C;AAE3C,SAAsB,iBAAiB,CAErC,QAAgB,EAChB,IAAY,EACZ,OAAkC;;QAElC,MAAM,wBAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEtC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;CAAA;AATD,8CASC"}

package/dist/page-extra/clear-input.js

@@ -2,15 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clearInput = void 0;
 const tslib_1 = require("tslib");
-function clearInput(selector, options) {
+function clearInput(selector, options = {}) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { blur, timeout } = options;
         yield this.fill(selector, '');
-        if (!options)
-            return;
-        if (options.blur) {
+        if (blur) {
             yield this.$eval(selector, (e) => e.blur());
         }
-        if (options.timeout) {
+        if (timeout) {
             yield this.waitForTimeout(options.timeout);
         }
     });

package/dist/page-extra/clear-input.js.map

@@ -1 +1 @@
-{"version":3,"file":"clear-input.js","sourceRoot":"","sources":["../../src/page-extra/clear-input.ts"],"names":[],"mappings":";;;;AAGA,SAAsB,UAAU,CAE9B,QAAgB,EAChB,OAA2B;;QAE3B,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;SAC7C;QACD,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC5C;IACH,CAAC;CAAA;AAbD,gCAaC"}
+{"version":3,"file":"clear-input.js","sourceRoot":"","sources":["../../src/page-extra/clear-input.ts"],"names":[],"mappings":";;;;AAGA,SAAsB,UAAU,CAE9B,QAAgB,EAChB,UAA6B,EAAE;;QAE/B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAElC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAE9B,IAAI,IAAI,EAAE;YACR,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;SAC7C;QAED,IAAI,OAAO,EAAE;YACX,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC5C;IACH,CAAC;CAAA;AAhBD,gCAgBC"}

package/dist/page-extra/extend-page.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.extendPage = void 0;
 const _1 = require(".");
 const touch_from_to_1 = require("./touch-from-to");
+const clear_input_and_type_1 = require("./clear-input-and-type");
 function extendPage(page) {
     const thisPage = page;
     thisPage.dragDropSelector = _1.dragDropSelector;
@@ -11,6 +12,7 @@ function extendPage(page) {
     thisPage.mouseMoveToSelector = _1.mouseMoveToSelector;
     thisPage.setSelectorSize = _1.setSelectorSize;
     thisPage.clearInput = _1.clearInput;
+    thisPage.clearInputAndType = clear_input_and_type_1.clearInputAndType;
     thisPage.selectorMouseWheel = _1.selectorMouseWheel;
     thisPage.touchCancel = _1.touchCancel;
     thisPage.touchMove = _1.touchMove;

package/dist/page-extra/extend-page.js.map

@@ -1 +1 @@
-{"version":3,"file":"extend-page.js","sourceRoot":"","sources":["../../src/page-extra/extend-page.ts"],"names":[],"mappings":";;;AAGA,wBAaW;AACX,mDAA8C;AAE9C,SAAgB,UAAU,CAAiB,IAAO;IAChD,MAAM,QAAQ,GAAG,IAAmC,CAAC;IAErD,QAAQ,CAAC,gBAAgB,GAAG,mBAAgB,CAAC;IAC7C,QAAQ,CAAC,cAAc,GAAG,iBAAc,CAAC;IACzC,QAAQ,CAAC,mBAAmB,GAAG,sBAAmB,CAAC;IACnD,QAAQ,CAAC,mBAAmB,GAAG,sBAAmB,CAAC;IACnD,QAAQ,CAAC,eAAe,GAAG,kBAAe,CAAC;IAC3C,QAAQ,CAAC,UAAU,GAAG,aAAU,CAAC;IACjC,QAAQ,CAAC,kBAAkB,GAAG,qBAAkB,CAAC;IACjD,QAAQ,CAAC,WAAW,GAAG,cAAW,CAAC;IACnC,QAAQ,CAAC,SAAS,GAAG,YAAS,CAAC;IAC/B,QAAQ,CAAC,QAAQ,GAAG,WAAQ,CAAC;IAC7B,QAAQ,CAAC,UAAU,GAAG,aAAU,CAAC;IACjC,QAAQ,CAAC,WAAW,GAAG,2BAAW,CAAC;IACnC,QAAQ,CAAC,WAAW,GAAG,cAAW,CAAC;IAEnC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAlBD,gCAkBC"}
+{"version":3,"file":"extend-page.js","sourceRoot":"","sources":["../../src/page-extra/extend-page.ts"],"names":[],"mappings":";;;AAGA,wBAaW;AACX,mDAA8C;AAC9C,iEAA2D;AAE3D,SAAgB,UAAU,CAAiB,IAAO;IAChD,MAAM,QAAQ,GAAG,IAAmC,CAAC;IAErD,QAAQ,CAAC,gBAAgB,GAAG,mBAAgB,CAAC;IAC7C,QAAQ,CAAC,cAAc,GAAG,iBAAc,CAAC;IACzC,QAAQ,CAAC,mBAAmB,GAAG,sBAAmB,CAAC;IACnD,QAAQ,CAAC,mBAAmB,GAAG,sBAAmB,CAAC;IACnD,QAAQ,CAAC,eAAe,GAAG,kBAAe,CAAC;IAC3C,QAAQ,CAAC,UAAU,GAAG,aAAU,CAAC;IACjC,QAAQ,CAAC,iBAAiB,GAAG,wCAAiB,CAAC;IAC/C,QAAQ,CAAC,kBAAkB,GAAG,qBAAkB,CAAC;IACjD,QAAQ,CAAC,WAAW,GAAG,cAAW,CAAC;IACnC,QAAQ,CAAC,SAAS,GAAG,YAAS,CAAC;IAC/B,QAAQ,CAAC,QAAQ,GAAG,WAAQ,CAAC;IAC7B,QAAQ,CAAC,UAAU,GAAG,aAAU,CAAC;IACjC,QAAQ,CAAC,WAAW,GAAG,2BAAW,CAAC;IACnC,QAAQ,CAAC,WAAW,GAAG,cAAW,CAAC;IAEnC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAnBD,gCAmBC"}

package/dist/page-extra/typings/extra.d.ts

@@ -27,6 +27,30 @@ export interface PageExtraTouchOptions {
 export interface ClearInputOptions extends PageExtraTimeOut {
     blur?: boolean;
 }
+export interface ClearInputAndTypeOptions {
+    /**
+     * Time to wait between key presses in milliseconds. Defaults to 0.
+     */
+    delay?: number;
+    /**
+     * Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can
+     * opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to
+     * inaccessible pages. Defaults to `false`.
+     */
+    noWaitAfter?: boolean;
+    /**
+     * When true, the call requires selector to resolve to a single element. If given selector resolves to more then one
+     * element, the call throws an exception.
+     */
+    strict?: boolean;
+    /**
+     * Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by
+     * using the
+     * [browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)
+     * or [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods.
+     */
+    timeout?: number;
+}
 export interface SelectorMouseWheelOptions {
     deltaMode?: number;
     deltaX?: number;
@@ -66,6 +90,11 @@ export interface PlaywrightPageWithExtra {
      * If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error.
      */
     clearInput: (selector: string, options?: ClearInputOptions) => Promise<void>;
+    /**
+     * This method fetches an element with `selector`, waits for actionability checks, focuses the element, clear it and type text and triggers an input event.
+     * If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error.
+     */
+    clearInputAndType: (selector: string, text: string, options?: ClearInputAndTypeOptions) => Promise<void>;
     /**
      * This method fetches an element with `selector`, and move it to the position given by user.
      * If there's no element matching `selector`, the method waits until a matching element appears in the DOM.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storybook-addon-playwright",
-  "version": "4.19.2",
+  "version": "4.20.0",
   "description": "An addon to visually test the stories in the multiple browsers within storybook environment",
   "author": "m.doaie <mdoaie@yahoo.co.uk>",
   "engines": {