v0.9.0

Minor Changes

• #70 1c36eca Thanks @vitalics! - Add example for every schema.

  Example:

  s.string().examples(["str1", "string 2"]); // OK
  s.number().examples(["str1", "string 2"]); // Error in typescript, but OK
  s.number().examples([1, 2, 3]); // OK
  s.number().examples(1, 2, 3); // OK

Patch Changes

• #67 1eab44b Thanks @vitalics! - switch changeset type to github

• #68 dda3326 Thanks @vitalics! - update pnpm minor version

v0.8.0

Minor Changes

• 9a62d94: Make strict numbers

  Strict numbers

  We make validation for number type, format, minValue and maxValue fields. That means we handle it in our side so you get an error for invalid values.

  Examples:

  s.number().format("float").int(); // error in type!
  s.int().const(3.4); // error in type!
  s.number().int().format("float"); // error in format!
  s.number().int().format("double"); // error in format!
  
  // ranges are also check for possibility
  
  s.number().min(5).max(3); // error in range!
  s.number().min(3).max(5).const(10); // error in constant - out of range!

  🏡 Chore/Infra

  • add type-fest library for correct type checking
  • add tsx package
  • add minified files for cjs and esm modules in dist folder
  • remove bun-types dependency

Patch Changes

• 37a7b1d: fix #61
• 0f787a7: add example in meta object. Closes #64

v0.7.1

Patch Changes

• 6acd6ef: This release contains next updates

  Fixes

  • Issue #57 - merge construct schema with undefined fields.
  • Extend don't update def property.
  • Advanced TS type for .array() call.

  Chore

  • remove benchmarks for now
  • add more detailed bug report template

  Infra

  • Configure vitest config file for testing and enable github actions reporter for CI
  • Add tsx package for inspection.
  • Update launch.json file for vscode debugger

  Tests

  • add #57 issue test for object type.

v0.7.0

Minor Changes

• 3e6636b: This release contains new cool features.

  New features

  • extend error method for map custom messages(#54). Originally works from ajv-errors and examples from this docs are works
    examples:

  import s from "ajv-ts";
  
  const s1 = s.string().error({ _: "any error here" });
  
  s.parse(123); // throws "any error here"
  
  s.string().error({ _: "any error here", type: "not a string. Custom" });
  
  s.parse(123); // throws "not a string. Custom"
  
  const Obj = s
    .object({ foo: s.string() })
    .strict()
    .error({ additionalProperties: "Not expected to pass additional props" });
  
  Obj.parse({ foo: "ok", bar: true }); // throws "Not expected to pass additional props"

  One more example:

  const Schema = s
    .object({
      foo: s.integer().minimum(2),
      bar: s.string().minLength(2),
    })
    .strict()
    .error({
      properties: {
        foo: "data.foo should be integer >= 2",
        bar: "data.bar should be string with length >= 2",
      },
    });
  Schema.parse({ foo: 1, bar: "a" }); // throws: "data.foo should be integer >= 2"

  • check length for string and array schema. Example:

  import s from "ajv-ts";
  s.string().minLength(3).maxLength(1); // error. MaxLength < MinLength
  
  s.array().minLength(4).maxLength(2); // error. MaxLength < MinLength
  
  s.string().length(-1); // error. Length is negative

  • fromJSON can eval incoming JSON(or object) and "attach" into schema.
    example:

  import s from "ajv-ts";
  const externalSchema = s.fromJSON(
    { someProp: "YesImCustomProp", type: "number" },
    s.string()
  );
  externalSchema.schema.someProp === "YesImCustomProp"; // true
  externalSchema.schema.type === "number"; // true

  Fixes

  • issue with merge when old schema(before modified with merge function) schema was applies

  Infra

  • migrate from bun to pnpm package manager
  • update PR steps. Now we use bun@latest, pnpm@9 with node@18, node@20 and node@22 versions.

v0.6.3

Patch Changes

• f5b5403: patch release
• 3d0d56d: $schema in meta support(#49)
• 84fe084: fix: homepage link, organize imports, exports (#48)
• f5b5403: feature: array.element. Add tests for addItems (#47)
• 4421ac8 chore: npmignore (#45)
• 152ebfa add shape for zod compatibility (#44)
• 9f98286 Zod: expose literal function (#42)
• b315539 feature: expose nativeEnum to zod compatibility (#39)

v0.6.2

Patch Changes

• 37b57f2: make object schema accept object type.

  What's new

  Object

  make object schema accept generic object type.

  import s from "ajv-ts";
  type CustomObj = {
    name: string;
    age: number;
  };
  // Before
  const before = s.object<CustomObj>(); // error, accept another definition
  // After
  s.object<CustomObj>(); // OK now

  Zod compatibility

  describe - add description to your schema. This method for zod compatibility.

v0.6.1

Patch Changes

• 1c4b78b: - fix default behavior.

  Now you can pass undefined or null and your default values will be applies.

  NOTE: default keyword will be applied for items and properties definition. That means default keyword will works only for object() and array() builders. See in ajv docs

  Example:

  import s from "ajv-ts";
  
  const Person = s.object({
    age: s.number().default(18),
  });
  
  // Before
  Person.parse({}); // throws error
  
  // Now
  Person.parse({}); // returns { age: 18 }, default value

  • parse, safeParse and validate now can be called without arguments.

  import s from "ajv-ts";
  
  // Before
  s.number().safeParse(); // Error, required at least 1 argument
  
  // After
  s.number().safeParse(); // ok now

  • expose default Ajv instance.

  • make object builder optional.

  Example:

  import s from "ajv-ts";
  // Before
  s.object(); // error, expected object
  // After
  s.object(); // OK, empty object definition

v0.6.0

Minor Changes

• 219c7b7: new method: refine.

  Inspired from zod. Set custom validation. Any result exept undefined will throws(or exposed for safeParse method).

  import s from "ajv-ts";
  // example: object with only 1 "active element"
  const Schema = s
    .object({
      active: s.boolean(),
      name: s.string(),
    })
    .array()
    .refine((arr) => {
      const subArr = arr.filter((el) => el.active === true);
      if (subArr.length > 1)
        throw new Error('Array should contains only 1 "active" element');
    });
  
  Schema.parse([
    { active: true, name: "some 1" },
    { active: true, name: "some 2" },
  ]); // throws Error: Array should contains only 1 "active" element

v0.5.1

Patch Changes

• 09c54ff: Add async keyword support

  example:

  const obj = s.object({}).async();
  
  obj.schema; // {type: 'object', $async: true}
  // make sync schema
  obj.sync(); // {type: 'object', $async: false}
  
  // or completely remove the `$async` keyword form schema
  obj.sync(true); // {type: 'object'}

  fixes/refactories

  • refactor safeParse logic.
  • update JSDoc for default method

v0.5.0

Minor Changes

• cc5ef23: Minor release 0.5 is out!

  Installation/Update

  npm i ajv-ts@latest # npm
  yarn add ajv-ts@latest # yarn
  pnpm add ajv-ts@latest # pnpm
  bun add ajv-ts@latest # bun

  New Features

  not, exclude

  Now you can mark your schema with not keyword!

  Here is a 2 differences between not and exclude.

  • not method wrap given schema with not
  • exclude(schema) - add not keyword for incoming schema argument

  Example:

  import s from "ajv-ts";
  
  // not
  const notAString = s.string().not(); // or s.not(s.string())
  
  notAString.valid("random string"); // false, this is a string
  notAString.valid(123); // true
  
  // exclude
  const notJohn = s.string().exclude(s.const("John"));
  
  notJohn.valid("random string"); // true
  notJohn.valid("John"); // false, this is John
  
  // advanced usage
  
  const str = s.string<"John" | "Mary">().exclude(s.const("John"));
  s.infer<typeof str>; // 'Mary'

  keyof

  New function that can be used in a root. Same as keyof T in Typescript.

  NOTE: currenty works only with objects only, this behavior will be fixed in future releases.

  Example:

  import s from "ajv-ts";
  
  const keys = s.keyof(
    s.object({
      key1: s.string(),
      key2: s.object({}),
    })
  );
  
  type Result = s.infer<typeof keys>; // 'key1' | 'key2'
  
  keys.schema; // { anyOf: [ { cosnt: 'key1' }, {const: 'key2' } ] }

  Never

  Same as never type in Typescript. JSON-schema equivalent is {not: {}}.

  Fixes

  • s.number() - now generic!
  • s.boolean() - now generic!

  Array

  empty schema definition

  function can be called without schema definition

  import s from "ajv-ts";
  // before 0.5
  s.array(); // error
  
  // 0.5 and later
  s.array(); // OK, deinition is not required anymore!

  pushItems

  push(append) schema to array(parent) schema.

  Example:

  import s from "ajv-ts";
  
  const empty = s.array();
  const stringArr = empty.addItems(s.string());
  
  stringArr.schema; // {type: 'array', items: [{ type: 'string' }]}

  minContains/maxContains

  Improve typescript generics usage. Now you cannot set float or negative values.

  Example:

  import s from "ajv-ts";
  
  // Before 0.5
  s.array(s.number()).minContains(-1); // Typescript was silent
  
  // After 0.5
  s.array(s.number()).minContains(-1); // Typescript error: `Argument of type 'number' is not assignable to parameter of type '[never, 'TypeError: "minContains" should be positive integer', "Received: '-1'"]'.`

  JS Doc updates

  Update and add JS Doc for:

  • nullable - update
  • array - update
  • validate - update
  • parse - update
  • number().const() - update
  • array().contains() - add
  • const() - add
  • any() - update
  • unknown - update
  • create - update