@scalar/json-schema-validator 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/json-schema-validator
 
+## 0.1.2
+
+### Patch Changes
+
+- [#10202](https://github.com/scalar/scalar/pull/10202): Explain invalid URI references and OpenAPI component names, and return parser errors for malformed reference escapes.
+
 ## 0.1.1
 
 ## 0.1.0

package/dist/create-specification-validator.d.ts

@@ -28,6 +28,8 @@ export type SpecificationValidatorConfig<TVersion extends string, TOptions exten
         /** The document's version is not supported. */
         versionNotSupported: string;
     };
+    /** Adds specification-specific guidance to schema errors before returning or throwing them. */
+    transformErrors?: (errors: ErrorObject[], specification: AnyObject) => ErrorObject[];
     /**
      * Adjusts the document before schema validation without touching the caller's
      * copy (AsyncAPI, for example, pins `asyncapi` to an exact version). The

package/dist/create-specification-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-specification-validator.d.ts","sourceRoot":"","sources":["../src/create-specification-validator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAGpD,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAG7D,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3C,qDAAqD;AACrD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,CAAC,QAAQ,SAAS,MAAM,EAAE,QAAQ,SAAS,6BAA6B,IAAI;IAClH,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;IACvC,gEAAgE;IAChE,aAAa,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,QAAQ,GAAG,SAAS,CAAA;IAC5D,gFAAgF;IAChF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpE,0EAA0E;IAC1E,MAAM,EAAE;QACN,iDAAiD;QACjD,cAAc,EAAE,MAAM,CAAA;QACtB,+CAA+C;QAC/C,mBAAmB,EAAE,MAAM,CAAA;KAC5B,CAAA;IACD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAA;IAC5E;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,KAAK,WAAW,EAAE,CAAA;CAC7G,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,QAAQ,SAAS,MAAM,EACvB,QAAQ,SAAS,6BAA6B,GAAG,6BAA6B,EAC9E,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAehD,UAAU,MAAM,GAAG,SAAS,EAAE,UAAU,QAAQ,KAAG,iBAAiB,CAAC,QAAQ,CAAC,CAmEvF"}
+{"version":3,"file":"create-specification-validator.d.ts","sourceRoot":"","sources":["../src/create-specification-validator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAGpD,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAG7D,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3C,qDAAqD;AACrD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,CAAC,QAAQ,SAAS,MAAM,EAAE,QAAQ,SAAS,6BAA6B,IAAI;IAClH,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAA;IACvC,gEAAgE;IAChE,aAAa,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,QAAQ,GAAG,SAAS,CAAA;IAC5D,gFAAgF;IAChF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpE,0EAA0E;IAC1E,MAAM,EAAE;QACN,iDAAiD;QACjD,cAAc,EAAE,MAAM,CAAA;QACtB,+CAA+C;QAC/C,mBAAmB,EAAE,MAAM,CAAA;KAC5B,CAAA;IACD,+FAA+F;IAC/F,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,aAAa,EAAE,SAAS,KAAK,WAAW,EAAE,CAAA;IACpF;;;;;OAKG;IACH,eAAe,CAAC,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAA;IAC5E;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,SAAS,KAAK,WAAW,EAAE,CAAA;CAC7G,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,QAAQ,SAAS,MAAM,EACvB,QAAQ,SAAS,6BAA6B,GAAG,6BAA6B,EAC9E,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAehD,UAAU,MAAM,GAAG,SAAS,EAAE,UAAU,QAAQ,KAAG,iBAAiB,CAAC,QAAQ,CAAC,CAyEvF"}

package/dist/create-specification-validator.js

@@ -56,9 +56,13 @@ export function createSpecificationValidator(config) {
                 return { valid: false, errors: [{ message: config.errors.versionNotSupported }] };
             }
             const documentToValidate = config.prepareDocument?.(specification, version) ?? specification;
-            const result = getValidator(version)(documentToValidate, options);
+            const result = getValidator(version)(documentToValidate);
             if (!result.valid) {
-                return { valid: false, version, errors: result.errors };
+                const errors = config.transformErrors?.(result.errors, documentToValidate) ?? result.errors;
+                if (options?.throwOnError) {
+                    throw new Error(errors[0]?.message ?? 'Validation failed');
+                }
+                return { valid: false, version, errors };
             }
             const semanticErrors = config.postValidate?.(specification, version, options) ?? [];
             if (semanticErrors.length > 0) {

package/dist/prettify-ajv-errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prettify-ajv-errors.d.ts","sourceRoot":"","sources":["../src/prettify-ajv-errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAyXD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAKtF"}
+{"version":3,"file":"prettify-ajv-errors.d.ts","sourceRoot":"","sources":["../src/prettify-ajv-errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAiYD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAKtF"}

package/dist/prettify-ajv-errors.js

@@ -109,20 +109,26 @@ function formatFormatError(error, document) {
     }
     return { message: `${error.keyword} ${error.message}`, path };
 }
-function uriReferenceMessage(document, path) {
+const uriReferenceMessage = (document, path) => {
     const refValue = extractRefValue(document, path);
     if (refValue && /[^\x00-\x7F]/.test(refValue)) {
-        return `$ref "${refValue}" contains non-ASCII characters`;
+        return `$ref "${refValue}" contains non-ASCII characters. Percent-encode them using UTF-8 (RFC 3986).`;
+    }
+    if (refValue && /%(?![0-9a-fA-F]{2})/.test(refValue)) {
+        return `$ref "${refValue}" contains invalid percent-encoding. Each "%" must be followed by two hexadecimal digits; encode a literal "%" as "%25".`;
+    }
+    if (refValue && /\s/.test(refValue)) {
+        return `$ref "${refValue}" contains whitespace. Remove it or percent-encode it (for example, use "%20" for a space).`;
     }
     if (refValue) {
         return `$ref "${refValue}" is not a valid URI reference`;
     }
     return '$ref is not a valid URI reference';
-}
+};
 /** Decodes the `~1` and `~0` escapes of a single JSON Pointer segment. */
 const unescapePointerSegment = (segment) => segment.replace(/~1/g, '/').replace(/~0/g, '~');
 /** Splits a JSON Pointer into its decoded segments. */
-const pointerSegments = (path) => path.split('/').filter(Boolean).map(unescapePointerSegment);
+const pointerSegments = (path) => path.split('/').slice(1).map(unescapePointerSegment);
 /**
  * Walks the document along a list of JSON Pointer segments.
  *

package/package.json

@@ -17,7 +17,7 @@
     "validator",
     "typescript"
   ],
-  "version": "0.1.1",
+  "version": "0.1.2",
   "engines": {
     "node": ">=22"
   },
@@ -42,8 +42,8 @@
     "ajv-draft-04": "^1.0.0",
     "ajv-formats": "^3.0.1",
     "yaml": "^2.9.0",
-    "@scalar/types": "0.19.0",
-    "@scalar/helpers": "0.11.3"
+    "@scalar/helpers": "0.12.0",
+    "@scalar/types": "0.20.0"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",