prostgles-server 3.0.86 → 3.0.88

package/lib/JSONBValidation/validate_jsonb_schema_sql.ts

@@ -0,0 +1,293 @@
+
+
+export const VALIDATE_SCHEMA_FUNCNAME = "prostgles.validate_jsonb_schema" as const;
+export const validate_jsonb_schema_sql = `
+DROP FUNCTION IF EXISTS ${VALIDATE_SCHEMA_FUNCNAME}(jsonb_schema text, data jsonb, checked_path text[]);
+
+CREATE OR REPLACE FUNCTION ${VALIDATE_SCHEMA_FUNCNAME}(jsonb_schema TEXT, data JSONB, checked_path TEXT[] DEFAULT ARRAY[]::TEXT[]) RETURNS boolean AS 
+$f$
+DECLARE
+  sub_schema RECORD;
+  array_element RECORD;
+  schema JSONB;
+  path text;
+  allowed_types text[] = '{any,boolean,number,integer,string,boolean[],number[],integer[],string[],any[]}';
+  typeStr TEXT = NULL; 
+  optional boolean;
+  nullable boolean; 
+  colname TEXT;
+
+  extra_keys TEXT[];
+BEGIN
+  path = concat_ws(', ', 
+    'Path: ' || array_to_string(checked_path, '.'), 
+    'Data: ' || data::TEXT, 
+    'JSONBSchema: ' || schema::TEXT
+  );
+  colname = COALESCE(checked_path[1], '');
+
+  IF length(jsonb_schema) = 0 THEN
+    RAISE EXCEPTION 'Empty schema. %', path USING HINT = path, COLUMN = colname; 
+  END IF;
+
+  /* 'string' */
+  IF ARRAY[jsonb_schema] <@ allowed_types THEN
+    schema = jsonb_build_object('type', jsonb_schema);
+  /* { "type": ... } */ 
+  ELSIF BTRIM(jsonb_schema) ILIKE '{%' THEN
+    schema = jsonb_schema::JSONB;
+  ELSE
+    RAISE EXCEPTION $$Invalid schema. Expecting 'typename' or { "type": "typename" } but received: %, %$$, jsonb_schema, path USING HINT = path, COLUMN = colname; 
+  END IF;
+
+
+  nullable = COALESCE((schema->'nullable')::BOOLEAN, FALSE);
+  IF data IS NULL OR jsonb_typeof(data) = 'null' THEN
+    IF NOT nullable THEN
+      RAISE EXCEPTION 'Is not nullable. %', path USING HINT = path, COLUMN = colname; 
+    ELSE
+      RETURN true;
+    END IF;
+  END IF;
+  
+  IF schema ? 'enum' THEN 
+    IF 
+      jsonb_typeof(schema->'enum') != 'array' OR 
+      jsonb_array_length(schema->'enum') < 1 
+    THEN
+      RAISE EXCEPTION 'Invalid schema enum (%) .Must be a non empty array %', schema->'enum', path USING HINT = path, COLUMN = colname; 
+    END IF;
+    
+    IF NOT jsonb_build_array(data) <@ (schema->'enum') THEN
+      RAISE EXCEPTION 'Data not in allowed enum list (%), %', schema->'enum', path USING HINT = path, COLUMN = colname; 
+    END IF;
+
+  ELSIF schema ? 'type' THEN    
+    
+    IF jsonb_typeof(schema->'type') = 'string' THEN
+      typeStr = schema->>'type';
+      IF NOT ARRAY[typeStr] <@ allowed_types THEN
+        RAISE EXCEPTION 'Bad schema type type %, allowed types: %. %',typeStr, allowed_types, path USING HINT = path, COLUMN = colname; 
+      END IF;
+      
+      /** Primitive array */
+      IF typeStr LIKE '%[]' THEN
+ 
+        typeStr = left(typeStr, -2);
+
+        IF jsonb_typeof(data) != 'array' THEN
+          RAISE EXCEPTION 'Types not matching. Expecting an array. %', path USING HINT = path, COLUMN = colname;
+        END IF;
+
+        FOR array_element IN
+          SELECT value, row_number() OVER() -1 as idx
+          FROM jsonb_array_elements(data)
+        LOOP
+          IF NOT ${VALIDATE_SCHEMA_FUNCNAME}(
+              CASE WHEN schema->'allowedValues' IS NOT NULL THEN 
+                jsonb_build_object('type', typeStr, 'allowedValues', schema->'allowedValues')::TEXT
+              ELSE typeStr END, 
+              array_element.value, 
+              checked_path || array_element.idx::TEXT
+          ) THEN
+            
+            RETURN FALSE;
+          END IF;
+        END LOOP;
+
+        RETURN TRUE;
+
+      /** Primitive */
+      ELSE 
+
+        IF (
+          typeStr = 'number' AND jsonb_typeof(data) != typeStr OR
+          (typeStr = 'integer' AND (jsonb_typeof(data) != 'number' OR ceil(data::NUMERIC) != floor(data::NUMERIC))) OR
+          typeStr = 'boolean' AND jsonb_typeof(data) != typeStr OR
+          typeStr = 'string' AND jsonb_typeof(data) != typeStr OR
+          typeStr = 'any' AND jsonb_typeof(data) = 'null'
+        ) THEN
+          RAISE EXCEPTION 'Data type not matching. Expected: %, Actual: %, %', typeStr, jsonb_typeof(data), path USING HINT = path, COLUMN = colname; 
+        END IF;
+
+        IF schema ? 'allowedValues' AND NOT(jsonb_build_array(data) <@ (schema->'allowedValues')) THEN
+          IF (
+            SELECT COUNT(distinct jsonb_typeof(value))
+            FROM jsonb_array_elements(schema->'allowedValues')
+          ) > 1 THEN
+            RAISE EXCEPTION 'Invalid schema. schema.allowedValues (%) contains more than one data type . %', schema->>'allowedValues', path USING HINT = path, COLUMN = colname;
+          END IF;
+
+          IF EXISTS(
+            SELECT 1
+            FROM jsonb_array_elements(schema->'allowedValues')
+            WHERE jsonb_typeof(value) != jsonb_typeof(data)
+          ) THEN
+            RAISE EXCEPTION 'Invalid schema. schema.allowedValues (%) contains contains values not matchine the schema.type %', schema->>'allowedValues', path USING HINT = path, COLUMN = colname; 
+          END IF;
+
+          RAISE EXCEPTION 'Data not in allowedValues (%). %', schema->>'allowedValues', path USING HINT = path, COLUMN = colname; 
+
+        END IF;
+
+      END IF;
+
+    /* Object */
+    ELSIF jsonb_typeof(schema->'type') = 'object' THEN
+
+      IF jsonb_typeof(data) != 'object' THEN
+        RAISE EXCEPTION E'Expecting an object: \n %', path USING HINT = path, COLUMN = colname; 
+      END IF;
+
+      extra_keys = ARRAY(SELECT k FROM (
+        SELECT jsonb_object_keys(data) as k
+        EXCEPT
+        SELECT jsonb_object_keys(schema->'type') as k
+      ) t);
+
+      IF array_length(extra_keys, 1) > 0 THEN
+        RAISE EXCEPTION E'Object contains invalid keys: % \n %', 
+          array_to_string(extra_keys, ', '), path USING HINT = path, COLUMN = colname; 
+      END IF;
+      
+      FOR sub_schema IN
+        SELECT key, value
+        FROM jsonb_each(schema->'type')
+      LOOP
+        optional = COALESCE((sub_schema.value->'optional')::BOOLEAN, FALSE);
+        IF NOT (data ? sub_schema.key) THEN
+          
+          IF NOT optional THEN
+            RAISE EXCEPTION 'Types not matching. Required property (%) is missing. %',sub_schema.key , path USING HINT = path, COLUMN = colname; 
+          ELSE
+            RETURN true; 
+          END IF;
+        END IF;
+
+        IF NOT ${VALIDATE_SCHEMA_FUNCNAME}(
+          -- sub_schema.value::TEXT, 
+          CASE WHEN jsonb_typeof(sub_schema.value) = 'string' THEN TRIM(both '"' from sub_schema.value::TEXT) ELSE sub_schema.value::TEXT END,
+          data->sub_schema.key, 
+          checked_path || sub_schema.key
+        ) THEN
+          RETURN false;
+        END IF;
+
+      END LOOP;
+    ELSE 
+      RAISE EXCEPTION 'Unexpected schema.type ( % ), %',jsonb_typeof(schema->'type'), path USING HINT = path, COLUMN = colname; 
+    END IF; 
+
+  /* oneOf: [{ key_name: { type: "string" } }] */
+  ELSIF schema ? 'oneOf' THEN
+    IF jsonb_typeof(schema->'oneOf') != 'array' THEN
+      RAISE EXCEPTION 'Unexpected oneOf schema. Expecting an array of objects but received: % , %',schema->>'oneOf', path USING HINT = path, COLUMN = colname; 
+    END IF;
+
+    FOR sub_schema IN
+      SELECT jsonb_build_object('type', value) as value
+      FROM jsonb_array_elements(schema->'oneOf')
+    LOOP
+
+      BEGIN
+
+        IF ${VALIDATE_SCHEMA_FUNCNAME}(
+          sub_schema.value::TEXT, 
+          data, 
+          checked_path
+        ) THEN
+          RETURN true;
+        END IF;
+
+      /* Ignore exceptions in case the last schema will match */
+      EXCEPTION WHEN others THEN
+      END;
+    END LOOP;
+
+    RAISE EXCEPTION 'Could not validate against any oneOf schemas ( % ), %', schema->>'oneOf', path USING HINT = path, COLUMN = colname;  
+
+  /* arrayOf: { key_name: { type: "string" } } */
+  ELSIF jsonb_typeof(schema->'arrayOf') = 'object' THEN
+    IF jsonb_typeof(data) != 'array' THEN
+      RAISE EXCEPTION 'Is not an array. %', path USING HINT = path, COLUMN = colname; 
+    END IF;
+
+    FOR array_element IN 
+      SELECT value, row_number() OVER() -1 as idx  
+      FROM jsonb_array_elements(data)
+    LOOP
+      IF NOT ${VALIDATE_SCHEMA_FUNCNAME}(
+        (schema - 'arrayOf' || jsonb_build_object('type', schema->'arrayOf'))::TEXT, -- RENAME
+        array_element.value, checked_path || array_element.idx::TEXT
+      ) THEN
+        RETURN false;
+      END IF; 
+    END LOOP;
+  
+  ELSE
+    RAISE EXCEPTION 'Unexpected schema: %, %', schema, path USING HINT = path, COLUMN = colname; 
+  END IF;
+  
+  RETURN true;
+END;
+$f$ LANGUAGE 'plpgsql' IMMUTABLE;
+
+COMMENT ON FUNCTION ${VALIDATE_SCHEMA_FUNCNAME}  
+IS $$Used to validate jsonb data against a schema:
+validate_jsonb_schema(
+  '{ "type": { "a": "number[]" } }', 
+  '{ "a": [2] }'
+)
+$$;
+ 
+
+/* TESTS */
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ "enum": ["a", "b", 2] }', 
+  '"a"'::JSONB
+);
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ "enum": ["a", "b", 2] }', 
+  '2'::JSONB
+);
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ 
+    "oneOf": [
+      { "a": "string" } , 
+      {
+        "a": {
+          "type": "boolean", 
+          "allowedValues": [false], 
+          "optional": true 
+        }
+      }
+    ] 
+  }', 
+  '{ "a": false }'
+);
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ "arrayOf": { "a": "string", "narr": { "arrayOf": { "a": { "type": "string", "optional": false, "nullable": true } } } } }', 
+  '[{ "a": "ddd", "narr": [{ "a": null }] }]'::JSONB
+);
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ "type": { "a": { "type": "integer[]", "allowedValues": [2] } } }'::TEXT, 
+  '{ "a": [2, 2] }'
+); 
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}(
+  '{ "type": { "a": { "type": "string[]", "allowedValues": ["2"] } } }'::TEXT, 
+  '{ "a": ["2"] }'
+);
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}('{ "type": "any"}', '{}');
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}('{ "type": { "a": { "enum": ["a"] } } }', '{ "a": "a"}');
+
+SELECT ${VALIDATE_SCHEMA_FUNCNAME}('{ "arrayOf": { "a": { "enum": ["a"] } } }', '[{ "a": "a"}]');
+
+`;

package/lib/JSONBValidation/validation.d.ts

@@ -0,0 +1,108 @@
+import { JSONSchema7 } from "json-schema";
+import { BaseColumn, JSONBColumnDef, StrictUnion } from "../TableConfig";
+declare const DATA_TYPES: readonly ["boolean", "number", "integer", "string", "any", ...("string[]" | "number[]" | "boolean[]" | "integer[]" | "any[]")[]];
+type DataType = typeof DATA_TYPES[number];
+export declare namespace JSONB {
+    export type BaseOptions = {
+        /**
+         * False by default
+         */
+        optional?: boolean;
+        /**
+         * False by default
+         */
+        nullable?: boolean;
+        description?: string;
+        title?: string;
+    };
+    export type BasicType = BaseOptions & {
+        type: DataType;
+        allowedValues?: any[];
+        oneOf?: undefined;
+        arrayOf?: undefined;
+        enum?: undefined;
+    };
+    export type ObjectType = BaseOptions & {
+        type: ObjectSchema;
+        allowedValues?: undefined;
+        oneOf?: undefined;
+        arrayOf?: undefined;
+        enum?: undefined;
+    };
+    export type EnumType = BaseOptions & {
+        type?: undefined;
+        enum: readonly any[];
+        oneOf?: undefined;
+        arrayOf?: undefined;
+        allowedValues?: undefined;
+    };
+    export type OneOf = BaseOptions & {
+        type?: undefined;
+        oneOf: readonly ObjectSchema[];
+        arrayOf?: undefined;
+        allowedValues?: undefined;
+        enum?: undefined;
+    };
+    export type ArrayOf = BaseOptions & {
+        type?: undefined;
+        arrayOf: ObjectSchema;
+        allowedValues?: undefined;
+        oneOf?: undefined;
+        enum?: undefined;
+    };
+    export type FieldTypeObj = BasicType | ObjectType | EnumType | OneOf | ArrayOf;
+    export type FieldType = DataType | FieldTypeObj;
+    export type GetType<T extends FieldType | Omit<FieldTypeObj, "optional">> = T extends {
+        type: ObjectSchema;
+    } ? NestedSchemaObject<T["type"]> : T extends "number" | {
+        type: "number";
+    } ? number : T extends "boolean" | {
+        type: "boolean";
+    } ? boolean : T extends "integer" | {
+        type: "integer";
+    } ? number : T extends "string" | {
+        type: "string";
+    } ? string : T extends "any" | {
+        type: "any";
+    } ? any : T extends "number[]" | {
+        type: "number[]";
+    } ? number[] : T extends "boolean[]" | {
+        type: "boolean[]";
+    } ? boolean[] : T extends "integer[]" | {
+        type: "integer[]";
+    } ? number[] : T extends "string[]" | {
+        type: "string[]";
+    } ? string[] : T extends "any[]" | {
+        type: "any[]";
+    } ? any[] : T extends {
+        enum: readonly any[];
+    } ? T["enum"][number] : T extends {
+        oneOf: readonly ObjectSchema[];
+    } ? StrictUnion<NestedSchemaObject<T["oneOf"][number]>> : T extends {
+        arrayOf: ObjectSchema;
+    } ? NestedSchemaObject<T["arrayOf"]>[] : any;
+    type IsOptional<F extends FieldType> = F extends DataType ? false : F extends {
+        optional: true;
+    } ? true : false;
+    export type ObjectSchema = Record<string, FieldType>;
+    export type JSONBSchema = Omit<FieldTypeObj, "optional">;
+    export type NestedSchemaObject<S extends ObjectSchema> = ({
+        [K in keyof S as IsOptional<S[K]> extends true ? K : never]?: GetType<S[K]>;
+    } & {
+        [K in keyof S as IsOptional<S[K]> extends true ? never : K]: GetType<S[K]>;
+    });
+    export type SchemaObject<S extends JSONBSchema> = S["nullable"] extends true ? (null | GetType<S>) : GetType<S>;
+    export {};
+}
+export declare function validate<T>(obj: T, key: keyof T, rawFieldType: JSONB.FieldType): boolean;
+export declare function validateSchema<S extends JSONB.ObjectSchema>(schema: S, obj: JSONB.NestedSchemaObject<S>, objName?: string, optional?: boolean): void;
+type ColOpts = {
+    nullable?: boolean;
+};
+export declare function getSchemaTSTypes(schema: JSONB.ObjectSchema, leading?: string, isOneOf?: boolean): string;
+export declare function getJSONBSchemaTSTypes(schema: JSONB.JSONBSchema, colOpts: ColOpts, leading?: string, isOneOf?: boolean): string;
+export declare function getJSONBSchemaAsJSONSchema(tableName: string, colName: string, columnConfig: BaseColumn<{
+    en: 1;
+}> & JSONBColumnDef): JSONSchema7;
+export {};
+//# sourceMappingURL=validation.d.ts.map

package/lib/JSONBValidation/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAuB,MAAM,aAAa,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIzE,QAAA,MAAM,UAAU,kIAGN,CAAC;AACX,KAAK,QAAQ,GAAG,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAE1C,yBAAiB,KAAK,CAAC;IAErB,MAAM,MAAM,WAAW,GAAG;QACxB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG;QACpC,IAAI,EAAE,QAAQ,CAAC;QACf,aAAa,CAAC,EAAE,GAAG,EAAE,CAAC;QACtB,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,OAAO,CAAC,EAAE,SAAS,CAAC;QACpB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAC;IAEF,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG;QACrC,IAAI,EAAE,YAAY,CAAC;QACnB,aAAa,CAAC,EAAE,SAAS,CAAC;QAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,OAAO,CAAC,EAAE,SAAS,CAAC;QACpB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAA;IAED,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG;QACnC,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;QACrB,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,OAAO,CAAC,EAAE,SAAS,CAAC;QACpB,aAAa,CAAC,EAAE,SAAS,CAAC;KAC3B,CAAC;IAEF,MAAM,MAAM,KAAK,GAAG,WAAW,GAAG;QAChC,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;QAC/B,OAAO,CAAC,EAAE,SAAS,CAAC;QACpB,aAAa,CAAC,EAAE,SAAS,CAAC;QAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAA;IACD,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG;QAClC,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,OAAO,EAAE,YAAY,CAAC;QACtB,aAAa,CAAC,EAAE,SAAS,CAAC;QAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB,CAAA;IAGD,MAAM,MAAM,YAAY,GACtB,SAAS,GACT,UAAU,GACV,QAAQ,GACR,KAAK,GACL,OAAO,CAAC;IAEV,MAAM,MAAM,SAAS,GACnB,QAAQ,GACR,YAAY,CAAC;IAGf,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,IACtE,CAAC,SAAS;QAAE,IAAI,EAAE,YAAY,CAAA;KAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAChE,CAAC,SAAS,QAAQ,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,MAAM,GAChD,CAAC,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,GACnD,CAAC,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG,MAAM,GAClD,CAAC,SAAS,QAAQ,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,MAAM,GAChD,CAAC,SAAS,KAAK,GAAG;QAAE,IAAI,EAAE,KAAK,CAAA;KAAE,GAAG,GAAG,GACvC,CAAC,SAAS,UAAU,GAAG;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,MAAM,EAAE,GACtD,CAAC,SAAS,WAAW,GAAG;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,EAAE,GACzD,CAAC,SAAS,WAAW,GAAG;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,GAAG,MAAM,EAAE,GACxD,CAAC,SAAS,UAAU,GAAG;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,MAAM,EAAE,GACtD,CAAC,SAAS,OAAO,GAAG;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,GAAG,EAAE,GAC7C,CAAC,SAAS;QAAE,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;KAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAEtD,CAAC,SAAS;QAAE,KAAK,EAAE,SAAS,YAAY,EAAE,CAAA;KAAE,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAElG,CAAC,SAAS;QAAE,OAAO,EAAE,YAAY,CAAA;KAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAC1E,GAAG,CAAC;IAEJ,KAAK,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,QAAQ,GAAE,KAAK,GAAG,CAAC,SAAS;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,GAAE,IAAI,GAAG,KAAK,CAAC;IAG9G,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrD,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAEzD,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,IAAI,CACvD;SACG,CAAC,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5E,GAAG;SACD,CAAC,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3E,CACF,CAAC;IACF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAE,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;;CAChH;AAiCD,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,SAAS,GAAG,OAAO,CAqBxF;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,UAAQ,QAG3I;AAGD,KAAK,OAAO,GAAG;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtC,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,YAAY,EAAE,OAAO,SAAK,EAAE,OAAO,UAAQ,GAAG,MAAM,CAkClG;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,SAAK,EAAE,OAAO,UAAQ,GAAG,MAAM,CAgBxH;AA6FD,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC;IAAE,EAAE,EAAE,CAAC,CAAA;CAAE,CAAC,GAAG,cAAc,GAAG,WAAW,CAQhJ"}

package/lib/JSONBValidation/validation.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getJSONBSchemaAsJSONSchema = exports.getJSONBSchemaTSTypes = exports.getSchemaTSTypes = exports.validateSchema = exports.validate = void 0;
+const prostgles_types_1 = require("prostgles-types");
+const PubSubManager_1 = require("../PubSubManager/PubSubManager");
+const PrimitiveTypes = ["boolean", "number", "integer", "string", "any"];
+const DATA_TYPES = [
+    ...PrimitiveTypes,
+    ...PrimitiveTypes.map(v => `${v}[]`)
+];
+/** tests */
+const s = {
+    type: {
+        a: { type: "boolean" },
+        c: { type: { c1: { type: "string" } } },
+        arr: { arrayOf: { d: "string" } },
+        o: {
+            oneOf: [
+                { z: { type: "integer" } },
+                { z1: { type: "integer" } }
+            ]
+        }
+    }
+};
+const ss = {
+    a: true,
+    arr: [{ d: "" }],
+    c: {
+        c1: ""
+    },
+    o: { z1: 23 }
+};
+const getFieldTypeObj = (rawFieldType) => {
+    if (typeof rawFieldType === "string")
+        return { type: rawFieldType };
+    return rawFieldType;
+};
+function validate(obj, key, rawFieldType) {
+    let err = `The provided value for ${JSON.stringify(key)} is of invalid type. Expecting `;
+    const val = obj[key];
+    const fieldType = getFieldTypeObj(rawFieldType);
+    if ("type" in fieldType && fieldType.type) {
+        if (typeof fieldType.type !== "string") {
+            (0, prostgles_types_1.getKeys)(fieldType.type).forEach(subKey => {
+                validate(val, subKey, fieldType.type[subKey]);
+            });
+        }
+        err += fieldType.type;
+        if (fieldType.type === "boolean" && typeof val !== fieldType.type)
+            throw new Error(err);
+        if (fieldType.type === "string" && typeof val !== fieldType.type)
+            throw new Error(err);
+        if (fieldType.type === "number" && !Number.isFinite(val))
+            throw new Error(err);
+        if (fieldType.type === "integer" && !Number.isInteger(val))
+            throw new Error(err);
+    }
+    else if (fieldType.enum) {
+        err += `on of: ${fieldType.enum}`;
+        if (!fieldType.enum.includes(val))
+            throw new Error(err);
+    }
+    return true;
+}
+exports.validate = validate;
+function validateSchema(schema, obj, objName, optional = false) {
+    if ((!schema || (0, prostgles_types_1.isEmpty)(schema)) && !optional)
+        throw new Error(`Expecting ${objName} to be defined`);
+    (0, prostgles_types_1.getKeys)(schema).forEach(k => validate(obj, k, schema[k]));
+}
+exports.validateSchema = validateSchema;
+function getSchemaTSTypes(schema, leading = "", isOneOf = false) {
+    const getFieldType = (rawFieldType) => {
+        const fieldType = getFieldTypeObj(rawFieldType);
+        const nullType = (fieldType.nullable ? `null | ` : "");
+        if (fieldType?.type) {
+            if (typeof fieldType.type === "string") {
+                const correctType = fieldType.type.replace("integer", "number");
+                if (fieldType.allowedValues && fieldType.type.endsWith("[]")) {
+                    return nullType + ` (${fieldType.allowedValues.map(v => JSON.stringify(v)).join(" | ")})[]`;
+                }
+                return nullType + correctType;
+            }
+            else {
+                return nullType + getSchemaTSTypes(fieldType.type, "", true);
+            }
+        }
+        else if (fieldType?.enum) {
+            return nullType + fieldType.enum.map(v => (0, PubSubManager_1.asValue)(v)).join(" | ");
+        }
+        else if (fieldType?.oneOf) {
+            return (fieldType.nullable ? `\n${leading}  | null` : "") + fieldType.oneOf.map(v => `\n${leading}  | ` + getSchemaTSTypes(v, "", true)).join("");
+        }
+        else if (fieldType?.arrayOf) {
+            return (fieldType.nullable ? `\n${leading}  | null` : "") + getSchemaTSTypes(fieldType.arrayOf, "", true) + "[]";
+        }
+        else
+            throw "Unexpected getSchemaTSTypes: " + JSON.stringify({ fieldType, schema }, null, 2);
+    };
+    const spacing = isOneOf ? " " : "  ";
+    const res = `${leading}{ \n` + (0, prostgles_types_1.getKeys)(schema).map(k => {
+        const fieldType = getFieldTypeObj(schema[k]);
+        return `${leading}${spacing}${k}${fieldType.optional ? "?" : ""}: ` + getFieldType(fieldType) + ";";
+    }).join("\n") + ` \n${leading}}${isOneOf ? "" : ";"}`;
+    /** Keep single line */
+    if (isOneOf)
+        return res.split("\n").join("");
+    return res;
+}
+exports.getSchemaTSTypes = getSchemaTSTypes;
+function getJSONBSchemaTSTypes(schema, colOpts, leading = "", isOneOf = false) {
+    if (schema.arrayOf) {
+        return (colOpts.nullable ? `\n${leading}  | null` : "") + getSchemaTSTypes(schema.arrayOf, leading, isOneOf) + "[]";
+    }
+    else if (schema.enum) {
+        return (colOpts.nullable ? `\n${leading}  | null` : "") + schema.enum.map(v => (0, PubSubManager_1.asValue)(v)).join(" | ");
+    }
+    else if (schema.oneOf) {
+        return (colOpts.nullable ? `\n${leading}  | null` : "") + schema.oneOf.map(s => `\n${leading}  | ` + getSchemaTSTypes(s, "", true)).join("");
+    }
+    else {
+        if (typeof schema.type === "string") {
+            return (colOpts.nullable ? `null | ` : "") + schema.type;
+        }
+        else if (schema.type) {
+            return (colOpts.nullable ? `null | ` : "") + getSchemaTSTypes(schema.type, leading, isOneOf);
+        }
+        return "";
+    }
+}
+exports.getJSONBSchemaTSTypes = getJSONBSchemaTSTypes;
+const getJSONSchemaObject = (rawType, rootInfo) => {
+    const { type, arrayOf, description, nullable, oneOf, title, ...t } = typeof rawType === "string" ? ({ type: rawType }) :
+        rawType;
+    let result = {};
+    const partialProps = {
+        ...((t.enum || t.allowedValues?.length) && { enum: t.allowedValues ?? t.enum.slice(0) }),
+        ...(!!description && { description }),
+        ...(!!title && { title }),
+    };
+    if (t.enum?.length) {
+        partialProps.type = typeof t.enum[0];
+    }
+    if (typeof type === "string" || arrayOf) {
+        /** ARRAY */
+        if (type && typeof type !== "string") {
+            throw "Not expected";
+        }
+        if (arrayOf || type?.endsWith("[]")) {
+            const arrayItems = arrayOf ? getJSONSchemaObject({ type: arrayOf }) :
+                type?.startsWith("any") ? { type: undefined } :
+                    {
+                        type: type?.slice(0, -2),
+                        ...(t.allowedValues && { enum: t.allowedValues }),
+                    };
+            result = {
+                type: "array",
+                items: arrayItems,
+            };
+            /** PRIMITIVES */
+        }
+        else {
+            result = {
+                type: type,
+            };
+        }
+        /** OBJECT */
+    }
+    else if ((0, prostgles_types_1.isObject)(type)) {
+        result = {
+            type: "object",
+            required: (0, prostgles_types_1.getKeys)(type).filter(k => {
+                const t = type[k];
+                return typeof t === "string" || !t.optional;
+            }),
+            properties: (0, prostgles_types_1.getKeys)(type).reduce((a, k) => {
+                return {
+                    ...a,
+                    [k]: getJSONSchemaObject(type[k])
+                };
+            }, {}),
+        };
+    }
+    else if (oneOf) {
+        result = {
+            type: "object",
+            oneOf: oneOf.map(s => getJSONSchemaObject({ type: s }))
+        };
+    }
+    if (nullable) {
+        const nullDef = { type: "null" };
+        if (result.oneOf) {
+            result.oneOf.push(nullDef);
+        }
+        else if (result.enum && !result.enum.includes(null)) {
+            result.enum.push(null);
+        }
+        else
+            result = {
+                type: 'object',
+                oneOf: [result, nullDef]
+            };
+    }
+    const rootSchema = !rootInfo ? undefined : {
+        "$id": rootInfo?.id,
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+    };
+    return {
+        ...rootSchema,
+        ...partialProps,
+        ...result,
+    };
+};
+function getJSONBSchemaAsJSONSchema(tableName, colName, columnConfig) {
+    const schema = {
+        ...columnConfig,
+        ...(columnConfig.jsonbSchema ?? { type: columnConfig.jsonbSchemaType })
+    };
+    return getJSONSchemaObject(schema, { id: `${tableName}.${colName}` });
+}
+exports.getJSONBSchemaAsJSONSchema = getJSONBSchemaAsJSONSchema;