prostgles-server 4.2.183 → 4.2.184

package/lib/DBEventsManager.ts

@@ -1,17 +1,19 @@
-import { PostgresNotifListenManager, PrglNotifListener } from "./PostgresNotifListenManager";
+import {
+  PostgresNotifListenManager,
+  PrglNotifListener,
+} from "./PostgresNotifListenManager";
 import { DB, PGP } from "./Prostgles";
 import { getKeys, CHANNELS } from "prostgles-types";
 import { PRGLIOSocket } from "./DboBuilder/DboBuilder";
 
 export class DBEventsManager {
-
-  notifies: { 
+  notifies: {
     [key: string]: {
       socketChannel: string;
-      sockets: any[]; 
+      sockets: any[];
       localFuncs: ((payload: string) => void)[];
       notifMgr: PostgresNotifListenManager;
-    } 
+    };
   } = {};
 
   notice: {
@@ -21,73 +23,82 @@ export class DBEventsManager {
   } = {
     socketChannel: CHANNELS.NOTICE_EV,
     socketUnsubChannel: CHANNELS.NOTICE_EV + "unsubscribe",
-    sockets: []
+    sockets: [],
   };
 
   notifManager?: PostgresNotifListenManager;
 
   db_pg: DB;
-  pgp: PGP
-  constructor(db_pg: DB, pgp: PGP){
+  pgp: PGP;
+  constructor(db_pg: DB, pgp: PGP) {
     this.db_pg = db_pg;
     this.pgp = pgp;
   }
 
   private onNotif: PrglNotifListener = ({ channel, payload }) => {
-
     // console.log(36, { channel, payload },  Object.keys(this.notifies));
 
     getKeys(this.notifies)
-      .filter(ch => ch === channel)
-      .map(ch => {
+      .filter((ch) => ch === channel)
+      .map((ch) => {
         const sub = this.notifies[ch]!;
-        
-        sub.sockets.map(s => {
-          s.emit(sub.socketChannel, payload)
+
+        sub.sockets.map((s) => {
+          s.emit(sub.socketChannel, payload);
         });
-        sub.localFuncs.map(lf => {
+        sub.localFuncs.map((lf) => {
           lf(payload);
-        })
+        });
       });
-  }
+  };
 
   onNotice = (notice: any) => {
-    if(this.notice && this.notice.sockets.length){
-      this.notice.sockets.map(s => {
+    if (this.notice && this.notice.sockets.length) {
+      this.notice.sockets.map((s) => {
         s.emit(this.notice.socketChannel, notice);
-      })
+      });
     }
-  }
+  };
 
   getNotifChannelName = async (channel: string) => {
     const c = await this.db_pg.one("SELECT quote_ident($1) as c", channel);
     return c.c;
-  }
+  };
 
-  async addNotify(query: string, socket?: PRGLIOSocket, func?: any): Promise<{
+  async addNotify(
+    query: string,
+    socket?: PRGLIOSocket,
+    func?: any,
+  ): Promise<{
     socketChannel: string;
     socketUnsubChannel: string;
     notifChannel: string;
     unsubscribe?: () => void;
   }> {
-    if(typeof query !== "string" || (!socket && !func)){
-      throw "Expecting (query: string, socket?, localFunc?) But received: " + JSON.stringify({ query, socket, func });
+    if (typeof query !== "string" || (!socket && !func)) {
+      throw (
+        "Expecting (query: string, socket?, localFunc?) But received: " +
+        JSON.stringify({ query, socket, func })
+      );
     }
 
     /* Remove comments */
-    let q = query.trim()
-      .replace(/\/\*[\s\S]*?\*\/|\/\/.*/g,'\n')
-      .split("\n").map(v => v.trim()).filter(v => v && !v.startsWith("--"))
+    let q = query
+      .trim()
+      .replace(/\/\*[\s\S]*?\*\/|\/\/.*/g, "\n")
+      .split("\n")
+      .map((v) => v.trim())
+      .filter((v) => v && !v.startsWith("--"))
       .join("\n");
 
     /* Find the notify channel name */
-    if(!q.toLowerCase().startsWith("listen")){
+    if (!q.toLowerCase().startsWith("listen")) {
       throw "Expecting a LISTEN query but got: " + query;
     }
     q = q.slice(7).trim(); // Remove listen
-    if(q.endsWith(";")) q = q.slice(0, -1);
+    if (q.endsWith(";")) q = q.slice(0, -1);
 
-    if(q.startsWith('"') && q.endsWith('"')) {
+    if (q.startsWith('"') && q.endsWith('"')) {
       q = q.slice(1, -1);
     } else {
       /* Replicate PG by lowercasing identifier if not quoted */
@@ -95,35 +106,40 @@ export class DBEventsManager {
     }
     q = q.replace(/""/g, `"`);
 
-    const channel = q;    
-    let notifChannel = await this.getNotifChannelName(channel)
+    const channel = q;
+    let notifChannel = await this.getNotifChannelName(channel);
 
     notifChannel = notifChannel.replace(/""/g, `"`);
-    if(notifChannel.startsWith('"')) notifChannel = notifChannel.slice(1, -1);
+    if (notifChannel.startsWith('"')) notifChannel = notifChannel.slice(1, -1);
 
     const socketChannel = CHANNELS.LISTEN_EV + notifChannel,
       socketUnsubChannel = socketChannel + "unsubscribe";
 
-    if(!this.notifies[notifChannel]){
+    if (!this.notifies[notifChannel]) {
       this.notifies[notifChannel] = {
         socketChannel,
-        sockets: socket? [socket] : [],
-        localFuncs: func? [func] : [],
-        notifMgr: await PostgresNotifListenManager.create(this.db_pg, this.onNotif, channel)
-      }
-
+        sockets: socket ? [socket] : [],
+        localFuncs: func ? [func] : [],
+        notifMgr: await PostgresNotifListenManager.create(
+          this.db_pg,
+          this.onNotif,
+          channel,
+        ),
+      };
     } else {
-      if(socket && !this.notifies[notifChannel]!.sockets.find(s => s.id === socket.id)) {
+      if (
+        socket &&
+        !this.notifies[notifChannel]!.sockets.find((s) => s.id === socket.id)
+      ) {
         this.notifies[notifChannel]!.sockets.push(socket);
-
-      } else if(func) {
+      } else if (func) {
         this.notifies[notifChannel]!.localFuncs.push(func);
       }
     }
 
-    if(socket){
+    if (socket) {
       socket.removeAllListeners(socketUnsubChannel);
-      socket.on(socketUnsubChannel, ()=>{
+      socket.on(socketUnsubChannel, () => {
         this.removeNotify(notifChannel, socket);
       });
     }
@@ -132,32 +148,38 @@ export class DBEventsManager {
       socketChannel,
       socketUnsubChannel,
       notifChannel,
-    }
+    };
   }
 
-  removeNotify(channel?: string, socket?: PRGLIOSocket, func?: any){
-    const notifChannel = channel && this.notifies[channel]
-    if(notifChannel){
-      if(socket){
-        notifChannel.sockets = notifChannel.sockets.filter(s => s.id !== socket.id);
-      } else if(func){
-        notifChannel.localFuncs = notifChannel.localFuncs.filter(f => f !== func);
+  removeNotify(channel?: string, socket?: PRGLIOSocket, func?: any) {
+    const notifChannel = channel && this.notifies[channel];
+    if (notifChannel) {
+      if (socket) {
+        notifChannel.sockets = notifChannel.sockets.filter(
+          (s) => s.id !== socket.id,
+        );
+      } else if (func) {
+        notifChannel.localFuncs = notifChannel.localFuncs.filter(
+          (f) => f !== func,
+        );
       }
 
       /* UNLISTEN if no listeners ?? */
     }
 
-    if(socket){
-      getKeys(this.notifies).forEach(channel => {
-        this.notifies[channel]!.sockets = this.notifies[channel]!.sockets.filter(s => s.id !== socket.id);
-      })
+    if (socket) {
+      getKeys(this.notifies).forEach((channel) => {
+        this.notifies[channel]!.sockets = this.notifies[
+          channel
+        ]!.sockets.filter((s) => s.id !== socket.id);
+      });
     }
   }
 
-  addNotice(socket: PRGLIOSocket){
-    if(!socket || !socket.id) throw "Expecting a socket obj with id";
+  addNotice(socket: PRGLIOSocket) {
+    if (!socket || !socket.id) throw "Expecting a socket obj with id";
 
-    if(!this.notice.sockets.find(s => s.id === socket.id)){
+    if (!this.notice.sockets.find((s) => s.id === socket.id)) {
       this.notice.sockets.push(socket);
     }
 
@@ -168,11 +190,11 @@ export class DBEventsManager {
       this.removeNotice(socket);
     });
 
-    return { socketChannel, socketUnsubChannel, }
+    return { socketChannel, socketUnsubChannel };
   }
 
-  removeNotice(socket: PRGLIOSocket){
-    if(!socket || !socket.id) throw "Expecting a socket obj with id";
-    this.notice.sockets = this.notice.sockets.filter(s => s.id !== socket.id)
+  removeNotice(socket: PRGLIOSocket) {
+    if (!socket || !socket.id) throw "Expecting a socket obj with id";
+    this.notice.sockets = this.notice.sockets.filter((s) => s.id !== socket.id);
   }
-}
+}

package/lib/DBSchemaBuilder.ts

@@ -10,7 +10,11 @@ import {
 } from "prostgles-types";
 import prostgles from ".";
 import { Auth } from "./Auth/AuthTypes";
-import { DboBuilder, escapeTSNames, postgresToTsType } from "./DboBuilder/DboBuilder";
+import {
+  DboBuilder,
+  escapeTSNames,
+  postgresToTsType,
+} from "./DboBuilder/DboBuilder";
 import {
   PublishAllOrNothing,
   PublishParams,
@@ -18,14 +22,28 @@ import {
   PublishViewRule,
 } from "./PublishParser/PublishParser";
 import { getJSONBSchemaTSTypes } from "./JSONBValidation/validation";
-import { DBHandlerServer, TableSchemaColumn, TX } from "./DboBuilder/DboBuilderTypes";
+import {
+  DBHandlerServer,
+  TableSchemaColumn,
+  TX,
+} from "./DboBuilder/DboBuilderTypes";
 
 export const getDBSchema = (dboBuilder: DboBuilder): string => {
   const tables: string[] = [];
 
-  const getColTypeForDBSchema = (udt_name: TableSchemaColumn["udt_name"]): string => {
+  const getColTypeForDBSchema = (
+    udt_name: TableSchemaColumn["udt_name"],
+  ): string => {
     if (udt_name === "interval") {
-      const units = ["years", "months", "days", "hours", "minutes", "seconds", "milliseconds"];
+      const units = [
+        "years",
+        "months",
+        "days",
+        "hours",
+        "minutes",
+        "seconds",
+        "milliseconds",
+      ];
 
       return `{ ${units.map((u) => `${u}?: number;`).join(" ")} }`;
     }
@@ -38,13 +56,23 @@ export const getDBSchema = (dboBuilder: DboBuilder): string => {
     ?.slice(0)
     .sort((a, b) => a.name.localeCompare(b.name))
     .forEach((tov) => {
-      const cols = tov.columns.slice(0).sort((a, b) => a.name.localeCompare(b.name));
+      const cols = tov.columns
+        .slice(0)
+        .sort((a, b) => a.name.localeCompare(b.name));
       const getColType = (c: (typeof cols)[number]) => {
         let type: string =
-          (c.is_nullable ? "null | " : "") + getColTypeForDBSchema(c.udt_name) + ";";
-        const colConf = dboBuilder.prostgles.tableConfigurator?.getColumnConfig(tov.name, c.name);
+          (c.is_nullable ? "null | " : "") +
+          getColTypeForDBSchema(c.udt_name) +
+          ";";
+        const colConf = dboBuilder.prostgles.tableConfigurator?.getColumnConfig(
+          tov.name,
+          c.name,
+        );
         if (colConf) {
-          if (isObject(colConf) && (colConf.jsonbSchema || colConf.jsonbSchemaType)) {
+          if (
+            isObject(colConf) &&
+            (colConf.jsonbSchema || colConf.jsonbSchemaType)
+          ) {
             const schema: JSONB.JSONBSchema = colConf.jsonbSchema || {
               ...colConf,
               type: colConf.jsonbSchemaType,
@@ -54,11 +82,13 @@ export const getDBSchema = (dboBuilder: DboBuilder): string => {
               schema,
               { nullable: colConf.nullable },
               "      ",
-              dboBuilder.tablesOrViews ?? []
+              dboBuilder.tablesOrViews ?? [],
             );
           } else if (isObject(colConf) && "enum" in colConf) {
             if (!colConf.enum) throw "colConf.enum missing";
-            const types = colConf.enum.map((t) => (typeof t === "number" ? t : JSON.stringify(t)));
+            const types = colConf.enum.map((t) =>
+              typeof t === "number" ? t : JSON.stringify(t),
+            );
             if (colConf.nullable) {
               types.unshift("null");
             }
@@ -80,7 +110,7 @@ export const getDBSchema = (dboBuilder: DboBuilder): string => {
     columns: {${cols
       .map(
         (c) => `
-      ${getColType(c)}`
+      ${getColType(c)}`,
       )
       .join("")}
     };
@@ -102,12 +132,11 @@ type ServerTableHandler<
   Schema extends DBSchema | void = void,
 > = TableHandler<T, Schema> & { is_view: boolean };
 
-export type DBTableHandlersFromSchema<Schema = void> =
-  Schema extends DBSchema ?
-    {
-      [tov_name in keyof Schema]: Schema[tov_name]["is_view"] extends true ?
-        ServerViewHandler<Schema[tov_name]["columns"], Schema>
-      : ServerTableHandler<Schema[tov_name]["columns"], Schema>;
+export type DBTableHandlersFromSchema<Schema = void> = Schema extends DBSchema
+  ? {
+      [tov_name in keyof Schema]: Schema[tov_name]["is_view"] extends true
+        ? ServerViewHandler<Schema[tov_name]["columns"], Schema>
+        : ServerTableHandler<Schema[tov_name]["columns"], Schema>;
     }
   : Record<string, Partial<ServerTableHandler>>;
 
@@ -125,17 +154,22 @@ export type DBHandlerServerExtra<
 export type DBOFullyTyped<Schema = void> = DBTableHandlersFromSchema<Schema> &
   DBHandlerServerExtra<DBTableHandlersFromSchema<Schema>>;
 
-export type PublishFullyTyped<Schema = void> =
-  Schema extends DBSchema ?
-    | PublishAllOrNothing
-    | {
-        [tov_name in keyof Partial<Schema>]:
-          | PublishAllOrNothing
-          | (Schema[tov_name]["is_view"] extends true ?
-              PublishViewRule<Schema[tov_name]["columns"], Schema>
-            : PublishTableRule<Schema[tov_name]["columns"], Schema>);
-      }
-  : PublishAllOrNothing | Record<string, PublishViewRule | PublishTableRule | PublishAllOrNothing>;
+export type PublishFullyTyped<Schema = void> = Schema extends DBSchema
+  ?
+      | PublishAllOrNothing
+      | {
+          [tov_name in keyof Partial<Schema>]:
+            | PublishAllOrNothing
+            | (Schema[tov_name]["is_view"] extends true
+                ? PublishViewRule<Schema[tov_name]["columns"], Schema>
+                : PublishTableRule<Schema[tov_name]["columns"], Schema>);
+        }
+  :
+      | PublishAllOrNothing
+      | Record<
+          string,
+          PublishViewRule | PublishTableRule | PublishAllOrNothing
+        >;
 
 /** Type checks */
 () => {

package/lib/DboBuilder/DboBuilder.ts

@@ -167,7 +167,9 @@ export class DboBuilder {
 
   _joins?: Join[];
   get joins(): Join[] {
-    return clone(this._joins ?? []).filter((j) => j.tables[0] !== j.tables[1]) as Join[];
+    return clone(this._joins ?? []).filter(
+      (j) => j.tables[0] !== j.tables[1],
+    ) as Join[];
   }
 
   set joins(j: Join[]) {
@@ -179,7 +181,8 @@ export class DboBuilder {
   }
 
   prepareShortestJoinPaths = async () => {
-    const { joins, shortestJoinPaths, joinGraph } = await prepareShortestJoinPaths(this);
+    const { joins, shortestJoinPaths, joinGraph } =
+      await prepareShortestJoinPaths(this);
     this.joinGraph = joinGraph;
     this.joins = joins;
     this.shortestJoinPaths = shortestJoinPaths;
@@ -189,12 +192,17 @@ export class DboBuilder {
     query: string,
     params: any,
     options: SQLOptions | undefined,
-    localParams?: LocalParams
+    localParams?: LocalParams,
   ) => {
     return runSQL
       .bind(this)(query, params, options, localParams)
       .catch((error) =>
-        Promise.reject(getSerializedClientErrorFromPGError(error, { type: "sql", localParams }))
+        Promise.reject(
+          getSerializedClientErrorFromPGError(error, {
+            type: "sql",
+            localParams,
+          }),
+        ),
       );
   };
 
@@ -207,7 +215,7 @@ export class DboBuilder {
       if (subscribeError) {
         console.error(
           "Could not initiate PubSubManager. Realtime data/Subscriptions will not work. Error: ",
-          subscribeError
+          subscribeError,
         );
         this.canSubscribe = false;
       } else {
@@ -218,7 +226,7 @@ export class DboBuilder {
     const start = Date.now();
     const tablesOrViewsReq = await getTablesForSchemaPostgresSQL(
       this,
-      this.prostgles.opts.schemaFilter
+      this.prostgles.opts.schemaFilter,
     );
     await this.prostgles.opts.onLog?.({
       type: "debug",
@@ -228,28 +236,31 @@ export class DboBuilder {
     });
     this.tablesOrViews = tablesOrViewsReq.result;
 
-    this.constraints = await getConstraints(this.db, this.prostgles.opts.schemaFilter);
+    this.constraints = await getConstraints(
+      this.db,
+      this.prostgles.opts.schemaFilter,
+    );
     await this.prepareShortestJoinPaths();
 
     this.dbo = {};
     this.tablesOrViews.map((tov) => {
-      const columnsForTypes = tov.columns.slice(0).sort((a, b) => a.name.localeCompare(b.name));
+      const columnsForTypes = tov.columns
+        .slice(0)
+        .sort((a, b) => a.name.localeCompare(b.name));
 
       const filterKeywords = Object.values(this.prostgles.keywords);
-      const $filterCol = columnsForTypes.find((c) => filterKeywords.includes(c.name));
+      const $filterCol = columnsForTypes.find((c) =>
+        filterKeywords.includes(c.name),
+      );
       if ($filterCol) {
         throw `DboBuilder init error: \n\nTable ${JSON.stringify(tov.name)} column ${JSON.stringify($filterCol.name)} is colliding with Prostgles filtering functionality ($filter keyword)
                 Please provide a replacement keyword name using the $filter_keyName init option. 
                 Alternatively you can rename the table column\n`;
       }
 
-      this.dbo[tov.escaped_identifier] = new (tov.is_view ? ViewHandler : TableHandler)(
-        this.db,
-        tov,
-        this,
-        undefined,
-        this.shortestJoinPaths
-      );
+      this.dbo[tov.escaped_identifier] = new (
+        tov.is_view ? ViewHandler : TableHandler
+      )(this.db, tov, this, undefined, this.shortestJoinPaths);
 
       if (
         this.shortestJoinPaths &&
@@ -282,7 +293,9 @@ export class DboBuilder {
     if (!this.dbo.sql) {
       this.dbo.sql = this.runSQL;
     } else {
-      console.warn(`Could not create dbo.sql handler because there is already a table named "sql"`);
+      console.warn(
+        `Could not create dbo.sql handler because there is already a table named "sql"`,
+      );
     }
 
     this.tsTypesDefinition = [
@@ -296,7 +309,7 @@ export class DboBuilder {
 
   getShortestJoinPath = (
     viewHandler: ViewHandler,
-    target: string
+    target: string,
   ): JoinPaths[number] | undefined => {
     const source = viewHandler.name;
     if (source === target) {
@@ -315,7 +328,9 @@ export class DboBuilder {
       };
     }
 
-    const jp = this.shortestJoinPaths.find((jp) => jp.t1 === source && jp.t2 === target);
+    const jp = this.shortestJoinPaths.find(
+      (jp) => jp.t1 === source && jp.t2 === target,
+    );
     return jp;
   };
 
@@ -324,7 +339,13 @@ export class DboBuilder {
       const dbTX: DbTxTableHandlers & Pick<DBHandlerServer, "sql"> = {};
       this.tablesOrViews?.map((tov) => {
         const handlerClass = tov.is_view ? ViewHandler : TableHandler;
-        dbTX[tov.name] = new handlerClass(this.db, tov, this, { t, dbTX }, this.shortestJoinPaths);
+        dbTX[tov.name] = new handlerClass(
+          this.db,
+          tov,
+          this,
+          { t, dbTX },
+          this.shortestJoinPaths,
+        );
       });
       dbTX.sql = (q, args, opts, localP) =>
         this.runSQL(q, args, opts, { tx: { dbTX, t }, ...(localP ?? {}) });
@@ -338,6 +359,9 @@ export class DboBuilder {
   cacheDBTypes = cacheDBTypes.bind(this);
 
   runClientTransactionStatement = (statement: string) => {
-    return runClientTransactionStatement(statement, this.prostgles.opts.dbConnection as any);
+    return runClientTransactionStatement(
+      statement,
+      this.prostgles.opts.dbConnection as any,
+    );
   };
 }