prostgles-server 2.0.173 → 2.0.174

package/lib/Prostgles.ts

@@ -21,14 +21,14 @@ import { PubSubManager, DEFAULT_SYNC_BATCH_SIZE, asValue } from "./PubSubManager
 export { DbHandler }
 export type PGP = pgPromise.IMain<{}, pg.IClient>;
 
-import { SQLRequest, TableSchemaForClient, MethodKey, CHANNELS, AnyObject, RULE_METHODS, ClientSchema, getKeys } from "prostgles-types";
+import { SQLRequest, TableSchemaForClient, MethodKey, CHANNELS, AnyObject, RULE_METHODS, ClientSchema, getKeys, DBSchemaTable, TableInfo } from "prostgles-types";
 
 import { DBEventsManager } from "./DBEventsManager";
 
 export type DB = pgPromise.IDatabase<{}, pg.IClient>;
 type DbConnection = string | pg.IConnectionParameters<pg.IClient>;
 type DbConnectionOpts = pg.IDefaults;
-const TABLE_METHODS = ["update", "find", "findOne", "insert", "delete", "upsert"];
+const TABLE_METHODS = ["update", "find", "findOne", "insert", "delete", "upsert"] as const;
 function getDbConnection(dbConnection: DbConnection, options: DbConnectionOpts | undefined, debugQueries = false, onNotice: ProstglesInitOptions["onNotice"]): { db: DB, pgp: PGP } {
     let pgp: PGP = pgPromise({
         
@@ -935,24 +935,26 @@ export class Prostgles<DBO = DbHandler> {
         // let DATA_TYPES = !needType? [] : await this.db.any("SELECT oid, typname FROM pg_type");
         // let USER_TABLES = !needType? [] :  await this.db.any("SELECT relid, relname FROM pg_catalog.pg_statio_user_tables");
 
-        let schema: TableSchemaForClient = {};
+        const { dbo, db, pgp, publishParser } = this;
+        let fullSchema: {
+            schema: TableSchemaForClient;
+            tables: DBSchemaTable[];
+        } | undefined;
         let publishValidationError;
         let rawSQL = false;
         
-        const { dbo, db, pgp, publishParser } = this;
         try {
             if(!publishParser) throw "publishParser undefined";
-            schema = await publishParser.getSchemaFromPublish(socket);
+            fullSchema = await publishParser.getSchemaFromPublish(socket);
         } catch(e){
             publishValidationError = "Server Error: PUBLISH VALIDATION ERROR";
             console.error(`\nProstgles PUBLISH VALIDATION ERROR (after socket connected):\n    ->`, e);
         }
         socket.prostgles = socket.prostgles || {};
-        socket.prostgles.schema = schema;
+        socket.prostgles.schema = fullSchema?.schema;
         /*  RUN Raw sql from client IF PUBLISHED
         */
-        let fullSchema: TableSchema[] = [];
-        let allTablesViews = this.dboBuilder.tablesOrViews ?? [];
+       
         if(this.opts.publishRawSQL && typeof this.opts.publishRawSQL === "function"){
             const canRunSQL = async () => {
                 const publishParams = await this.publishParser?.getPublishParams({ socket })
@@ -974,13 +976,13 @@ export class Prostgles<DBO = DbHandler> {
                 });
                 if(db){
                     // let allTablesViews = await db.any(STEP2_GET_ALL_TABLES_AND_COLUMNS);
-                    fullSchema = allTablesViews;
+                    // fullSchema = allTablesViews;
                     rawSQL = true;
                 } else console.error("db missing");
             }
         }
 
-        // let joinTables = [];
+        const { schema, tables } = fullSchema ?? { schema: {}, tables: [] };
         let joinTables2: string[][] = [];
         if(this.opts.joins){
             // joinTables = Array.from(new Set(flat(this.dboBuilder.getJoins().map(j => j.tables)).filter(t => schema[t])));
@@ -999,7 +1001,7 @@ export class Prostgles<DBO = DbHandler> {
         const clientSchema: ClientSchema = {
             schema, 
             methods: getKeys(methods), 
-            ...(fullSchema? { fullSchema } : {}),
+            tableSchema: tables,
             rawSQL,
             joinTables: joinTables2,
             auth,
@@ -1330,7 +1332,11 @@ export class PublishParser {
                         .find(method => {
                             let rm = MY_RULES.find(r => r.rule === method || (r.methods as any).includes(method));
                             if(!rm){
-                                throw `Invalid rule in publish.${tableName} -> ${method} \nExpecting any of: ${MY_RULES.flatMap(r => [r.rule, ...r.methods]).join(", ")}`;
+                                let extraInfo = "";
+                                if(is_view && RULE_TO_METHODS.find(r => !is_view && r.rule === method || (r.methods as any).includes(method))){
+                                    extraInfo = "You've specified table rules to a view\n";
+                                }
+                                throw `Invalid rule in publish.${tableName} -> ${method} \n${extraInfo}Expecting any of: ${MY_RULES.flatMap(r => [r.rule, ...r.methods]).join(", ")}`;
                             }
 
                             /** Check user privileges */
@@ -1393,8 +1399,9 @@ export class PublishParser {
 
     
     /* Prepares schema for client. Only allowed views and commands will be present */
-    async getSchemaFromPublish(socket: any): Promise<TableSchemaForClient> {
+    async getSchemaFromPublish(socket: any): Promise<{schema: TableSchemaForClient; tables: DBSchemaTable[] }> {
         let schema: TableSchemaForClient = {};
+        let tables: DBSchemaTable[] = []
         
         try {
             /* Publish tables and views based on socket */
@@ -1420,10 +1427,11 @@ export class PublishParser {
 
                         const table_rules = await this.getTableRules({ localParams: {socket}, tableName }, clientInfo);
             
-                        // if(tableName === "insert_rule") throw {table_rules}
                         if(table_rules && Object.keys(table_rules).length){
                             schema[tableName] = {};
-                            let methods: Array<MethodKey> = [];
+                            let methods: MethodKey[] = [];
+                            let tableInfo: TableInfo | undefined;
+                            let tableColumns: DBSchemaTable["columns"] | undefined;
         
                             if(typeof table_rules === "object"){
                                 methods = getKeys(table_rules) as any;
@@ -1438,13 +1446,13 @@ export class PublishParser {
 
                                     schema[tableName][method] = {};
 
-                                    /* Test for issues with the publish rules */
-                                    if(TABLE_METHODS.includes(method)){
+                                    /* Test for issues with the common table CRUD methods () */
+                                    if(TABLE_METHODS.includes(method as any)){
 
                                         let err = null;
                                         try {
                                             let valid_table_command_rules = await this.getValidatedRequestRule({ tableName, command: method, localParams: {socket} }, clientInfo);
-                                            await (this.dbo[tableName] as any)[method]({}, {}, {}, valid_table_command_rules, { socket, has_rules: true, testRule: true }); 
+                                            await (this.dbo[tableName] as any)[method]({}, {}, {}, valid_table_command_rules, { socket, has_rules: true, testRule: true });
                                                 
                                         } catch(e) {
                                             err = "INTERNAL PUBLISH ERROR";
@@ -1453,8 +1461,28 @@ export class PublishParser {
                                             throw `publish.${tableName}.${method}: \n   -> ${e}`;
                                         }
                                     }
+
+
+                                    if(method === "getInfo" || method === "getColumns"){
+                                        let tableRules = await this.getValidatedRequestRule({ tableName, command: method, localParams: {socket} }, clientInfo);
+                                        const res = await (this.dbo[tableName] as any)[method](undefined, undefined, undefined , tableRules, { socket, has_rules: true });
+                                        if(method === "getInfo"){
+                                            tableInfo = res;
+                                        } else if(method === "getColumns"){
+                                            tableColumns = res;
+                                        }
+                                    }
                                 }
                             }));
+
+                            if(tableInfo && tableColumns){
+
+                                tables.push({
+                                    name: tableName,
+                                    info: tableInfo,
+                                    columns: tableColumns
+                                })
+                            }
                         }
                         
                         return true;
@@ -1467,8 +1495,8 @@ export class PublishParser {
             console.error("Prostgles \nERRORS IN PUBLISH: ", JSON.stringify(e));
             throw e;
         }
-
-        return schema;
+        
+        return { schema, tables };
     }
 
 }

package/lib/TableConfig.ts

@@ -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: {
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "2.0.173",
+  "version": "2.0.174",
   "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.140",
     "sharp": "^0.30.5"
   },
   "devDependencies": {

package/tests/client/PID.txt

@@ -1 +1 @@
-38236
+23576

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.150",
         "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.150",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.150.tgz",
+      "integrity": "sha512-ocdd0We0xjB6vmlT87hWhx33Y9+beydgDkFGGiJWLV3kLCNV5obURon4sGZuI4/qi1Am4EkgCzktFoWzaNPrmQ==",
       "dependencies": {
-        "prostgles-types": "^1.5.133"
+        "prostgles-types": "^1.5.140"
       }
     },
     "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.140",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.140.tgz",
+      "integrity": "sha512-nJcrL2yjB2dY4M6whIlIpDDb9USgdfxTwylqUUCMx6Bt+DsSPEMHKD76Ao55WJ6BZAhxNfo6aqg6aOGprY7vRA=="
     },
     "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.150",
+      "resolved": "https://registry.npmjs.org/prostgles-client/-/prostgles-client-1.5.150.tgz",
+      "integrity": "sha512-ocdd0We0xjB6vmlT87hWhx33Y9+beydgDkFGGiJWLV3kLCNV5obURon4sGZuI4/qi1Am4EkgCzktFoWzaNPrmQ==",
       "requires": {
-        "prostgles-types": "^1.5.133"
+        "prostgles-types": "^1.5.140"
       }
     },
     "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.140",
+      "resolved": "https://registry.npmjs.org/prostgles-types/-/prostgles-types-1.5.140.tgz",
+      "integrity": "sha512-nJcrL2yjB2dY4M6whIlIpDDb9USgdfxTwylqUUCMx6Bt+DsSPEMHKD76Ao55WJ6BZAhxNfo6aqg6aOGprY7vRA=="
     },
     "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.150",
     "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

@@ -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",

package/tests/server/index.js

@@ -63,7 +63,7 @@ const dbConnection = {
     const tableConfig = {
         tr2: {
             columns: {
-                t1: { label: { fr: "fr_t1" } },
+                t1: { label: { fr: "fr_t1" }, info: { hint: "hint...", min: "a", max: "b" } },
                 t2: { label: { en: "en_t2" } },
             }
         },

package/tests/server/index.ts

@@ -80,7 +80,7 @@ const dbConnection = {
 
 		tr2: {
 			columns: {
-				t1: { label: { fr: "fr_t1" } },
+				t1: { label: { fr: "fr_t1" }, info: { hint: "hint...", min: "a", max: "b" } },
 				t2: { label: { en: "en_t2" } },
 			}
 		},

package/tests/server/package-lock.json

@@ -21,7 +21,7 @@
     },
     "../..": {
       "name": "prostgles-server",
-      "version": "2.0.172",
+      "version": "2.0.173",
       "license": "MIT",
       "dependencies": {
         "@aws-sdk/client-s3": "^3.95.0",
@@ -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.140",
         "sharp": "^0.30.5"
       },
       "devDependencies": {
@@ -1371,7 +1371,7 @@
         "bluebird": "^3.7.2",
         "file-type": "^16.5.3",
         "pg-promise": "^10.11.1",
-        "prostgles-types": "^1.5.135",
+        "prostgles-types": "^1.5.140",
         "sharp": "^0.30.5",
         "typescript": "^4.7.2"
       }