chore: sync with origin

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: build
+name: build & test
 
 on:
   push:
@@ -12,26 +12,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [16.x, 18.x, 20.x, 21.x]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
       - run: git submodule update --init
-      # - name: update website
-      #   if: ${{ github.event_name == 'push' && matrix.node-version == '14.x' }}
-      #   run: ./scripts/publish-site
-      #   env:
-      #     GH_TOKEN_PUBLIC: ${{ secrets.GH_TOKEN_PUBLIC }}
-      #     GIT_USER_EMAIL: ${{ secrets.GIT_USER_EMAIL }}
-      #     GIT_USER_NAME: ${{ secrets.GIT_USER_NAME }}
       - run: npm run build
       - run: npm run test-ci
-      # - name: coveralls
-      #   uses: coverallsapp/github-action@master
-      #   with:
-      #     github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -7,22 +7,22 @@ on:
 jobs:
   publish-npm:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Required for OIDC
+      contents: read
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 14
-          registry-url: https://registry.npmjs.org/
+          node-version: 18
       - run: npm install
       - run: git submodule update --init
       - run: npm run test-ci
       - name: Publish beta version to npm
-        if: "github.event.release.prerelease"
+        if: ${{ github.event.release.prerelease }}
         run: npm publish --tag beta
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Publish to npm
-        if: "!github.event.release.prerelease"
+        if: ${{ !github.event.release.prerelease }}
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -8,11 +8,11 @@ The fastest JSON validator for Node.js and browser.
 
 Supports JSON Schema draft-04/06/07/2019-09/2020-12 ([draft-04 support](https://ajv.js.org/json-schema.html#draft-04) requires ajv-draft-04 package) and JSON Type Definition [RFC8927](https://datatracker.ietf.org/doc/rfc8927/).
 
-[![build](https://github.com/ajv-validator/ajv/workflows/build/badge.svg)](https://github.com/ajv-validator/ajv/actions?query=workflow%3Abuild)
+[![build](https://github.com/ajv-validator/ajv/actions/workflows/build.yml/badge.svg)](https://github.com/ajv-validator/ajv/actions?query=workflow%3Abuild)
 [![npm](https://img.shields.io/npm/v/ajv.svg)](https://www.npmjs.com/package/ajv)
 [![npm downloads](https://img.shields.io/npm/dm/ajv.svg)](https://www.npmjs.com/package/ajv)
 [![Coverage Status](https://coveralls.io/repos/github/ajv-validator/ajv/badge.svg?branch=master)](https://coveralls.io/github/ajv-validator/ajv?branch=master)
-[![SimpleX](https://img.shields.io/badge/chat-on%20SimpleX-%2307b4b9)](https://simplex.chat/contact#/?v=1&smp=smp%3A%2F%2Fu2dS9sG8nMNURyZwqASV4yROM28Er0luVTx5X1CsMrU%3D%40smp4.simplex.im%2Fap4lMFzfXF8Hzmh-Vz0WNxp_1jKiOa-h%23MCowBQYDK2VuAyEAcdefddRvDfI8iAuBpztm_J3qFucj8MDZoVs_2EcMTzU%3D)
+[![SimpleX](https://img.shields.io/badge/chat-on%20SimpleX-70F0F9)](https://simplex.chat/contact#/?v=1-2&smp=smp%3A%2F%2Fu2dS9sG8nMNURyZwqASV4yROM28Er0luVTx5X1CsMrU%3D%40smp4.simplex.im%2F8KvvURM6J38Gdq9dCuPswMOkMny0xCOJ%23%2F%3Fv%3D1-2%26dh%3DMCowBQYDK2VuAyEAr8rPVRuMOXv6kwF2yUAap-eoVg-9ssOFCi1fIrxTUw0%253D%26srv%3Do5vmywmrnaxalvz6wi3zicyftgio6psuvyniis6gco6bp6ekl4cqj4id.onion&data=%7B%22type%22%3A%22group%22%2C%22groupLinkId%22%3A%224pwLRgWHU9tlroMWHz0uOg%3D%3D%22%7D)
 [![Gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
 [![GitHub Sponsors](https://img.shields.io/badge/$-sponsors-brightgreen)](https://github.com/sponsors/epoberezkin)
 
@@ -35,6 +35,7 @@ Please review [Contributing guidelines](./CONTRIBUTING.md) and [Code components]
 All documentation is available on the [Ajv website](https://ajv.js.org).
 
 Some useful site links:
+
 - [Getting started](https://ajv.js.org/guide/getting-started.html)
 - [JSON Schema vs JSON Type Definition](https://ajv.js.org/guide/schema-language.html)
 - [API reference](https://ajv.js.org/api.html)
@@ -53,7 +54,7 @@ Your continuing support is very important - the funds will be used to develop an
 Please sponsor Ajv via:
 
 - [GitHub sponsors page](https://github.com/sponsors/epoberezkin) (GitHub will match it)
-- [Ajv Open Collective️](https://opencollective.com/ajv)
+- [Ajv Open Collective](https://opencollective.com/ajv)
 
 Thank you.
 
@@ -73,6 +74,19 @@ Thank you.
 <a href="https://opencollective.com/ajv/organization/9/website"><img src="https://opencollective.com/ajv/organization/9/avatar.svg"></a>
 <a href="https://opencollective.com/ajv/organization/10/website"><img src="https://opencollective.com/ajv/organization/10/avatar.svg"></a>
 <a href="https://opencollective.com/ajv/organization/11/website"><img src="https://opencollective.com/ajv/organization/11/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/12/website"><img src="https://opencollective.com/ajv/organization/12/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/13/website"><img src="https://opencollective.com/ajv/organization/13/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/14/website"><img src="https://opencollective.com/ajv/organization/14/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/15/website"><img src="https://opencollective.com/ajv/organization/15/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/16/website"><img src="https://opencollective.com/ajv/organization/16/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/17/website"><img src="https://opencollective.com/ajv/organization/17/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/18/website"><img src="https://opencollective.com/ajv/organization/18/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/19/website"><img src="https://opencollective.com/ajv/organization/19/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/20/website"><img src="https://opencollective.com/ajv/organization/20/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/21/website"><img src="https://opencollective.com/ajv/organization/21/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/22/website"><img src="https://opencollective.com/ajv/organization/22/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/23/website"><img src="https://opencollective.com/ajv/organization/23/avatar.svg"></a>
+<a href="https://opencollective.com/ajv/organization/24/website"><img src="https://opencollective.com/ajv/organization/24/avatar.svg"></a>
 
 ## Performance
 
@@ -87,7 +101,7 @@ Currently Ajv is the fastest and the most standard compliant validator according
 
 Performance of different validators by [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark):
 
-[![performance](https://chart.googleapis.com/chart?chxt=x,y&cht=bhs&chco=76A4FB&chls=2.0&chbh=62,4,1&chs=600x416&chxl=-1:|ajv|@exodus&#x2F;schemasafe|is-my-json-valid|djv|@cfworker&#x2F;json-schema|jsonschema&chd=t:100,69.2,51.5,13.1,5.1,1.2)](https://github.com/ebdrup/json-schema-benchmark/blob/master/README.md#performance)
+[![performance](https://chart.googleapis.com/chart?chxt=x,y&cht=bhs&chco=76A4FB&chls=2.0&chbh=62,4,1&chs=600x416&chxl=-1:|ajv|@exodus/schemasafe|is-my-json-valid|djv|@cfworker/json-schema|jsonschema/=t:100,69.2,51.5,13.1,5.1,1.2)](https://github.com/ebdrup/json-schema-benchmark/blob/master/README.md#performance)
 
 ## Features
 
@@ -144,15 +158,15 @@ const schema = {
   type: "object",
   properties: {
     foo: {type: "integer"},
-    bar: {type: "string"}
+    bar: {type: "string"},
   },
   required: ["foo"],
   additionalProperties: false,
 }
 
 const data = {
   foo: 1,
-  bar: "abc"
+  bar: "abc",
 }
 
 const validate = ajv.compile(schema)

docs/api.md

@@ -149,7 +149,7 @@ Every time this method is called the errors are overwritten so you need to copy
 
 If the schema is asynchronous (has `$async` keyword on the top level) this method returns a Promise. See [Asynchronous validation](./guide/async-validation.md).
 
-<a name="add-schema"></a>
+<a id="add-schema"></a>
 
 ### ajv.addSchema(schema: object | object[], key?: string): Ajv
 
@@ -245,13 +245,13 @@ Formats can be also added via `formats` option.
 
 <a name="api-addkeyword"></a>
 
-### ajv.addKeyword(definition: object): Ajv
+### ajv.addKeyword(definition: string | object): Ajv
 
 Add validation keyword to Ajv instance.
 
 Keyword should be different from all standard JSON Schema keywords and different from previously defined keywords. There is no way to redefine keywords or to remove keyword definition from the instance.
 
-Keyword must start with a letter, `_` or `$`, and may continue with letters, numbers, `_`, `$`, or `-`.
+Keyword must start with an ASCII letter, `_` or `$`, and may continue with ASCII letters, numbers, `_`, `$`, `-`, or `:`.
 It is recommended to use an application-specific prefix for keywords to avoid current and future name collisions.
 
 Example Keywords:
@@ -297,6 +297,8 @@ interface KeywordDefinition {
 }
 ```
 
+If only the property `keyword` is provided in the definition object, you can also pass the keyword name as the argument.
+
 `compile`, `macro` and `code` are mutually exclusive, only one should be used at a time. `validate` can be used separately or in addition to `compile` or `macro` to support [\$data reference](./guide/combining-schemas.md#data-reference).
 
 ::: tip Keyword is validated only for applicable data types

docs/guide/combining-schemas.md

@@ -41,7 +41,7 @@ const ajv = new Ajv()
 const validate = ajv.addSchema(defsSchema).compile(schema)
 ```
 
-See [Options](./api.md#options) and [addSchema](./api.md#add-schema) method.
+See [Options](../options.md) and [addSchema](../api.md#add-schema) method.
 
 ::: tip Reference resolution
 - `$ref` is resolved as the uri-reference using schema \$id as the base URI (see the example).

docs/guide/getting-started.md

@@ -8,7 +8,7 @@
 You can try Ajv without installing it in the Node.js REPL: [https://runkit.com/npm/ajv](https://runkit.com/npm/ajv)
 :::
 
-To install Ajv version 7:
+To install Ajv version 8:
 
 ```bash
 npm install ajv
@@ -140,8 +140,8 @@ const parse = ajv.compileParser(schema)
 const json = '{"foo": 1, "bar": "abc"}'
 const invalidJson = '{"unknown": "abc"}'
 
-console.log(parseAndLog(json)) // logs {foo: 1, bar: "abc"}
-console.log(parseAndLog(invalidJson)) // logs error and position
+parseAndLog(json) // logs {foo: 1, bar: "abc"}
+parseAndLog(invalidJson) // logs error and position
 
 function parseAndLog(json) {
   const data = parse(json)

docs/guide/managing-schemas.md

@@ -88,7 +88,7 @@ app.post("/user", async (cxt) => {
 </code-group>
 
 ::: warning Use single Ajv instance
-It recommended to use a single Ajv instance for the whole application, so if you use validation in more than one module, you should:
+It is recommended to use a single Ajv instance for the whole application, so if you use validation in more than one module, you should:
 
 - require Ajv in a separate module responsible for validation
 - compile all validators there
@@ -186,7 +186,7 @@ In the example above, the key passed to the `addSchema` method was used to retri
 
 ### Pre-adding all schemas vs adding on demand
 
-In the example above all schemas were added in advance. It is also possible, to add schemas as they are used - it can be helpful if there is many schemas. In this case, you need to check first whether the schema is already added by calling `getSchema` method - it would return `undefined` if not:
+In the example above all schemas were added in advance. It is also possible, to add schemas as they are used - it can be helpful if there are many schemas. In this case, you need to check first whether the schema is already added by calling `getSchema` method - it would return `undefined` if not:
 
 ```javascript
 const schema_user = require("./schema_user.json")

docs/guide/modifying-data.md

@@ -154,7 +154,7 @@ See [discriminator](../json-schema.md#discriminator) keyword.
 
 ## Assigning defaults
 
-With [option `useDefaults`](./api.md#options) Ajv will assign values from `default` keyword in the schemas of `properties` and `items` (when it is the array of schemas) to the missing properties and items.
+With [option `useDefaults`](./options.md#options) Ajv will assign values from `default` keyword in the schemas of `properties` and `items` (when it is the array of schemas) to the missing properties and items.
 
 With the option value `"empty"` properties and items equal to `null` or `""` (empty string) will be considered missing and assigned defaults.
 
@@ -210,7 +210,7 @@ With `useDefaults` option `default` keywords throws exception during schema comp
 
 The strict mode option can change the behaviour for these unsupported defaults (`strict: false` to ignore them, `"log"` to log a warning).
 
-See [Strict mode](./strict-mode.md).
+See [Strict mode](../strict-mode.md).
 
 ::: tip Default with discriminator keyword
 Defaults will be assigned in schemas inside `oneOf` in case [discriminator](../json-schema.md#discriminator) keyword is used.

docs/guide/schema-language.md

@@ -2,6 +2,7 @@
 tags:
   - JTD
 ---
+
 # Choosing schema language
 
 [[toc]]
@@ -70,7 +71,7 @@ Draft-2019-09 support is provided via a separate export in order to avoid increa
 With this import Ajv supports the following features:
 
 - keywords [`unevaluatedProperties`](../json-schema.md#unevaluatedproperties) and [`unevaluatedItems`](../json-schema.md#unevaluateditems)
-- keywords [`dependentRequired`](../json-schema.md#dependentrequired), [`dependentSchemas`](../json-schema.md#dependentschemas), [`maxContains`/`minContain`](../json-schema.md#maxcontains--mincontains)
+- keywords [`dependentRequired`](../json-schema.md#dependentrequired), [`dependentSchemas`](../json-schema.md#dependentschemas), [`maxContains`/`minContains`](../json-schema.md#maxcontains-mincontains)
 - dynamic recursive references with [`recursiveAnchor`/`recursiveReference`] - see [Extending recursive schemas](./combining-schemas.md#extending-recursive-schemas)
 - draft-2019-09 meta-schema is the default.
 
@@ -123,17 +124,19 @@ See [JSON Schema](../json-schema.md) for more information and the list of define
 - Defines the shape of JSON data via strictly defined schema forms (rather than the collection of restrictions).
 - Effective support for tagged unions.
 - Designed to protect against user mistakes.
-- Supports compilation of schemas to efficient [serializers and parsers](./getting-started.md#parsing-and-serializing-json) (no need to validate as a separate step)
-- Approved as [RFC8927](https://datatracker.ietf.org/doc/rfc8927/)
+- Supports compilation of schemas to efficient [serializers and parsers](./getting-started.md#parsing-and-serializing-json) (no need to validate as a separate step).
+- Approved as [RFC8927](https://datatracker.ietf.org/doc/rfc8927/).
+- Substantial industry adoption since it was standardized in 2020, Ajv v8.12.0 fixed all reported JTD bugs.
 
 **Cons**:
 
-- Limited, compared with JSON Schema - no support for untagged unions<sup>\*</sup>, conditionals, references between different schema files<sup>\*\*</sup>, etc.
-- No meta-schema in the specification<sup>\*</sup>.
-- Brand new - limited industry adoption (as of January 2021).
+- Limited, compared with JSON Schema - no support for untagged unions<sup>1</sup>, conditionals, references between different schema files<sup>2</sup>, etc.
+- No meta-schema in the specification<sup>3</sup>.
+
+<sup>1</sup> Ajv defines non-standard keyword "union" that can be used inside "metadata" object.
 
-<sup>\*</sup> Ajv defines meta-schema for JTD schemas and non-standard keyword "union" that can be used inside "metadata" object.
+<sup>2</sup> You can still combine schemas from multiple files in the application code.
 
-<sup>\*\*</sup> You can still combine schemas from multiple files in the application code.
+<sup>3</sup> Ajv defines meta-schema for JTD schemas.
 
 See [JSON Type Definition](../json-type-definition.md) for more information and the list of defined schema forms.

docs/json-schema.md

@@ -280,6 +280,10 @@ The value of the keyword should be a number. The data to be valid should be a mu
 
 ### `maxLength` / `minLength`
 
+::: warning Grapheme clusters will count as multiple characters
+Certain charsets have characters that are made up of multiple Unicode code points. These [grapheme clusters](https://www.unicode.org/reports/tr29/tr29-17.html#Grapheme_Cluster_Boundaries) are counted as multiple in length calculations.
+:::
+
 The value of the keywords should be a number. The data to be valid should have length satisfying this rule. Unicode pairs are counted as a single character.
 
 **Examples**
@@ -474,11 +478,11 @@ To create and equivalent schema in draft-2020-12 use keywords [prefixItems](#pre
 
 The value of the keyword should be a boolean or an object.
 
-If `items` keyword is not present or it is an object, `additionalItems` keyword should be ignored regardless of its value. By default Ajv will throw exception in this case - see [Strict mode](./strict-mode.md)
+`additionalItems` keyword is ignored if `items` keyword is not present or is an object. By default Ajv will throw exception in this case - see [Strict mode](./strict-mode.md)
 
-If `items` keyword is an array and data array has not more items than the length of `items` keyword value, `additionalItems` keyword is also ignored.
+`additionalItems` keyword is ignored if `items` keyword has more elements than data array.
 
-If the length of data array is bigger than the length of "items" keyword value than the result of the validation depends on the value of `additionalItems` keyword:
+If the data array has more elements than the `items` keyword value then the result of the validation depends on the value of `additionalItems` keyword:
 
 - `false`: data is invalid
 - `true`: data is valid

docs/json-type-definition.md

@@ -416,6 +416,10 @@ Any user-defined keywords that can be used in JSON Schema schemas can also be us
 It is strongly recommended to only use it to simplify migration from JSON Schema to JTD and not to use non-standard keywords in the new schemas, as these keywords are not supported by any other tools.
 :::
 
+::: warning Parsing does NOT support non-standard JTD keywords
+compileParser method does not support non-standard JTD keywords, you will have to use JSON.parse and then validates.
+:::
+
 ## Validation errors
 
 TODO

docs/keywords.md

@@ -239,7 +239,7 @@ ajv.addKeyword({
 })
 ```
 
-Macro keywords an be recursive - i.e. return schemas containing the same keyword. See the example of defining a recursive macro keyword `deepProperties` in the [test](https://github.com/ajv-validator/ajv/blob/master/spec/keyword.spec.ts#L316).
+Macro keywords can be recursive - i.e. return schemas containing the same keyword. See the example of defining a recursive macro keyword `deepProperties` in the [test](https://github.com/ajv-validator/ajv/blob/master/spec/keyword.spec.ts#L316).
 
 ## Schema compilation context