fast-json-stringify 4.0.0 → 5.0.0

package/README.md

@@ -62,6 +62,8 @@ compile-json-stringify date format x 1,086,187 ops/sec ±0.16% (99 runs sampled)
  - <a href="#nullable">`Nullable`</a>
  - <a href="#largearrays">`Large Arrays`</a>
 - <a href="#security">`Security Notice`</a>
+- <a href="#debug">`Debug Mode`</a>
+- <a href="#standalone">`Standalone Mode`</a>
 - <a href="#acknowledgements">`Acknowledgements`</a>
 - <a href="#license">`License`</a>
 
@@ -663,13 +665,37 @@ const debugCompiled = fastJson({
       type: 'string'
     }
   }
-}, { debugMode: true })
+}, { mode: 'debug' })
 
-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
+console.log(debugCompiled) // it is a object contain code, ajv instance
+const rawString = debugCompiled.code // it is the generated code
+console.log(rawString) 
 
-const rawString = debugCompiled.toString()
-const stringify = fastJson.restore(rawString) // use the generated string to get back the `stringify` function
+const stringify = fastJson.restore(debugCompiled) // use the generated string to get back the `stringify` function
+console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
+```
+
+<a name="standalone"></a>
+### Standalone Mode
+
+The standalone mode is used to compile the code that can be directly run by `node`
+itself. You need to install `ajv`, `fast-uri` and `ajv-formats` for
+the standalone code to work.
+
+```js
+const fs = require('fs')
+const code = fastJson({
+  title: 'default string',
+  type: 'object',
+  properties: {
+    firstName: {
+      type: 'string'
+    }
+  }
+}, { mode: 'standalone' })
+
+fs.writeFileSync('stringify.js', code)
+const stringify = require('stringify.js')
 console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
 ```
 

package/ajv.js

@@ -0,0 +1,37 @@
+'use strict'
+
+const Ajv = require('ajv')
+const fastUri = require('fast-uri')
+const ajvFormats = require('ajv-formats')
+
+module.exports = buildAjv
+
+function buildAjv (options) {
+  const ajvInstance = new Ajv({ ...options, strictSchema: false, validateSchema: false, uriResolver: fastUri })
+  ajvFormats(ajvInstance)
+
+  const validateDateTimeFormat = ajvFormats.get('date-time').validate
+  const validateDateFormat = ajvFormats.get('date').validate
+  const validateTimeFormat = ajvFormats.get('time').validate
+
+  ajvInstance.addKeyword({
+    keyword: 'fjs_date_type',
+    validate: (schema, date) => {
+      if (date instanceof Date) {
+        return true
+      }
+      if (schema === 'date-time') {
+        return validateDateTimeFormat(date)
+      }
+      if (schema === 'date') {
+        return validateDateFormat(date)
+      }
+      if (schema === 'time') {
+        return validateTimeFormat(date)
+      }
+      return false
+    }
+  })
+
+  return ajvInstance
+}

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Options as AjvOptions } from "ajv"
+import Ajv, { Options as AjvOptions } from "ajv"
 declare namespace build {
   interface BaseSchema {
     /**
@@ -157,14 +157,38 @@ declare namespace build {
      * Optionally configure how the integer will be rounded
      */
     rounding?: 'ceil' | 'floor' | 'round'
+    /**
+     * @deprecated 
+     * Enable debug mode. Please use `mode: "debug"` instead
+     */
+    debugMode?: boolean
+    /**
+     * Running mode of fast-json-stringify
+     */
+    mode?: 'debug' | 'standalone'
   }
 }
 
+interface DebugOption extends build.Options {
+  mode: 'debug'
+}
+
+interface DeprecateDebugOption extends build.Options {
+  debugMode: true
+}
+
+interface StandaloneOption extends build.Options {
+  mode: 'standalone'
+}
+
 /**
  * Build a stringify function using a schema of the documents that should be stringified
  * @param schema The schema used to stringify values
  * @param options The options to use (optional)
  */
+declare function build(schema: build.AnySchema, options: DebugOption): { code: string, ajv: Ajv };
+declare function build(schema: build.AnySchema, options: DeprecateDebugOption): { code: string, ajv: Ajv };
+declare function build(schema: build.AnySchema, options: StandaloneOption): string;
 declare function build(schema: build.AnySchema, options?: build.Options): (doc: any) => any;
 declare function build(schema: build.StringSchema, options?: build.Options): (doc: string) => string;
 declare function build(schema: build.IntegerSchema | build.NumberSchema, options?: build.Options): (doc: number) => string;