jsonbinpack/lib/simplifier/syntax-sugar.ts

A space-efficient schema-driven binary JSON serialization format based on JSON Schema

/*
 * Copyright 2021 Juan Cruz Viotti
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {
  strict as assert
} from 'assert'

import {
  omit
} from 'lodash'

import {
  JSONBoolean
} from '../json'

import {
  ObjectSchema
} from '../jsonschema'

import {
  SimplificationRule
} from './rule'

export const RULES: SimplificationRule[] = [
  {
    id: 'type-union-anyof',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return Array.isArray(schema.type)
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      assert(Array.isArray(schema.type))
      return {
        anyOf: schema.type.map((type) => {
          return Object.assign({}, schema, {
            type
          })
        })
      }
    }
  },
  {
    id: 'boolean-as-enum',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return schema.type === 'boolean'
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      return Object.assign({}, omit(schema, [ 'type' ]), {
        enum: [ false, true ]
      })
    }
  },
  {
    id: 'null-as-const',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return schema.type === 'null'
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      return Object.assign({}, omit(schema, [ 'type' ]), {
        const: null
      })
    }
  },
  {
    id: 'const-as-enum',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return typeof schema.const !== 'undefined'
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      assert(typeof schema.const !== 'undefined')
      return Object.assign({}, omit(schema, [ 'const' ]), {
        enum: [ schema.const ]
      })
    }
  },
  {
    id: 'exclusive-minimum-to-minimum',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return typeof schema.exclusiveMinimum !== 'undefined'
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      const minimum: number = Math.max(
        (schema.exclusiveMinimum ?? -Infinity) + 1,
        schema.minimum ?? -Infinity)
      Reflect.deleteProperty(schema, 'exclusiveMinimum')
      return Object.assign(schema, { minimum })
    }
  },
  {
    id: 'exclusive-maximum-to-maximum',
    condition: (schema: ObjectSchema): JSONBoolean => {
      return typeof schema.exclusiveMaximum !== 'undefined'
    },
    transform: (schema: ObjectSchema): ObjectSchema => {
      const maximum: number = Math.max(
        (schema.exclusiveMaximum ?? Infinity) - 1,
        schema.maximum ?? Infinity)
      Reflect.deleteProperty(schema, 'exclusiveMaximum')
      return Object.assign(schema, { maximum })
    }
  }
]