You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					178 lines
				
				5.9 KiB
			
		
		
			
		
	
	
					178 lines
				
				5.9 KiB
			| 
								 
											3 years ago
										 
									 | 
							
								import type {
							 | 
						||
| 
								 | 
							
								  CodeKeywordDefinition,
							 | 
						||
| 
								 | 
							
								  ErrorObject,
							 | 
						||
| 
								 | 
							
								  KeywordErrorDefinition,
							 | 
						||
| 
								 | 
							
								  SchemaObject,
							 | 
						||
| 
								 | 
							
								} from "../../types"
							 | 
						||
| 
								 | 
							
								import type {KeywordCxt} from "../../compile/validate"
							 | 
						||
| 
								 | 
							
								import {propertyInData, allSchemaProperties, isOwnProperty} from "../code"
							 | 
						||
| 
								 | 
							
								import {alwaysValidSchema, schemaRefOrVal} from "../../compile/util"
							 | 
						||
| 
								 | 
							
								import {_, and, not, Code, Name} from "../../compile/codegen"
							 | 
						||
| 
								 | 
							
								import {checkMetadata} from "./metadata"
							 | 
						||
| 
								 | 
							
								import {checkNullableObject} from "./nullable"
							 | 
						||
| 
								 | 
							
								import {typeErrorMessage, typeErrorParams, _JTDTypeError} from "./error"
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								enum PropError {
							 | 
						||
| 
								 | 
							
								  Additional = "additional",
							 | 
						||
| 
								 | 
							
								  Missing = "missing",
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								type PropKeyword = "properties" | "optionalProperties"
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								type PropSchema = {[P in string]?: SchemaObject}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								export type JTDPropertiesError =
							 | 
						||
| 
								 | 
							
								  | _JTDTypeError<PropKeyword, "object", PropSchema>
							 | 
						||
| 
								 | 
							
								  | ErrorObject<PropKeyword, {error: PropError.Additional; additionalProperty: string}, PropSchema>
							 | 
						||
| 
								 | 
							
								  | ErrorObject<PropKeyword, {error: PropError.Missing; missingProperty: string}, PropSchema>
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								export const error: KeywordErrorDefinition = {
							 | 
						||
| 
								 | 
							
								  message: (cxt) => {
							 | 
						||
| 
								 | 
							
								    const {params} = cxt
							 | 
						||
| 
								 | 
							
								    return params.propError
							 | 
						||
| 
								 | 
							
								      ? params.propError === PropError.Additional
							 | 
						||
| 
								 | 
							
								        ? "must NOT have additional properties"
							 | 
						||
| 
								 | 
							
								        : `must have property '${params.missingProperty}'`
							 | 
						||
| 
								 | 
							
								      : typeErrorMessage(cxt, "object")
							 | 
						||
| 
								 | 
							
								  },
							 | 
						||
| 
								 | 
							
								  params: (cxt) => {
							 | 
						||
| 
								 | 
							
								    const {params} = cxt
							 | 
						||
| 
								 | 
							
								    return params.propError
							 | 
						||
| 
								 | 
							
								      ? params.propError === PropError.Additional
							 | 
						||
| 
								 | 
							
								        ? _`{error: ${params.propError}, additionalProperty: ${params.additionalProperty}}`
							 | 
						||
| 
								 | 
							
								        : _`{error: ${params.propError}, missingProperty: ${params.missingProperty}}`
							 | 
						||
| 
								 | 
							
								      : typeErrorParams(cxt, "object")
							 | 
						||
| 
								 | 
							
								  },
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								const def: CodeKeywordDefinition = {
							 | 
						||
| 
								 | 
							
								  keyword: "properties",
							 | 
						||
| 
								 | 
							
								  schemaType: "object",
							 | 
						||
| 
								 | 
							
								  error,
							 | 
						||
| 
								 | 
							
								  code: validateProperties,
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								// const error: KeywordErrorDefinition = {
							 | 
						||
| 
								 | 
							
								//   message: "should NOT have additional properties",
							 | 
						||
| 
								 | 
							
								//   params: ({params}) => _`{additionalProperty: ${params.additionalProperty}}`,
							 | 
						||
| 
								 | 
							
								// }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								export function validateProperties(cxt: KeywordCxt): void {
							 | 
						||
| 
								 | 
							
								  checkMetadata(cxt)
							 | 
						||
| 
								 | 
							
								  const {gen, data, parentSchema, it} = cxt
							 | 
						||
| 
								 | 
							
								  const {additionalProperties, nullable} = parentSchema
							 | 
						||
| 
								 | 
							
								  if (it.jtdDiscriminator && nullable) throw new Error("JTD: nullable inside discriminator mapping")
							 | 
						||
| 
								 | 
							
								  if (commonProperties()) {
							 | 
						||
| 
								 | 
							
								    throw new Error("JTD: properties and optionalProperties have common members")
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								  const [allProps, properties] = schemaProperties("properties")
							 | 
						||
| 
								 | 
							
								  const [allOptProps, optProperties] = schemaProperties("optionalProperties")
							 | 
						||
| 
								 | 
							
								  if (properties.length === 0 && optProperties.length === 0 && additionalProperties) {
							 | 
						||
| 
								 | 
							
								    return
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  const [valid, cond] =
							 | 
						||
| 
								 | 
							
								    it.jtdDiscriminator === undefined
							 | 
						||
| 
								 | 
							
								      ? checkNullableObject(cxt, data)
							 | 
						||
| 
								 | 
							
								      : [gen.let("valid", false), true]
							 | 
						||
| 
								 | 
							
								  gen.if(cond, () =>
							 | 
						||
| 
								 | 
							
								    gen.assign(valid, true).block(() => {
							 | 
						||
| 
								 | 
							
								      validateProps(properties, "properties", true)
							 | 
						||
| 
								 | 
							
								      validateProps(optProperties, "optionalProperties")
							 | 
						||
| 
								 | 
							
								      if (!additionalProperties) validateAdditional()
							 | 
						||
| 
								 | 
							
								    })
							 | 
						||
| 
								 | 
							
								  )
							 | 
						||
| 
								 | 
							
								  cxt.pass(valid)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function commonProperties(): boolean {
							 | 
						||
| 
								 | 
							
								    const props = parentSchema.properties as Record<string, any> | undefined
							 | 
						||
| 
								 | 
							
								    const optProps = parentSchema.optionalProperties as Record<string, any> | undefined
							 | 
						||
| 
								 | 
							
								    if (!(props && optProps)) return false
							 | 
						||
| 
								 | 
							
								    for (const p in props) {
							 | 
						||
| 
								 | 
							
								      if (Object.prototype.hasOwnProperty.call(optProps, p)) return true
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								    return false
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function schemaProperties(keyword: string): [string[], string[]] {
							 | 
						||
| 
								 | 
							
								    const schema = parentSchema[keyword]
							 | 
						||
| 
								 | 
							
								    const allPs = schema ? allSchemaProperties(schema) : []
							 | 
						||
| 
								 | 
							
								    if (it.jtdDiscriminator && allPs.some((p) => p === it.jtdDiscriminator)) {
							 | 
						||
| 
								 | 
							
								      throw new Error(`JTD: discriminator tag used in ${keyword}`)
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								    const ps = allPs.filter((p) => !alwaysValidSchema(it, schema[p]))
							 | 
						||
| 
								 | 
							
								    return [allPs, ps]
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function validateProps(props: string[], keyword: string, required?: boolean): void {
							 | 
						||
| 
								 | 
							
								    const _valid = gen.var("valid")
							 | 
						||
| 
								 | 
							
								    for (const prop of props) {
							 | 
						||
| 
								 | 
							
								      gen.if(
							 | 
						||
| 
								 | 
							
								        propertyInData(gen, data, prop, it.opts.ownProperties),
							 | 
						||
| 
								 | 
							
								        () => applyPropertySchema(prop, keyword, _valid),
							 | 
						||
| 
								 | 
							
								        () => missingProperty(prop)
							 | 
						||
| 
								 | 
							
								      )
							 | 
						||
| 
								 | 
							
								      cxt.ok(_valid)
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    function missingProperty(prop: string): void {
							 | 
						||
| 
								 | 
							
								      if (required) {
							 | 
						||
| 
								 | 
							
								        gen.assign(_valid, false)
							 | 
						||
| 
								 | 
							
								        cxt.error(false, {propError: PropError.Missing, missingProperty: prop}, {schemaPath: prop})
							 | 
						||
| 
								 | 
							
								      } else {
							 | 
						||
| 
								 | 
							
								        gen.assign(_valid, true)
							 | 
						||
| 
								 | 
							
								      }
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function applyPropertySchema(prop: string, keyword: string, _valid: Name): void {
							 | 
						||
| 
								 | 
							
								    cxt.subschema(
							 | 
						||
| 
								 | 
							
								      {
							 | 
						||
| 
								 | 
							
								        keyword,
							 | 
						||
| 
								 | 
							
								        schemaProp: prop,
							 | 
						||
| 
								 | 
							
								        dataProp: prop,
							 | 
						||
| 
								 | 
							
								      },
							 | 
						||
| 
								 | 
							
								      _valid
							 | 
						||
| 
								 | 
							
								    )
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function validateAdditional(): void {
							 | 
						||
| 
								 | 
							
								    gen.forIn("key", data, (key: Name) => {
							 | 
						||
| 
								 | 
							
								      const _allProps =
							 | 
						||
| 
								 | 
							
								        it.jtdDiscriminator === undefined ? allProps : [it.jtdDiscriminator].concat(allProps)
							 | 
						||
| 
								 | 
							
								      const addProp = isAdditional(key, _allProps, "properties")
							 | 
						||
| 
								 | 
							
								      const addOptProp = isAdditional(key, allOptProps, "optionalProperties")
							 | 
						||
| 
								 | 
							
								      const extra =
							 | 
						||
| 
								 | 
							
								        addProp === true ? addOptProp : addOptProp === true ? addProp : and(addProp, addOptProp)
							 | 
						||
| 
								 | 
							
								      gen.if(extra, () => {
							 | 
						||
| 
								 | 
							
								        if (it.opts.removeAdditional) {
							 | 
						||
| 
								 | 
							
								          gen.code(_`delete ${data}[${key}]`)
							 | 
						||
| 
								 | 
							
								        } else {
							 | 
						||
| 
								 | 
							
								          cxt.error(
							 | 
						||
| 
								 | 
							
								            false,
							 | 
						||
| 
								 | 
							
								            {propError: PropError.Additional, additionalProperty: key},
							 | 
						||
| 
								 | 
							
								            {instancePath: key, parentSchema: true}
							 | 
						||
| 
								 | 
							
								          )
							 | 
						||
| 
								 | 
							
								          if (!it.opts.allErrors) gen.break()
							 | 
						||
| 
								 | 
							
								        }
							 | 
						||
| 
								 | 
							
								      })
							 | 
						||
| 
								 | 
							
								    })
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  function isAdditional(key: Name, props: string[], keyword: string): Code | true {
							 | 
						||
| 
								 | 
							
								    let additional: Code | boolean
							 | 
						||
| 
								 | 
							
								    if (props.length > 8) {
							 | 
						||
| 
								 | 
							
								      // TODO maybe an option instead of hard-coded 8?
							 | 
						||
| 
								 | 
							
								      const propsSchema = schemaRefOrVal(it, parentSchema[keyword], keyword)
							 | 
						||
| 
								 | 
							
								      additional = not(isOwnProperty(gen, propsSchema as Code, key))
							 | 
						||
| 
								 | 
							
								    } else if (props.length) {
							 | 
						||
| 
								 | 
							
								      additional = and(...props.map((p) => _`${key} !== ${p}`))
							 | 
						||
| 
								 | 
							
								    } else {
							 | 
						||
| 
								 | 
							
								      additional = true
							 | 
						||
| 
								 | 
							
								    }
							 | 
						||
| 
								 | 
							
								    return additional
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								export default def
							 |