prostgles-server 4.2.326 → 4.2.328

package/lib/WebsocketAPI/getClientSchema.ts

@@ -1,11 +1,15 @@
 import { isObject, omitKeys, tryCatchV2, type ClientSchema } from "prostgles-types";
 import type { AuthClientRequest } from "../Auth/AuthTypes";
 import { Prostgles } from "../Prostgles";
-import type { PublishParser } from "../PublishParser/PublishParser";
+import type { PermissionScope, PublishParser } from "../PublishParser/PublishParser";
 import { clientCanRunSqlRequest } from "../runClientRequest";
-const version = (require("../../package.json") as { version: string }).version;
+import { version } from "../../package.json";
 
-export async function getClientSchema(this: Prostgles, clientReq: AuthClientRequest) {
+export async function getClientSchema(
+  this: Prostgles,
+  clientReq: AuthClientRequest,
+  scope: PermissionScope | undefined
+) {
   const result = await tryCatchV2(async () => {
     const clientInfo =
       clientReq.socket ?
@@ -22,10 +26,13 @@ export async function getClientSchema(this: Prostgles, clientReq: AuthClientRequ
 
     try {
       if (!publishParser) throw "publishParser undefined";
-      fullSchema = await publishParser.getSchemaFromPublish({
-        ...clientInfo,
-        userData,
-      });
+      fullSchema = await publishParser.getSchemaFromPublish(
+        {
+          ...clientInfo,
+          userData,
+        },
+        scope
+      );
     } catch (e) {
       publishValidationError = e;
       console.error(`\nProstgles Publish validation failed (after socket connected):\n    ->`, e);

package/lib/WebsocketAPI/onSocketConnected.ts

@@ -105,7 +105,7 @@ export async function onSocketConnected(this: Prostgles, socket: PRGLIOSocket) {
         }
       ) => {
         runClientRequest
-          .bind(this)(args, { socket })
+          .bind(this)(args, { socket }, undefined)
           .then((res) => {
             cb(null, res);
           })

package/lib/WebsocketAPI/pushSocketSchema.ts

@@ -5,7 +5,7 @@ import { runClientSqlRequest } from "../runClientRequest";
 import { makeSocketError } from "./onSocketConnected";
 export async function pushSocketSchema(this: Prostgles, socket: PRGLIOSocket) {
   try {
-    const clientSchema = await this.getClientSchema({ socket });
+    const clientSchema = await this.getClientSchema({ socket }, undefined);
     socket.prostgles = clientSchema;
     if (clientSchema.rawSQL) {
       socket.removeAllListeners(CHANNELS.SQL);

package/lib/initProstgles.ts

@@ -7,7 +7,7 @@ import { DBEventsManager } from "./DBEventsManager";
 import { DBOFullyTyped } from "./DBSchemaBuilder";
 import { DBHandlerServer, Prostgles, getIsSuperUser } from "./Prostgles";
 import { ProstglesInitOptions } from "./ProstglesTypes";
-import { DbTableInfo, PublishParser } from "./PublishParser/PublishParser";
+import { DbTableInfo, PublishParser, type PermissionScope } from "./PublishParser/PublishParser";
 import { SchemaWatch } from "./SchemaWatch/SchemaWatch";
 import { runSQLFile } from "./TableConfig/runSQLFile";
 import { sleep } from "./utils";
@@ -72,7 +72,10 @@ export type InitResult<S = void, SUser extends SessionUser = SessionUser> = {
   update: (newOpts: UpdateableOptions<S, SUser>) => Promise<void>;
   restart: () => Promise<InitResult<S, SUser>>;
   options: ProstglesInitOptions<S, SUser>;
-  getClientDBHandlers: (clientReq: AuthClientRequest) => ReturnType<typeof getClientHandlers<S>>;
+  getClientDBHandlers: (
+    clientReq: AuthClientRequest,
+    scope: PermissionScope | undefined
+  ) => ReturnType<typeof getClientHandlers<S>>;
 };
 
 const clientOnlyUpdateKeys = ["auth"] as const satisfies (keyof UpdateableOptions)[];
@@ -270,7 +273,8 @@ export const initProstgles = async function (
         await sleep(1000);
         return true;
       },
-      getClientDBHandlers: (clientReq: AuthClientRequest) => getClientHandlers(this, clientReq),
+      getClientDBHandlers: (clientReq: AuthClientRequest, scope: PermissionScope | undefined) =>
+        getClientHandlers(this, clientReq, scope),
     };
 
     return initResult;

package/lib/runClientRequest.ts

@@ -12,7 +12,7 @@ import { TableHandler as TableHandlerServer } from "./DboBuilder/TableHandler/Ta
 import { parseFieldFilter } from "./DboBuilder/ViewHandler/parseFieldFilter";
 import { canRunSQL } from "./DboBuilder/runSQL";
 import { Prostgles } from "./Prostgles";
-import { ParsedTableRule } from "./PublishParser/publishTypesAndUtils";
+import { ParsedTableRule, type PermissionScope } from "./PublishParser/publishTypesAndUtils";
 
 const TABLE_METHODS = {
   find: 1,
@@ -57,7 +57,8 @@ type TableMethodFunctionWithRulesAndLocalParams = (
 export const runClientRequest = async function (
   this: Prostgles,
   args: Args,
-  clientReq: AuthClientRequest
+  clientReq: AuthClientRequest,
+  scope: PermissionScope | undefined
 ) {
   /* Channel name will only include client-sent params so we ignore table_rules enforced params */
   if (!this.publishParser || !this.dbo) {
@@ -82,7 +83,8 @@ export const runClientRequest = async function (
   }
   const validRules = await this.publishParser.getValidatedRequestRule(
     { tableName, command, clientReq },
-    clientInfo
+    clientInfo,
+    scope
   );
 
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
@@ -151,8 +153,8 @@ export const clientCanRunSqlRequest = async function (
       throw "authHandler missing";
     }
     const publishParams = await this.publishParser?.getPublishParams(clientReq, undefined);
-    const res = publishParams && (await this.opts.publishRawSQL?.(publishParams));
-    return Boolean((res && typeof res === "boolean") || res === "*");
+    const allowedToRunSQL = publishParams && (await this.opts.publishRawSQL?.(publishParams));
+    return allowedToRunSQL === true || allowedToRunSQL === "*";
   };
 
   const allowed = await canRunSQL();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.326",
+  "version": "4.2.328",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -56,7 +56,7 @@
     "pg": "^8.15.6",
     "pg-cursor": "^2.14.6",
     "pg-promise": "^11.13.0",
-    "prostgles-types": "^4.0.177"
+    "prostgles-types": "^4.0.178"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",