fast-json-stringify 5.4.1 → 5.5.0

package/README.md

@@ -650,12 +650,16 @@ AJV Serialize large array x 58.76 ops/sec ±4.59% (60 runs sampled)
 Treat the schema definition as application code, it
 is not safe to use user-provided schemas.
 
-In order to achieve lowest cost/highest performance redaction `fast-json-stringify`
+To achieve low cost and high performance redaction `fast-json-stringify`
 creates and compiles a function (using the `Function` constructor) on initialization.
 While the `schema` is currently validated for any developer errors,
 there is no guarantee that supplying user-generated schema could not
 expose your application to remote attacks.
 
+Users are responsible for sending trusted data. `fast-json-stringify` guarantees that you will get
+a valid output only if your input matches the schema or can be coerced to the schema. If your input
+doesn't match the schema, you will get undefined behavior. 
+
 <a name="debug"></a>
 ### Debug Mode
 

package/index.js

@@ -888,6 +888,8 @@ function buildValue (location, input) {
 }
 
 module.exports = build
+module.exports.default = build
+module.exports.build = build
 
 module.exports.validLargeArrayMechanisms = validLargeArrayMechanisms
 

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "fast-json-stringify",
-  "version": "5.4.1",
+  "version": "5.5.0",
   "description": "Stringify your JSON at max speed",
   "main": "index.js",
-  "types": "index.d.ts",
-  "precommit": [
-    "lint",
-    "test"
-  ],
+  "types": "types/index.d.ts",
+  "scripts": {
+    "bench": "node ./benchmark/bench.js",
+    "bench:cmp": "node ./benchmark/bench-cmp-branch.js",
+    "bench:cmp:ci": "node ./benchmark/bench-cmp-branch.js --ci",
+    "benchmark": "node ./benchmark/bench-cmp-lib.js",
+    "lint": "standard",
+    "lint:fix": "standard --fix",
+    "test:typescript": "tsd",
+    "test:unit": "tap -J test/*.test.js test/**/*.test.js",
+    "test": "npm run test:unit && npm run test:typescript"
+  },
+  "precommit": ["lint", "test"],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fastify/fast-json-stringify.git"
@@ -38,7 +46,6 @@
     "standard": "^17.0.0",
     "tap": "^16.0.1",
     "tsd": "^0.24.1",
-    "typescript": "^4.0.2",
     "webpack": "^5.40.0"
   },
   "dependencies": {
@@ -54,19 +61,5 @@
       "schema-validator.js"
     ]
   },
-  "runkitExampleFilename": "./examples/example.js",
-  "tsd": {
-    "directory": "test/types"
-  },
-  "scripts": {
-    "bench": "node ./benchmark/bench.js",
-    "bench:cmp": "node ./benchmark/bench-cmp-branch.js",
-    "bench:cmp:ci": "node ./benchmark/bench-cmp-branch.js --ci",
-    "benchmark": "node ./benchmark/bench-cmp-lib.js",
-    "lint": "standard",
-    "lint:fix": "standard --fix",
-    "test:typescript": "tsc --project ./test/types/tsconfig.json && tsd",
-    "test:unit": "tap -J test/*.test.js test/**/*.test.js",
-    "test": "npm run test:unit && npm run test:typescript"
-  }
-}
+  "runkitExampleFilename": "./examples/example.js"
+}

package/{index.d.ts → types/index.d.ts}

@@ -1,5 +1,7 @@
 import Ajv, { Options as AjvOptions } from "ajv"
 
+type Build = typeof build
+
 declare namespace build {
   interface BaseSchema {
     /**
@@ -168,6 +170,12 @@ declare namespace build {
      */
     mode?: 'debug' | 'standalone'
   }
+
+  export const validLargeArrayMechanisms: string[]
+  export function restore (value: <TDoc extends object = object>(doc: TDoc) => string): ReturnType<Build> 
+
+  export const build: Build
+  export { build as default }
 }
 
 interface DebugOption extends build.Options {

package/{test/types/test.ts → types/index.test-d.ts}

@@ -1,5 +1,6 @@
 import Ajv from 'ajv'
-import build, { Schema } from '../..'
+import build, { restore, Schema, validLargeArrayMechanisms } from '..'
+import { expectError, expectType } from 'tsd'
 
 // Number schemas
 const schema1: Schema = {
@@ -150,4 +151,69 @@ str = build(schema1, { debugMode: true }).code
 ajv = build(schema1, { debugMode: true }).ajv
 str = build(schema1, { mode: 'debug' }).code
 ajv = build(schema1, { mode: 'debug' }).ajv
-str = build(schema1, { mode: 'standalone' })
+str = build(schema1, { mode: 'standalone' })
+
+const debugCompiled = build({
+  title: 'default string',
+  type: 'object',
+  properties: {
+    firstName: {
+      type: 'string'
+    }
+  }
+}, { mode: 'debug' })
+expectType<ReturnType<typeof build>>(build.restore(debugCompiled))
+expectType<ReturnType<typeof build>>(restore(debugCompiled))
+
+expectType<string[]>(build.validLargeArrayMechanisms)
+expectType<string[]>(validLargeArrayMechanisms)
+
+/**
+ * Schema inference
+ */
+
+// With inference
+interface InferenceSchema {
+  id: string;
+  a?: number;
+}
+
+const stringify3 = build({
+  type: "object",
+  properties: { a: { type: "string" } },
+});
+stringify3<InferenceSchema>({ id: "123" });
+stringify3<InferenceSchema>({ a: 123, id: "123" });
+expectError(stringify3<InferenceSchema>({ anotherOne: "bar" }));
+expectError(stringify3<Schema>({ a: "bar" }));
+
+// Without inference
+const stringify4 = build({
+  type: "object",
+  properties: { a: { type: "string" } },
+});
+stringify4({ id: "123" });
+stringify4({ a: 123, id: "123" });
+stringify4({ anotherOne: "bar" });
+stringify4({ a: "bar" });
+
+// Without inference - string type
+const stringify5 = build({
+  type: "string",
+});
+stringify5("foo");
+expectError(stringify5({ id: "123" }));
+
+// Without inference - null type
+const stringify6 = build({
+  type: "null",
+});
+stringify6(null);
+expectError(stringify6("a string"));
+
+// Without inference - boolean type
+const stringify7 = build({
+  type: "boolean",
+});
+stringify7(true);
+expectError(stringify7("a string"));

package/test/types/schema-inference.test-d.ts

@@ -1,48 +0,0 @@
-import { expectError } from "tsd";
-import build from "../..";
-
-// With inference
-interface Schema {
-  id: string;
-  a?: number;
-}
-
-const stringify3 = build({
-  type: "object",
-  properties: { a: { type: "string" } },
-});
-stringify3<Schema>({ id: "123" });
-stringify3<Schema>({ a: 123, id: "123" });
-expectError(stringify3<Schema>({ anotherOne: "bar" }));
-expectError(stringify3<Schema>({ a: "bar" }));
-
-// Without inference
-const stringify4 = build({
-  type: "object",
-  properties: { a: { type: "string" } },
-});
-stringify4({ id: "123" });
-stringify4({ a: 123, id: "123" });
-stringify4({ anotherOne: "bar" });
-stringify4({ a: "bar" });
-
-// Without inference - string type
-const stringify5 = build({
-  type: "string",
-});
-stringify5("foo");
-expectError(stringify5({ id: "123" }));
-
-// Without inference - null type
-const stringify6 = build({
-  type: "null",
-});
-stringify6(null);
-expectError(stringify6("a string"));
-
-// Without inference - boolean type
-const stringify7 = build({
-  type: "boolean",
-});
-stringify7(true);
-expectError(stringify7("a string"));

package/test/types/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "esModuleInterop": true,
-    "noEmit": true,
-    "rootDir": "../..",
-    "strict": true,
-    "target": "ES2015",
-    "moduleResolution": "node"
-  },
-  "include": [
-    "./test.ts"
-  ]
-}