prostgles-server 4.2.583 → 4.2.585

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/dist/DboBuilder/DboBuilder.d.ts.map +1 -1
  2. package/dist/DboBuilder/DboBuilder.js +6 -4
  3. package/dist/DboBuilder/DboBuilder.js.map +1 -1
  4. package/dist/DboBuilder/TableHandler/TableHandler.d.ts +8 -6
  5. package/dist/DboBuilder/TableHandler/TableHandler.d.ts.map +1 -1
  6. package/dist/DboBuilder/TableHandler/TableHandler.js +6 -6
  7. package/dist/DboBuilder/TableHandler/TableHandler.js.map +1 -1
  8. package/dist/DboBuilder/TableHandler/delete.d.ts.map +1 -1
  9. package/dist/DboBuilder/TableHandler/delete.js +1 -1
  10. package/dist/DboBuilder/TableHandler/delete.js.map +1 -1
  11. package/dist/DboBuilder/ViewHandler/ViewHandler.d.ts +4 -1
  12. package/dist/DboBuilder/ViewHandler/ViewHandler.d.ts.map +1 -1
  13. package/dist/DboBuilder/ViewHandler/ViewHandler.js +3 -1
  14. package/dist/DboBuilder/ViewHandler/ViewHandler.js.map +1 -1
  15. package/dist/DboBuilder/schema/getTablesForSchemaPostgresSQL.d.ts +1 -1
  16. package/dist/Prostgles.d.ts +4 -50
  17. package/dist/Prostgles.d.ts.map +1 -1
  18. package/dist/Prostgles.js +9 -6
  19. package/dist/Prostgles.js.map +1 -1
  20. package/dist/ProstglesTypes.d.ts +5 -0
  21. package/dist/ProstglesTypes.d.ts.map +1 -1
  22. package/dist/ProstglesTypes.js.map +1 -1
  23. package/dist/StorageClient/getFileTableConfig.d.ts +5 -1
  24. package/dist/StorageClient/getFileTableConfig.d.ts.map +1 -1
  25. package/dist/StorageClient/getFileTableConfig.js +57 -50
  26. package/dist/StorageClient/getFileTableConfig.js.map +1 -1
  27. package/dist/TableConfig/TableConfigTypes.d.ts +6 -38
  28. package/dist/TableConfig/TableConfigTypes.d.ts.map +1 -1
  29. package/dist/TableConfig/TableConfigurator.d.ts +1 -51
  30. package/dist/TableConfig/TableConfigurator.d.ts.map +1 -1
  31. package/dist/TableConfig/TableConfigurator.js +1 -1
  32. package/dist/TableConfig/TableConfigurator.js.map +1 -1
  33. package/dist/TableConfig/getCreateSchemaQueries.d.ts +3 -102
  34. package/dist/TableConfig/getCreateSchemaQueries.d.ts.map +1 -1
  35. package/dist/TableConfig/getTableConfigSchemaQueries.d.ts +3 -102
  36. package/dist/TableConfig/getTableConfigSchemaQueries.d.ts.map +1 -1
  37. package/dist/TableHooks/TableHooks.d.ts +38 -0
  38. package/dist/TableHooks/TableHooks.d.ts.map +1 -0
  39. package/dist/TableHooks/TableHooks.js +3 -0
  40. package/dist/TableHooks/TableHooks.js.map +1 -0
  41. package/dist/index.d.ts +1 -0
  42. package/dist/index.d.ts.map +1 -1
  43. package/dist/index.js.map +1 -1
  44. package/dist/updateConfiguration.d.ts.map +1 -1
  45. package/dist/updateConfiguration.js +8 -2
  46. package/dist/updateConfiguration.js.map +1 -1
  47. package/lib/DboBuilder/DboBuilder.ts +6 -4
  48. package/lib/DboBuilder/TableHandler/TableHandler.ts +8 -7
  49. package/lib/DboBuilder/TableHandler/delete.ts +2 -3
  50. package/lib/DboBuilder/ViewHandler/ViewHandler.ts +5 -0
  51. package/lib/Prostgles.ts +11 -6
  52. package/lib/ProstglesTypes.ts +6 -0
  53. package/lib/StorageClient/getFileTableConfig.ts +66 -59
  54. package/lib/TableConfig/TableConfigTypes.ts +5 -43
  55. package/lib/TableConfig/TableConfigurator.ts +1 -1
  56. package/lib/TableHooks/TableHooks.ts +51 -0
  57. package/lib/index.ts +1 -0
  58. package/lib/updateConfiguration.ts +8 -2
  59. package/package.json +1 -1
@@ -28,36 +28,14 @@ export type ColExtraInfo = {
28
28
 
29
29
  export type LangToTranslation = Record<string, string>;
30
30
 
31
- type BaseTableDefinition<R = AnyObject, DBX = DBHandlerServer> = {
31
+ type BaseTableDefinition = {
32
32
  info?: {
33
33
  label?: string | LangToTranslation;
34
34
  };
35
35
  dropIfExistsCascade?: boolean;
36
36
  dropIfExists?: boolean;
37
37
  syncConfig?: SyncConfig;
38
- hooks?: {
39
- /**
40
- * Hook used to run custom logic before inserting a row.
41
- * The returned row must satisfy the table schema.
42
- */
43
- getPreInsertRow?: (
44
- args: GetPreInsertRowArgs,
45
- ) => Promise<{ row: AnyObject; onInserted: Promise<void> }>;
46
- beforeEach?: BeforeEachTsTrigger<R, DBX>[];
47
- afterEach?: AfterEachTsTrigger<R, DBX>[];
48
- afterAll?: AfterAllTsTrigger<R, DBX>[];
49
- onInsteadOfDelete?: (args: {
50
- dbx: DBX;
51
- tx: pgPromise.ITask<{}>;
52
- returningQuery: string;
53
- isOneOrNone: boolean;
54
- queryType: "any" | "none";
55
- filterOpts: {
56
- where: string;
57
- filter: AnyObject;
58
- };
59
- }) => Promise<AnyObject[]>;
60
- };
38
+
61
39
  triggers?: {
62
40
  [triggerName: string]: {
63
41
  /**
@@ -232,11 +210,7 @@ type ConstraintType = "PRIMARY KEY" | "UNIQUE" | "CHECK" | "FOREIGN KEY";
232
210
  * Each column definition cannot reference to tables that appear later in the table definition.
233
211
  * These references should be specified in constraints property
234
212
  */
235
- export type TableDefinition<
236
- LANG_IDS = { en: 1 },
237
- R = AnyObject,
238
- DBX = DBHandlerServer,
239
- > = BaseTableDefinition<R, DBX> & {
213
+ export type TableDefinition<LANG_IDS = { en: 1 }> = BaseTableDefinition & {
240
214
  onMount?: (params: {
241
215
  dbo: DBHandlerServer;
242
216
  _db: DB;
@@ -323,18 +297,6 @@ export type TableDefinition<
323
297
  };
324
298
  };
325
299
 
326
- type GetPreInsertRowArgs = Omit<ValidateRowArgsCommon, "localParams"> & {
327
- validate: InsertRule["validate"];
328
- localParams: LocalParams | undefined;
300
+ export type TableConfig<LANG_IDS = { en: 1 }> = {
301
+ [table_name: string]: TableDefinition<LANG_IDS> | LookupTableDefinition<LANG_IDS>;
329
302
  };
330
-
331
- export type TableConfig<LANG_IDS = { en: 1 }, S = void> =
332
- S extends DBSchema ?
333
- Partial<{
334
- [TableName in keyof S]:
335
- | TableDefinition<LANG_IDS, S[TableName]["columns"], DBOFullyTyped<S>>
336
- | LookupTableDefinition<LANG_IDS>;
337
- }>
338
- : {
339
- [table_name: string]: TableDefinition<LANG_IDS> | LookupTableDefinition<LANG_IDS>;
340
- };
@@ -16,7 +16,7 @@ export class TableConfigurator {
16
16
  instanceId = Date.now() + Math.random();
17
17
 
18
18
  get config() {
19
- return this.prostgles.mergedTableConfig ?? {};
19
+ return this.prostgles.mergedTableConfig.tableConfig ?? {};
20
20
  }
21
21
  get dbo(): DBHandlerServer {
22
22
  if (!this.prostgles.dbo) throw "this.prostgles.dbo missing";
@@ -0,0 +1,51 @@
1
+ import type pgPromise from "pg-promise";
2
+ import type { AnyObject, DBSchema } from "prostgles-types";
3
+
4
+ import type { DbTxTableHandlers, LocalParams } from "../DboBuilder/DboBuilderTypes";
5
+ import type { DBOFullyTyped } from "../DBSchemaBuilder/DBSchemaBuilder";
6
+ import type {
7
+ AfterAllTsTrigger,
8
+ AfterEachTsTrigger,
9
+ BeforeEachTsTrigger,
10
+ InsertRule,
11
+ ValidateRowArgsCommon,
12
+ } from "../PublishParser/PublishParser";
13
+
14
+ export type TableHooks<S = void> =
15
+ S extends DBSchema ?
16
+ Partial<{
17
+ [tableName in keyof S]: TableHooksDefinition<
18
+ Required<S[tableName]["columns"]>,
19
+ DBOFullyTyped<S>
20
+ >;
21
+ }>
22
+ : Record<string, TableHooksDefinition>;
23
+
24
+ export type TableHooksDefinition<R = AnyObject, DBX = DbTxTableHandlers> = {
25
+ /**
26
+ * Hook used to run custom logic before inserting a row.
27
+ * The returned row must satisfy the table schema.
28
+ */
29
+ getPreInsertRow?: (
30
+ args: PreInsertRowArgs,
31
+ ) => Promise<{ row: AnyObject; onInserted: Promise<void> }>;
32
+ beforeEach?: BeforeEachTsTrigger<R, DBX>[];
33
+ afterEach?: AfterEachTsTrigger<R, DBX>[];
34
+ afterAll?: AfterAllTsTrigger<R, DBX>[];
35
+ onInsteadOfDelete?: (args: {
36
+ dbx: DBX;
37
+ tx: pgPromise.ITask<{}>;
38
+ returningQuery: string;
39
+ isOneOrNone: boolean;
40
+ queryType: "any" | "none";
41
+ filterOpts: {
42
+ where: string;
43
+ filter: AnyObject;
44
+ };
45
+ }) => Promise<AnyObject[] | undefined>;
46
+ };
47
+
48
+ type PreInsertRowArgs = Omit<ValidateRowArgsCommon, "localParams"> & {
49
+ validate: InsertRule["validate"];
50
+ localParams: LocalParams | undefined;
51
+ };
package/lib/index.ts CHANGED
@@ -20,6 +20,7 @@ export type { StorageClient as CloudClient } from "./StorageClient/StorageClient
20
20
  export * from "./StorageClient/getLocalStorageClient";
21
21
  export type { DB } from "./initProstgles";
22
22
  export type * from "./TableConfig/TableConfigTypes";
23
+ export type * from "./TableHooks/TableHooks";
23
24
  export * from "./Auth/utils/upsertNamedExpressMiddleware";
24
25
  export type { RequestWithUser } from "./Auth/middleware/userContextMiddleware";
25
26
  export default prostgles;
@@ -29,7 +29,10 @@ export const updateConfiguration = async <DBSchema, UserSchema extends SessionUs
29
29
  prgl.initRestApi();
30
30
  }
31
31
  if (includes(optionsThatChanged, "tableConfig")) {
32
- await prgl.initTableConfig({ type: "prgl.update", newOpts });
32
+ await prgl.initTableConfig({
33
+ type: "prgl.update",
34
+ newOpts: newOpts,
35
+ });
33
36
  }
34
37
  if (includes(optionsThatChanged, "schema")) {
35
38
  await prgl.refreshDBO();
@@ -61,7 +64,10 @@ export const updateConfiguration = async <DBSchema, UserSchema extends SessionUs
61
64
  ) {
62
65
  prgl.setupSocketIO();
63
66
  } else {
64
- await prgl.init(onReady, { type: "prgl.update", newOpts });
67
+ await prgl.init(onReady, {
68
+ type: "prgl.update",
69
+ newOpts: newOpts,
70
+ });
65
71
  }
66
72
  };
67
73
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "prostgles-server",
3
- "version": "4.2.583",
3
+ "version": "4.2.585",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",