doc-detective-common 3.3.0 → 3.4.0-dita.0

package/dist/schemas/config_v3.schema.json

@@ -121,6 +121,11 @@
       "type": "boolean",
       "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
     },
+    "processDitaMaps": {
+      "description": "If `true`, processes DITA maps and includes generated files as inputs.",
+      "type": "boolean",
+      "default": true
+    },
     "logLevel": {
       "description": "Amount of detail to output when performing an operation.",
       "type": "string",
@@ -520,7 +525,8 @@
       "default": [
         "markdown",
         "asciidoc",
-        "html"
+        "html",
+        "dita"
       ],
       "anyOf": [
         {
@@ -535,7 +541,8 @@
                 "enum": [
                   "markdown",
                   "asciidoc",
-                  "html"
+                  "html",
+                  "dita"
                 ]
               },
               {

package/dist/schemas/resolvedTests_v3.schema.json

@@ -134,6 +134,11 @@
           "type": "boolean",
           "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
         },
+        "processDitaMaps": {
+          "description": "If `true`, processes DITA maps and includes generated files as inputs.",
+          "type": "boolean",
+          "default": true
+        },
         "logLevel": {
           "description": "Amount of detail to output when performing an operation.",
           "type": "string",
@@ -533,7 +538,8 @@
           "default": [
             "markdown",
             "asciidoc",
-            "html"
+            "html",
+            "dita"
           ],
           "anyOf": [
             {
@@ -548,7 +554,8 @@
                     "enum": [
                       "markdown",
                       "asciidoc",
-                      "html"
+                      "html",
+                      "dita"
                     ]
                   },
                   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.3.0",
+  "version": "3.4.0-dita.0",
   "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.3.1",
-    "mocha": "^11.7.1",
+    "chai": "^6.2.0",
+    "mocha": "^11.7.4",
     "sinon": "^21.0.0"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^14.2.0",
+    "@apidevtools/json-schema-ref-parser": "^14.2.1",
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.11.0",
-    "uuid": "^11.1.0",
+    "axios": "^1.12.2",
+    "uuid": "^13.0.0",
     "yaml": "^2.8.1"
   }
 }

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

@@ -77,5 +77,5 @@
       ]
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/checkLink_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/checkLink_v2.schema.json"
 }

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

@@ -88,5 +88,5 @@
       ]
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/checkLink_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/checkLink_v3.schema.json"
 }

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

@@ -73,5 +73,5 @@
       "button": "middle"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/click_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/click_v3.schema.json"
 }

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

@@ -108,7 +108,7 @@
           "items": {
             "oneOf": [
               {
-                "$ref": "/home/runner/work/common/common/src/schemas/build/context_v2.schema.json#"
+                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/context_v2.schema.json#"
               }
             ]
           },
@@ -314,37 +314,37 @@
                                 ]
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/checkLink_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/checkLink_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/find_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/find_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/goTo_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/goTo_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/httpRequest_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/httpRequest_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/runShell_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/runShell_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/saveScreenshot_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/saveScreenshot_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/setVariables_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/setVariables_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/startRecording_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/startRecording_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/stopRecording_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/stopRecording_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/typeKeys_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/typeKeys_v2.schema.json#"
                               },
                               {
-                                "$ref": "/home/runner/work/common/common/src/schemas/build/wait_v2.schema.json#"
+                                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/wait_v2.schema.json#"
                               }
                             ]
                           }
@@ -541,7 +541,7 @@
           "items": {
             "allOf": [
               {
-                "$ref": "/home/runner/work/common/common/src/schemas/build/openApi_v2.schema.json#"
+                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/openApi_v2.schema.json#"
               },
               {
                 "type": "object",
@@ -1075,5 +1075,5 @@
       }
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/config_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/config_v2.schema.json"
 }

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

@@ -53,7 +53,7 @@
       "default": "file"
     },
     "loadVariables": {
-      "$ref": "/home/runner/work/common/common/src/schemas/build/loadVariables_v3.schema.json#"
+      "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/loadVariables_v3.schema.json#"
     },
     "origin": {
       "description": "Default protocol and domain to use for relative URLs.",
@@ -104,6 +104,11 @@
       "type": "boolean",
       "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
     },
+    "processDitaMaps": {
+      "description": "If `true`, processes DITA maps and includes generated files as inputs.",
+      "type": "boolean",
+      "default": true
+    },
     "logLevel": {
       "description": "Amount of detail to output when performing an operation.",
       "type": "string",
@@ -117,14 +122,15 @@
       "default": "info"
     },
     "runOn": {
-      "$ref": "/home/runner/work/common/common/src/schemas/build/test_v3.schema.json#/properties/runOn"
+      "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/test_v3.schema.json#/properties/runOn"
     },
     "fileTypes": {
       "description": "Configuration for file types and their markup detection.",
       "default": [
         "markdown",
         "asciidoc",
-        "html"
+        "html",
+        "dita"
       ],
       "anyOf": [
         {
@@ -139,7 +145,8 @@
                 "enum": [
                   "markdown",
                   "asciidoc",
-                  "html"
+                  "html",
+                  "dita"
                 ]
               },
               {
@@ -213,7 +220,7 @@
                     "description": "`runShell` step to perform for this file type. Use $1 as a placeholder for the file path.",
                     "anyOf": [
                       {
-                        "$ref": "/home/runner/work/common/common/src/schemas/build/runShell_v3.schema.json#"
+                        "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/runShell_v3.schema.json#"
                       }
                     ]
                   }
@@ -230,7 +237,7 @@
       "additionalProperties": false,
       "properties": {
         "openApi": {
-          "$ref": "/home/runner/work/common/common/src/schemas/build/test_v3.schema.json#/properties/openApi"
+          "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/test_v3.schema.json#/properties/openApi"
         }
       },
       "title": "Integrations options"
@@ -360,7 +367,7 @@
                       "$ref": "#/components/schemas/markupActionString"
                     },
                     {
-                      "$ref": "/home/runner/work/common/common/src/schemas/build/step_v3.schema.json#"
+                      "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/step_v3.schema.json#"
                     }
                   ]
                 }
@@ -548,5 +555,5 @@
       "debug": "stepThrough"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/config_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/config_v3.schema.json"
 }

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

@@ -131,5 +131,5 @@
       ]
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/context_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/context_v2.schema.json"
 }

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

@@ -225,5 +225,5 @@
       ]
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/context_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/context_v3.schema.json"
 }

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

@@ -117,5 +117,5 @@
       }
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/dragAndDrop_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/dragAndDrop_v3.schema.json"
 }

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

@@ -73,10 +73,10 @@
           "additionalProperties": false,
           "properties": {
             "keys": {
-              "$ref": "/home/runner/work/common/common/src/schemas/build/typeKeys_v2.schema.json#/properties/keys"
+              "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/typeKeys_v2.schema.json#/properties/keys"
             },
             "delay": {
-              "$ref": "/home/runner/work/common/common/src/schemas/build/typeKeys_v2.schema.json#/properties/delay"
+              "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/typeKeys_v2.schema.json#/properties/delay"
             }
           }
         }
@@ -164,5 +164,5 @@
       ]
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/find_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/find_v2.schema.json"
 }

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

@@ -56,13 +56,13 @@
             "description": "Click the element.",
             "anyOf": [
               {
-                "$ref": "/home/runner/work/common/common/src/schemas/build/click_v3.schema.json#"
+                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/click_v3.schema.json#"
               },
               {
                 "type": "object",
                 "properties": {
                   "button": {
-                    "$ref": "/home/runner/work/common/common/src/schemas/build/click_v3.schema.json#/components/schemas/button"
+                    "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/click_v3.schema.json#/components/schemas/button"
                   }
                 },
                 "title": "Find element and click"
@@ -73,7 +73,7 @@
             "description": "Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`type`](type). To type in the element, make the element active with the `click` parameter.",
             "allOf": [
               {
-                "$ref": "/home/runner/work/common/common/src/schemas/build/type_v3.schema.json#"
+                "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/type_v3.schema.json#"
               },
               {
                 "not": {
@@ -124,5 +124,5 @@
       }
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/find_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/find_v3.schema.json"
 }

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

@@ -59,5 +59,5 @@
       "origin": "https://www.google.com"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/goTo_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/goTo_v2.schema.json"
 }

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

@@ -59,5 +59,5 @@
       "origin": "www.google.com"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/goTo_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/goTo_v3.schema.json"
 }

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

@@ -27,7 +27,7 @@
     "openApi": {
       "allOf": [
         {
-          "$ref": "/home/runner/work/common/common/src/schemas/build/openApi_v2.schema.json#"
+          "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/openApi_v2.schema.json#"
         },
         {
           "type": "object",
@@ -317,5 +317,5 @@
       }
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/httpRequest_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/httpRequest_v2.schema.json"
 }

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

@@ -46,7 +46,7 @@
               {
                 "allOf": [
                   {
-                    "$ref": "/home/runner/work/common/common/src/schemas/build/openApi_v3.schema.json#/components/schemas/operationId"
+                    "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/openApi_v3.schema.json#/components/schemas/operationId"
                   },
                   {
                     "title": "Operation ID",
@@ -57,7 +57,7 @@
               {
                 "allOf": [
                   {
-                    "$ref": "/home/runner/work/common/common/src/schemas/build/openApi_v3.schema.json#"
+                    "$ref": "/home/hawkeyexl/Workspaces/common/src/schemas/build/openApi_v3.schema.json#"
                   },
                   {
                     "type": "object",
@@ -381,5 +381,5 @@
       }
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/httpRequest_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/httpRequest_v3.schema.json"
 }

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

@@ -134,5 +134,5 @@
       "domain": "app.example.com"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/loadCookie_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/loadCookie_v3.schema.json"
 }

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

@@ -0,0 +1,156 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "loadCookies",
+  "description": "Load cookies from a file or environment variable into the browser.",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "type": "string",
+        "title": "Environment variable or file path",
+        "description": "Environment variable name containing cookies as JSON string, or file path to cookie file.",
+        "transform": [
+          "trim"
+        ]
+      },
+      "object": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "variable": {
+            "type": "string",
+            "title": "Environment variable name",
+            "description": "Environment variable name containing cookies 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.",
+            "transform": [
+              "trim"
+            ]
+          },
+          "directory": {
+            "type": "string",
+            "title": "Directory path",
+            "description": "Directory containing the cookie file.",
+            "transform": [
+              "trim"
+            ]
+          },
+          "filter": {
+            "type": "object",
+            "title": "Cookie filter",
+            "description": "Filter criteria to specify which cookies to load from the source.",
+            "additionalProperties": false,
+            "properties": {
+              "names": {
+                "type": "array",
+                "title": "Cookie names",
+                "description": "Array of specific cookie names to include. If specified, only these cookies will be loaded.",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "patterns": {
+                "type": "array",
+                "title": "Cookie name patterns",
+                "description": "Array of wildcard patterns (* and ?) or regex patterns to match cookie names.",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "domains": {
+                "type": "array",
+                "title": "Cookie domains",
+                "description": "Array of domains to include. Only cookies for these domains will be loaded.",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "exclude": {
+                "type": "object",
+                "title": "Exclusion filters",
+                "description": "Cookies matching these criteria will be excluded from loading.",
+                "additionalProperties": false,
+                "properties": {
+                  "names": {
+                    "type": "array",
+                    "title": "Excluded cookie names",
+                    "description": "Array of cookie names to exclude.",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "patterns": {
+                    "type": "array",
+                    "title": "Excluded patterns",
+                    "description": "Array of patterns to exclude.",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "title": "Load cookies (detailed)"
+      }
+    }
+  },
+  "examples": [
+    "AUTH_COOKIES",
+    "./test-data/auth-session.txt",
+    {
+      "variable": "SESSION_COOKIES"
+    },
+    {
+      "path": "login-state.txt",
+      "directory": "./test-data"
+    },
+    {
+      "variable": "ALL_COOKIES",
+      "filter": {
+        "names": [
+          "sessionToken",
+          "authToken"
+        ]
+      }
+    },
+    {
+      "path": "saved-cookies.txt",
+      "filter": {
+        "patterns": [
+          "*auth*",
+          "*session*"
+        ],
+        "exclude": {
+          "names": [
+            "temp_session"
+          ]
+        }
+      }
+    },
+    {
+      "variable": "DOMAIN_COOKIES",
+      "filter": {
+        "domains": [
+          "app.example.com"
+        ]
+      }
+    }
+  ],
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/loadCookies_v3.schema.json"
+}

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

@@ -6,5 +6,5 @@
   "examples": [
     ".env"
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/loadVariables_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/loadVariables_v3.schema.json"
 }

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

@@ -95,5 +95,5 @@
       "duration": 1000
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/moveTo_v2.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/moveTo_v2.schema.json"
 }

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

@@ -1,5 +1,5 @@
 {
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/openApi_v2.schema.json",
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/openApi_v2.schema.json",
   "version": "1.0.0",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "openApi",

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

@@ -1,5 +1,5 @@
 {
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/openApi_v3.schema.json",
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/openApi_v3.schema.json",
   "version": "1.0.0",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "openApi",

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

@@ -66,5 +66,5 @@
       "overwrite": "true"
     }
   ],
-  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/record_v3.schema.json"
+  "$id": "/home/hawkeyexl/Workspaces/common/src/schemas/src_schemas/record_v3.schema.json"
 }