screenright-client 0.9.7 → 0.9.9

package/dist/index.d.ts

@@ -7,5 +7,8 @@ export declare const finalize: () => Promise<void>;
  * @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) => Promise<void>;
+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 || '';
@@ -61,8 +62,9 @@ export const finalize = () => __awaiter(void 0, void 0, void 0, function* () {
  * @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) => __awaiter(void 0, void 0, void 0, function* () {
+export const capture = (page, key, title, parentKey, options = { waitMilliseconds: 0 }) => __awaiter(void 0, void 0, void 0, function* () {
     if (deploymentId === null) {
         return;
     }
@@ -70,6 +72,13 @@ export const capture = (page, key, title, parentKey) => __awaiter(void 0, void 0
         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.7",
+  "version": "0.9.9",
   "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
@@ -77,12 +78,14 @@ export const finalize = async () => {
  * @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
@@ -93,6 +96,15 @@ export const capture = async (
     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' })

package/dist/index.mjs

@@ -1,69 +0,0 @@
-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());
-    });
-};
-import * as fs from 'fs';
-import fetch from 'node-fetch';
-const tmpDir = 'screenright/tmp';
-const result = { screenshotItemAttributes: [] };
-let deploymentId = null;
-export const initializeScreenwright = () => __awaiter(void 0, void 0, void 0, function* () {
-    const baseUrl = `${process.env.SCREENRIGHT_ENDPOINT}/client_api`;
-    const diagramId = process.env.SCREENRIGHT_DIAGRAM_ID;
-    const deploymentToken = process.env.SCREENRIGHT_DEVELOPMENT_TOKEN;
-    const response = yield fetch(`${baseUrl}/diagrams/${diagramId}/deployments`, {
-        method: 'POST',
-        body: JSON.stringify({ deployment_token: deploymentToken }),
-        headers: { 'Content-Type': 'application/json' }
-    });
-    const body = yield response.text();
-    const json = JSON.parse(body);
-    deploymentId = json.id;
-    process.on('exit', (exitCode) => __awaiter(void 0, void 0, void 0, function* () {
-        if (exitCode === 0) {
-            fs.writeFileSync(`${tmpDir}/result.json`, JSON.stringify({
-                screenshotItemAttributes: result.screenshotItemAttributes,
-            }));
-            yield fetch(`${baseUrl}/diagrams/${diagramId}/deployments/${deploymentId}/done_upload`, {
-                method: 'PUT',
-                body: JSON.stringify({ deployment_token: deploymentToken }),
-                headers: { 'Content-Type': 'application/json' }
-            });
-        }
-    }));
-});
-initializeScreenwright();
-export const capture = (page, key, title, parentKey) => __awaiter(void 0, void 0, void 0, function* () {
-    if (deploymentId === null) {
-        return;
-    }
-    fs.mkdirSync(tmpDir, { recursive: true });
-    const path = `${tmpDir}/${key}.png`;
-    yield page.screenshot({ path, fullPage: true });
-    const attribute = {
-        key,
-        title,
-        src: path,
-        childrens: [],
-    };
-    if (parentKey) {
-        const searchParent = (attributes) => {
-            for (let i = 0; i < attributes.length; i++) {
-                if (attributes[i].key === parentKey) {
-                    attributes[i].childrens.push(attribute);
-                    break;
-                }
-                searchParent(attributes[i].childrens);
-            }
-        };
-        searchParent(result.screenshotItemAttributes);
-    }
-    else {
-        result.screenshotItemAttributes.push(attribute);
-    }
-});