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

package/dist/schemas/spec_v3.schema.json

@@ -3104,6 +3104,14 @@
                                             }
                                           ],
                                           "default": {}
+                                        },
+                                        "required": {
+                                          "type": "array",
+                                          "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                          "items": {
+                                            "type": "string"
+                                          },
+                                          "default": []
                                         }
                                       },
                                       "title": "Response"
@@ -3495,6 +3503,14 @@
                                               }
                                             ],
                                             "default": {}
+                                          },
+                                          "required": {
+                                            "type": "array",
+                                            "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                            "items": {
+                                              "type": "string"
+                                            },
+                                            "default": []
                                           }
                                         },
                                         "title": "Response"
@@ -3676,6 +3692,52 @@
                                   "request": {
                                     "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                   }
+                                },
+                                {
+                                  "url": "https://api.example.com/users/123",
+                                  "response": {
+                                    "required": [
+                                      "id",
+                                      "email",
+                                      "createdAt"
+                                    ]
+                                  }
+                                },
+                                {
+                                  "url": "https://api.example.com/users/123",
+                                  "response": {
+                                    "required": [
+                                      "user.profile.name",
+                                      "user.profile.avatar",
+                                      "user.settings.notifications"
+                                    ]
+                                  }
+                                },
+                                {
+                                  "url": "https://api.example.com/orders",
+                                  "response": {
+                                    "required": [
+                                      "orders[0].id",
+                                      "orders[0].total",
+                                      "orders[0].items[0].productId"
+                                    ]
+                                  }
+                                },
+                                {
+                                  "url": "https://api.example.com/users",
+                                  "response": {
+                                    "required": [
+                                      "sessionToken",
+                                      "expiresAt",
+                                      "user.id"
+                                    ],
+                                    "body": {
+                                      "status": "success",
+                                      "user": {
+                                        "role": "admin"
+                                      }
+                                    }
+                                  }
                                 }
                               ]
                             }
@@ -8866,6 +8928,14 @@
                                                   }
                                                 ],
                                                 "default": {}
+                                              },
+                                              "required": {
+                                                "type": "array",
+                                                "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                "items": {
+                                                  "type": "string"
+                                                },
+                                                "default": []
                                               }
                                             },
                                             "title": "Response"
@@ -9257,6 +9327,14 @@
                                                     }
                                                   ],
                                                   "default": {}
+                                                },
+                                                "required": {
+                                                  "type": "array",
+                                                  "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                                  "items": {
+                                                    "type": "string"
+                                                  },
+                                                  "default": []
                                                 }
                                               },
                                               "title": "Response"
@@ -9438,6 +9516,52 @@
                                         "request": {
                                           "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                                         }
+                                      },
+                                      {
+                                        "url": "https://api.example.com/users/123",
+                                        "response": {
+                                          "required": [
+                                            "id",
+                                            "email",
+                                            "createdAt"
+                                          ]
+                                        }
+                                      },
+                                      {
+                                        "url": "https://api.example.com/users/123",
+                                        "response": {
+                                          "required": [
+                                            "user.profile.name",
+                                            "user.profile.avatar",
+                                            "user.settings.notifications"
+                                          ]
+                                        }
+                                      },
+                                      {
+                                        "url": "https://api.example.com/orders",
+                                        "response": {
+                                          "required": [
+                                            "orders[0].id",
+                                            "orders[0].total",
+                                            "orders[0].items[0].productId"
+                                          ]
+                                        }
+                                      },
+                                      {
+                                        "url": "https://api.example.com/users",
+                                        "response": {
+                                          "required": [
+                                            "sessionToken",
+                                            "expiresAt",
+                                            "user.id"
+                                          ],
+                                          "body": {
+                                            "status": "success",
+                                            "user": {
+                                              "role": "admin"
+                                            }
+                                          }
+                                        }
                                       }
                                     ]
                                   }

package/dist/schemas/step_v3.schema.json

@@ -1904,6 +1904,14 @@
                             }
                           ],
                           "default": {}
+                        },
+                        "required": {
+                          "type": "array",
+                          "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                          "items": {
+                            "type": "string"
+                          },
+                          "default": []
                         }
                       },
                       "title": "Response"
@@ -2295,6 +2303,14 @@
                               }
                             ],
                             "default": {}
+                          },
+                          "required": {
+                            "type": "array",
+                            "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                            "items": {
+                              "type": "string"
+                            },
+                            "default": []
                           }
                         },
                         "title": "Response"
@@ -2476,6 +2492,52 @@
                   "request": {
                     "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                   }
+                },
+                {
+                  "url": "https://api.example.com/users/123",
+                  "response": {
+                    "required": [
+                      "id",
+                      "email",
+                      "createdAt"
+                    ]
+                  }
+                },
+                {
+                  "url": "https://api.example.com/users/123",
+                  "response": {
+                    "required": [
+                      "user.profile.name",
+                      "user.profile.avatar",
+                      "user.settings.notifications"
+                    ]
+                  }
+                },
+                {
+                  "url": "https://api.example.com/orders",
+                  "response": {
+                    "required": [
+                      "orders[0].id",
+                      "orders[0].total",
+                      "orders[0].items[0].productId"
+                    ]
+                  }
+                },
+                {
+                  "url": "https://api.example.com/users",
+                  "response": {
+                    "required": [
+                      "sessionToken",
+                      "expiresAt",
+                      "user.id"
+                    ],
+                    "body": {
+                      "status": "success",
+                      "user": {
+                        "role": "admin"
+                      }
+                    }
+                  }
                 }
               ]
             }

package/dist/schemas/test_v3.schema.json

@@ -2503,6 +2503,14 @@
                                   }
                                 ],
                                 "default": {}
+                              },
+                              "required": {
+                                "type": "array",
+                                "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                "items": {
+                                  "type": "string"
+                                },
+                                "default": []
                               }
                             },
                             "title": "Response"
@@ -2894,6 +2902,14 @@
                                     }
                                   ],
                                   "default": {}
+                                },
+                                "required": {
+                                  "type": "array",
+                                  "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                  "items": {
+                                    "type": "string"
+                                  },
+                                  "default": []
                                 }
                               },
                               "title": "Response"
@@ -3075,6 +3091,52 @@
                         "request": {
                           "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                         }
+                      },
+                      {
+                        "url": "https://api.example.com/users/123",
+                        "response": {
+                          "required": [
+                            "id",
+                            "email",
+                            "createdAt"
+                          ]
+                        }
+                      },
+                      {
+                        "url": "https://api.example.com/users/123",
+                        "response": {
+                          "required": [
+                            "user.profile.name",
+                            "user.profile.avatar",
+                            "user.settings.notifications"
+                          ]
+                        }
+                      },
+                      {
+                        "url": "https://api.example.com/orders",
+                        "response": {
+                          "required": [
+                            "orders[0].id",
+                            "orders[0].total",
+                            "orders[0].items[0].productId"
+                          ]
+                        }
+                      },
+                      {
+                        "url": "https://api.example.com/users",
+                        "response": {
+                          "required": [
+                            "sessionToken",
+                            "expiresAt",
+                            "user.id"
+                          ],
+                          "body": {
+                            "status": "success",
+                            "user": {
+                              "role": "admin"
+                            }
+                          }
+                        }
                       }
                     ]
                   }
@@ -8265,6 +8327,14 @@
                                         }
                                       ],
                                       "default": {}
+                                    },
+                                    "required": {
+                                      "type": "array",
+                                      "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                      "items": {
+                                        "type": "string"
+                                      },
+                                      "default": []
                                     }
                                   },
                                   "title": "Response"
@@ -8656,6 +8726,14 @@
                                           }
                                         ],
                                         "default": {}
+                                      },
+                                      "required": {
+                                        "type": "array",
+                                        "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                                        "items": {
+                                          "type": "string"
+                                        },
+                                        "default": []
                                       }
                                     },
                                     "title": "Response"
@@ -8837,6 +8915,52 @@
                               "request": {
                                 "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
                               }
+                            },
+                            {
+                              "url": "https://api.example.com/users/123",
+                              "response": {
+                                "required": [
+                                  "id",
+                                  "email",
+                                  "createdAt"
+                                ]
+                              }
+                            },
+                            {
+                              "url": "https://api.example.com/users/123",
+                              "response": {
+                                "required": [
+                                  "user.profile.name",
+                                  "user.profile.avatar",
+                                  "user.settings.notifications"
+                                ]
+                              }
+                            },
+                            {
+                              "url": "https://api.example.com/orders",
+                              "response": {
+                                "required": [
+                                  "orders[0].id",
+                                  "orders[0].total",
+                                  "orders[0].items[0].productId"
+                                ]
+                              }
+                            },
+                            {
+                              "url": "https://api.example.com/users",
+                              "response": {
+                                "required": [
+                                  "sessionToken",
+                                  "expiresAt",
+                                  "user.id"
+                                ],
+                                "body": {
+                                  "status": "success",
+                                  "user": {
+                                    "role": "admin"
+                                  }
+                                }
+                              }
                             }
                           ]
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.4.0",
+  "version": "3.4.1-dev.2",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -20,17 +20,17 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
-    "chai": "^6.2.0",
-    "mocha": "^11.7.4",
+    "chai": "^6.2.1",
+    "mocha": "^11.7.5",
     "sinon": "^21.0.0"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^14.2.1",
+    "@apidevtools/json-schema-ref-parser": "^15.1.1",
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.12.2",
+    "axios": "^1.13.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;
@@ -134,6 +140,11 @@ async function resolvePaths({
     pathProperties = specPaths;
   }
 
+  // If the object is null or empty, return it as is
+  if (object === null || Object.keys(object).length === 0) {
+    return object;
+  }
+
   for (const property of Object.keys(object)) {
     // If the property is an array, recursively call resolvePaths for each item in the array
     if (Array.isArray(object[property])) {

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."
     },
+    "crawl": {
+      "description": "If `true`, crawls sitemap.xml files specified by URL to find additional files to test.",
+      "type": "boolean",
+      "default": false
+    },
     "processDitaMaps": {
       "description": "If `true`, processes DITA maps and includes generated files as inputs.",
       "type": "boolean",
@@ -238,6 +243,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"
@@ -553,6 +570,16 @@
     },
     {
       "debug": "stepThrough"
+    },
+    {
+      "integrations": {
+        "docDetectiveApi": {
+          "apiKey": "your-api-key-here"
+        }
+      }
+    },
+    {
+      "crawl": true
     }
   ],
   "$id": "/home/runner/work/common/common/src/schemas/src_schemas/config_v3.schema.json"

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

@@ -198,6 +198,14 @@
                   }
                 ],
                 "default": {}
+              },
+              "required": {
+                "type": "array",
+                "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
               }
             },
             "title": "Response"
@@ -379,6 +387,52 @@
       "request": {
         "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
       }
+    },
+    {
+      "url": "https://api.example.com/users/123",
+      "response": {
+        "required": [
+          "id",
+          "email",
+          "createdAt"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/users/123",
+      "response": {
+        "required": [
+          "user.profile.name",
+          "user.profile.avatar",
+          "user.settings.notifications"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/orders",
+      "response": {
+        "required": [
+          "orders[0].id",
+          "orders[0].total",
+          "orders[0].items[0].productId"
+        ]
+      }
+    },
+    {
+      "url": "https://api.example.com/users",
+      "response": {
+        "required": [
+          "sessionToken",
+          "expiresAt",
+          "user.id"
+        ],
+        "body": {
+          "status": "success",
+          "user": {
+            "role": "admin"
+          }
+        }
+      }
     }
   ],
   "$id": "/home/runner/work/common/common/src/schemas/src_schemas/httpRequest_v3.schema.json"