@web/test-runner-commands - npm Package Compare versions

Comparing version 0.4.1 to 0.4.2

browser/commands.d.ts

 import { Media } from '../dist/index';
 import { Viewport } from '../dist/index';
+import { SendKeysPayload } from '../dist/index';
 
@@ -28,2 +29,38 @@ /**
 
-export { Media, Viewport };
+/**
+ * Sends a string of keys for the browser to press (all at once, as with single keys
+ * or shortcuts; e.g. `{press: 'Tab'}` or `{press: 'Shift+a'}` or
+ * `{press: 'Option+ArrowUp}`) or type (in sequence, e.g. `{type: 'Your name'}`) natively.
+ *
+ * For specific documentation of the strings to leverage here, see the Playwright documentation,
+ * here:
+ *
+ * - `press`: https://playwright.dev/docs/api/class-keyboard#keyboardpresskey-options
+ * - `type`: https://playwright.dev/docs/api/class-keyboard#keyboardtypetext-options
+ *
+ * Or, the Puppeter documentation, here:
+ *
+ * - `press`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardpresskey-options
+ * - `type`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardtypetext-options
+ *
+ * @param payload An object including a `press` or `type` property an the associated string
+ *     for the browser runner to apply via that input method.
+ *
+ * * @example
+ * ```ts
+ *    await sendKeys({
+ *        press: 'Tab',
+ *    });
+ * ```
+ *
+ * * @example
+ * ```ts
+ *    await sendKeys({
+ *        type: 'Your address',
+ *    });
+ * ```
+ *
+ **/
+export function sendKeys(payload: SendKeysPayload): Promise<void>;
+
+export { Media, Viewport, SendKeysPayload };

CHANGELOG.md

 # @web/test-runner-commands
 
+## 0.4.2
+
+### Patch Changes
+
+- ce90c7c3: Add the `sendKeys` command
+
+  Sends a string of keys for the browser to press (all at once, as with single keys
+  or shortcuts; e.g. `{press: 'Tab'}` or `{press: 'Shift+a'}` or
+  `{press: 'Option+ArrowUp}`) or type (in sequence, e.g. `{type: 'Your name'}`) natively.
+
+  For specific documentation of the strings to leverage here, see the Playwright documentation,
+  here:
+
+  - `press`: https://playwright.dev/docs/api/class-keyboard#keyboardpresskey-options
+  - `type`: https://playwright.dev/docs/api/class-keyboard#keyboardtypetext-options
+
+  Or, the Puppeter documentation, here:
+
+  - `press`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardpresskey-options
+  - `type`: https://pptr.dev/#?product=Puppeteer&show=api-keyboardtypetext-options
+
+  @param payload An object including a `press` or `type` property an the associated string
+  for the browser runner to apply via that input method.
+
+  @example
+
+  ```ts
+  await sendKeys({
+    press: 'Tab',
+  });
+  ```
+
+  @example
+
+  ```ts
+  await sendKeys({
+    type: 'Your address',
+  });
+  ```
+
+- Updated dependencies [ce90c7c3]
+  - @web/test-runner-core@0.10.14
+
 ## 0.4.1
@@ -4,0 +47,0 @@

dist/index.d.ts

 export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
 export { setUserAgentPlugin } from './setUserAgentPlugin';
+export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
+exports.sendKeysPlugin = exports.setUserAgentPlugin = exports.emulateMediaPlugin = exports.setViewportPlugin = void 0;
 var setViewportPlugin_1 = require("./setViewportPlugin");
@@ -10,2 +10,4 @@ Object.defineProperty(exports, "setViewportPlugin", { enumerable: true, get: function () { return setViewportPlugin_1.setViewportPlugin; } });
 Object.defineProperty(exports, "setUserAgentPlugin", { enumerable: true, get: function () { return setUserAgentPlugin_1.setUserAgentPlugin; } });
+var sendKeysPlugin_1 = require("./sendKeysPlugin");
+Object.defineProperty(exports, "sendKeysPlugin", { enumerable: true, get: function () { return sendKeysPlugin_1.sendKeysPlugin; } });
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@web/test-runner-commands",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "publishConfig": {
@@ -48,3 +48,3 @@ "access": "public"
   "dependencies": {
-    "@web/test-runner-core": "^0.10.8"
+    "@web/test-runner-core": "^0.10.14"
   },
@@ -51,0 +51,0 @@ "devDependencies": {

src/index.ts

 export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
 export { setUserAgentPlugin } from './setUserAgentPlugin';
+export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';

No alert changes

Improved metrics

Total package byte prevSize

36491

increased by41.91%

Number of package files

34

increased by17.24%

Lines of code

529

increased by47.77%

Dependency changes

• Updated@web/test-runner-core@^0.10.14