screenright-client 0.9.6 → 0.9.8

package/dist/index.d.ts

@@ -1,4 +1,14 @@
 import { Page } from '@playwright/test';
 export declare const initializeScreenwright: () => Promise<void>;
 export declare const finalize: () => Promise<void>;
-export declare const capture: (page: Page, key: string, title: string, parentKey?: string) => Promise<void>;
+/**
+ * Get screen capture.
+ * @param {Page} page - Playwright's page object.
+ * @param {string} key - Unique key. cannot contain slashes.
+ * @param {string} title - Page title.
+ * @param {string|null} [parentKey] - Parent page key. Creates a hierarchical structure.
+ * @param {{ waitMilliseconds: number }} [options] - Wait milliseconds before capture.
+*/
+export declare const capture: (page: Page, key: string, title: string, parentKey?: string, options?: {
+    waitMilliseconds: number;
+}) => Promise<void>;

package/dist/index.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import fetch from 'node-fetch';
 import process from 'node:process';
 import FormData from 'form-data';
+import { setTimeout } from 'timers/promises';
 const result = { screenshotItemAttributes: [] };
 let deploymentId = null;
 const deploymentToken = process.env.SCREENRIGHT_DEPLOYMENT_TOKEN || '';
@@ -55,10 +56,29 @@ export const finalize = () => __awaiter(void 0, void 0, void 0, function* () {
     });
     deploymentId = null;
 });
-export const capture = (page, key, title, parentKey) => __awaiter(void 0, void 0, void 0, function* () {
+/**
+ * Get screen capture.
+ * @param {Page} page - Playwright's page object.
+ * @param {string} key - Unique key. cannot contain slashes.
+ * @param {string} title - Page title.
+ * @param {string|null} [parentKey] - Parent page key. Creates a hierarchical structure.
+ * @param {{ waitMilliseconds: number }} [options] - Wait milliseconds before capture.
+*/
+export const capture = (page, key, title, parentKey, options = { waitMilliseconds: 0 }) => __awaiter(void 0, void 0, void 0, function* () {
     if (deploymentId === null) {
         return;
     }
+    if (0 <= key.indexOf('/')) {
+        errorOccurred('Capture argument[key] cannot contain slashes.');
+        return;
+    }
+    const { waitMilliseconds } = options;
+    if (waitMilliseconds) {
+        const nWaitMilliseconds = Number(waitMilliseconds);
+        if (0 < waitMilliseconds) {
+            yield setTimeout(waitMilliseconds);
+        }
+    }
     const fileName = `${key}.jpg`;
     try {
         const buffer = yield page.screenshot({ fullPage: true, type: 'jpeg' });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screenright-client",
-  "version": "0.9.6",
+  "version": "0.9.8",
   "description": "screenright's nodejs client library",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -3,6 +3,7 @@ import { Page } from '@playwright/test'
 import fetch from 'node-fetch'
 import process from 'node:process'
 import FormData from 'form-data'
+import { setTimeout } from 'timers/promises'
 
 type ScreenshotItemAttribute = {
   key: string
@@ -71,16 +72,39 @@ export const finalize = async () => {
   deploymentId = null
 }
 
+/**
+ * Get screen capture.
+ * @param {Page} page - Playwright's page object.
+ * @param {string} key - Unique key. cannot contain slashes.
+ * @param {string} title - Page title.
+ * @param {string|null} [parentKey] - Parent page key. Creates a hierarchical structure.
+ * @param {{ waitMilliseconds: number }} [options] - Wait milliseconds before capture.
+*/
 export const capture = async (
   page: Page,
   key: string,
   title: string,
-  parentKey?: string
+  parentKey?: string,
+  options: { waitMilliseconds: number } = { waitMilliseconds: 0 },
 ) => {
   if (deploymentId === null) {
     return
   }
 
+  if (0 <= key.indexOf('/')) {
+    errorOccurred('Capture argument[key] cannot contain slashes.')
+    return
+  }
+
+  const { waitMilliseconds } = options
+
+  if (waitMilliseconds) {
+    const nWaitMilliseconds = Number(waitMilliseconds)
+    if (0 < waitMilliseconds) {
+      await setTimeout(waitMilliseconds)
+    }
+  }
+
   const fileName = `${key}.jpg`
   try {
     const buffer = await page.screenshot({ fullPage: true, type: 'jpeg' })