@lionweb/validation 0.7.0-beta.8 → 0.7.0-beta.9

package/src/validators/generic/schema/DefinitionSchema.ts

@@ -0,0 +1,84 @@
+import { Definition, isObjectDefinition, PrimitiveDefinition, TaggedUnionDefinition } from "./ValidationTypes.js"
+
+/**
+ * A collection of object and primitive definitions describing JSON objects.
+ * Used to 
+ * - validate an incoming JSON object
+ * - generate the corresponding TypeScript type definitions.
+ */
+export class DefinitionSchema {
+    unionDefinitions: TaggedUnionDefinition[] = []
+    /**
+     * Mapping from extenden object type name to list of extending Object Definitions
+     */
+    taggedUnions: Map<string, Definition[]> = new Map<string, Definition[]>()
+    definitionsMap: Map<string, Definition> = new Map<string, Definition>()
+
+    constructor(taggedUnions: TaggedUnionDefinition[], definitions: Definition[]) {
+        this.add(definitions)
+        this.addTaggedUnion(taggedUnions)
+    }
+    
+    getDefinition(name: string): Definition | undefined {
+        return this.definitionsMap.get(name)
+    }
+    
+    addTaggedUnion(defs: TaggedUnionDefinition[]){
+        this.unionDefinitions.push(...defs)
+    }
+
+    add(definitions :Definition[] | Definition) {
+        if (!Array.isArray(definitions)) {
+            definitions = [definitions]
+        }
+        for(const def of definitions) {
+            if (isObjectDefinition(def)) {
+                if (def.taggedUnionType !== "") {
+                    let existingExtends = this.taggedUnions.get(def.taggedUnionType!)
+                    if (existingExtends === undefined) {
+                        existingExtends = []
+                        this.taggedUnions.set(def.taggedUnionType!, existingExtends)
+                    }
+                    existingExtends.push(def)
+                }
+            }
+            this.definitionsMap.set(def.name, def)
+        }
+    }
+    
+    isTagProperty(propertyName: string): boolean {
+        return this.unionDefinitions.find(def => def.unionProperty === propertyName) !== undefined
+    }
+
+    definitions(): Definition[] {
+        return Array.from(this.definitionsMap.values())
+    }
+    
+    getTaggedUnionDefinition(name: string): TaggedUnionDefinition | undefined {
+        return this.unionDefinitions.find(def => def.unionType === name)
+    }
+
+    isUnionDiscriminator(propDef: PrimitiveDefinition): boolean {
+        return this.unionDefinitions.find(def => def.unionDiscriminator === propDef.name) !== undefined
+    }
+
+    extending(name: string): Definition[] {
+        const result = this.taggedUnions.get(name)
+        if (result === undefined) {
+            return []
+        } else {
+            return Array.from(result.values())
+        }
+    }
+    
+    static join(...schema: DefinitionSchema[]): DefinitionSchema {
+        const result = new DefinitionSchema([], [])
+        schema.forEach(sch => {
+            sch.definitions().forEach(value => {
+                result.add([value])
+            })
+            result.addTaggedUnion(sch.unionDefinitions)
+        })
+        return result
+    }
+}

package/src/validators/generic/{ValidationTypes.ts → schema/ValidationTypes.ts}

@@ -1,5 +1,5 @@
 import { JsonContext } from "@lionweb/json-utils"
-import { ValidationResult } from "./ValidationResult.js"
+import { ValidationResult } from "../ValidationResult.js"
 
 export type UnknownObjectType = { [key: string]: unknown }
 
@@ -15,11 +15,11 @@ export type PropertyDefinition = {
     /**
      * The property name
      */
-    property: string
+    name: string
     /**
      * The expected type of the property value
      */
-    expectedType: string
+    type: string
     /**
      * Whether the property value is allowed to be null
      */
@@ -39,38 +39,17 @@ export type PropertyDefinition = {
 }
 
 export type ValidatorFunction = <T>(obj: T, result: ValidationResult, ctx: JsonContext, pdef?: PropertyDefinition) => void
-
-/**
- * Default for the `validation` property, does nothing.
- * @param object
- * @param result
- * @param ctx
- * @param pdef
- */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-function emptyValidation<T>(object: T, result: ValidationResult, ctx: JsonContext, pdef?: PropertyDefinition): void {}
+export function emptyValidation<T>(object: T, result: ValidationResult, ctx: JsonContext, pdef?: PropertyDefinition): void {}
 
 // Make boolean argument more readable.
 export const MAY_BE_NULL = true
 
 /**
- * Easy way to create a PropertyDefinition typed object with default values.
- * @param propDef
- * @constructor
+ * Definition of a primitive type.
  */
-export function PropertyDef(propDef: PropertyDefinition): PropertyDefinition {
-    const { property, expectedType, mayBeNull = false, isList = false, isOptional = false, validate = emptyValidation } = propDef
-    return {
-        property: property,
-        expectedType: expectedType,
-        isList: isList,
-        mayBeNull: mayBeNull,
-        isOptional: isOptional,
-        validate: validate
-    }
-}
-
 export type PrimitiveDefinition = {
+    name: string,
     /**
      * The expected type of the property value
      */
@@ -80,25 +59,76 @@ export type PrimitiveDefinition = {
      */
     validate?: ValidatorFunction
 }
+
 /**
- * Easy way to create a PropertyDefinition typed object with default values.
+ * Definition of an object type.
+ */
+export type ObjectDefinition = {
+    name: string,
+    properties: PropertyDefinition[],
+    /**
+     * The name of the tagged union that this type belongs to
+     */
+    taggedUnionType?: string
+}
+
+export type Definition = ObjectDefinition | PrimitiveDefinition
+/**
+ * Defionition of tagged union.
+ */
+export type TaggedUnionDefinition = {
+    /**
+     * The tagged union "super" type
+     */
+    unionType: string,
+    /**
+     * The primitive property type that is the discriminator or tag
+     */
+    unionDiscriminator: string,
+    /**
+     * The name of the property in an object that contains the discriminator value
+     */
+    unionProperty: string
+}
+/**
+ * Easy way to create a PrimitiveDefinition typed object with default values.
  * @param propDef
  * @constructor
  */
 export function PrimitiveDef(propDef: PrimitiveDefinition): PrimitiveDefinition {
-    const { primitiveType, validate = emptyValidation } = propDef
+    const { name, primitiveType, validate = emptyValidation } = propDef
     return {
+        name: name,
         primitiveType: primitiveType,
         validate: validate
     }
 }
-export type ObjectDefinition = PropertyDefinition[]
-export type TypeDefinition = ObjectDefinition | PrimitiveDefinition
 
-export function isObjectDefinition(def: TypeDefinition): def is ObjectDefinition {
-    return Array.isArray(def)
+/**
+ * Easy way to create a PropertyDefinition typed object with default values.
+ * @param propDef
+ * @constructor
+ */
+export function PropertyDef(propDef: PropertyDefinition): PropertyDefinition {
+    const { name, type, mayBeNull = false, isList = false, isOptional = false, validate = emptyValidation } = propDef
+    return {
+        name: name,
+        type: type,
+        isList: isList,
+        mayBeNull: mayBeNull,
+        isOptional: isOptional,
+        validate: validate
+    }
+}
+
+export function isObjectDefinition(def: Definition | undefined): def is ObjectDefinition {
+    return  (def !== undefined) && Array.isArray((def as ObjectDefinition)?.properties)
+}
+
+export function isPrimitiveDefinition(def: Definition | undefined): def is PrimitiveDefinition {
+    return (def !== undefined) && (def as PrimitiveDefinition)?.primitiveType !== undefined
 }
 
-export function isPrimitiveDefinition(def: TypeDefinition): def is PrimitiveDefinition {
-    return (def as PrimitiveDefinition)?.primitiveType !== undefined
+export function isJavaScriptPrimitive(type: string): boolean {
+    return ["number", "string", "boolean"].includes(type)
 }

package/src/validators/generic/schema/index.ts

@@ -0,0 +1,2 @@
+export * from "./ValidationTypes.js"
+export * from "./DefinitionSchema.js"

package/dist/validators/generic/ValidationTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ValidationTypes.d.ts","sourceRoot":"","sources":["../../../src/validators/generic/ValidationTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,MAAM,MAAM,iBAAiB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA;AAE1D;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAA;AAa1H,eAAO,MAAM,WAAW,OAAO,CAAA;AAE/B;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,kBAAkB,CAU3E;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;CAC/B,CAAA;AACD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,mBAAmB,CAM9E;AACD,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,EAAE,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,CAAA;AAEnE,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,cAAc,GAAG,GAAG,IAAI,gBAAgB,CAE/E;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,cAAc,GAAG,GAAG,IAAI,mBAAmB,CAErF"}

package/dist/validators/generic/ValidationTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ValidationTypes.js","sourceRoot":"","sources":["../../../src/validators/generic/ValidationTypes.ts"],"names":[],"mappings":"AA0CA;;;;;;GAMG;AACH,6DAA6D;AAC7D,SAAS,eAAe,CAAI,MAAS,EAAE,MAAwB,EAAE,GAAgB,EAAE,IAAyB,IAAS,CAAC;AAEtH,uCAAuC;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAA;AAE/B;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,OAA2B;IACnD,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,GAAG,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,UAAU,GAAG,KAAK,EAAE,QAAQ,GAAG,eAAe,EAAE,GAAG,OAAO,CAAA;IAC7H,OAAO;QACH,QAAQ,EAAE,QAAQ;QAClB,YAAY,EAAE,YAAY;QAC1B,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,SAAS;QACpB,UAAU,EAAE,UAAU;QACtB,QAAQ,EAAE,QAAQ;KACrB,CAAA;AACL,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,OAA4B;IACrD,MAAM,EAAE,aAAa,EAAE,QAAQ,GAAG,eAAe,EAAE,GAAG,OAAO,CAAA;IAC7D,OAAO;QACH,aAAa,EAAE,aAAa;QAC5B,QAAQ,EAAE,QAAQ;KACrB,CAAA;AACL,CAAC;AAID,MAAM,UAAU,kBAAkB,CAAC,GAAmB;IAClD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;AAC7B,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAmB;IACrD,OAAQ,GAA2B,EAAE,aAAa,KAAK,SAAS,CAAA;AACpE,CAAC"}