doc-detective-common 3.1.2-dev.2 → 3.1.2-dev.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.1.2-dev.2",
+  "version": "3.1.2-dev.3",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -20,18 +20,18 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
-    "chai": "^5.2.0",
+    "chai": "^5.2.1",
     "mocha": "^11.7.1",
     "sinon": "^21.0.0"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^14.0.3",
+    "@apidevtools/json-schema-ref-parser": "^14.1.1",
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.10.0",
+    "axios": "^1.11.0",
     "uuid": "^11.1.0",
-    "yaml": "^2.8.0"
+    "yaml": "^2.8.1"
   }
 }

package/src/schemas/build/config_v3.schema.json

@@ -378,10 +378,12 @@
           "find",
           "goTo",
           "httpRequest",
+          "loadCookie",
           "loadVariables",
           "record",
           "runCode",
           "runShell",
+          "saveCookie",
           "screenshot",
           "stopRecord",
           "type",

package/src/schemas/build/loadCookie_v3.schema.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "loadCookie",
+  "description": "Load a specific cookie from a file or environment variable into the browser.",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "type": "string",
+        "title": "Cookie name or file path",
+        "description": "Name of the specific cookie to load from default location, or file path to cookie file.",
+        "pattern": "^[A-Za-z0-9_./\\-]+$",
+        "transform": [
+          "trim"
+        ]
+      },
+      "object": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name"
+        ],
+        "anyOf": [
+          {
+            "required": [
+              "path"
+            ],
+            "not": {
+              "required": [
+                "variable"
+              ]
+            }
+          },
+          {
+            "required": [
+              "variable"
+            ],
+            "not": {
+              "anyOf": [
+                {
+                  "required": [
+                    "path"
+                  ]
+                },
+                {
+                  "required": [
+                    "directory"
+                  ]
+                }
+              ]
+            }
+          }
+        ],
+        "properties": {
+          "$schema": {
+            "description": "Optional self-describing schema URI for linters",
+            "type": "string",
+            "format": "uri-reference"
+          },
+          "name": {
+            "type": "string",
+            "title": "Cookie name",
+            "description": "Name of the specific cookie to load.",
+            "pattern": "^[A-Za-z0-9_.-]+$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "variable": {
+            "type": "string",
+            "title": "Environment variable name",
+            "description": "Environment variable name containing the cookie as JSON string.",
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "path": {
+            "type": "string",
+            "title": "Cookie file path",
+            "description": "File path to cookie file, relative to directory. Supports Netscape cookie format.",
+            "pattern": "^(?:[A-Za-z0-9_.-]+\\.(?:txt|cookies)|\\$[A-Za-z_][A-Za-z0-9_]*)$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "directory": {
+            "type": "string",
+            "title": "Directory path",
+            "description": "Directory containing the cookie file.",
+            "transform": [
+              "trim"
+            ]
+          },
+          "domain": {
+            "type": "string",
+            "title": "Cookie domain",
+            "description": "Specific domain to filter the cookie by when loading from multi-cookie file (optional).",
+            "transform": [
+              "trim"
+            ]
+          }
+        },
+        "title": "Load cookie (detailed)"
+      }
+    }
+  },
+  "examples": [
+    "session_token",
+    "./test-data/auth-session.txt",
+    {
+      "name": "auth_cookie",
+      "variable": "AUTH_COOKIE"
+    },
+    {
+      "name": "session_token",
+      "path": "session-token.txt",
+      "directory": "./test-data"
+    },
+    {
+      "name": "user_session",
+      "path": "saved-cookies.txt",
+      "domain": "app.example.com"
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/loadCookie_v3.schema.json"
+}

package/src/schemas/build/saveCookie_v3.schema.json

@@ -0,0 +1,149 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "saveCookie",
+  "description": "Save a specific browser cookie to a file or environment variable for later reuse.",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "type": "string",
+        "title": "Cookie name",
+        "description": "Name of the specific cookie to save. Will be saved to a default file path or environment variable.",
+        "pattern": "^[A-Za-z0-9_./\\-]+$",
+        "transform": [
+          "trim"
+        ]
+      },
+      "object": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "$schema": {
+            "description": "Optional self-describing schema URI for linters",
+            "type": "string",
+            "format": "uri-reference"
+          },
+          "name": {
+            "type": "string",
+            "title": "Cookie name",
+            "description": "Name of the specific cookie to save.",
+            "pattern": "^[A-Za-z0-9_.-]+$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "variable": {
+            "type": "string",
+            "title": "Environment variable name",
+            "description": "Environment variable name to store the cookie as JSON string.",
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "path": {
+            "type": "string",
+            "title": "Cookie file path",
+            "description": "File path to save the cookie, relative to directory. Uses Netscape cookie format.",
+            "pattern": "^(?:[A-Za-z0-9_.-]+\\.(?:txt|cookies)|\\$[A-Za-z_][A-Za-z0-9_]*)$",
+            "transform": [
+              "trim"
+            ]
+          },
+          "directory": {
+            "type": "string",
+            "title": "Directory path",
+            "description": "Directory to save the cookie file. If not specified, uses output directory.",
+            "transform": [
+              "trim"
+            ]
+          },
+          "overwrite": {
+            "type": "boolean",
+            "title": "Overwrite existing file",
+            "description": "Whether to overwrite existing cookie file.",
+            "default": false
+          },
+          "domain": {
+            "type": "string",
+            "title": "Cookie domain",
+            "description": "Specific domain to filter the cookie by (optional).",
+            "transform": [
+              "trim"
+            ]
+          }
+        },
+        "required": [
+          "name"
+        ],
+        "anyOf": [
+          {
+            "required": [
+              "path"
+            ],
+            "not": {
+              "required": [
+                "variable"
+              ]
+            }
+          },
+          {
+            "required": [
+              "variable"
+            ],
+            "not": {
+              "anyOf": [
+                {
+                  "required": [
+                    "path"
+                  ]
+                },
+                {
+                  "required": [
+                    "directory"
+                  ]
+                },
+                {
+                  "required": [
+                    "overwrite"
+                  ]
+                }
+              ]
+            }
+          }
+        ],
+        "title": "Save cookie (detailed)"
+      }
+    }
+  },
+  "examples": [
+    "session_token",
+    {
+      "name": "auth_cookie",
+      "path": "auth-cookie.txt"
+    },
+    {
+      "name": "session_token",
+      "variable": "SESSION_TOKEN"
+    },
+    {
+      "name": "user_session",
+      "path": "user-session.txt",
+      "directory": "./test-data",
+      "overwrite": true
+    },
+    {
+      "name": "login_token",
+      "path": "login-token.txt",
+      "domain": "app.example.com"
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/saveCookie_v3.schema.json"
+}

package/src/schemas/build/step_v3.schema.json

@@ -258,6 +258,25 @@
         }
       ]
     },
+    {
+      "allOf": [
+        {
+          "$ref": "#/components/schemas/common"
+        },
+        {
+          "type": "object",
+          "required": [
+            "saveCookie"
+          ],
+          "properties": {
+            "saveCookie": {
+              "$ref": "/home/runner/work/common/common/src/schemas/build/saveCookie_v3.schema.json#"
+            }
+          },
+          "title": "saveCookie"
+        }
+      ]
+    },
     {
       "allOf": [
         {
@@ -315,6 +334,25 @@
         }
       ]
     },
+    {
+      "allOf": [
+        {
+          "$ref": "#/components/schemas/common"
+        },
+        {
+          "title": "loadCookie",
+          "type": "object",
+          "required": [
+            "loadCookie"
+          ],
+          "properties": {
+            "loadCookie": {
+              "$ref": "/home/runner/work/common/common/src/schemas/build/loadCookie_v3.schema.json#"
+            }
+          }
+        }
+      ]
+    },
     {
       "allOf": [
         {
@@ -461,6 +499,27 @@
     {
       "loadVariables": "variables.env"
     },
+    {
+      "saveCookie": "session_token"
+    },
+    {
+      "saveCookie": {
+        "name": "auth_cookie",
+        "path": "auth-session.txt",
+        "directory": "./test-data",
+        "overwrite": true
+      }
+    },
+    {
+      "loadCookie": "session_token"
+    },
+    {
+      "loadCookie": {
+        "name": "auth_cookie",
+        "path": "auth-session.txt",
+        "directory": "./test-data"
+      }
+    },
     {
       "find": {
         "$ref": "/home/runner/work/common/common/src/schemas/build/find_v3.schema.json#/examples/0"

package/src/schemas/dereferenceSchemas.js

@@ -32,6 +32,7 @@ async function dereferenceSchemas() {
     "context_v3.schema.json",
     "find_v3.schema.json",
     "goTo_v3.schema.json",
+    "loadCookie_v3.schema.json",
     "loadVariables_v3.schema.json",
     "httpRequest_v3.schema.json",
     "openApi_v3.schema.json",
@@ -40,6 +41,7 @@ async function dereferenceSchemas() {
     "report_v3.schema.json",
     "runCode_v3.schema.json",
     "runShell_v3.schema.json",
+    "saveCookie_v3.schema.json",
     "screenshot_v3.schema.json",
     "spec_v3.schema.json",
     "step_v3.schema.json",