prostgles-server 4.2.507 → 4.2.508

package/lib/TableConfig/TableConfig.ts

@@ -6,20 +6,24 @@ import type {
   DBSchema,
   JSONB,
   StrictUnion,
-  TableInfo,
 } from "prostgles-types";
 import { isObject } from "prostgles-types";
 import type { JoinInfo, LocalParams } from "../DboBuilder/DboBuilder";
 import type { TableHandler } from "../DboBuilder/TableHandler/TableHandler";
 import { uploadFile } from "../DboBuilder/uploadFile";
+import type { DBOFullyTyped } from "../DBSchemaBuilder/DBSchemaBuilder";
 import type { DB, DBHandlerServer, Prostgles } from "../Prostgles";
 import type {
   InsertRule,
+  SyncConfig,
   ValidateRowArgsCommon,
   ValidateRowsArgsCommon,
 } from "../PublishParser/PublishParser";
+import {
+  DEFAULT_SYNC_BATCH_SIZE,
+  DEFAULT_SYNC_THROTTLE,
+} from "../PubSubManager/PubSubManagerUtils";
 import { initTableConfig } from "./initTableConfig";
-import type { DBOFullyTyped } from "../DBSchemaBuilder/DBSchemaBuilder";
 
 type ColExtraInfo = {
   min?: string | number;
@@ -53,6 +57,7 @@ type BaseTableDefinition<R = AnyObject, DBX = DBHandlerServer> = {
   };
   dropIfExistsCascade?: boolean;
   dropIfExists?: boolean;
+  syncConfig?: SyncConfig;
   hooks?: {
     /**
      * Hook used to run custom logic before inserting a row.
@@ -418,17 +423,26 @@ export default class TableConfigurator {
     return undefined;
   };
 
-  getTableInfo = (params: { tableName: string; lang?: string }): TableInfo["info"] | undefined => {
+  getTableSyncConfig = (tableName: string) => {
+    const syncConfig = this.config[tableName]?.syncConfig;
+    return (
+      syncConfig && {
+        ...syncConfig,
+        batch_size: syncConfig.batch_size ?? DEFAULT_SYNC_BATCH_SIZE,
+        throttle: syncConfig.throttle ?? DEFAULT_SYNC_THROTTLE,
+      }
+    );
+  };
+
+  getTableLabel = (params: { tableName: string; lang?: string }) => {
     const tconf = this.config[params.tableName];
 
-    return {
-      label: parseI18N({
-        config: tconf?.info?.label,
-        lang: params.lang,
-        defaultLang: "en",
-        defaultValue: params.tableName,
-      }),
-    };
+    return parseI18N({
+      config: tconf?.info?.label,
+      lang: params.lang,
+      defaultLang: "en",
+      defaultValue: params.tableName,
+    });
   };
 
   getColInfo = (params: {

package/lib/TableConfig/getCreateSchemaQueries.ts

@@ -15,18 +15,18 @@ export type SchemaRelatedOptions = Pick<
 export const tableConfigWithMigrations = async (
   db: DB,
   { tableConfig, tableConfigMigrations }: SchemaRelatedOptions,
-  file_table_schema: string
+  file_table_schema: string,
 ) => {
   if (!tableConfigMigrations) return { config: tableConfig };
   const { versionTableName = "schema_version" } = tableConfigMigrations;
 
   if (tableConfig?.[versionTableName]) {
     throw new Error(
-      `Table "${versionTableName}" is reserved for version tracking. Please use a different name in tableConfig.`
+      `Table "${versionTableName}" is reserved for version tracking. Please use a different name in tableConfig.`,
     );
   }
 
-  const newConfig = {
+  const newConfig: TableConfig = {
     ...tableConfig,
     [versionTableName]: {
       columns: {
@@ -45,7 +45,7 @@ export const tableConfigWithMigrations = async (
       versionTableName,
       newConfig,
       tableConfigMigrations,
-      file_table_schema
+      file_table_schema,
     ),
   };
 };
@@ -60,10 +60,10 @@ const getMigration = async (
   versionTableName: string,
   tableConfig: TableConfig,
   { version, onMigrate }: Pick<TableConfigMigrations, "version" | "onMigrate">,
-  file_table_queries: string
+  file_table_queries: string,
 ) => {
   const maxVersion = Number(
-    (await db.oneOrNone<{ v: string }>(`SELECT MAX(id) as v FROM ${asName(versionTableName)}`))?.v
+    (await db.oneOrNone<{ v: string }>(`SELECT MAX(id) as v FROM ${asName(versionTableName)}`))?.v,
   );
   const latestVersion = Number.isFinite(maxVersion) ? maxVersion : undefined;
 
@@ -77,7 +77,7 @@ const getMigration = async (
           AND table_config = \${table_config}
           AND file_table_queries = \${file_table_queries}
         `,
-        { version, table_config: tableConfig, file_table_queries }
+        { version, table_config: tableConfig, file_table_queries },
       )
     )?.v;
 
@@ -94,7 +94,7 @@ const getMigration = async (
   const finishMigration = async (t: pgPromise.ITask<{}>) => {
     await t.none(
       `INSERT INTO ${asName(versionTableName)} (id, table_config, file_table_queries) VALUES (\${version}, \${table_config}, \${file_table_queries})`,
-      { version, table_config: tableConfig, file_table_queries }
+      { version, table_config: tableConfig, file_table_queries },
     );
   };
 

package/lib/TableConfig/getTableColumnQueries.ts

@@ -90,7 +90,7 @@ export const getTableColumnQueries = async ({
 
     /** Add new columns */
     newColumnDefs = colDefs
-      .filter((nc) => !tableHandler.columns?.some((c) => nc.name === c.name))
+      .filter((nc) => !tableHandler.columns.some((c) => nc.name === c.name))
       .map((c) => c.def);
 
     /** Altered/Dropped columns */

package/lib/WebsocketAPI/getClientSchema.ts

@@ -39,7 +39,10 @@ export async function getClientSchema(
     }
     const { allowed: rawSQL } = await clientCanRunSqlRequest.bind(this)(clientInfo);
 
-    const { schema, tables, tableSchemaErrors } = fullSchema ?? {
+    const tablesWithSelectRules = new Set(
+      fullSchema?.tables.filter((t) => t.publishInfo.select).map((t) => t.name) ?? [],
+    );
+    const { tables, tableSchemaErrors } = fullSchema ?? {
       schema: {},
       tables: [],
       tableSchemaErrors: {},
@@ -48,7 +51,7 @@ export async function getClientSchema(
     if (this.opts.joins) {
       const _joinTables2 = this.dboBuilder
         .getAllJoinPaths()
-        .filter((jp) => ![jp.t1, jp.t2].find((t) => !schema[t] || !schema[t].findOne))
+        .filter((jp) => [jp.t1, jp.t2].every((t) => tablesWithSelectRules.has(t)))
         .map((jp) => [jp.t1, jp.t2].sort());
       _joinTables2.map((jt) => {
         if (!joinTables2.find((_jt) => _jt.join() === jt.join())) {
@@ -82,7 +85,6 @@ export async function getClientSchema(
     }
 
     const clientSchema: ClientSchema = {
-      schema,
       methods: methodSchema,
       tableSchema: tables,
       rawSQL,

package/lib/index.ts

@@ -7,7 +7,7 @@ function prostgles<S = void, SUser extends SessionUser = SessionUser>(
   params: ProstglesInitOptions<S, SUser>,
 ) {
   const prgl = new Prostgles(params as ProstglesInitOptions);
-  return prgl.init(params.onReady as OnReadyCallbackBasic, {
+  return prgl.init(params.onReady as unknown as OnReadyCallbackBasic, {
     type: "init",
   }) as unknown as Promise<InitResult<S, SUser>>;
 }

package/lib/initProstgles.ts

@@ -1,6 +1,6 @@
 import type pgPromise from "pg-promise";
 import type pg from "pg-promise/typescript/pg-subset";
-import type { SQLHandler } from "prostgles-types";
+import type { SQLHandler, TableSchema } from "prostgles-types";
 import type { AuthClientRequest, SessionUser } from "./Auth/AuthTypes";
 import { removeExpressRoutesTest } from "./Auth/utils/removeExpressRoute";
 import { DBEventsManager } from "./DBEventsManager";
@@ -10,7 +10,6 @@ import { getDbConnection } from "./getDbConnection";
 import type { DBHandlerServer, Prostgles } from "./Prostgles";
 import { getIsSuperUser } from "./Prostgles";
 import type { ProstglesInitOptions } from "./ProstglesTypes";
-import type { DbTableInfo } from "./PublishParser/PublishParser";
 import { PublishParser, type PermissionScope } from "./PublishParser/PublishParser";
 import { SchemaWatch } from "./SchemaWatch/SchemaWatch";
 import { runSQLFile } from "./TableConfig/runSQLFile";
@@ -62,7 +61,7 @@ export type OnInitReason =
 type OnReadyParamsCommon = {
   db: DB;
   sql: SQLHandler;
-  tables: DbTableInfo[];
+  tables: TableSchema[];
   reason: OnInitReason;
 };
 export type OnReadyParamsBasic = OnReadyParamsCommon & {

package/lib/runClientRequest.ts

@@ -94,7 +94,8 @@ export const runClientRequest = async function (
     );
   }
 
-  if (!this.dboBuilder.dboMap.has(tableName)) {
+  const tableHandler = this.dboBuilder.dboMap.get(tableName);
+  if (!tableHandler) {
     throw `tableName ${tableName} is invalid or not allowed`;
   }
 
@@ -140,17 +141,14 @@ export const runClientRequest = async function (
       throw "Must be allowed to run sql to use returnQuery";
     }
   }
-  const tableHandler = this.dbo[tableName];
-  if (!tableHandler || !tableHandler.column_names) throw `Invalid tableName ${tableName} provided`;
 
   /**
    * satisfies check is used to ensure rules arguments are correctly passed to each method
    */
-  const tableCommand = tableHandler[command]?.bind(tableHandler) satisfies
+  const _tableCommand = tableHandler[command].bind(tableHandler) satisfies
     | undefined
     | TableMethodFunctionWithRulesAndLocalParams;
-  if (!tableCommand) throw `Invalid or disallowed command provided: ${command}`;
-  return (this.dbo[tableName]![command] as TableMethodFunctionWithRulesAndLocalParams)(
+  return (tableHandler[command] as TableMethodFunctionWithRulesAndLocalParams)(
     param1,
     param2,
     param3,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prostgles-server",
-  "version": "4.2.507",
+  "version": "4.2.508",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,7 +57,7 @@
     "pg": "^8.19.0",
     "pg-cursor": "^2.19.0",
     "pg-promise": "^12.6.2",
-    "prostgles-types": "^4.0.222"
+    "prostgles-types": "^4.0.232"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",

package/dist/DboBuilder/TableRules/getValidatedRules.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getValidatedRules.d.ts","sourceRoot":"","sources":["../../../lib/DboBuilder/TableRules/getValidatedRules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAI9D,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,WAAW,EACjB,UAAU,CAAC,EAAE,eAAe,EAC5B,WAAW,CAAC,EAAE,WAAW,GACxB,mBAAmB,CAmKrB"}

package/dist/DboBuilder/TableRules/getValidatedRules.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getValidatedRules.js","sourceRoot":"","sources":["../../../lib/DboBuilder/TableRules/getValidatedRules.ts"],"names":[],"mappings":";;AAQA,8CAuKC;AA/KD,qDAA4D;AAK5D,+EAA4E;AAC5E,yDAAsD;AAEtD,SAAgB,iBAAiB,CAE/B,UAA4B,EAC5B,WAAyB;IAEzB,IAAI,WAAW,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAClD,MAAM,+DAA+D,CAAC;IACxE,CAAC;IAED,2DAA2D;IAC3D,MAAM,UAAU,GAAgB,IAAI,CAAC,YAAY;SAC9C,KAAK,CAAC,CAAC,CAAC;SACR,GAAG,CACF,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC;QACC,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,IAAA,yBAAW,EAAC,SAAS,EAAE,UAAU,CAAC;QAC/E,QAAQ,EAAE,KAAK;KAChB,CAAc,CAClB;SACA,MAAM,CACL,iCAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,QAAQ,EAAE,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,EAAE,EAAE,CACzD,CAAC,CAAC,QAAQ,CAAC;YACT,aAAa;YACb,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,IAAI,CAAC,OAAO;YAExB,yCAAyC;YACzC,+CAA+C;YAC/C,aAAa,EAAE,UAAU;SAC1B,CAAC;QACJ,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC,CACJ,CAAC;IAEJ,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,IAAA,yBAAO,EAAC,UAAU,CAAC;YACrB,MAAM,2DAA2D,GAAG,IAAI,CAAC,IAAI,CAAC;QAChF,MAAM,cAAc,GAAG,CACnB,OAAkD,EAClD,SAAS,GAAG,QAAQ,EACpB,EAAE;YACF,MAAM,mBAAmB,IAAI,CAAC,IAAI,IAAI,OAAO,YAAY,SAAS,gDAAgD,SAAS,yEAAyE,CAAC;QACvM,CAAC,EACD,8BAA8B,GAAG,CAAC,GAAG,WAAwC,EAAY,EAAE;YACzF,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC,CAAC;QAEJ,MAAM,GAAG,GAAwB;YAC/B,UAAU;YACV,UAAU,EAAE,UAAU,CAAC,UAAU,IAAI,IAAI;YACzC,OAAO,EAAE,UAAU,CAAC,UAAU,IAAI,IAAI;SACvC,CAAC;QAEF,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM;gBAAE,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;YAE/D,IAAI,QAAQ,GAAkB,IAAI,CAAC;YACnC,IACE,CAAC,WAAW,EAAE,WAAW;gBACzB,UAAU,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS;gBACxC,UAAU,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,EACvC,CAAC;gBACD,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACtC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;oBACjC,MAAM,CACJ,oBAAoB,IAAI,CAAC,IAAI,wEAAwE;wBACrG,EAAE,CACH,CAAC;gBACJ,QAAQ,GAAG,EAAE,CAAC;YAChB,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC/D,GAAG,CAAC,MAAM,GAAG;gBACX,MAAM;gBACN,aAAa,EACX,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;oBAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC;oBACxD,CAAC,CAAC,MAAM;gBACV,YAAY,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE;gBACnD,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnE,QAAQ;aACT,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM;gBAAE,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;YAE/D,GAAG,CAAC,MAAM,GAAG;gBACX,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC;gBACvD,UAAU,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC/C,YAAY,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE;gBACnD,eAAe,EAAE,8BAA8B,CAC7C,UAAU,CAAC,MAAM,CAAC,eAAe,EACjC,UAAU,CAAC,MAAM,EAAE,MAAM,EACzB,UAAU,CAAC,MAAM,CAAC,MAAM,CACzB;gBACD,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC;aACpE,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM;gBAAE,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;YAE/D,GAAG,CAAC,MAAM,GAAG;gBACX,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC;gBACvD,UAAU,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC/C,eAAe,EAAE,8BAA8B,CAC7C,UAAU,CAAC,MAAM,CAAC,eAAe,EACjC,UAAU,CAAC,MAAM,EAAE,MAAM,EACzB,UAAU,CAAC,MAAM,CAAC,MAAM,CACzB;aACF,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY;gBAAE,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAErF,GAAG,CAAC,MAAM,GAAG;gBACX,YAAY,EAAE,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE;gBACnD,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnE,eAAe,EAAE,8BAA8B,CAAC,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;aACnF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACzF,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAc,CAAC;gBAAE,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;YAC3E,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAiB,CAAC;gBAAE,GAAG,CAAC,UAAU,GAAG,KAAK,CAAC;QACnF,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO;QACL,UAAU;QACV,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,IAAI;QACb,MAAM,EAAE;YACN,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,OAAO;YACrB,aAAa,EAAE,OAAO;YACtB,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAE;YACN,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,OAAO;YACrB,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,EAAE;YACd,eAAe,EAAE,OAAO;SACzB;QACD,MAAM,EAAE;YACN,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,EAAE;YACd,eAAe,EAAE,OAAO;SACzB;QACD,MAAM,EAAE;YACN,YAAY,EAAE,OAAO;YACrB,YAAY,EAAE,EAAE;YAChB,eAAe,EAAE,OAAO;SACzB;KACF,CAAC;AACJ,CAAC"}