Merge branch 'master' into master

ajv-validator · Sep 12, 2021 · 41dd4bc · 41dd4bc
2 parents 698f411 + a9f38cd
commit 41dd4bc
Show file tree

Hide file tree

Showing 27 changed files with 210 additions and 95 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,26 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: "@types/node"
+    versions:
+    - 15.0.0
+  - dependency-name: eslint-config-prettier
+    versions:
+    - 8.0.0
+    - 8.1.0
+    - 8.2.0
+  - dependency-name: karma
+    versions:
+    - 6.0.3
+    - 6.0.4
+    - 6.1.0
+    - 6.1.1
+    - 6.1.2
+    - 6.2.0
+    - 6.3.0
+    - 6.3.1
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -22,13 +22,13 @@ jobs:
           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 }}
+      # - 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

diff --git a/docs/README.md b/docs/README.md
@@ -187,6 +187,7 @@ Ajv stands out as the implementation of choice - it provides a rich API which ma
 [Vega-Lite](https://vega.github.io/vega-lite/)
 [![middy](./projects/middy.png)](https://middy.js.org)
 [JSDoc](https://github.com/jsdoc/jsdoc)
+[![Ts.ED](./projects/tsed.png)](https://tsed.io)
 
 </Projects>
 </HomeSection>

diff --git a/docs/api.md b/docs/api.md
@@ -46,7 +46,7 @@ if (validate(data)) {
 }
 ```
 
-See more advanced example in [the test](../spec/types/json-schema.spec.ts).
+See more advanced example in [the test](https://github.com/ajv-validator/ajv/blob/master/spec/types/json-schema.spec.ts).
 
 <a name="jtd-serialize"></a>
 
@@ -385,7 +385,7 @@ if (validate(data)) {
 }
 ```
 
-Also see an example in [this test](../spec/types/error-parameters.spec.ts)
+Also see an example in [this test](https://github.com/ajv-validator/ajv/blob/master/spec/types/error-parameters.spec.ts)
 
 - `maxItems`, `minItems`, `maxLength`, `minLength`, `maxProperties`, `minProperties`:
 

diff --git a/docs/codegen.md b/docs/codegen.md
@@ -54,7 +54,7 @@ if (num0 > 0) {
 }
 ```
 
-`.const`, `.if` and `.code` above are methods of CodeGen class that generate code inside class instance `gen` - see [source code](https://github.com/ajv-validator/ajv/blob/master/lib/compile/codegen/index.ts) for all available methods and [tests](../spec/codegen.spec.ts) for other code generation examples.
+`.const`, `.if` and `.code` above are methods of CodeGen class that generate code inside class instance `gen` - see [source code](https://github.com/ajv-validator/ajv/blob/master/lib/compile/codegen/index.ts) for all available methods and [tests](https://github.com/ajv-validator/ajv/blob/master/spec/codegen.spec.ts) for other code generation examples.
 
 These methods only accept instances of private class `_Code`, other values will be rejected by Typescript compiler - the risk to pass unsafe string is mitigated on type level.
 
@@ -72,7 +72,7 @@ CodeGen class generates code trees and performs several optimizations before the
 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.
 :::
 
-See [these tests](../spec/codegen.spec.ts) for examples.
+See [these tests](https://github.com/ajv-validator/ajv/blob/master/spec/codegen.spec.ts) for examples.
 
 By default Ajv does 1-pass optimization - based on the test suite it reduces the code size by 10.5% and the number of tree nodes by 16.7% (TODO benchmark the validation time). The second optimization pass changes it by less than 0.1%, so you won't need it unless you have really complex schemas or if you generate standalone code and want it to pass relevant eslint rules.
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -76,7 +76,7 @@ There are several ways to implement the described logic that would allow two pro
 
 This problem is related to the problem explained above - properties treated as additional in the sense of `additionalProperties` keyword, based on `properties`/`patternProperties` keyword in the same schema object.
 
-See the example in [Filtering Data](https://github.com/ajv-validator/ajv#filtering-data) section of readme.
+See the example in the [Removing Additional Data](https://ajv.js.org/guide/modifying-data.html#removing-additional-properties) section of the docs.
 
 ## Generating schemas with resolved references ($ref)
 

diff --git a/docs/guide/async-validation.md b/docs/guide/async-validation.md
@@ -22,7 +22,7 @@ Example:
 const ajv = new Ajv()
 
 ajv.addKeyword({
-  keyword: "idExists"
+  keyword: "idExists",
   async: true,
   type: "number",
   validate: checkIdExists,

diff --git a/docs/guide/combining-schemas.md b/docs/guide/combining-schemas.md
@@ -112,7 +112,7 @@ const ajv = new Ajv2019({
 const validate = ajv.getSchema("https://example.com/strict-tree")
 ```
 
-See [dynamic-refs](../spec/dynamic-ref.spec.ts) test for the example using `$dynamicAnchor`/`$dynamicRef`.
+See [dynamic-refs](https://github.com/ajv-validator/ajv/blob/master/spec/dynamic-ref.spec.ts) test for the example using `$dynamicAnchor`/`$dynamicRef`.
 
 At the moment Ajv implements the spec for dynamic recursive references with these limitations:
 

diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
@@ -127,15 +127,16 @@ const schema = {
 }
 
 const serialize = ajv.compileSerializer(schema)
-console.log(serialize(data))
-
-const parse = ajv.compileParser(schema)
 
 const data = {
   foo: 1,
   bar: "abc"
 }
 
+console.log(serialize(data))
+
+const parse = ajv.compileParser(schema)
+
 const json = '{"foo": 1, "bar": "abc"}'
 const invalidJson = '{"unknown": "abc"}'
 

diff --git a/docs/json-schema.md b/docs/json-schema.md
@@ -290,7 +290,7 @@ The value of the keywords should be a number. The data to be valid should have l
 
     _invalid_: `"abcdef"`
 
-2)  _schema_: `{type: "string", minLength": 2}`
+2)  _schema_: `{type: "string", minLength: 2}`
 
     _valid_: `"ab"`, `"😀😀"`
 
@@ -453,16 +453,16 @@ For the data array to be valid, the items with indices less than the number of s
 
 _schema_:
 
-    ```javascript
-    {
-      type: "array",
-      prefixItems: [{type: "integer"}, {type: "string"}]
-    }
-    ```
+```javascript
+{
+  type: "array",
+  prefixItems: [{type: "integer"}, {type: "string"}]
+}
+```
 
-    _valid_: `[1]`, `[1, "abc"]`, `[1, "abc", 2]`, `[]`
+_valid_: `[1]`, `[1, "abc"]`, `[1, "abc", 2]`, `[]`
 
-    _invalid_: `["abc", 1]`, `["abc"]`
+_invalid_: `["abc", 1]`, `["abc"]`
 
 The schema in example will log warning by default (see `strictTuples` option), because it defines unconstrained tuple. To define a tuple with exactly 2 elements use [minItems](#minitems) and [items](#items-in-draft-2020-12) keywords (see example 2 in [items](#items-in-draft-2020-12)).
 

diff --git a/docs/json-type-definition.md b/docs/json-type-definition.md
@@ -376,7 +376,7 @@ const schema: JTDSchemaType<LinkedList, {node: LinkedList}> = {
 
 ### Notable Omissions
 
-`JTDSchemaType` currently validats that if the schema compiles it will verify an accurate type, but there are a few places with potentially unexpected behavior.
+`JTDSchemaType` currently validates that if the schema compiles it will verify an accurate type, but there are a few places with potentially unexpected behavior.
 `JTDSchemaType` doesn't verify the schema is correct. It won't reject schemas that definitions anywhere by the root, and it won't reject discriminator schemas that still define the descriminator in mapping properties. It also won't verify that enum schemas have every enum member as this isn't generally feasible in typescript yet.
 
 ## Extending JTD

diff --git a/docs/keywords.md b/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](../spec/keyword.spec.ts#L316).
+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).
 
 ## Schema compilation context
 

diff --git a/docs/news/2021-05-24-ajv-online-event-video.md b/docs/news/2021-05-24-ajv-online-event-video.md
@@ -0,0 +1,10 @@
+---
+news: true
+title: Ajv online event video uploaded
+date: 2021-05-24
+more: false
+---
+
+Huge thanks to everybody who joined, and to the speakers! The video of the event is [available on YouTube](https://www.youtube.com/watch?v=KxSKqXEBB7A).
+
+<!-- more -->
diff --git a/docs/news/2021-07-22-ajv-microsoft-foss-fund-award.md b/docs/news/2021-07-22-ajv-microsoft-foss-fund-award.md
@@ -0,0 +1,12 @@
+---
+news: true
+title: Microsoft FOSS award
+date: 2021-07-22
+more: false
+---
+
+Ajv was awarded a sponsorship from [Microsoft FOSS fund](https://github.com/microsoft/foss-fund/blob/main/README.md#2021) - huge thanks to Microsoft and the engineers who voted to support Ajv development. 
+
+This award will contribute to a long term maintenance of Ajv.
+
+<!-- more -->
diff --git a/docs/projects/tsed.png b/docs/projects/tsed.png
diff --git a/docs/standalone.md b/docs/standalone.md
@@ -32,7 +32,7 @@ npm install ajv
 ```javascript
 const Ajv = require("ajv") // version >= v7.0.0
 const ajv = new Ajv({code: {source: true}}) // this option is required to generate standalone code
-const standaloneCode = require("ajv/dist/standalone")
+const standaloneCode = require("ajv/dist/standalone").default
 
 const schema = {
   $id: "https://example.com/object.json",

diff --git a/lib/compile/errors.ts b/lib/compile/errors.ts
@@ -6,7 +6,7 @@ import {getErrorPath, Type} from "./util"
 import N from "./names"
 
 export const keywordError: KeywordErrorDefinition = {
-  message: ({keyword}) => str`should pass "${keyword}" keyword validation`,
+  message: ({keyword}) => str`must pass "${keyword}" keyword validation`,
 }
 
 export const keyword$DataError: KeywordErrorDefinition = {

diff --git a/lib/compile/index.ts b/lib/compile/index.ts
@@ -300,11 +300,12 @@ function getJsonPointer(
 ): SchemaEnv | undefined {
   if (parsedRef.fragment?.[0] !== "/") return
   for (const part of parsedRef.fragment.slice(1).split("/")) {
-    if (typeof schema == "boolean") return
-    schema = schema[unescapeFragment(part)]
-    if (schema === undefined) return
+    if (typeof schema === "boolean") return
+    const partSchema = schema[unescapeFragment(part)]
+    if (partSchema === undefined) return
+    schema = partSchema
     // TODO PREVENT_SCOPE_CHANGE could be defined in keyword def?
-    const schId = typeof schema == "object" && schema[this.opts.schemaId]
+    const schId = typeof schema === "object" && schema[this.opts.schemaId]
     if (!PREVENT_SCOPE_CHANGE.has(part) && schId) {
       baseId = resolveUrl(baseId, schId)
     }

diff --git a/lib/compile/jtd/serialize.ts b/lib/compile/jtd/serialize.ts
@@ -213,7 +213,7 @@ function serializeType(cxt: SerializeCxt): void {
     case "timestamp":
       gen.if(
         _`${data} instanceof Date`,
-        () => gen.add(N.json, _`${data}.toISOString()`),
+        () => gen.add(N.json, _`'"' + ${data}.toISOString() + '"'`),
         () => serializeString(cxt)
       )
       break

diff --git a/lib/runtime/parseJson.ts b/lib/runtime/parseJson.ts
@@ -9,7 +9,7 @@ export function parseJson(s: string, pos: number): unknown {
     parseJson.position = pos + s.length
     return JSON.parse(s)
   } catch (e) {
-    matches = rxParseJson.exec(e.message)
+    matches = rxParseJson.exec((e as Error).message)
     if (!matches) {
       parseJson.message = "unexpected end"
       return undefined
@@ -128,14 +128,16 @@ export function parseJsonString(s: string, pos: number): string | undefined {
         let code = 0
         while (count--) {
           code <<= 4
-          c = s[pos].toLowerCase()
+          c = s[pos]
+          if (c === undefined) {
+            errorMessage("unexpected end")
+            return undefined
+          }
+          c = c.toLowerCase()
           if (c >= "a" && c <= "f") {
             code += c.charCodeAt(0) - CODE_A + 10
           } else if (c >= "0" && c <= "9") {
             code += c.charCodeAt(0) - CODE_0
-          } else if (c === undefined) {
-            errorMessage("unexpected end")
-            return undefined
           } else {
             errorMessage(`unexpected token ${c}`)
             return undefined
@@ -147,6 +149,7 @@ export function parseJsonString(s: string, pos: number): string | undefined {
         errorMessage(`unexpected token ${c}`)
         return undefined
       }
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     } else if (c === undefined) {
       errorMessage("unexpected end")
       return undefined