@takeshape/json-schema 11.70.2 → 11.71.2

package/dist/__tests__/schema-validator.test.js

@@ -1,5 +1,5 @@
 import { expect, test } from 'vitest';
-import { createAjv, createSchemaValidator, fixSchema, isInvalidPropertyRequired, validate } from "../schema-validator.js";
+import { createAjv, createSchemaValidator, createTypedValidator, fixSchema, isInvalidPropertyRequired, validate } from "../schema-validator.js";
 test('createSchemaValidator - missing $id', () => {
     const testSchema = {
         type: 'object',
@@ -293,3 +293,31 @@ test('validate - ignoreNulls', () => {
     expect(valid).toBe(true);
     expect(errors.length).toBe(0);
 });
+test('createTypedValidator - valid data', () => {
+    const schema = {
+        type: 'object',
+        properties: {
+            id: { type: 'string' },
+            name: { type: 'string' }
+        },
+        required: ['id', 'name']
+    };
+    const validate = createTypedValidator(schema);
+    const data = { id: '123', name: 'Test' };
+    expect(validate(data)).toBe(true);
+});
+test('createTypedValidator - invalid data', () => {
+    const schema = {
+        type: 'object',
+        properties: {
+            id: { type: 'string' },
+            name: { type: 'string' }
+        },
+        required: ['id', 'name']
+    };
+    const validate = createTypedValidator(schema);
+    const data = { id: '123' }; // Missing 'name'
+    expect(validate(data)).toBe(false);
+    expect(validate.errors).toBeDefined();
+    expect(validate.errors?.[0].message).toBe("must have required property 'name'");
+});

package/dist/schema-validator.d.ts

@@ -1,5 +1,6 @@
 import type { ErrorObject, Options, SchemaObject } from 'ajv';
 import { Ajv } from 'ajv';
+import type { JSONSchema7 } from 'json-schema';
 export type Data = any;
 export type ValidateParams = {
     ignoreMissing: boolean;
@@ -29,3 +30,7 @@ export declare function createAjv(options?: Options): Ajv;
  */
 export declare function fixSchema(schema: SchemaObject): SchemaObject;
 export declare function createSchemaValidator(schema: SchemaObject | SchemaObject[], metaSchemas?: SchemaObject[], options?: Options): Validator;
+/**
+ * Returns a compiled validator from a schema which can act as a type guard.
+ */
+export declare function createTypedValidator<T>(schema: JSONSchema7, options?: Options): import("ajv").ValidateFunction<T>;

package/dist/schema-validator.js

@@ -198,3 +198,10 @@ export function createSchemaValidator(schema, metaSchemas = [], options = {}) {
         return validate(ajv, defaultRef, data, options);
     };
 }
+/**
+ * Returns a compiled validator from a schema which can act as a type guard.
+ */
+export function createTypedValidator(schema, options = {}) {
+    const ajv = createAjv(options);
+    return ajv.compile(schema);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/json-schema",
-  "version": "11.70.2",
+  "version": "11.71.2",
   "description": "JSON Schema validator",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -38,7 +38,7 @@
     "ajv-formats": "3.0.1",
     "lodash": "^4.17.21",
     "minimatch": "^3.0.4",
-    "@takeshape/util": "11.70.2"
+    "@takeshape/util": "11.71.2"
   },
   "devDependencies": {
     "@types/json-schema": "^7.0.7",