fast-json-stringify 2.4.1 → 2.5.2

package/.github/dependabot.yml

@@ -1,8 +1,12 @@
 version: 2
 updates:
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
   - package-ecosystem: npm
     directory: '/'
     schedule:
       interval: daily
     open-pull-requests-limit: 10
-

package/.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v2.1.5
       with:
         node-version: ${{ matrix.node-version }}
     - name: Install Dependencies
@@ -21,7 +21,7 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: fastify/github-action-merge-dependabot@v1
+      - uses: fastify/github-action-merge-dependabot@v1.2.1
         if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request' }}
         with:
           github-token: ${{secrets.github_token}}

package/README.md

@@ -30,6 +30,7 @@ fast-json-stringify obj x 13,537,123 ops/sec ±0.19% (95 runs sampled)
 
 #### Table of contents:
 - <a href="#example">`Example`</a>
+- <a href="#options">`Options`</a>
 - <a href="#api">`API`</a>
  - <a href="#fastJsonStringify">`fastJsonStringify`</a>
  - <a href="#specific">`Specific use cases`</a>
@@ -48,6 +49,7 @@ fast-json-stringify obj x 13,537,123 ops/sec ±0.19% (95 runs sampled)
 
 
 <a name="example"></a>
+Try it out on RunKit: <a href="https://runkit.com/npm/fast-json-stringify">https://runkit.com/npm/fast-json-stringify</a>
 ## Example
 
 ```js
@@ -79,13 +81,32 @@ console.log(stringify({
   reg: /"([^"]|\\")*"/
 }))
 ```
+
+<a name="options"></a>
+## Options
+
+Optionally, you may provide to `fast-json-stringify` an option object as second parameter:
+
+```js
+const fastJson = require('fast-json-stringify')
+const stringify = fastJson(mySchema, {
+  schema: { ... },
+  ajv: { ... },
+  rounding: 'ceil'
+})
+```
+
+- `schema`: external schemas references by $ref property. [More details](#ref)
+- `ajv`: ajv instance's settings for those properties that require `ajv`. [More details](#anyof)
+- `rounding`: setup how the `integer` types will be rounded when not integers. [More details](#integer)
+
+
 <a name="api"></a>
 ## API
 <a name="fastJsonStringify"></a>
 ### fastJsonStringify(schema)
 
-Build a `stringify()` function based on
-[jsonschema](http://json-schema.org/).
+Build a `stringify()` function based on [jsonschema](http://json-schema.org/).
 
 Supported types:
 

package/index.js

@@ -4,6 +4,8 @@
 
 const Ajv = require('ajv')
 const merge = require('deepmerge')
+const clone = require('rfdc')({ proto: true })
+const fjsCloned = Symbol('fast-json-stringify.cloned')
 
 const validate = require('./schema-validator')
 let stringSimilarity = null
@@ -442,6 +444,11 @@ function addPatternProperties (location) {
           ${addComma}
           json += $asString(keys[i]) + ':' + $asBoolean(obj[keys[i]])
       `
+    } else if (type === undefined) {
+      code += `
+          ${addComma}
+          json += $asString(keys[i]) + ':' + $asAny(obj[keys[i]])
+      `
     } else {
       code += `
         throw new Error('Cannot coerce ' + obj[keys[i]] + ' to ' + ${JSON.stringify(type)})
@@ -468,7 +475,7 @@ function additionalProperty (location) {
   let code = ''
   if (ap === true) {
     return `
-        if (obj[keys[i]] !== undefined) {
+        if (obj[keys[i]] !== undefined && typeof obj[keys[i]] !== 'function' && typeof obj[keys[i]] !== 'symbol') {
           ${addComma}
           json += $asString(keys[i]) + ':' + JSON.stringify(obj[keys[i]])
         }
@@ -535,6 +542,11 @@ function additionalProperty (location) {
         ${addComma}
         json += $asString(keys[i]) + ':' + $asBoolean(obj[keys[i]])
     `
+  } else if (type === undefined) {
+    code += `
+        ${addComma}
+        json += $asString(keys[i]) + ':' + $asAny(obj[keys[i]])
+    `
   } else {
     code += `
         throw new Error('Cannot coerce ' + obj[keys[i]] + ' to ' + ${JSON.stringify(type)})
@@ -945,7 +957,7 @@ function buildObject (location, code, name) {
 }
 
 function buildArray (location, code, name, key = null) {
-  const schema = location.schema
+  let schema = location.schema
   code += `
     function ${name} (obj) {
   `
@@ -967,6 +979,10 @@ function buildArray (location, code, name, key = null) {
   }
 
   if (schema.items.$ref) {
+    if (!schema[fjsCloned]) {
+      schema = clone(location.schema)
+      schema[fjsCloned] = true
+    }
     location = refFinder(schema.items.$ref, location)
     schema.items = location.schema
   }
@@ -1059,6 +1075,12 @@ function buildArrayTypeCondition (type, accessor) {
 }
 
 function dereferenceOfRefs (location, type) {
+  if (!location.schema[fjsCloned]) {
+    const schemaClone = clone(location.schema)
+    schemaClone[fjsCloned] = true
+    location.schema = schemaClone
+  }
+
   const schema = location.schema
   const locations = []
 
@@ -1183,7 +1205,7 @@ function nested (laterCode, name, key, location, subKey, isArray) {
 
           // see comment on anyOf about derefencing the schema before calling ajv.validate
           code += `
-            ${index === 0 ? 'if' : 'else if'}(ajv.validate(${require('util').inspect(location.schema, { depth: null, maxArrayLength: null })}, obj${accessor}))
+            ${index === 0 ? 'if' : 'else if'}(ajv.validate(${JSON.stringify(location.schema)}, obj${accessor}))
               ${nestedResult.code}
           `
           laterCode = nestedResult.laterCode
@@ -1197,7 +1219,7 @@ function nested (laterCode, name, key, location, subKey, isArray) {
         `
       } else if ('const' in schema) {
         code += `
-          if(ajv.validate(${require('util').inspect(schema, { depth: null })}, obj${accessor}))
+          if(ajv.validate(${JSON.stringify(schema)}, obj${accessor}))
             json += '${JSON.stringify(schema.const)}'
           else
             throw new Error(\`Item $\{JSON.stringify(obj${accessor})} does not match schema definition.\`)

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "fast-json-stringify",
-  "version": "2.4.1",
+  "version": "2.5.2",
   "description": "Stringify your JSON at max speed",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
     "benchmark": "node bench.js",
+    "lint:fix": "standard --fix",
     "test:lint": "standard",
     "test:typescript": "tsc --project ./test/types/tsconfig.json",
     "test:unit": "tap -J test/*.test.js test/**/*.test.js",
@@ -45,6 +46,7 @@
   "dependencies": {
     "ajv": "^6.11.0",
     "deepmerge": "^4.2.2",
+    "rfdc": "^1.2.0",
     "string-similarity": "^4.0.1"
   },
   "engines": {
@@ -54,5 +56,6 @@
     "ignore": [
       "schema-validator.js"
     ]
-  }
+  },
+  "runkitExampleFilename": "example.js"
 }

package/test/additionalProperties.test.js

@@ -161,6 +161,31 @@ test('additionalProperties - array coerce', (t) => {
   t.equal('{"foo":["t","r","u","e"],"ofoo":[],"arrfoo":["1","2"],"objfoo":[]}', stringify(obj))
 })
 
+test('additionalProperties with empty schema', (t) => {
+  t.plan(1)
+  const stringify = build({
+    type: 'object',
+    additionalProperties: {}
+  })
+
+  const obj = { a: 1, b: true, c: null }
+  t.equal('{"a":1,"b":true,"c":null}', stringify(obj))
+})
+
+test('additionalProperties with nested empty schema', (t) => {
+  t.plan(1)
+  const stringify = build({
+    type: 'object',
+    properties: {
+      data: { type: 'object', additionalProperties: {} }
+    },
+    required: ['data']
+  })
+
+  const obj = { data: { a: 1, b: true, c: null } }
+  t.equal('{"data":{"a":1,"b":true,"c":null}}', stringify(obj))
+})
+
 test('nested additionalProperties', (t) => {
   t.plan(1)
   const stringify = build({
@@ -284,3 +309,20 @@ test('property without type but with enum, will acts as additionalProperties wit
   const obj = { ap: { additional: 'field' } }
   t.equal('{"ap":{}}', stringify(obj))
 })
+
+test('function and symbol references are not serialized as undefined', (t) => {
+  t.plan(1)
+  const stringify = build({
+    title: 'additionalProperties',
+    type: 'object',
+    additionalProperties: true,
+    properties: {
+      str: {
+        type: 'string'
+      }
+    }
+  })
+
+  const obj = { str: 'x', test: 'test', meth: () => 'x', sym: Symbol('x') }
+  t.equal('{"str":"x","test":"test"}', stringify(obj))
+})

package/test/side-effect.test.js

@@ -0,0 +1,157 @@
+'use strict'
+
+const { test } = require('tap')
+const clone = require('rfdc/default')
+const build = require('..')
+
+test('oneOf with $ref should not change the input schema', t => {
+  t.plan(2)
+
+  const referenceSchema = {
+    $id: 'externalId',
+    type: 'object',
+    properties: {
+      name: { type: 'string' }
+    }
+  }
+
+  const schema = {
+    $id: 'mainSchema',
+    type: 'object',
+    properties: {
+      people: {
+        oneOf: [{ $ref: 'externalId' }]
+      }
+    }
+  }
+  const clonedSchema = clone(schema)
+  const stringify = build(schema, {
+    schema: {
+      [referenceSchema.$id]: referenceSchema
+    }
+  })
+
+  const value = stringify({ people: { name: 'hello', foo: 'bar' } })
+  t.is(value, '{"people":{"name":"hello"}}')
+  t.deepEqual(schema, clonedSchema)
+})
+
+test('oneOf and anyOf with $ref should not change the input schema', t => {
+  t.plan(3)
+
+  const referenceSchema = {
+    $id: 'externalSchema',
+    type: 'object',
+    properties: {
+      name: { type: 'string' }
+    }
+  }
+
+  const schema = {
+    $id: 'rootSchema',
+    type: 'object',
+    properties: {
+      people: {
+        oneOf: [{ $ref: 'externalSchema' }]
+      },
+      love: {
+        anyOf: [
+          { $ref: '#/definitions/foo' },
+          { type: 'boolean' }
+        ]
+      }
+    },
+    definitions: {
+      foo: { type: 'string' }
+    }
+  }
+  const clonedSchema = clone(schema)
+  const stringify = build(schema, {
+    schema: {
+      [referenceSchema.$id]: referenceSchema
+    }
+  })
+
+  const valueAny1 = stringify({ people: { name: 'hello', foo: 'bar' }, love: 'music' })
+  const valueAny2 = stringify({ people: { name: 'hello', foo: 'bar' }, love: true })
+
+  t.equal(valueAny1, '{"people":{"name":"hello"},"love":"music"}')
+  t.equal(valueAny2, '{"people":{"name":"hello"},"love":true}')
+  t.deepEqual(schema, clonedSchema)
+})
+
+test('multiple $ref tree', t => {
+  t.plan(2)
+
+  const referenceDeepSchema = {
+    $id: 'deepId',
+    type: 'number'
+  }
+
+  const referenceSchema = {
+    $id: 'externalId',
+    type: 'object',
+    properties: {
+      name: { $ref: '#/definitions/foo' },
+      age: { $ref: 'deepId' }
+    },
+    definitions: {
+      foo: { type: 'string' }
+    }
+  }
+
+  const schema = {
+    $id: 'mainSchema',
+    type: 'object',
+    properties: {
+      people: {
+        oneOf: [{ $ref: 'externalId' }]
+      }
+    }
+  }
+  const clonedSchema = clone(schema)
+  const stringify = build(schema, {
+    schema: {
+      [referenceDeepSchema.$id]: referenceDeepSchema,
+      [referenceSchema.$id]: referenceSchema
+    }
+  })
+
+  const value = stringify({ people: { name: 'hello', foo: 'bar', age: 42 } })
+  t.is(value, '{"people":{"name":"hello","age":42}}')
+  t.deepEqual(schema, clonedSchema)
+})
+
+test('must not mutate items $ref', t => {
+  t.plan(2)
+
+  const referenceSchema = {
+    $id: 'ShowSchema',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    type: 'object',
+    properties: {
+      name: {
+        type: 'string'
+      }
+    }
+  }
+
+  const schema = {
+    $id: 'ListSchema',
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    type: 'array',
+    items: {
+      $ref: 'ShowSchema#'
+    }
+  }
+  const clonedSchema = clone(schema)
+  const stringify = build(schema, {
+    schema: {
+      [referenceSchema.$id]: referenceSchema
+    }
+  })
+
+  const value = stringify([{ name: 'foo' }])
+  t.is(value, '[{"name":"foo"}]')
+  t.deepEqual(schema, clonedSchema)
+})