fast-json-stringify 6.0.0 → 6.1.0

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import Ajv, { Options as AjvOptions } from "ajv"
+import Ajv, { Options as AjvOptions } from 'ajv'
 
 type Build = typeof build
 
@@ -65,33 +65,33 @@ declare namespace build {
      */
     $ref: string;
   }
-  
+
   export interface AnySchema extends BaseSchema {
   }
 
   export interface StringSchema extends BaseSchema {
-    type: "string";
+    type: 'string';
     format?: string;
   }
 
   export interface IntegerSchema extends BaseSchema {
-    type: "integer";
+    type: 'integer';
   }
 
   export interface NumberSchema extends BaseSchema {
-    type: "number";
+    type: 'number';
   }
 
   export interface NullSchema extends BaseSchema {
-    type: "null";
+    type: 'null';
   }
 
   export interface BooleanSchema extends BaseSchema {
-    type: "boolean";
+    type: 'boolean';
   }
 
   export interface ArraySchema extends BaseSchema {
-    type: "array";
+    type: 'array';
     /**
      * The schema for the items in the array
      */
@@ -99,7 +99,7 @@ declare namespace build {
   }
 
   export interface TupleSchema extends BaseSchema {
-    type: "array";
+    type: 'array';
     /**
      * The schemas for the items in the tuple
      */
@@ -115,7 +115,7 @@ declare namespace build {
   }
 
   export interface ObjectSchema extends BaseSchema {
-    type: "object";
+    type: 'object';
     /**
      * Describe the properties of the object
      */
@@ -145,7 +145,7 @@ declare namespace build {
     | BooleanSchema
     | ArraySchema
     | TupleSchema
-    | ObjectSchema;
+    | ObjectSchema
 
   export interface Options {
     /**
@@ -158,12 +158,12 @@ declare namespace build {
     ajv?: AjvOptions
     /**
      * Optionally configure how the integer will be rounded
-     * 
+     *
      * @default 'trunc'
      */
     rounding?: 'ceil' | 'floor' | 'round' | 'trunc'
     /**
-     * @deprecated 
+     * @deprecated
      * Enable debug mode. Please use `mode: "debug"` instead
      */
     debugMode?: boolean
@@ -190,7 +190,7 @@ declare namespace build {
   }
 
   export const validLargeArrayMechanisms: string[]
-  export function restore (value: <TDoc extends object = object>(doc: TDoc) => string): ReturnType<Build> 
+  export function restore (value: <TDoc extends object = object>(doc: TDoc) => string): ReturnType<Build>
 
   export const build: Build
   export { build as default }
@@ -208,24 +208,24 @@ interface StandaloneOption extends build.Options {
   mode: 'standalone'
 }
 
-type StringCoercible = string | Date | RegExp;
-type IntegerCoercible = number | BigInt;
+type StringCoercible = string | Date | RegExp
+type IntegerCoercible = number | BigInt
 
 /**
  * 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): <TDoc = any>(doc: TDoc) => any;
-declare function build(schema: build.StringSchema, options?: build.Options): <TDoc extends StringCoercible = StringCoercible>(doc: TDoc) => string;
-declare function build(schema: build.IntegerSchema | build.NumberSchema, options?: build.Options): <TDoc extends IntegerCoercible = IntegerCoercible>(doc: TDoc) => string;
-declare function build(schema: build.NullSchema, options?: build.Options): <TDoc extends null = null>(doc: TDoc) => "null";
-declare function build(schema: build.BooleanSchema, options?: build.Options): <TDoc extends boolean = boolean>(doc: TDoc) => string;
-declare function build(schema: build.ArraySchema | build.TupleSchema, options?: build.Options): <TDoc extends any[]= any[]>(doc: TDoc) => string;
-declare function build(schema: build.ObjectSchema, options?: build.Options): <TDoc extends object = object>(doc: TDoc) => string;
-declare function build(schema: build.Schema, options?: build.Options): <TDoc = object | any[] | string | number | boolean | null> (doc: TDoc) => string;
-
-export = build;
+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): <TDoc = any>(doc: TDoc) => any
+declare function build (schema: build.StringSchema, options?: build.Options): <TDoc extends StringCoercible = StringCoercible>(doc: TDoc) => string
+declare function build (schema: build.IntegerSchema | build.NumberSchema, options?: build.Options): <TDoc extends IntegerCoercible = IntegerCoercible>(doc: TDoc) => string
+declare function build (schema: build.NullSchema, options?: build.Options): <TDoc extends null = null>(doc: TDoc) => 'null'
+declare function build (schema: build.BooleanSchema, options?: build.Options): <TDoc extends boolean = boolean>(doc: TDoc) => string
+declare function build (schema: build.ArraySchema | build.TupleSchema, options?: build.Options): <TDoc extends any[]= any[]>(doc: TDoc) => string
+declare function build (schema: build.ObjectSchema, options?: build.Options): <TDoc extends object = object>(doc: TDoc) => string
+declare function build (schema: build.Schema, options?: build.Options): <TDoc = object | any[] | string | number | boolean | null> (doc: TDoc) => string
+
+export = build

package/types/index.test-d.ts

@@ -1,32 +1,33 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars -- Test using this disabled, see https://github.com/fastify/fast-json-stringify/pull/683
 import Ajv from 'ajv'
 import build, { restore, Schema, validLargeArrayMechanisms } from '..'
 import { expectError, expectType } from 'tsd'
 
 // Number schemas
 build({
-    type: 'number'
+  type: 'number'
 })(25)
 build({
-    type: 'integer'
+  type: 'integer'
 })(-5)
 build({
-    type: 'integer'
+  type: 'integer'
 })(5n)
 
 build({
-    type: 'number'
+  type: 'number'
 }, { rounding: 'ceil' })
 build({
-    type: 'number'
+  type: 'number'
 }, { rounding: 'floor' })
 build({
-    type: 'number'
+  type: 'number'
 }, { rounding: 'round' })
 build({
-    type: 'number'
+  type: 'number'
 }, { rounding: 'trunc' })
 expectError(build({
-    type: 'number'
+  type: 'number'
 }, { rounding: 'invalid' }))
 
 // String schema
@@ -36,55 +37,55 @@ build({
 
 // Boolean schema
 build({
-    type: 'boolean'
+  type: 'boolean'
 })(true)
 
 // Null schema
 build({
-    type: 'null'
+  type: 'null'
 })(null)
 
 // Array schemas
 build({
-    type: 'array',
-    items: { type: 'number' }
+  type: 'array',
+  items: { type: 'number' }
 })([25])
 build({
-    type: 'array',
-    items: [{ type: 'string'}, {type: 'integer'}]
+  type: 'array',
+  items: [{ type: 'string' }, { type: 'integer' }]
 })(['hello', 42])
 
 // Object schemas
 build({
-    type: 'object'
+  type: 'object'
 })({})
 build({
-    type: 'object',
-    properties: {
-        foo: { type: 'string' },
-        bar: { type: 'integer' }
-    },
-    required: ['foo'],
-    patternProperties: {
-      'baz*': { type: 'null' }
-    },
-    additionalProperties: {
-      type: 'boolean'
-    }
+  type: 'object',
+  properties: {
+    foo: { type: 'string' },
+    bar: { type: 'integer' }
+  },
+  required: ['foo'],
+  patternProperties: {
+    'baz*': { type: 'null' }
+  },
+  additionalProperties: {
+    type: 'boolean'
+  }
 })({ foo: 'bar' })
 build({
-    type: 'object',
-    properties: {
-        foo: { type: 'string' },
-        bar: { type: 'integer' }
-    },
-    required: ['foo'],
-    patternProperties: {
-      'baz*': { type: 'null' }
-    },
-    additionalProperties: {
-      type: 'boolean'
-    }
+  type: 'object',
+  properties: {
+    foo: { type: 'string' },
+    bar: { type: 'integer' }
+  },
+  required: ['foo'],
+  patternProperties: {
+    'baz*': { type: 'null' }
+  },
+  additionalProperties: {
+    type: 'boolean'
+  }
 }, { rounding: 'floor' })({ foo: 'bar' })
 
 // Reference schemas
@@ -113,7 +114,7 @@ build({
     }
   },
   patternProperties: {
-    'num': {
+    num: {
       $ref: '#/definitions/num'
     }
   },
@@ -159,7 +160,7 @@ build({
 })(new Date())
 
 /*
-This overload doesn't work yet - 
+This overload doesn't work yet -
 TypeScript chooses the generic for the schema
 before it chooses the overload for the options
 parameter.
@@ -207,52 +208,52 @@ interface InferenceSchema {
 }
 
 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" }));
+  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" });
+  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" }));
+  type: 'string',
+})
+stringify5('foo')
+expectError(stringify5({ id: '123' }))
 
 // Without inference - null type
 const stringify6 = build({
-  type: "null",
-});
-stringify6(null);
-expectError(stringify6("a string"));
+  type: 'null',
+})
+stringify6(null)
+expectError(stringify6('a string'))
 
 // Without inference - boolean type
 const stringify7 = build({
-  type: "boolean",
-});
-stringify7(true);
-expectError(stringify7("a string"));
+  type: 'boolean',
+})
+stringify7(true)
+expectError(stringify7('a string'))
 
 // largeArrayMechanism
 
-build({}, { largeArrayMechanism: 'json-stringify'} )
-build({}, { largeArrayMechanism: 'default'} )
-expectError(build({} as Schema, { largeArrayMechanism: 'invalid'} ))
+build({}, { largeArrayMechanism: 'json-stringify' })
+build({}, { largeArrayMechanism: 'default' })
+expectError(build({} as Schema, { largeArrayMechanism: 'invalid' }))
 
-build({}, { largeArraySize: 2000 } )
-build({}, { largeArraySize: '2e4' } )
-build({}, { largeArraySize: 2n } )
-expectError(build({} as Schema, { largeArraySize: ['asdf']} ))
+build({}, { largeArraySize: 2000 })
+build({}, { largeArraySize: '2e4' })
+build({}, { largeArraySize: 2n })
+expectError(build({} as Schema, { largeArraySize: ['asdf'] }))

package/.github/workflows/benchmark.yml

@@ -1,85 +0,0 @@
-name: Benchmark PR
-
-on:
-  pull_request_target:
-    types: [labeled]
-
-jobs:
-  benchmark:
-    if: ${{ github.event.label.name == 'benchmark' }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    outputs:
-      PR-BENCH: ${{ steps.benchmark-pr.outputs.BENCH_RESULT }}
-      MASTER-BENCH: ${{ steps.benchmark-master.outputs.BENCH_RESULT }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-          ref: ${{github.event.pull_request.head.sha}}
-          repository: ${{github.event.pull_request.head.repo.full_name}}
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18
-
-      - name: Install
-        run: |
-          npm install --ignore-scripts
-
-      - name: Run benchmark
-        id: benchmark-pr
-        run: |
-          npm run --silent bench > ./bench-result
-          content=$(cat ./bench-result)
-          content="${content//'%'/'%25'}"
-          content="${content//$'\n'/'%0A'}"
-          content="${content//$'\r'/'%0D'}"
-          echo "::set-output name=BENCH_RESULT::$content"
-
-      # master benchmark
-      - uses: actions/checkout@v4
-        with:
-          ref: 'master'
-
-      - name: Install
-        run: |
-          npm install --ignore-scripts
-
-      - name: Run benchmark
-        id: benchmark-master
-        run: |
-          npm run --silent bench > ./bench-result
-          content=$(cat ./bench-result)
-          content="${content//'%'/'%25'}"
-          content="${content//$'\n'/'%0A'}"
-          content="${content//$'\r'/'%0D'}"
-          echo "::set-output name=BENCH_RESULT::$content"
-
-  output-benchmark:
-    if: "always()"
-    needs: [benchmark]
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-    steps:
-      - name: Comment PR
-        uses: thollander/actions-comment-pull-request@v2
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          message: |
-            **PR**:
-            ```
-            ${{ needs.benchmark.outputs.PR-BENCH }}
-            ```
-            **MASTER**:
-            ```
-            ${{ needs.benchmark.outputs.MASTER-BENCH }}
-            ```
-            
-      - uses: actions-ecosystem/action-remove-labels@v1
-        with:
-          labels: |
-            benchmark
-          github_token: ${{ secrets.GITHUB_TOKEN }}

package/.taprc

@@ -1,7 +0,0 @@
-disable-coverage: true
-
-files:
-  - test/**/*.test.js
-
-plugin:
-  - "!@tapjs/typescript"