doc-detective-common 3.3.0 → 3.4.0-dev.2

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"
                 ]
               },
               {
@@ -6747,6 +6754,18 @@
               }
             ]
           }
+        },
+        "docDetectiveApi": {
+          "type": "object",
+          "description": "Configuration for Doc Detective Orchestration API integration.",
+          "additionalProperties": false,
+          "properties": {
+            "apiKey": {
+              "type": "string",
+              "description": "API key for authenticating with the Doc Detective Orchestration API."
+            }
+          },
+          "title": "Doc Detective Orchestration API"
         }
       },
       "title": "Integrations options"
@@ -12695,6 +12714,13 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
     }
   ]
 }

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"
                     ]
                   },
                   {
@@ -6760,6 +6767,18 @@
                   }
                 ]
               }
+            },
+            "docDetectiveApi": {
+              "type": "object",
+              "description": "Configuration for Doc Detective Orchestration API integration.",
+              "additionalProperties": false,
+              "properties": {
+                "apiKey": {
+                  "type": "string",
+                  "description": "API key for authenticating with the Doc Detective Orchestration API."
+                }
+              },
+              "title": "Doc Detective Orchestration API"
             }
           },
           "title": "Integrations options"
@@ -12708,6 +12727,13 @@
         },
         {
           "debug": "stepThrough"
+        },
+        {
+          "integrations": {
+            "docDetectiveApi": {
+              "apiKey": "your-api-key-here"
+            }
+          }
         }
       ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.3.0",
+  "version": "3.4.0-dev.2",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -20,18 +20,17 @@
   },
   "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",
     "yaml": "^2.8.1"
   }
 }

package/src/resolvePaths.js

@@ -76,8 +76,14 @@ async function resolvePaths({
    * @returns {string} The absolute path corresponding to {@link relativePath}.
    *
    * @remark If {@link relativePath} is already absolute, it is returned unchanged. If {@link filePath} does not exist, its extension is used to infer whether it is a file or directory.
+   * @remark HTTP and HTTPS URLs are returned unchanged without resolution.
    */
   function resolve(baseType, relativePath, filePath) {
+    // If the path is an http:// or https:// URL, return it
+    if (relativePath.startsWith("https://") || relativePath.startsWith("http://")) {
+      return relativePath;
+    }
+
     // If path is already absolute, return it
     if (path.isAbsolute(relativePath)) {
       return relativePath;

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

@@ -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",
@@ -124,7 +129,8 @@
       "default": [
         "markdown",
         "asciidoc",
-        "html"
+        "html",
+        "dita"
       ],
       "anyOf": [
         {
@@ -139,7 +145,8 @@
                 "enum": [
                   "markdown",
                   "asciidoc",
-                  "html"
+                  "html",
+                  "dita"
                 ]
               },
               {
@@ -231,6 +238,18 @@
       "properties": {
         "openApi": {
           "$ref": "/home/runner/work/common/common/src/schemas/build/test_v3.schema.json#/properties/openApi"
+        },
+        "docDetectiveApi": {
+          "type": "object",
+          "description": "Configuration for Doc Detective Orchestration API integration.",
+          "additionalProperties": false,
+          "properties": {
+            "apiKey": {
+              "type": "string",
+              "description": "API key for authenticating with the Doc Detective Orchestration API."
+            }
+          },
+          "title": "Doc Detective Orchestration API"
         }
       },
       "title": "Integrations options"
@@ -546,6 +565,13 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
     }
   ],
   "$id": "/home/runner/work/common/common/src/schemas/src_schemas/config_v3.schema.json"

package/src/schemas/output_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"
                 ]
               },
               {
@@ -6747,6 +6754,18 @@
               }
             ]
           }
+        },
+        "docDetectiveApi": {
+          "type": "object",
+          "description": "Configuration for Doc Detective Orchestration API integration.",
+          "additionalProperties": false,
+          "properties": {
+            "apiKey": {
+              "type": "string",
+              "description": "API key for authenticating with the Doc Detective Orchestration API."
+            }
+          },
+          "title": "Doc Detective Orchestration API"
         }
       },
       "title": "Integrations options"
@@ -12695,6 +12714,13 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
     }
   ]
 }

package/src/schemas/output_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"
                     ]
                   },
                   {
@@ -6760,6 +6767,18 @@
                   }
                 ]
               }
+            },
+            "docDetectiveApi": {
+              "type": "object",
+              "description": "Configuration for Doc Detective Orchestration API integration.",
+              "additionalProperties": false,
+              "properties": {
+                "apiKey": {
+                  "type": "string",
+                  "description": "API key for authenticating with the Doc Detective Orchestration API."
+                }
+              },
+              "title": "Doc Detective Orchestration API"
             }
           },
           "title": "Integrations options"
@@ -12708,6 +12727,13 @@
         },
         {
           "debug": "stepThrough"
+        },
+        {
+          "integrations": {
+            "docDetectiveApi": {
+              "apiKey": "your-api-key-here"
+            }
+          }
         }
       ]
     },

package/src/schemas/schemas.json

@@ -383,6 +383,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",
@@ -782,7 +787,8 @@
         "default": [
           "markdown",
           "asciidoc",
-          "html"
+          "html",
+          "dita"
         ],
         "anyOf": [
           {
@@ -797,7 +803,8 @@
                   "enum": [
                     "markdown",
                     "asciidoc",
-                    "html"
+                    "html",
+                    "dita"
                   ]
                 },
                 {
@@ -7009,6 +7016,18 @@
                 }
               ]
             }
+          },
+          "docDetectiveApi": {
+            "type": "object",
+            "description": "Configuration for Doc Detective Orchestration API integration.",
+            "additionalProperties": false,
+            "properties": {
+              "apiKey": {
+                "type": "string",
+                "description": "API key for authenticating with the Doc Detective Orchestration API."
+              }
+            },
+            "title": "Doc Detective Orchestration API"
           }
         },
         "title": "Integrations options"
@@ -12957,6 +12976,13 @@
       },
       {
         "debug": "stepThrough"
+      },
+      {
+        "integrations": {
+          "docDetectiveApi": {
+            "apiKey": "your-api-key-here"
+          }
+        }
       }
     ]
   },
@@ -15947,6 +15973,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",
@@ -16346,7 +16377,8 @@
             "default": [
               "markdown",
               "asciidoc",
-              "html"
+              "html",
+              "dita"
             ],
             "anyOf": [
               {
@@ -16361,7 +16393,8 @@
                       "enum": [
                         "markdown",
                         "asciidoc",
-                        "html"
+                        "html",
+                        "dita"
                       ]
                     },
                     {
@@ -22573,6 +22606,18 @@
                     }
                   ]
                 }
+              },
+              "docDetectiveApi": {
+                "type": "object",
+                "description": "Configuration for Doc Detective Orchestration API integration.",
+                "additionalProperties": false,
+                "properties": {
+                  "apiKey": {
+                    "type": "string",
+                    "description": "API key for authenticating with the Doc Detective Orchestration API."
+                  }
+                },
+                "title": "Doc Detective Orchestration API"
               }
             },
             "title": "Integrations options"
@@ -28521,6 +28566,13 @@
           },
           {
             "debug": "stepThrough"
+          },
+          {
+            "integrations": {
+              "docDetectiveApi": {
+                "apiKey": "your-api-key-here"
+              }
+            }
           }
         ]
       },

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

@@ -101,6 +101,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",
@@ -112,7 +117,7 @@
     },
     "fileTypes": {
       "description": "Configuration for file types and their markup detection.",
-      "default": ["markdown", "asciidoc", "html"],
+      "default": ["markdown", "asciidoc", "html", "dita"],
       "anyOf": [
         {
           "type": "array",
@@ -123,7 +128,7 @@
                 "$comment": "Simple mode: Reference predefined templates by name.",
                 "title": "File type (predefined)",
                 "type": "string",
-                "enum": ["markdown", "asciidoc", "html"]
+                "enum": ["markdown", "asciidoc", "html", "dita"]
               },
               {
                 "$comment": "Custom mode: Extend predefined templates or write whole new ones.",
@@ -200,6 +205,18 @@
       "properties": {
         "openApi": {
           "$ref": "test_v3.schema.json#/properties/openApi"
+        },
+        "docDetectiveApi": {
+          "type": "object",
+          "description": "Configuration for Doc Detective Orchestration API integration.",
+          "additionalProperties": false,
+          "properties": {
+            "apiKey": {
+              "type": "string",
+              "description": "API key for authenticating with the Doc Detective Orchestration API."
+            }
+          },
+          "title": "Doc Detective Orchestration API"
         }
       },
       "title": "Integrations options"
@@ -491,6 +508,13 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
     }
   ]
 }

package/src/validate.js

@@ -6,7 +6,7 @@ const addFormats = require("ajv-formats");
 const addKeywords = require("ajv-keywords");
 // Ajv custom errors: https://ajv.js.org/packages/ajv-errors.html
 const addErrors = require("ajv-errors");
-const uuid = require("uuid");
+const { randomUUID } = require("crypto");
 
 // Configure base Ajv
 const ajv = new Ajv({
@@ -19,7 +19,7 @@ const ajv = new Ajv({
 
 // Enable `uuid` dynamic default
 const def = require("ajv-keywords/dist/definitions/dynamicDefaults");
-def.DEFAULTS.uuid = () => uuid.v4;
+def.DEFAULTS.uuid = () => randomUUID;
 
 // Enhance Ajv
 addFormats(ajv);