screenright-client 0.9.13 → 0.9.14

package/dist/index.d.ts

@@ -10,6 +10,7 @@ type CaptureOptions = {
     paddingPixel?: number | undefined;
     annotationDirection?: AnnotationDirection | undefined;
     annotationTextColor?: AnnotationTextColor | undefined;
+    description?: string | undefined;
 };
 /**
  * Get screen capture.

package/dist/index.js

@@ -72,13 +72,14 @@ export const capture = (page, key, title, parentKey, options = {}) => __awaiter(
         errorOccurred('Capture argument[key] cannot contain slashes.');
         return;
     }
-    let { waitMilliseconds, clickLocatorSelector, annotationText, paddingPixel, annotationDirection, annotationTextColor } = options;
+    let { waitMilliseconds, clickLocatorSelector, annotationText, paddingPixel, annotationDirection, annotationTextColor, description } = options;
     waitMilliseconds = waitMilliseconds || 0;
     clickLocatorSelector = clickLocatorSelector || undefined;
     annotationText = annotationText || "";
     paddingPixel = paddingPixel || 4;
     annotationDirection = annotationDirection || "bottom";
     annotationTextColor = annotationTextColor || "red";
+    description = description || "";
     if (waitMilliseconds) {
         const nWaitMilliseconds = Number(waitMilliseconds);
         if (0 < waitMilliseconds) {
@@ -112,6 +113,7 @@ export const capture = (page, key, title, parentKey, options = {}) => __awaiter(
         title,
         url: page.url(),
         children: [],
+        description: "",
     };
     if (parentKey) {
         const searchParent = (attributes) => {
@@ -140,6 +142,7 @@ export const capture = (page, key, title, parentKey, options = {}) => __awaiter(
             paddingPixel,
             direction: annotationDirection,
             textColor: annotationTextColor,
+            description,
         };
         result.annotations[key] = annotation;
         yield locator.click();

package/package.json

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

package/src/index.ts

@@ -10,6 +10,7 @@ type ScreenshotItemAttribute = {
   title: string
   url: string
   children: ScreenshotItemAttribute[]
+  description: string
 }
 
 type Result = {
@@ -96,6 +97,7 @@ type CaptureOptions = {
   paddingPixel?: number | undefined
   annotationDirection?: AnnotationDirection | undefined
   annotationTextColor?: AnnotationTextColor | undefined
+  description?: string | undefined
 }
 
 /**
@@ -128,7 +130,8 @@ export const capture = async (
     annotationText,
     paddingPixel,
     annotationDirection,
-    annotationTextColor
+    annotationTextColor,
+    description
   } = options
 
   waitMilliseconds = waitMilliseconds || 0
@@ -137,6 +140,7 @@ export const capture = async (
   paddingPixel = paddingPixel || 4
   annotationDirection = annotationDirection || "bottom"
   annotationTextColor = annotationTextColor || "red"
+  description = description || ""
 
   if (waitMilliseconds) {
     const nWaitMilliseconds = Number(waitMilliseconds)
@@ -175,6 +179,7 @@ export const capture = async (
     title,
     url: page.url(),
     children: [],
+    description: "",
   }
 
   if (parentKey) {
@@ -206,6 +211,7 @@ export const capture = async (
       paddingPixel,
       direction: annotationDirection,
       textColor: annotationTextColor,
+      description,
     }
 
     result.annotations[key] = annotation