.github/CODEOWNERS

@@ -0,0 +1 @@
+@epoberezkin

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: 14
           registry-url: https://registry.npmjs.org/

.gitignore

@@ -42,7 +42,9 @@ package-lock.json
 
 spec/_json/*.js
 
+# docs
 docs/README.md
 docs/code_of_conduct.md
 docs/contributing.md
 docs/license.md
+docs/.vuepress/components/Contributors/

CONTRIBUTING.md

@@ -6,7 +6,7 @@ permalink: /contributing
 
 Thank you for your help making Ajv better! Every contribution is appreciated. There are many areas where you can contribute.
 
-::: tip Please note
+::: tip Submit issue first
 If you plan to implement a new feature or some other change please create an issue first, to make sure that your work is not lost.
 :::
 

README.md

@@ -4,12 +4,13 @@
 
 # Ajv: Another JSON schema validator
 
-Super fast JSON schema validator for Node.js and browser.
+Super fast JSON validator for Node.js and browser.
 
 Supports JSON Schema draft-06/07/2019-09 (draft-04 is supported in [version 6](https://github.com/ajv-validator/ajv/tree/v6)) 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)
 [![npm](https://img.shields.io/npm/v/ajv.svg)](https://www.npmjs.com/package/ajv)
+[![npm (beta)](https://img.shields.io/npm/v/ajv/beta)](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)
 [![Gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
@@ -54,6 +55,8 @@ At Ajv, we are committed to creating more equitable and inclusive spaces for our
 
 We strive to create an environment of respect and healthy discourse by setting standards for our interactions and we expect it from all members of our community - from long term project member to first time visitor. For more information, review our [code of conduct](./CODE_OF_CONDUCT.md) and values.
 
+<Contributors />
+
 ### How we make decisions
 
 We value conscious curation of our library size, and balancing performance and functionality. To that end, we cannot accept every suggestion. When evaluating pull requests we consider:
@@ -242,7 +245,7 @@ const valid = validate(data)
 if (!valid) console.log(validate.errors)
 ```
 
-See more examples in [Guide: getting started](./docs/guide/getting-started)
+See more examples in [Guide: getting started](./docs/guide/getting-started.md)
 
 ## Extending Ajv
 

docs/.vuepress/components/Contributors.vue

@@ -0,0 +1,37 @@
+<template>
+  <div>
+    <a
+      v-for="(contributor, i) in contributors"
+      class="contributor"
+      :style="'background-position: ' + (100 * i) / (contributors.length - 1) + '% 0'"
+      :href="'https://github.com/' + contributor"
+    >
+      {{ contributor }}
+    </a>
+  </div>
+</template>
+
+<script>
+import contributors from "./Contributors/_contributors.js"
+export default {
+  data() {
+    return {
+      contributors: contributors,
+    }
+  },
+}
+</script>
+
+<style scoped>
+.contributor {
+  width: 2.4em;
+  height: 2.4em;
+  border-radius: 50%;
+  text-indent: -9999px;
+  display: inline-block;
+  background: no-repeat url(./Contributors/contributors.jpg);
+  background-size: auto 102%;
+  margin: 0 0.5em 0.5em 0;
+  border: 2px solid var(--second);
+}
+</style>

docs/.vuepress/components/GitHub.vue

@@ -1,29 +1,32 @@
 <template>
   <ClientOnly>
     <span>
-      <a class="github-button"
+      <a
+        class="github-button"
         href="https://github.com/ajv-validator/ajv"
         data-show-count="true"
         data-size="large"
         aria-label="Star ajv-validator/ajv on GitHub"
-        >Star</a>
+      >
+        Star
+      </a>
     </span>
   </ClientOnly>
 </template>
 
 <script>
-  export default {
-    mounted() {
-      let githubScript = document.createElement("script")
-      githubScript.setAttribute("src", "https://buttons.github.io/buttons.js")
-      document.head.appendChild(githubScript)
-    }
-  }
+export default {
+  mounted() {
+    let githubScript = document.createElement("script")
+    githubScript.setAttribute("src", "https://buttons.github.io/buttons.js")
+    document.head.appendChild(githubScript)
+  },
+}
 </script>
 
 <style scoped>
-  span {
-    vertical-align: -8px;
-    padding-left: 20px;
-  }
+span {
+  vertical-align: -8px;
+  padding-left: 20px;
+}
 </style>

docs/.vuepress/components/RecFeatures.vue

@@ -0,0 +1,79 @@
+<template>
+  <div>
+    <div class="rec" id="less-code">
+      <p class="header">Write less code</p>
+      <p class="text">Ensure your data is valid once it's received</p>
+    </div>
+
+    <div class="rec" id="fast-and-secure">
+      <p class="header">Super fast and secure</p>
+      <p class="text">The fastest and the most secure JSON validator</p>
+    </div>
+
+    <div class="rec" id="multi-spec">
+      <p class="header">Multi-specification</p>
+      <p class="text">Choose your JSON schema standard</p>
+    </div>
+
+    <br class="clearBoth" />
+  </div>
+</template>
+
+<style scoped>
+.rec {
+  display: inline-block;
+  float: left;
+  margin: 10px;
+  width: 430px;
+  height: 300px;
+  border-radius: 8px;
+}
+
+.rec#less-code {
+  background: #007bff;
+}
+
+.rec#fast-and-secure {
+  background: #00a3aa;
+}
+
+.rec#multi-spec {
+  background: #f5775b;
+}
+
+.header {
+  position: relative;
+  width: 359px;
+  height: 39px;
+  left: 30px;
+  top: 30px;
+
+  font-family: Heebo;
+  font-style: normal;
+  font-weight: normal;
+  font-size: 36px;
+  line-height: 39px;
+
+  color: #ffffff;
+}
+
+.text {
+  position: relative;
+  width: 359px;
+  height: 78px;
+  left: 30px;
+  top: 30px;
+
+  font-family: Heebo;
+  font-style: normal;
+  font-weight: normal;
+  font-size: 24px;
+  line-height: 39px;
+
+  color: #ffffff;
+}
+
+.clearBoth {
+  clear: both;
+}
+</style>

docs/HOME.md

@@ -2,6 +2,8 @@
 
 Safety, security and reliability for JavaScript applications
 
+<RecFeatures />
+
 ## Ajv News
 
 This section will include the last update and the headlines of several previous updates, e.g. these sections:
@@ -43,3 +45,5 @@ Try in the playground (TBC)
 ## Contributors
 
 Ajv is free to use and open-source that many developers contributed to. Join us!
+
+<Contributors />

docs/api.md

@@ -84,8 +84,8 @@ const serializeMyData = ajv.compileSerializer(mySchema)
 // it prevents you from accidentally passing the wrong type
 ```
 
-::: warning Please note
-Compiled serializers do NOT validate passed data, it is assumed that the data is valid according to the schema. In the future there may be an option added that would make serializers also validate the data.
+::: warning Compiled serializers do NOT validate data!
+It is assumed that the data is valid according to the schema.
 :::
 
 <a name="jtd-parse"></a>
@@ -113,10 +113,6 @@ console.log(parseMyData.position) // 4
 console.log(parseMyData.message) // property x not allowed
 ```
 
-::: warning Please note
-Generated parsers is a NEW Ajv functionality (as of March 2021), there can be some edge cases that are not handled correctly - please report any issues/submit fixes.
-:::
-
 <sup>\*</sup> As long as empty schema `{}` is not used - there is a possibility to improve performance in this case. Also, the performance of parsing `discriminator` schemas depends on the position of discriminator tag in the schema - the best parsing performance will be achieved if the tag is the first property - this is how compiled JTD serializers generate JSON in case of discriminator schemas.
 
 <a name="api-compileAsync"></a>
@@ -147,7 +143,7 @@ Validation errors will be available in the `errors` property of Ajv instance (`n
 
 In typescript this method can act as a type guard (similarly to function returned by `compile` method - see example there).
 
-::: warning Please note
+::: warning Save errors property
 Every time this method is called the errors are overwritten so you need to copy them to another variable if you want to use them later.
 :::
 
@@ -169,13 +165,12 @@ Although `addSchema` does not compile schemas, explicit compilation is not requi
 
 By default the schema is validated against meta-schema before it is added, and if the schema does not pass validation the exception is thrown. This behaviour is controlled by `validateSchema` option.
 
-::: tip Please note
-Ajv return it instance for method chaining from all methods with the prefix `add*` and `remove*`:
+::: tip Method chaining
+Ajv returns its instance for chaining from all methods prefixed `add*` and `remove*`:
 
 ```javascript
 const validate = new Ajv().addSchema(schema).addFormat(name, regex).getSchema(uri)
 ```
-
 :::
 
 ### ajv.addMetaSchema(schema: object | object[], key?: string): Ajv
@@ -304,7 +299,7 @@ interface KeywordDefinition {
 
 `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 Please note
+::: tip Keyword is validated only for applicable data types
 If the keyword is validating data type that is different from the type(s) in its definition, the validation function will not be called (and expanded macro will not be used), so there is no need to check for data type inside validation function or inside schema returned by macro function (unless you want to enforce a specific type and for some reason do not want to use a separate `type` keyword for that). In the same way as standard keywords work, if the keyword does not apply to the data type being validated, the validation of this keyword will succeed.
 :::
 
@@ -320,7 +315,7 @@ Removes added or pre-defined keyword so you can redefine them.
 
 While this method can be used to extend pre-defined keywords, it can also be used to completely change their meaning - it may lead to unexpected results.
 
-::: warning Please note
+::: warning Compiled schemas and removed keywords
 The schemas compiled before the keyword is removed will continue to work without changes. To recompile schemas use `removeSchema` method and compile them again.
 :::
 
@@ -367,7 +362,7 @@ interface JTDErrorObject {
 
 This error format is used when using JTD schemas. To simplify usage, you may still generate Ajv error objects using `ajvErrors` option. You can also add a human-readable error message to error objects using option `messages`.
 
-::: warning Please note
+::: warning JTD errors are not fully spec-compliant
 Ajv is not fully consistent with JTD regarding the error objects in some scenarios - it will be consistent by the time Ajv version 8 is released. Therefore it is not recommended yet to use error objects for any advanced application logic.
 :::
 

docs/codegen.md

@@ -68,7 +68,7 @@ CodeGen class generates code trees and performs several optimizations before the
 2. removes unused variable declarations.
 3. replaces variables that are used only once and assigned expressions that are explicitly marked as "constant" (i.e. having referential transparency) with the expressions themselves.
 
-::: warning Please note
+::: warning Optimizations assume no side effects
 These optimizations assume that the expressions in `if` conditions, `for` statement headers and assigned expressions are free of any side effects - this is the case for all pre-defined validation keywords.
 :::
 
@@ -87,6 +87,6 @@ While tagged template literals wrap passed strings based on their run-time value
 
 It is strongly recommended to define additional keywords only with Typescript - using plain JavaScript would still allow passing unsafe strings to code generation methods.
 
-::: warning Please note
+::: warning Optimization and side-effects
 If your user-defined keywords need to have side-effects that are removed by optimization (see above), you may need to disable it.
 :::

docs/guide/async-validation.md

@@ -4,7 +4,7 @@ You can define formats and keywords that perform validation asynchronously by ac
 
 If your schema uses asynchronous formats/keywords or refers to some schema that contains them it should have `"$async": true` keyword so that Ajv can compile it correctly. If asynchronous format/keyword or reference to asynchronous schema is used in the schema without `$async` keyword Ajv will throw an exception during schema compilation.
 
-::: warning Please note
+::: warning Use $async: true in referenced schemas
 All asynchronous subschemas that are referenced from the current or other schemas should have `"$async": true` keyword as well, otherwise the schema compilation will fail.
 :::
 

docs/guide/combining-schemas.md

@@ -43,16 +43,15 @@ const validate = ajv.addSchema(defsSchema).compile(schema)
 
 See [Options](./api.md#options) and [addSchema](./api.md#add-schema) method.
 
-::: tip Please note
-
+::: tip Reference resolution
 - `$ref` is resolved as the uri-reference using schema \$id as the base URI (see the example).
 - References can be recursive (and mutually recursive) to implement the schemas for different data structures (such as linked lists, trees, graphs, etc.).
 - You don't have to host your schema files at the URIs that you use as schema \$id. These URIs are only used to identify the schemas, and according to JSON Schema specification validators should not expect to be able to download the schemas from these URIs.
 - The actual location of the schema file in the file system is not used.
 - You can pass the identifier of the schema as the second parameter of `addSchema` method or as a property name in `schemas` option. This identifier can be used instead of (or in addition to) schema \$id.
 - You cannot have the same \$id (or the schema identifier) used for more than one schema - the exception will be thrown.
 - You can implement dynamic resolution of the referenced schemas using `compileAsync` method. In this way you can store schemas in any system (files, web, database, etc.) and reference them without explicitly adding to Ajv instance. See [Asynchronous schema compilation](./managing-schemas.md#asynchronous-schema-compilation).
-  :::
+:::
 
 ## Extending recursive schemas
 

docs/guide/environments.md

@@ -73,7 +73,7 @@ This bundle can be used with different module systems; it creates global `ajv`/`
 
 The browser bundles are available on [cdnjs](https://cdnjs.com/libraries/ajv).
 
-::: warning Please note
+::: warning Some frameworks re-define require
 Some frameworks, e.g. Dojo, may redefine global require in a way that is not compatible with CommonJS module format. In this case Ajv bundle has to be loaded before the framework and then you can use global `ajv` (see issue [#234](https://github.com/ajv-validator/ajv/issues/234)).
 :::