v1.3.0

- Improved error messages when not chained to an API response.
- Updated icons for disable validation message.
- Improved API documentation.

README.md

@@ -105,7 +105,7 @@ npm install -D cypress-ajv-schema-validator
 
 #### `cy.validateSchema(schema, path)`
 
-Validates the response body against the provided schema.
+It is expected to be chained to an API response (from a `cy.request()` or `cy.api()`). It validates the response body against the provided schema.
 
 ##### Parameters
 
@@ -288,6 +288,11 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
 
 ## Changelog
 
+### [1.3.0]
+- Improved error messages when not chained to an API response.
+- Updated icons for disable validation message.
+- Improved API documentation.
+
 ### [1.2.0]
 - Integration with bahmutov/cy-api and filiphric/cypress-plugin-api to show JSON violations directly in their outputs on the UI.
 - New Cypress environment variable to disable schema validation.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-ajv-schema-validator",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Lightweight API schema validator for Plain JSON schemas, Swagger schema documents, or OpenAPI schema documents using Ajv JSON Schema Validator",
   "main": "src/index.js",
   "scripts": {

src/index.js

@@ -26,8 +26,12 @@ const iconPropertyError = '🟠'
 const iconPropertyMissing = '🟥'
 const iconMoreErrors = '➕'
 
-const warningDisableSchemaValidation = `⛔ API SCHEMA VALIDATION DISABLED ⛔`
+const warningDisableSchemaValidation = `⚠️ API SCHEMA VALIDATION DISABLED ⚠️`
 const msgDisableSchemaValidation = '- The Cypress environment variable "disableSchemaValidation" has been set to true.'
+const errorNoValidApiResponse = 'The element chained to the cy.validateSchema() command is expected to be an API response!'
+const invalidSchemaParameter = `You must provide a valid schema!`
+const errorInvalidSchemaParameters = `You must provide valid schema parameters (missing 'endpoint', 'method' or 'status' params)!`
+const errorResponseBodyAgainstSchema ='The response body is not valid against the schema!'
 
 // ------------------------------------
 // PUBLIC CUSTOM COMMANDS
@@ -87,6 +91,11 @@ Cypress.Commands.add("validateSchema",
 
             console.log(`${warningDisableSchemaValidation} ${msgDisableSchemaValidation}`)
         } else {
+            // Check if it is a valid API Response object
+            if (response == null || !(response.hasOwnProperty('body') && response.hasOwnProperty('status') && response.hasOwnProperty('headers'))) {
+                console.log(errorNoValidApiResponse)
+                throw new Error(errorNoValidApiResponse)
+            }
 
             const data = response.body
 
@@ -152,15 +161,15 @@ Cypress.Commands.add("validateSchema",
  * });
  */
 export const validateSchema = (data, schema, path) => {
-
     if (Cypress.env('disableSchemaValidation') === true) {
         // We need to check also here since validateSchema() is a public function
         console.log(warningDisableSchemaValidation)
         return null
     }
 
     if (schema == null) {
-        throw new Error(`You must provide a valid schema parameter!`);
+        console.log(errorInvalidSchema)
+        throw new Error(errorInvalidSchema)
     }
 
     if (path != null) {
@@ -238,7 +247,8 @@ export const validateSchema = (data, schema, path) => {
 const _getSchemaFromSpecificationDoc = (schema, { endpoint, method, status }) => {
 
     if (endpoint == null || method == null || status == null) {
-        throw new Error(`You must provide valid schema parameters (missing 'endpoint', 'method' or 'status' params)!`);
+        console.log(errorInvalidSchemaParameters)
+        throw new Error(errorInvalidSchemaParameters)
     }
 
     // Normalize the method to lowercase for Swagger and OpenAPI documents
@@ -465,7 +475,8 @@ const _logValidationResult = (data, errors, maxErrorsToShow = 10) => {
 
         // Throw an error to fail the test
         cy.then(() => {
-            throw new Error('The response body is not valid against the schema!')
+            console.log(errorResponseBodyAgainstSchema)
+            throw new Error(errorResponseBodyAgainstSchema)
         })
     }
 }
@@ -547,4 +558,4 @@ const mustEnableMismatchesOnUI = () => {
 const _random = () => {
     return Math.random().toString(36).substring(10)
 
-}
+}