prostgles-server 2.0.328 → 2.0.330

package/lib/validation.ts

@@ -1,9 +1,12 @@
-import { asName, getKeys, isEmpty, isObject } from "prostgles-types";
+import { AnyObject, asName, getKeys, isEmpty, isObject } from "prostgles-types";
 import { asValue } from "./PubSubManager";
+import { BaseColumn, ColumnConfig, JSONBColumnDef } from "./TableConfig";
 
 type BaseOptions = {
   optional?: boolean;
   nullable?: boolean;
+  description?: string;
+  title?: string;
 };
 
 type SimpleType = BaseOptions & ({
@@ -203,3 +206,93 @@ export function getJSONBSchemaTSTypes(schema: ValidationSchema | OneOfTypes, col
     return (colOpts.nullable? `null | ` : "") + getSchemaTSTypes(schema, leading, isOneOf);
   }
 }
+
+// type JSONSchema = 
+const getJSONSchemaObject = <T extends ValidationSchema>(objDef: T): Record<keyof T, any> => {
+  const resultType: Record<keyof T, any> = {} as any;
+  
+  return getKeys(objDef).reduce((a, k) => {
+    const itemSchema: FieldType = objDef[k];
+    const { nullable, optional, description, title } = itemSchema;
+    let item = {} as any;
+
+    if("type" in itemSchema){
+      const { type } = itemSchema;
+      /**
+       * Is primitive or any
+       */
+      if(typeof type === "string"){
+        const arrayType = type.endsWith("[]")? type.slice(0, -2) : undefined;
+        if(arrayType){
+          item = {
+            type: "array",
+            items: { type: arrayType === "any"? {} : arrayType }
+          }
+        } else {
+          item = {
+            type: type === "any"? {} : type
+          }
+        }
+
+      /**
+       * Is object
+       */
+      } else {
+        item = {
+          type: "object",
+          properties: getJSONSchemaObject(type)
+        }
+
+      }
+
+    } else if("oneOf" in itemSchema) {
+      item = { 
+        type: "array",
+        items: {
+          "type": typeof itemSchema.oneOf[0]!,
+          "enum": itemSchema.oneOf //.concat(nullable? [null] : [])
+        }
+      }
+    } else if("oneOfTypes" in itemSchema) {
+      item = {
+        oneOf: itemSchema.oneOfTypes.map(t => getJSONSchemaObject(t))
+      }
+    } else {
+      throw "Unexpected jsonbSchema"
+    }
+
+    if(nullable){
+      const nullDef = { type: "null" }
+      if(item.oneOf) item.oneOf.push(nullDef)
+      else item = {
+        oneOf: [item, nullDef]
+      }
+    }
+
+    return { 
+      ...a,
+      [k]: {
+        ...item,
+        required: !optional,
+        description, 
+        title,
+      }
+    }
+  }, resultType)
+}
+
+export function getJSONBSchemaAsJSONSchema(tableName: string, columnConfig: BaseColumn<{ en: 1 }> & JSONBColumnDef): AnyObject {
+
+  const schema = columnConfig.jsonbSchema;
+  const jSchema = isOneOfTypes(schema)? getJSONSchemaObject({ d: schema }).d : getJSONSchemaObject(schema as ValidationSchema);
+
+  return {
+    "$id": tableName ?? "???",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": tableName,
+    "type": "object",
+    description: columnConfig.info?.hint ,
+    ...jSchema
+  }
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "2.0.328",
+  "version": "2.0.330",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,7 +31,7 @@
     "check-disk-space": "^3.3.1",
     "file-type": "^17.1.4",
     "pg-promise": "^10.11.1",
-    "prostgles-types": "^1.5.177",
+    "prostgles-types": "^1.5.179",
     "sharp": "^0.31.0"
   },
   "devDependencies": {
@@ -39,6 +39,6 @@
     "@types/bluebird": "^3.5.36",
     "@types/node": "^18.0.3",
     "@types/sharp": "^0.30.4",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.4"
   }
 }

package/tests/client/PID.txt

@@ -1 +1 @@
-35859
+48447

package/tests/client/package-lock.json

@@ -10,7 +10,7 @@
       "license": "ISC",
       "dependencies": {
         "@types/node": "^14.14.16",
-        "prostgles-client": "^1.5.180",
+        "prostgles-client": "^1.5.183",
         "prostgles-types": "^1.5.68",
         "socket.io-client": "^4.5.1"
       }
@@ -67,17 +67,17 @@
       "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
     },
     "node_modules/prostgles-client": {
-      "version": "1.5.180",
-      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.180.tgz",
-      "integrity": "sha512-A5KA854qMK1pt3dorWLdZMgpQtvNbJEqwFYaAaxdMG/If9YLiFlwSupkg0UgP32jM7doOCtOlgtHYDd4MpUA3w==",
+      "version": "1.5.183",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.183.tgz",
+      "integrity": "sha512-X0w6/HcrauIFI1fgk/lLDnXiQ4f1HsILFHqctPAAnNMGOXosVuAtUMuktAIODYhGomBizodQw5MN7ufkqMER5Q==",
       "dependencies": {
-        "prostgles-types": "^1.5.176"
+        "prostgles-types": "^1.5.179"
       }
     },
     "node_modules/prostgles-types": {
-      "version": "1.5.176",
-      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.176.tgz",
-      "integrity": "sha512-ahphcQ7aVJ/3QNZG1UP3h+pD0NGB73yWzdzKfdQaRVDEmR8p0fzAocAv3MhfaNaanBY6CYTqj0+TJpN/UcqAig=="
+      "version": "1.5.179",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.179.tgz",
+      "integrity": "sha512-ciAxlwoEloybfMjTiOU1w/N3nguCwlcWFTKJ1bD7XHm3VXaLKJraQelOPJPeYr27ujo5iYWJzWBy6GT2yM0wbQ=="
     },
     "node_modules/socket.io-client": {
       "version": "4.5.1",
@@ -176,17 +176,17 @@
       "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
     },
     "prostgles-client": {
-      "version": "1.5.180",
-      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.180.tgz",
-      "integrity": "sha512-A5KA854qMK1pt3dorWLdZMgpQtvNbJEqwFYaAaxdMG/If9YLiFlwSupkg0UgP32jM7doOCtOlgtHYDd4MpUA3w==",
+      "version": "1.5.183",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.183.tgz",
+      "integrity": "sha512-X0w6/HcrauIFI1fgk/lLDnXiQ4f1HsILFHqctPAAnNMGOXosVuAtUMuktAIODYhGomBizodQw5MN7ufkqMER5Q==",
       "requires": {
-        "prostgles-types": "^1.5.176"
+        "prostgles-types": "^1.5.179"
       }
     },
     "prostgles-types": {
-      "version": "1.5.176",
-      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.176.tgz",
-      "integrity": "sha512-ahphcQ7aVJ/3QNZG1UP3h+pD0NGB73yWzdzKfdQaRVDEmR8p0fzAocAv3MhfaNaanBY6CYTqj0+TJpN/UcqAig=="
+      "version": "1.5.179",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.179.tgz",
+      "integrity": "sha512-ciAxlwoEloybfMjTiOU1w/N3nguCwlcWFTKJ1bD7XHm3VXaLKJraQelOPJPeYr27ujo5iYWJzWBy6GT2yM0wbQ=="
     },
     "socket.io-client": {
       "version": "4.5.1",

package/tests/client/package.json

@@ -13,7 +13,7 @@
   "license": "ISC",
   "dependencies": {
     "@types/node": "^14.14.16",
-    "prostgles-client": "^1.5.180",
+    "prostgles-client": "^1.5.183",
     "prostgles-types": "^1.5.68",
     "socket.io-client": "^4.5.1"
   }

package/tests/isomorphic_queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isomorphic_queries.d.ts","sourceRoot":"","sources":["isomorphic_queries.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,iBAYzE;AACD,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,oBAW7F;AAED,wBAA8B,UAAU,CAAC,EAAE,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,iBAq1BjG"}
+{"version":3,"file":"isomorphic_queries.d.ts","sourceRoot":"","sources":["isomorphic_queries.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,iBAYzE;AACD,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,EAAE,QAAQ,oBAW7F;AAED,wBAA8B,UAAU,CAAC,EAAE,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,iBA23BjG"}

package/tests/isomorphic_queries.js

@@ -594,6 +594,42 @@ async function isomorphic(db) {
             // Perfect
         }
     });
+    await tryRun("jsonb JSON Schema validation", async () => {
+        const cols = await db.tjson.getColumns();
+        assert_1.strict.deepEqual({
+            '$id': 'tjson',
+            '$schema': 'https://json-schema.org/draft/2020-12/schema',
+            title: 'tjson',
+            type: 'object',
+            a: { type: 'boolean', required: true },
+            arr: {
+                type: 'array',
+                items: { type: 'string', enum: ['1', '2', '3'] },
+                required: true
+            },
+            arr1: {
+                type: 'array',
+                items: { type: 'number', enum: [1, 2, 3] },
+                required: true
+            },
+            arr2: { type: 'array', items: { type: 'integer' }, required: true },
+            arrStr: {
+                oneOf: [
+                    { type: 'array', items: { type: 'string' } },
+                    { type: 'null' }
+                ],
+                required: false
+            },
+            o: {
+                oneOf: [
+                    { o1: { type: 'integer', required: true } },
+                    { o2: { type: 'boolean', required: true } },
+                    { type: 'null' }
+                ],
+                required: false
+            }
+        }, cols.find(c => c.name === "json").jsonSchema);
+    });
     await tryRun("Exists filter example", async () => {
         const fo = await db.items.findOne(), f = await db.items.find();
         assert_1.strict.deepStrictEqual(fo, { h: null, id: 1, name: 'a' }, "findOne query failed");

package/tests/isomorphic_queries.ts

@@ -677,6 +677,44 @@ export default async function isomorphic(db: Required<DBHandlerServer> | Require
       // Perfect
     }
   });
+
+
+  await tryRun("jsonb JSON Schema validation", async () => {
+    const cols = await db.tjson.getColumns!();
+    assert.deepEqual({
+      '$id': 'tjson',
+      '$schema': 'https://json-schema.org/draft/2020-12/schema',
+      title: 'tjson',
+      type: 'object',
+      a: { type: 'boolean', required: true },
+      arr: {
+        type: 'array',
+        items: { type: 'string', enum: [ '1', '2', '3' ] },
+        required: true
+      },
+      arr1: {
+        type: 'array',
+        items: { type: 'number', enum: [ 1, 2, 3 ] },
+        required: true
+      },
+      arr2: { type: 'array', items: { type: 'integer' }, required: true },
+      arrStr: {
+        oneOf: [
+          { type: 'array', items: { type: 'string' } },
+          { type: 'null' }
+        ],
+        required: false
+      },
+      o: {
+        oneOf: [
+          { o1: { type: 'integer', required: true } },
+          { o2: { type: 'boolean', required: true } },
+          { type: 'null' }
+        ],
+        required: false
+      }
+    }, cols.find(c => c.name === "json").jsonSchema)
+  })
   
   await tryRun("Exists filter example", async () => {
   

package/tests/server/package-lock.json

@@ -21,7 +21,7 @@
     },
     "../..": {
       "name": "prostgles-server",
-      "version": "2.0.327",
+      "version": "2.0.329",
       "license": "MIT",
       "dependencies": {
         "@aws-sdk/client-s3": "^3.121.0",
@@ -31,7 +31,7 @@
         "check-disk-space": "^3.3.1",
         "file-type": "^17.1.4",
         "pg-promise": "^10.11.1",
-        "prostgles-types": "^1.5.177",
+        "prostgles-types": "^1.5.179",
         "sharp": "^0.31.0"
       },
       "devDependencies": {
@@ -39,7 +39,7 @@
         "@types/bluebird": "^3.5.36",
         "@types/node": "^18.0.3",
         "@types/sharp": "^0.30.4",
-        "typescript": "^4.7.4"
+        "typescript": "^4.8.4"
       }
     },
     "node_modules/@types/component-emitter": {
@@ -1375,9 +1375,9 @@
         "check-disk-space": "^3.3.1",
         "file-type": "^17.1.4",
         "pg-promise": "^10.11.1",
-        "prostgles-types": "^1.5.177",
+        "prostgles-types": "^1.5.179",
         "sharp": "^0.31.0",
-        "typescript": "^4.7.4"
+        "typescript": "^4.8.4"
       }
     },
     "proxy-addr": {