fast-json-stringify 1.17.0 → 1.20.1

package/.dependabot/config.yml

@@ -0,0 +1,8 @@
+version: 1
+update_configs:
+  - package_manager: "javascript"
+    directory: "/"
+    update_schedule: "daily"
+    ignored_updates:
+      - match:
+          dependency_name: "tap"

package/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI workflow
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [6.x, 8.x, 10.x, 11.x, 12.x, 13.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install Dependencies
+      run: npm install --ignore-scripts
+    - name: Test
+      run: npm run test

package/README.md

@@ -1,6 +1,9 @@
 # fast-json-stringify
 
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)  [![Build Status](https://dev.azure.com/fastify/fastify/_apis/build/status/fastify.fast-json-stringify?branchName=master)](https://dev.azure.com/fastify/fastify/_build/latest?definitionId=3&branchName=master)  [![Build Status](https://travis-ci.org/fastify/fast-json-stringify.svg?branch=master)](https://travis-ci.org/fastify/fast-json-stringify)  [![NPM downloads](https://img.shields.io/npm/dm/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+![Ci Workflow](https://github.com/fastify/fast-json-stringify/workflows/CI%20workflow/badge.svg)
+[![NPM downloads](https://img.shields.io/npm/dm/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
+
 
 __fast-json-stringify__ is significantly faster than `JSON.stringify()` for small payloads. Its performance advantage shrinks as your payload grows. It pairs well with [__flatstr__](https://www.npmjs.com/package/flatstr), which triggers a V8 optimization that improves performance when eventually converting the string to a `Buffer`.
 
@@ -102,11 +105,34 @@ And nested ones, too.
 <a name="specific"></a>
 #### Specific use cases
 
-| Instance   | Serialized as                |
-| -----------|------------------------------|
-| `Date`     | `string` via `toISOString()` |
-| `RegExp`   | `string`                     |
-| `BigInt`   | `integer` via `toString`     |
+| Instance | Serialized as                |
+| -------- | ---------------------------- |
+| `Date`   | `string` via `toISOString()` |
+| `RegExp` | `string`                     |
+| `BigInt` | `integer` via `toString`     |
+
+[JSON Schema built-in formats](https://json-schema.org/understanding-json-schema/reference/string.html#built-in-formats) for dates are supported and will be serialized as:
+
+| Format      | Serialized format example  |
+| ----------- | -------------------------- |
+| `date-time` | `2020-04-03T09:11:08.615Z` |
+| `date`      | `2020-04-03`               |
+| `time`      | `09:11:08`                 |
+
+Example with a MomentJS object:
+
+```javascript
+const moment = require('moment')
+
+const stringify = fastJson({
+  title: 'Example Schema with string date-time field',
+  type: 'string',
+  format: 'date-time'
+}
+
+console.log(stringify(moment())) // '"YYYY-MM-DDTHH:mm:ss.sssZ"'
+```
+
 
 <a name="required"></a>
 #### Required
@@ -441,7 +467,7 @@ const stringify = fastJson(schema, { schema: externalSchema })
 
 <a name="long"></a>
 #### Long integers
-By default the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) from Node.js v10.3 and above.  
+By default the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) from Node.js v10.3 and above.
 If you can't use BigInts in your environment, long integers (64-bit) are also supported using the [long](https://github.com/dcodeIO/long.js) module.
 Example:
 ```javascript
@@ -552,6 +578,31 @@ allowing user input to directly supply a schema.
 It can't be guaranteed that allowing user input for the schema couldn't feasibly expose an attack
 vector.
 
+<a name="debug"></a>
+### Debug Mode
+
+The debug mode can be activated during your development to understand what is going on when things do not
+work as you expect.
+
+```js
+const debugCompiled = fastJson({
+  title: 'default string',
+  type: 'object',
+  properties: {
+    firstName: {
+      type: 'string'
+    }
+  }
+}, { debugMode: true })
+
+console.log(debugCompiled) // it is an array of functions that can create your `stringify` function
+console.log(debugCompiled.toString()) // print a "ready to read" string function, you can save it to a file
+
+const rawString = debugCompiled.toString()
+const stringify = fastJson.restore(rawString) // use the generated string to get back the `stringify` function
+console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
+```
+
 <a name="acknowledgements"></a>
 ## Acknowledgements
 

package/example.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const moment = require('moment')
 const fastJson = require('.')
 const stringify = fastJson({
   title: 'Example Schema',
@@ -18,6 +19,10 @@ const stringify = fastJson({
     now: {
       type: 'string'
     },
+    birthdate: {
+      type: ['string'],
+      format: 'date-time'
+    },
     reg: {
       type: 'string'
     },
@@ -48,6 +53,10 @@ const stringify = fastJson({
     },
     test: {
       type: 'number'
+    },
+    date: {
+      type: 'string',
+      format: 'date-time'
     }
   },
   additionalProperties: {
@@ -60,10 +69,12 @@ console.log(stringify({
   lastName: 'Collina',
   age: 32,
   now: new Date(),
+  birthdate: moment(),
   reg: /"([^"]|\\")*"/,
   foo: 'hello',
   numfoo: 42,
   test: 42,
+  date: moment(),
   strtest: '23',
   arr: [{ str: 'stark' }, { str: 'lannister' }],
   obj: { bool: true },

package/index.js

@@ -4,6 +4,7 @@
 
 var Ajv = require('ajv')
 var merge = require('deepmerge')
+
 var util = require('util')
 var validate = require('./schema-validator')
 var stringSimilarity = null
@@ -52,9 +53,13 @@ function build (schema, options) {
   `
 
   code += `
+    ${$pad2Zeros.toString()}
     ${$asString.toString()}
     ${$asStringNullable.toString()}
     ${$asStringSmall.toString()}
+    ${$asDatetime.toString()}
+    ${$asDate.toString()}
+    ${$asTime.toString()}
     ${$asNumber.toString()}
     ${$asNumberNullable.toString()}
     ${$asIntegerNullable.toString()}
@@ -94,7 +99,7 @@ function build (schema, options) {
       code = buildObject(schema, code, main, options.schema, fullSchema)
       break
     case 'string':
-      main = schema.nullable ? $asStringNullable.name : $asString.name
+      main = schema.nullable ? $asStringNullable.name : getStringSerializer(schema.format)
       break
     case 'integer':
       main = schema.nullable ? $asIntegerNullable.name : $asInteger.name
@@ -127,12 +132,20 @@ function build (schema, options) {
 
   var dependencies = []
   var dependenciesName = []
-  if (hasAnyOf(schema) || hasSchemaSomeIf) {
+  if (hasOf(schema) || hasSchemaSomeIf) {
     dependencies.push(new Ajv(options.ajv))
     dependenciesName.push('ajv')
   }
 
   dependenciesName.push(code)
+
+  if (options.debugMode) {
+    dependenciesName.toString = function () {
+      return dependenciesName.join('\n')
+    }
+    return dependenciesName
+  }
+
   return (Function.apply(null, dependenciesName).apply(null, dependencies))
 }
 
@@ -189,15 +202,15 @@ function inferTypeByKeyword (schema) {
   return schema.type
 }
 
-function hasAnyOf (schema) {
+function hasOf (schema) {
   if (!schema) { return false }
-  if ('anyOf' in schema) { return true }
+  if ('anyOf' in schema || 'oneOf' in schema) { return true }
 
   var objectKeys = Object.keys(schema)
   for (var i = 0; i < objectKeys.length; i++) {
     var value = schema[objectKeys[i]]
     if (typeof value === 'object') {
-      if (hasAnyOf(value)) { return true }
+      if (hasOf(value)) { return true }
     }
   }
 
@@ -209,6 +222,21 @@ function hasIf (schema) {
   return /"if":{/.test(str) && /"then":{/.test(str)
 }
 
+const stringSerializerMap = {
+  'date-time': '$asDatetime',
+  date: '$asDate',
+  time: '$asTime'
+}
+
+function getStringSerializer (format) {
+  return stringSerializerMap[format] || '$asString'
+}
+
+function $pad2Zeros (num) {
+  var s = '00' + num
+  return s[s.length - 2] + s[s.length - 1]
+}
+
 function $asNull () {
   return 'null'
 }
@@ -248,6 +276,42 @@ function $asBooleanNullable (bool) {
   return bool === null ? null : $asBoolean(bool)
 }
 
+function $asDatetime (date) {
+  if (date instanceof Date) {
+    return '"' + date.toISOString() + '"'
+  } else if (date && typeof date.toISOString === 'function') {
+    return '"' + date.toISOString() + '"'
+  } else {
+    return $asString(date)
+  }
+}
+
+function $asDate (date) {
+  if (date instanceof Date) {
+    var year = new Intl.DateTimeFormat('en', { year: 'numeric' }).format(date)
+    var month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(date)
+    var day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(date)
+    return '"' + year + '-' + month + '-' + day + '"'
+  } else if (date && typeof date.format === 'function') {
+    return '"' + date.format('YYYY-MM-DD') + '"'
+  } else {
+    return $asString(date)
+  }
+}
+
+function $asTime (date) {
+  if (date instanceof Date) {
+    var hour = new Intl.DateTimeFormat('en', { hour: 'numeric', hour12: false }).format(date)
+    var minute = new Intl.DateTimeFormat('en', { minute: 'numeric' }).format(date)
+    var second = new Intl.DateTimeFormat('en', { second: 'numeric' }).format(date)
+    return '"' + $pad2Zeros(hour) + ':' + $pad2Zeros(minute) + ':' + $pad2Zeros(second) + '"'
+  } else if (date && typeof date.format === 'function') {
+    return '"' + date.format('HH:mm:ss') + '"'
+  } else {
+    return $asString(date)
+  }
+}
+
 function $asString (str) {
   if (str instanceof Date) {
     return '"' + str.toISOString() + '"'
@@ -317,6 +381,8 @@ function addPatternProperties (schema, externalSchema, fullSchema) {
       pp[regex] = refFinder(pp[regex].$ref, fullSchema, externalSchema)
     }
     var type = pp[regex].type
+    var format = pp[regex].format
+    var stringSerializer = getStringSerializer(format)
     code += `
         if (/${regex.replace(/\\*\//g, '\\/')}/.test(keys[i])) {
     `
@@ -340,7 +406,7 @@ function addPatternProperties (schema, externalSchema, fullSchema) {
     } else if (type === 'string') {
       code += `
           ${addComma}
-          json += $asString(keys[i]) + ':' + $asString(obj[keys[i]])
+          json += $asString(keys[i]) + ':' + ${stringSerializer}(obj[keys[i]])
       `
     } else if (type === 'integer') {
       code += `
@@ -394,6 +460,8 @@ function additionalProperty (schema, externalSchema, fullSchema) {
   }
 
   var type = ap.type
+  var format = ap.format
+  var stringSerializer = getStringSerializer(format)
   if (type === 'object') {
     code += buildObject(ap, '', 'buildObjectAP', externalSchema)
     code += `
@@ -414,7 +482,7 @@ function additionalProperty (schema, externalSchema, fullSchema) {
   } else if (type === 'string') {
     code += `
         ${addComma}
-        json += $asString(keys[i]) + ':' + $asString(obj[keys[i]])
+        json += $asString(keys[i]) + ':' + ${stringSerializer}(obj[keys[i]])
     `
   } else if (type === 'integer') {
     code += `
@@ -903,12 +971,12 @@ function buildArrayTypeCondition (type, accessor) {
   return condition
 }
 
-function dereferenceAnyOfRefs (schema, externalSchema, fullSchema) {
-  schema.anyOf.forEach((s, index) => {
+function dereferenceOfRefs (schema, externalSchema, fullSchema, type) {
+  schema[type].forEach((s, index) => {
     // follow the refs
     while (s.$ref) {
-      schema.anyOf[index] = refFinder(s.$ref, fullSchema, externalSchema)
-      s = schema.anyOf[index]
+      schema[type][index] = refFinder(s.$ref, fullSchema, externalSchema)
+      s = schema[type][index]
     }
   })
 }
@@ -941,7 +1009,8 @@ function nested (laterCode, name, key, schema, externalSchema, fullSchema, subKe
       `
       break
     case 'string':
-      code += nullable ? `json += obj${accessor} === null ? null : $asString(obj${accessor})` : `json += $asString(obj${accessor})`
+      var stringSerializer = getStringSerializer(schema.format)
+      code += nullable ? `json += obj${accessor} === null ? null : ${stringSerializer}(obj${accessor})` : `json += ${stringSerializer}(obj${accessor})`
       break
     case 'integer':
       code += nullable ? `json += obj${accessor} === null ? null : $asInteger(obj${accessor})` : `json += $asInteger(obj${accessor})`
@@ -968,7 +1037,7 @@ function nested (laterCode, name, key, schema, externalSchema, fullSchema, subKe
       break
     case undefined:
       if ('anyOf' in schema) {
-        dereferenceAnyOfRefs(schema, externalSchema, fullSchema)
+        dereferenceOfRefs(schema, externalSchema, fullSchema, 'anyOf')
         schema.anyOf.forEach((s, index) => {
           var nestedResult = nested(laterCode, name, key, s, externalSchema, fullSchema, subKey !== '' ? subKey : 'i' + index)
           code += `
@@ -980,6 +1049,19 @@ function nested (laterCode, name, key, schema, externalSchema, fullSchema, subKe
         code += `
           else json+= null
         `
+      } else if ('oneOf' in schema) {
+        dereferenceOfRefs(schema, externalSchema, fullSchema, 'oneOf')
+        schema.oneOf.forEach((s, index) => {
+          var nestedResult = nested(laterCode, name, key, s, externalSchema, fullSchema, subKey !== '' ? subKey : 'i' + index)
+          code += `
+            ${index === 0 ? 'if' : 'else if'}(ajv.validate(${require('util').inspect(s, { depth: null })}, obj${accessor}))
+              ${nestedResult.code}
+          `
+          laterCode = nestedResult.laterCode
+        })
+        code += `
+          else json+= null
+        `
       } else if (isEmpty(schema)) {
         code += `
           json += JSON.stringify(obj${accessor})
@@ -995,9 +1077,10 @@ function nested (laterCode, name, key, schema, externalSchema, fullSchema, subKe
         sortedTypes.forEach((type, index) => {
           var tempSchema = Object.assign({}, schema, { type })
           var nestedResult = nested(laterCode, name, key, tempSchema, externalSchema, fullSchema, subKey)
+
           if (type === 'string') {
             code += `
-              ${index === 0 ? 'if' : 'else if'}(typeof obj${accessor} === "${type}" || obj${accessor} instanceof Date || obj${accessor} instanceof RegExp)
+              ${index === 0 ? 'if' : 'else if'}(obj${accessor} === null || typeof obj${accessor} === "${type}" || obj${accessor} instanceof Date || typeof obj${accessor}.toISOString === "function" || obj${accessor} instanceof RegExp)
                 ${nestedResult.code}
             `
           } else if (type === 'null') {
@@ -1082,3 +1165,16 @@ function isEmpty (schema) {
 }
 
 module.exports = build
+
+module.exports.restore = function (debugModeStr, options = {}) {
+  const dependencies = [debugModeStr]
+  const args = []
+  if (debugModeStr.startsWith('ajv')) {
+    dependencies.unshift('ajv')
+    args.push(new Ajv(options.ajv))
+  }
+
+  // eslint-disable-next-line
+  return (Function.apply(null, ['ajv', debugModeStr])
+    .apply(null, args))
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-json-stringify",
-  "version": "1.17.0",
+  "version": "1.20.1",
   "description": "Stringify your JSON at max speed",
   "main": "index.js",
   "types": "index.d.ts",
@@ -9,9 +9,7 @@
     "test:lint": "standard",
     "test:typescript": "tsc --project ./test/types/tsconfig.json",
     "test:unit": "tap -J test/*.test.js test/**/*.test.js",
-    "test": "npm run test:lint && npm run test:unit && npm run test:typescript",
-    "test:report": "npm run test:unit | tee out.tap",
-    "test:reporter": "tap-mocha-reporter xunit < out.tap > test/junit-testresults.xml"
+    "test": "npm run test:lint && npm run test:unit && npm run test:typescript"
   },
   "precommit": "test",
   "repository": {
@@ -37,12 +35,12 @@
     "is-my-json-valid": "^2.20.0",
     "json-strify": "^0.1.7",
     "long": "^4.0.0",
+    "moment": "^2.24.0",
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
     "semver": "^7.1.0",
     "standard": "^14.0.0",
     "tap": "^12.6.5",
-    "tap-mocha-reporter": "^3.0.9",
     "typescript": "^3.7.5",
     "uglify-es": "^3.3.9"
   },
@@ -55,10 +53,5 @@
     "ignore": [
       "schema-validator.js"
     ]
-  },
-  "greenkeeper": {
-    "ignore": [
-      "tap"
-    ]
   }
 }

package/test/array.test.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const moment = require('moment')
 const test = require('tap').test
 const validator = require('is-my-json-valid')
 const build = require('..')
@@ -164,3 +165,28 @@ test('invalid items throw', (t) => {
   const stringify = build(schema)
   t.throws(() => stringify({ args: ['invalid'] }))
 })
+
+test('moment array', (t) => {
+  t.plan(1)
+  const schema = {
+    type: 'object',
+    properties: {
+      times: {
+        type: 'array',
+        items: {
+          type: 'string',
+          format: 'date-time'
+        }
+      }
+    }
+  }
+  const stringify = build(schema)
+  try {
+    const value = stringify({
+      times: [moment('2018-04-21T07:52:31.017Z')]
+    })
+    t.is(value, '{"times":["2018-04-21T07:52:31.017Z"]}')
+  } catch (e) {
+    t.fail(e)
+  }
+})