prostgles-server 2.0.173 → 2.0.176

package/lib/QueryBuilder.ts

@@ -5,8 +5,8 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { pgp, Filter, LocalParams, isPlainObject, TableHandler, ViewHandler, postgresToTsType } from "./DboBuilder";
-import { TableRule } from "./Prostgles";
-import { SelectParamsBasic as SelectParams, isEmpty, FieldFilter, asName, TextFilter_FullTextSearchFilterKeys, ColumnInfo, PG_COLUMN_UDT_DATA_TYPE, isObject } from "prostgles-types";
+import { TableRule } from "./PublishParser";
+import { SelectParams, isEmpty, FieldFilter, asName, TextFilter_FullTextSearchFilterKeys, ColumnInfo, PG_COLUMN_UDT_DATA_TYPE, isObject, Select } from "prostgles-types";
 import { get } from "./utils";
 
 
@@ -200,7 +200,7 @@ const FTS_Funcs: FunctionSpec[] =
       if(isPlainObject(qVal)){
         const keys = Object.keys(qVal);
         if(!keys.length) throw "Bad arg";
-        if(keys.length !==1 || !searchTypes.includes(keys[0])) throw "Expecting a an object with a single key named one of: " + searchTypes.join(", ");
+        if(keys.length !==1 || !searchTypes.includes(keys[0] as any)) throw "Expecting a an object with a single key named one of: " + searchTypes.join(", ");
         qType = keys[0];
         qVal = asValue(qVal[qType]);
 
@@ -1094,7 +1094,7 @@ export class SelectItemBuilder {
     });
   }
 
-  parseUserSelect = async (userSelect: FieldFilter, joinParse?: (key: string, val: any, throwErr: (msg: string) => any) => any) => {
+  parseUserSelect = async (userSelect: Select, joinParse?: (key: string, val: any, throwErr: (msg: string) => any) => any) => {
 
     /* Array select */
     if(Array.isArray(userSelect)){
@@ -1113,7 +1113,8 @@ export class SelectItemBuilder {
       return [];
     } else if(userSelect === "*"){
       this.allowedFields.map(key => this.addColumn(key, true) );
-    } else if(isPlainObject(userSelect) && !isEmpty(userSelect as object)){
+
+    } else if(isPlainObject(userSelect) && !isEmpty(userSelect)){
       const selectKeys = Object.keys(userSelect),
         selectValues = Object.values(userSelect);
   

package/lib/TableConfig.ts

@@ -1,7 +1,7 @@
 import { getKeys, asName } from "prostgles-types";
 import { JoinInfo } from "./DboBuilder";
 import { ALLOWED_EXTENSION, ALLOWED_CONTENT_TYPE } from "./FileManager";
-import { DB, DbHandler, Prostgles } from "./Prostgles";
+import { DB, DBHandlerServer, Prostgles } from "./Prostgles";
 import { asValue } from "./PubSubManager";
 
 type ColExtraInfo = {
@@ -117,7 +117,7 @@ type NamedJoinColumn = {
     joinDef: JoinDef[];
 }
 
-type ColumnConfig<LANG_IDS= { en: 1 }> = NamedJoinColumn | MediaColumn | (BaseColumn<LANG_IDS> & (SQLDefColumn | ReferencedColumn | TextColumn))
+type ColumnConfig<LANG_IDS = { en: 1 }> = NamedJoinColumn | MediaColumn | (BaseColumn<LANG_IDS> & (SQLDefColumn | ReferencedColumn | TextColumn))
 
 type TableDefinition<LANG_IDS> = {
     columns: {
@@ -184,7 +184,7 @@ export type TableConfig<LANG_IDS = { en: 1 }> = {
 export default class TableConfigurator {
 
     config?: TableConfig;
-    get dbo(): DbHandler {
+    get dbo(): DBHandlerServer {
         if(!this.prostgles.dbo) throw "this.prostgles.dbo missing"
         return this.prostgles.dbo 
     };
@@ -208,8 +208,39 @@ export default class TableConfigurator {
         return undefined;
     }
 
-    getColInfo = (params: {col: string, table: string}): ColExtraInfo | undefined => {
-        return (this.config as any)[params.table]?.[params.col]?.info;
+    getColInfo = (params: {col: string, table: string, lang?: string }): (ColExtraInfo & { label?: string }) | undefined => {
+        const colConf = this.getColumnConfig(params.table, params.col);
+        let result: (ColExtraInfo & { label?: string }) | undefined = undefined;
+        if(colConf){
+
+            if("info" in colConf){
+                result = {
+                    ...(result ?? {}),
+                    ...colConf?.info
+                }
+            }
+
+            /**
+             * Get labels from TableConfig if specified
+             */
+            if(colConf.label){
+                const { lang } = params;
+                const lbl = colConf?.label;
+                if(["string", "object"].includes(typeof lbl)){
+                    if(typeof lbl === "string") {
+                        result ??= {};
+                        result.label = lbl
+                    } else if(lang && (lbl?.[lang as "en"] || lbl?.en)) {
+                        result ??= {};
+                        result.label = (lbl?.[lang as "en"]) || lbl?.en;
+                    }
+                }
+
+            }
+        }
+
+                
+        return result;
     }
 
     checkColVal = (params: {col: string, table: string, value: any }): void => {

package/lib/index.ts

@@ -1,11 +1,12 @@
 import { Prostgles, ProstglesInitOptions } from "./Prostgles";
-import { DbHandler, TableHandler, ViewHandler } from "./DboBuilder";
+import { DBSchema } from "prostgles-types";
 
-function prostgles<DBObj = DbHandler>(params: ProstglesInitOptions<DBObj>){
+function prostgles<S extends DBSchema = any>(params: ProstglesInitOptions<S>){
 
-    let prgl = new Prostgles<DBObj>(params as any);
+    let prgl = new Prostgles<S>(params as any);
     return prgl.init(params.onReady);
 }
+export = prostgles;//{ , TableHandler, ViewHandler };
 
 
 // declare const init (params: InitOptions) => {
@@ -13,7 +14,6 @@ function prostgles<DBObj = DbHandler>(params: ProstglesInitOptions<DBObj>){
 //     prgl.init(params.isReady);
 // }
 
-export = prostgles;//{ , TableHandler, ViewHandler };
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "2.0.173",
+  "version": "2.0.176",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,7 +29,7 @@
     "bluebird": "^3.7.2",
     "file-type": "^16.5.3",
     "pg-promise": "^10.11.1",
-    "prostgles-types": "^1.5.135",
+    "prostgles-types": "^1.5.153",
     "sharp": "^0.30.5"
   },
   "devDependencies": {

package/tests/client/PID.txt

@@ -1 +1 @@
-38236
+78625

package/tests/client/index.js

@@ -45,7 +45,7 @@ try {
             onReconnect: (socket) => {
                 log("Reconnected");
             },
-            onReady: async (db, methods, fullSchema, auth) => {
+            onReady: async (db, methods, tableSchema, auth) => {
                 log("onReady.auth", auth);
                 try {
                     log("Starting Client isomorphic tests");
@@ -56,7 +56,7 @@ try {
                     // }
                     log("Client isomorphic tests successful");
                     // try {
-                    await (0, client_only_queries_1.default)(db, auth, log, methods);
+                    await (0, client_only_queries_1.default)(db, auth, log, methods, tableSchema);
                     // } catch(e){
                     //   throw { ClientErr: e }
                     // }

package/tests/client/index.ts

@@ -50,7 +50,7 @@ try {
       onReconnect: (socket) => {
         log("Reconnected")          
       },
-      onReady: async (db, methods, fullSchema, auth) => {
+      onReady: async (db, methods, tableSchema, auth) => {
         log("onReady.auth", auth)
         try {
           log("Starting Client isomorphic tests")
@@ -62,7 +62,7 @@ try {
           log("Client isomorphic tests successful")
   
           // try {
-            await client_only(db, auth, log, methods);
+            await client_only(db, auth, log, methods, tableSchema);
           // } catch(e){
           //   throw { ClientErr: e }
           // }

package/tests/client/package-lock.json

@@ -10,7 +10,7 @@
       "license": "ISC",
       "dependencies": {
         "@types/node": "^14.14.16",
-        "prostgles-client": "^1.5.147",
+        "prostgles-client": "^1.5.153",
         "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.147",
-      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.147.tgz",
-      "integrity": "sha512-OHKHn9/Ynv/v3QSB53ZvhVvWp4pWsrLIy8ZDXloQprB8IUXSS2SdCWnbdkBoD9JH9Z4tUBoq88lTdS7G1KZY3w==",
+      "version": "1.5.153",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.153.tgz",
+      "integrity": "sha512-kveb392Ye8XNgcWGmaMUg9PTQFVdb+f1RegK9TNVLLFG1b03hmsaVBAXCQvO5VvmGkW4rgQ5fZvfsEre5t+flg==",
       "dependencies": {
-        "prostgles-types": "^1.5.133"
+        "prostgles-types": "^1.5.153"
       }
     },
     "node_modules/prostgles-types": {
-      "version": "1.5.133",
-      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.133.tgz",
-      "integrity": "sha512-WVSuoiWAo1hgDl+9QSBPVhszwhxuX1WRi6CdE4epede1eD2Q5rQfO22bli0BBCQXyhE6l/A0Tt6UxhAIlDDSmw=="
+      "version": "1.5.153",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.153.tgz",
+      "integrity": "sha512-TIPtsMFBGH3M01zGXMT1m7aVkr9cJgFryE8mOotJGTZUcaTaNA3s21wwGo4tbOVnyNqnyEgBolItb1s1DuNexg=="
     },
     "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.147",
-      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.147.tgz",
-      "integrity": "sha512-OHKHn9/Ynv/v3QSB53ZvhVvWp4pWsrLIy8ZDXloQprB8IUXSS2SdCWnbdkBoD9JH9Z4tUBoq88lTdS7G1KZY3w==",
+      "version": "1.5.153",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.153.tgz",
+      "integrity": "sha512-kveb392Ye8XNgcWGmaMUg9PTQFVdb+f1RegK9TNVLLFG1b03hmsaVBAXCQvO5VvmGkW4rgQ5fZvfsEre5t+flg==",
       "requires": {
-        "prostgles-types": "^1.5.133"
+        "prostgles-types": "^1.5.153"
       }
     },
     "prostgles-types": {
-      "version": "1.5.133",
-      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.133.tgz",
-      "integrity": "sha512-WVSuoiWAo1hgDl+9QSBPVhszwhxuX1WRi6CdE4epede1eD2Q5rQfO22bli0BBCQXyhE6l/A0Tt6UxhAIlDDSmw=="
+      "version": "1.5.153",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.153.tgz",
+      "integrity": "sha512-TIPtsMFBGH3M01zGXMT1m7aVkr9cJgFryE8mOotJGTZUcaTaNA3s21wwGo4tbOVnyNqnyEgBolItb1s1DuNexg=="
     },
     "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.147",
+    "prostgles-client": "^1.5.153",
     "prostgles-types": "^1.5.68",
     "socket.io-client": "^4.5.1"
   }

package/tests/client_only_queries.js

@@ -1,8 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const assert_1 = require("assert");
+const dist_1 = require("./client/node_modules/prostgles-types/dist");
 const isomorphic_queries_1 = require("./isomorphic_queries");
-async function client_only(db, auth, log, methods) {
+async function client_only(db, auth, log, methods, tableSchema) {
+    /**
+     * onReady(dbo, methodsObj, tableSchema, _auth)
+     * tableSchema must contan an array of all tables and their columns that have getInfo and getColumns allowed
+     */
+    await (0, isomorphic_queries_1.tryRun)("Check tableSchema", async () => {
+        const dbTables = Object.keys(db).map(k => {
+            const h = db[k];
+            return !!(h.getColumns && h.getInfo) ? k : undefined;
+        }).filter(dist_1.isDefined);
+        const missingTbl = dbTables.find(t => !tableSchema.some(st => st.name === t));
+        if (missingTbl)
+            throw `${missingTbl} is missing from tableSchema: ${JSON.stringify(tableSchema)}`;
+        const missingscTbl = tableSchema.find(t => !dbTables.includes(t.name));
+        if (missingscTbl)
+            throw `${missingscTbl} is missing from db`;
+        await Promise.all(tableSchema.map(async (tbl) => {
+            const cols = await db[tbl.name]?.getColumns();
+            const info = await db[tbl.name]?.getInfo();
+            assert_1.strict.deepStrictEqual(tbl.columns, cols);
+            assert_1.strict.deepStrictEqual(tbl.info, info);
+        }));
+    });
     const testRealtime = () => {
         return new Promise(async (resolve, reject) => {
             try {

package/tests/client_only_queries.ts

@@ -1,10 +1,32 @@
 import { strict as assert } from 'assert';
 
 import { DBHandlerClient, Auth } from "./client/index";
+import { DBSchemaTable, isDefined } from "./client/node_modules/prostgles-types/dist";
 import { tryRun, tryRunP } from './isomorphic_queries';
 
-export default async function client_only(db: DBHandlerClient, auth: Auth, log: (...args: any[]) => any, methods){
+export default async function client_only(db: DBHandlerClient, auth: Auth, log: (...args: any[]) => any, methods, tableSchema: DBSchemaTable[]){
   
+  /**
+   * onReady(dbo, methodsObj, tableSchema, _auth)
+   * tableSchema must contan an array of all tables and their columns that have getInfo and getColumns allowed
+   */
+  await tryRun("Check tableSchema", async () => {
+    const dbTables = Object.keys(db).map(k => {
+      const h = db[k];
+      return !!(h.getColumns && h.getInfo)? k : undefined;
+    }).filter(isDefined);
+    const missingTbl = dbTables.find(t => !tableSchema.some(st => st.name === t));
+    if(missingTbl) throw `${missingTbl} is missing from tableSchema: ${JSON.stringify(tableSchema)}`
+    const missingscTbl = tableSchema.find(t => !dbTables.includes(t.name));
+    if(missingscTbl) throw `${missingscTbl} is missing from db`;
+
+    await Promise.all(tableSchema.map(async tbl => {
+      const cols = await db[tbl.name]?.getColumns();
+      const info = await db[tbl.name]?.getInfo();
+      assert.deepStrictEqual(tbl.columns, cols);
+      assert.deepStrictEqual(tbl.info, info);
+    }))
+  });
 
   const testRealtime = () => {
 

package/tests/isomorphic_queries.js

@@ -140,6 +140,9 @@ async function isomorphic(db) {
             },
             {
                 "label": "fr_t1",
+                hint: "hint...",
+                min: "a",
+                max: "b",
                 "name": "t1",
                 "data_type": "text",
                 "udt_name": "text",

package/tests/isomorphic_queries.ts

@@ -1,6 +1,6 @@
 import { strict as assert } from 'assert';
 
-import { DbHandler} from "../dist/Prostgles";
+import { DBHandlerServer} from "../dist/Prostgles";
 import { DBHandlerClient } from "./client/index";
 import * as fs from "fs";
 
@@ -29,7 +29,7 @@ export function tryRunP(desc: string, func: (resolve: any, reject: any) => any,
   });
 }
 
-export default async function isomorphic(db: Partial<DbHandler> | Partial<DBHandlerClient>) {
+export default async function isomorphic(db: Partial<DBHandlerServer> | Partial<DBHandlerClient>) {
   console.log("Starting isomorphic queries");
 
   if(await db.items.count()){
@@ -126,6 +126,9 @@ export default async function isomorphic(db: Partial<DbHandler> | Partial<DBHand
         },
         {
           "label": "fr_t1",
+          hint: "hint...",
+          min: "a", 
+          max: "b",
           "name": "t1",
           "data_type": "text",
           "udt_name": "text",