@ruiapp/rapid-core 0.9.9 → 0.10.1

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 (198) hide show
  1. package/CHANGELOG.md +11 -11
  2. package/dist/bootstrapApplicationConfig.d.ts +51 -0
  3. package/dist/index.js +168 -40
  4. package/dist/plugins/auth/services/AuthService.d.ts +7 -1
  5. package/dist/types.d.ts +4 -0
  6. package/package.json +1 -1
  7. package/rollup.config.js +16 -16
  8. package/src/bootstrapApplicationConfig.ts +897 -782
  9. package/src/core/actionHandler.ts +23 -23
  10. package/src/core/eventManager.ts +20 -20
  11. package/src/core/facility.ts +7 -7
  12. package/src/core/http/formDataParser.ts +89 -89
  13. package/src/core/http-types.ts +4 -4
  14. package/src/core/pluginManager.ts +193 -193
  15. package/src/core/providers/runtimeProvider.ts +5 -5
  16. package/src/core/request.ts +96 -96
  17. package/src/core/response.ts +79 -79
  18. package/src/core/routeContext.ts +127 -127
  19. package/src/core/routes/healthz.ts +20 -20
  20. package/src/core/routes/index.ts +3 -3
  21. package/src/core/routesBuilder.ts +110 -110
  22. package/src/core/server.ts +156 -156
  23. package/src/dataAccess/columnTypeMapper.ts +22 -22
  24. package/src/dataAccess/dataAccessTypes.ts +165 -165
  25. package/src/dataAccess/dataAccessor.ts +135 -135
  26. package/src/dataAccess/entityManager.ts +1932 -1932
  27. package/src/dataAccess/entityMapper.ts +111 -111
  28. package/src/dataAccess/entityValidator.ts +33 -33
  29. package/src/dataAccess/propertyMapper.ts +28 -28
  30. package/src/deno-std/assert/assert.ts +9 -9
  31. package/src/deno-std/assert/assertion_error.ts +7 -7
  32. package/src/deno-std/datetime/to_imf.ts +32 -32
  33. package/src/deno-std/encoding/base64.ts +141 -141
  34. package/src/deno-std/http/cookie.ts +372 -372
  35. package/src/facilities/cache/CacheFacilityTypes.ts +29 -29
  36. package/src/facilities/cache/CacheFactory.ts +31 -31
  37. package/src/facilities/cache/MemoryCache.ts +58 -58
  38. package/src/facilities/cache/MemoryCacheProvider.ts +15 -15
  39. package/src/facilities/log/LogFacility.ts +35 -35
  40. package/src/helpers/entityHelper.ts +89 -89
  41. package/src/helpers/filterHelper.ts +148 -148
  42. package/src/helpers/inputHelper.ts +11 -11
  43. package/src/helpers/licenseHelper.ts +29 -29
  44. package/src/helpers/metaHelper.ts +111 -111
  45. package/src/helpers/runCollectionEntityActionHandler.ts +58 -58
  46. package/src/index.ts +82 -82
  47. package/src/plugins/auth/AuthPlugin.ts +107 -103
  48. package/src/plugins/auth/AuthPluginTypes.ts +11 -11
  49. package/src/plugins/auth/actionHandlers/changePassword.ts +61 -61
  50. package/src/plugins/auth/actionHandlers/createSession.ts +68 -68
  51. package/src/plugins/auth/actionHandlers/deleteSession.ts +18 -18
  52. package/src/plugins/auth/actionHandlers/getMyProfile.ts +28 -38
  53. package/src/plugins/auth/actionHandlers/index.ts +8 -8
  54. package/src/plugins/auth/actionHandlers/resetPassword.ts +45 -45
  55. package/src/plugins/auth/models/AccessToken.ts +56 -56
  56. package/src/plugins/auth/models/index.ts +3 -3
  57. package/src/plugins/auth/routes/changePassword.ts +15 -15
  58. package/src/plugins/auth/routes/getMyProfile.ts +15 -15
  59. package/src/plugins/auth/routes/index.ts +7 -7
  60. package/src/plugins/auth/routes/resetPassword.ts +15 -15
  61. package/src/plugins/auth/routes/signin.ts +15 -15
  62. package/src/plugins/auth/routes/signout.ts +15 -15
  63. package/src/plugins/auth/services/AuthService.ts +66 -39
  64. package/src/plugins/cronJob/CronJobPlugin.ts +104 -104
  65. package/src/plugins/cronJob/CronJobPluginTypes.ts +44 -44
  66. package/src/plugins/cronJob/actionHandlers/index.ts +4 -4
  67. package/src/plugins/cronJob/actionHandlers/runCronJob.ts +32 -32
  68. package/src/plugins/cronJob/entityWatchers/cronJobEntityWatchers.ts +24 -24
  69. package/src/plugins/cronJob/entityWatchers/index.ts +4 -4
  70. package/src/plugins/cronJob/models/CronJob.ts +129 -129
  71. package/src/plugins/cronJob/models/index.ts +3 -3
  72. package/src/plugins/cronJob/routes/index.ts +3 -3
  73. package/src/plugins/cronJob/routes/runCronJob.ts +15 -15
  74. package/src/plugins/cronJob/services/CronJobService.ts +252 -252
  75. package/src/plugins/dataManage/DataManagePlugin.ts +163 -163
  76. package/src/plugins/dataManage/actionHandlers/addEntityRelations.ts +15 -15
  77. package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts +17 -17
  78. package/src/plugins/dataManage/actionHandlers/createCollectionEntitiesBatch.ts +81 -81
  79. package/src/plugins/dataManage/actionHandlers/createCollectionEntity.ts +20 -20
  80. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntities.ts +45 -45
  81. package/src/plugins/dataManage/actionHandlers/deleteCollectionEntityById.ts +20 -20
  82. package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts +27 -27
  83. package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts +30 -30
  84. package/src/plugins/dataManage/actionHandlers/queryDatabase.ts +22 -22
  85. package/src/plugins/dataManage/actionHandlers/removeEntityRelations.ts +15 -15
  86. package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts +38 -38
  87. package/src/plugins/entityAccessControl/EntityAccessControlPlugin.ts +146 -146
  88. package/src/plugins/fileManage/FileManagePlugin.ts +52 -52
  89. package/src/plugins/fileManage/actionHandlers/downloadDocument.ts +65 -65
  90. package/src/plugins/fileManage/actionHandlers/downloadFile.ts +44 -44
  91. package/src/plugins/fileManage/actionHandlers/uploadFile.ts +33 -33
  92. package/src/plugins/fileManage/routes/downloadDocument.ts +15 -15
  93. package/src/plugins/fileManage/routes/downloadFile.ts +15 -15
  94. package/src/plugins/fileManage/routes/index.ts +5 -5
  95. package/src/plugins/fileManage/routes/uploadFile.ts +15 -15
  96. package/src/plugins/license/LicensePlugin.ts +79 -79
  97. package/src/plugins/license/LicensePluginTypes.ts +95 -95
  98. package/src/plugins/license/LicenseService.ts +137 -137
  99. package/src/plugins/license/actionHandlers/getLicense.ts +18 -18
  100. package/src/plugins/license/actionHandlers/index.ts +5 -5
  101. package/src/plugins/license/actionHandlers/updateLicense.ts +24 -24
  102. package/src/plugins/license/helpers/certHelper.ts +21 -21
  103. package/src/plugins/license/helpers/cryptoHelper.ts +47 -47
  104. package/src/plugins/license/models/index.ts +1 -1
  105. package/src/plugins/license/routes/getLicense.ts +15 -15
  106. package/src/plugins/license/routes/index.ts +4 -4
  107. package/src/plugins/license/routes/updateLicense.ts +15 -15
  108. package/src/plugins/mail/MailPlugin.ts +74 -74
  109. package/src/plugins/mail/MailPluginTypes.ts +27 -27
  110. package/src/plugins/mail/MailService.ts +38 -38
  111. package/src/plugins/mail/actionHandlers/index.ts +3 -3
  112. package/src/plugins/mail/models/index.ts +1 -1
  113. package/src/plugins/mail/routes/index.ts +1 -1
  114. package/src/plugins/metaManage/MetaManagePlugin.ts +198 -198
  115. package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts +10 -10
  116. package/src/plugins/metaManage/actionHandlers/listMetaModels.ts +9 -9
  117. package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts +9 -9
  118. package/src/plugins/metaManage/services/MetaService.ts +376 -376
  119. package/src/plugins/notification/NotificationPlugin.ts +68 -68
  120. package/src/plugins/notification/NotificationPluginTypes.ts +13 -13
  121. package/src/plugins/notification/NotificationService.ts +25 -25
  122. package/src/plugins/notification/actionHandlers/index.ts +3 -3
  123. package/src/plugins/notification/models/Notification.ts +60 -60
  124. package/src/plugins/notification/models/index.ts +3 -3
  125. package/src/plugins/notification/routes/index.ts +1 -1
  126. package/src/plugins/routeManage/RouteManagePlugin.ts +64 -64
  127. package/src/plugins/routeManage/actionHandlers/httpProxy.ts +13 -13
  128. package/src/plugins/routeManage/actionHandlers/mock.ts +28 -28
  129. package/src/plugins/sequence/SequencePlugin.ts +146 -146
  130. package/src/plugins/sequence/SequencePluginTypes.ts +69 -69
  131. package/src/plugins/sequence/SequenceService.ts +92 -92
  132. package/src/plugins/sequence/actionHandlers/generateSn.ts +32 -32
  133. package/src/plugins/sequence/actionHandlers/index.ts +4 -4
  134. package/src/plugins/sequence/models/SequenceAutoIncrementRecord.ts +49 -49
  135. package/src/plugins/sequence/models/SequenceRule.ts +42 -42
  136. package/src/plugins/sequence/models/index.ts +4 -4
  137. package/src/plugins/sequence/routes/generateSn.ts +15 -15
  138. package/src/plugins/sequence/routes/index.ts +3 -3
  139. package/src/plugins/sequence/segment-utility.ts +11 -11
  140. package/src/plugins/sequence/segments/autoIncrement.ts +90 -90
  141. package/src/plugins/sequence/segments/dayOfMonth.ts +19 -19
  142. package/src/plugins/sequence/segments/index.ts +9 -9
  143. package/src/plugins/sequence/segments/literal.ts +16 -16
  144. package/src/plugins/sequence/segments/month.ts +19 -19
  145. package/src/plugins/sequence/segments/parameter.ts +20 -20
  146. package/src/plugins/sequence/segments/year.ts +19 -19
  147. package/src/plugins/serverOperation/ServerOperationPlugin.ts +91 -91
  148. package/src/plugins/serverOperation/ServerOperationPluginTypes.ts +15 -15
  149. package/src/plugins/serverOperation/actionHandlers/index.ts +4 -4
  150. package/src/plugins/serverOperation/actionHandlers/runServerOperation.ts +15 -15
  151. package/src/plugins/setting/SettingPlugin.ts +68 -68
  152. package/src/plugins/setting/SettingPluginTypes.ts +37 -37
  153. package/src/plugins/setting/SettingService.ts +213 -213
  154. package/src/plugins/setting/actionHandlers/getSystemSettingValues.ts +30 -30
  155. package/src/plugins/setting/actionHandlers/getUserSettingValues.ts +38 -38
  156. package/src/plugins/setting/actionHandlers/index.ts +6 -6
  157. package/src/plugins/setting/actionHandlers/setSystemSettingValues.ts +30 -30
  158. package/src/plugins/setting/models/SystemSettingGroupSetting.ts +57 -57
  159. package/src/plugins/setting/models/SystemSettingItem.ts +48 -48
  160. package/src/plugins/setting/models/SystemSettingItemSetting.ts +73 -73
  161. package/src/plugins/setting/models/UserSettingGroupSetting.ts +57 -57
  162. package/src/plugins/setting/models/UserSettingItem.ts +55 -55
  163. package/src/plugins/setting/models/UserSettingItemSetting.ts +73 -73
  164. package/src/plugins/setting/models/index.ts +8 -8
  165. package/src/plugins/setting/routes/getSystemSettingValues.ts +15 -15
  166. package/src/plugins/setting/routes/getUserSettingValues.ts +15 -15
  167. package/src/plugins/setting/routes/index.ts +5 -5
  168. package/src/plugins/setting/routes/setSystemSettingValues.ts +15 -15
  169. package/src/plugins/stateMachine/StateMachinePlugin.ts +196 -196
  170. package/src/plugins/stateMachine/StateMachinePluginTypes.ts +48 -48
  171. package/src/plugins/stateMachine/actionHandlers/index.ts +4 -4
  172. package/src/plugins/stateMachine/actionHandlers/sendStateMachineEvent.ts +54 -54
  173. package/src/plugins/stateMachine/models/StateMachine.ts +42 -42
  174. package/src/plugins/stateMachine/models/index.ts +3 -3
  175. package/src/plugins/stateMachine/routes/index.ts +3 -3
  176. package/src/plugins/stateMachine/routes/sendStateMachineEvent.ts +15 -15
  177. package/src/plugins/stateMachine/stateMachineHelper.ts +36 -36
  178. package/src/plugins/webhooks/WebhooksPlugin.ts +148 -148
  179. package/src/plugins/webhooks/pluginConfig.ts +75 -75
  180. package/src/polyfill.ts +5 -5
  181. package/src/proxy/mod.ts +38 -38
  182. package/src/proxy/types.ts +21 -21
  183. package/src/queryBuilder/index.ts +1 -1
  184. package/src/queryBuilder/queryBuilder.ts +755 -755
  185. package/src/server.ts +530 -530
  186. package/src/types/cron-job-types.ts +66 -66
  187. package/src/types.ts +862 -856
  188. package/src/utilities/accessControlUtility.ts +33 -33
  189. package/src/utilities/entityUtility.ts +18 -18
  190. package/src/utilities/errorUtility.ts +15 -15
  191. package/src/utilities/fsUtility.ts +137 -137
  192. package/src/utilities/httpUtility.ts +19 -19
  193. package/src/utilities/jwtUtility.ts +26 -26
  194. package/src/utilities/passwordUtility.ts +26 -26
  195. package/src/utilities/pathUtility.ts +14 -14
  196. package/src/utilities/timeUtility.ts +17 -17
  197. package/src/utilities/typeUtility.ts +15 -15
  198. package/tsconfig.json +19 -19
@@ -1,376 +1,376 @@
1
- import { IRpdServer } from "~/core/server";
2
- import { find, isString, map } from "lodash";
3
- import { RouteContext } from "~/core/routeContext";
4
- import { getEntityPropertyByCode, isOneRelationProperty, isRelationProperty } from "~/helpers/metaHelper";
5
- import { IQueryBuilder, RpdApplicationConfig, RpdDataModel, RpdDataModelIndex, RpdDataPropertyTypes } from "~/types";
6
- import { convertModelIndexConditionsToRowFilterOptions } from "~/helpers/filterHelper";
7
- import { pgPropertyTypeColumnMap } from "~/dataAccess/columnTypeMapper";
8
-
9
- type TableInformation = {
10
- table_schema: string;
11
- table_name: string;
12
- table_description: string;
13
- };
14
-
15
- type ColumnInformation = {
16
- table_schema: string;
17
- table_name: string;
18
- column_name: string;
19
- ordinal_position: number;
20
- description?: string;
21
- data_type: string;
22
- udt_name: string;
23
- is_nullable: "YES" | "NO";
24
- column_default: string;
25
- character_maximum_length: number;
26
- numeric_precision: number;
27
- numeric_scale: number;
28
- };
29
-
30
- type ConstraintInformation = {
31
- table_schema: string;
32
- table_name: string;
33
- constraint_type: string;
34
- constraint_name: string;
35
- };
36
-
37
- function generateCreateColumnDDL(
38
- queryBuilder: IQueryBuilder,
39
- options: {
40
- schema?: string;
41
- tableName: string;
42
- name: string;
43
- type: RpdDataPropertyTypes;
44
- autoIncrement?: boolean;
45
- notNull?: boolean;
46
- defaultValue?: string;
47
- },
48
- ) {
49
- let columnDDL = `ALTER TABLE ${queryBuilder.quoteTable(options)} ADD`;
50
- columnDDL += ` ${queryBuilder.quoteObject(options.name)}`;
51
- if (options.type === "integer" && options.autoIncrement) {
52
- columnDDL += ` serial`;
53
- } else {
54
- const columnType = pgPropertyTypeColumnMap[options.type];
55
- if (!columnType) {
56
- throw new Error(`Property type "${options.type}" is not supported.`);
57
- }
58
- columnDDL += ` ${columnType}`;
59
- }
60
- if (options.notNull) {
61
- columnDDL += " NOT NULL";
62
- }
63
-
64
- if (options.defaultValue) {
65
- columnDDL += ` DEFAULT ${options.defaultValue}`;
66
- }
67
-
68
- return columnDDL;
69
- }
70
-
71
- function generateLinkTableDDL(
72
- queryBuilder: IQueryBuilder,
73
- options: {
74
- linkSchema?: string;
75
- linkTableName: string;
76
- targetIdColumnName: string;
77
- selfIdColumnName: string;
78
- },
79
- ) {
80
- let columnDDL = `CREATE TABLE ${queryBuilder.quoteTable({
81
- schema: options.linkSchema,
82
- tableName: options.linkTableName,
83
- })} (`;
84
- columnDDL += `id serial not null,`;
85
- columnDDL += `${queryBuilder.quoteObject(options.selfIdColumnName)} integer not null,`;
86
- columnDDL += `${queryBuilder.quoteObject(options.targetIdColumnName)} integer not null);`;
87
-
88
- return columnDDL;
89
- }
90
-
91
- function generateTableIndexDDL(queryBuilder: IQueryBuilder, server: IRpdServer, model: RpdDataModel, index: RpdDataModelIndex) {
92
- let indexName = index.name;
93
- if (!indexName) {
94
- indexName = model.tableName;
95
- for (const indexProp of index.properties) {
96
- const propCode = isString(indexProp) ? indexProp : indexProp.code;
97
- const property = getEntityPropertyByCode(server, model, propCode);
98
- if (!isRelationProperty(property)) {
99
- indexName += "_" + property.columnName;
100
- } else if (isOneRelationProperty(property)) {
101
- indexName += "_" + property.targetIdColumnName;
102
- }
103
- }
104
- indexName += index.unique ? "_uindex" : "_index";
105
- }
106
-
107
- const indexColumns = map(index.properties, (indexProp) => {
108
- let columnName: string;
109
- const propCode = isString(indexProp) ? indexProp : indexProp.code;
110
- const property = getEntityPropertyByCode(server, model, propCode);
111
- if (!isRelationProperty(property)) {
112
- columnName = property.columnName;
113
- } else if (isOneRelationProperty(property)) {
114
- columnName = property.targetIdColumnName;
115
- }
116
-
117
- if (isString(indexProp)) {
118
- return columnName;
119
- }
120
-
121
- if (indexProp.order === "desc") {
122
- return `${columnName} desc`;
123
- }
124
-
125
- return columnName;
126
- });
127
-
128
- let ddl = `CREATE ${index.unique ? "UNIQUE" : ""} INDEX ${indexName} `;
129
- ddl += `ON ${queryBuilder.quoteTable({
130
- schema: model.schema,
131
- tableName: model.tableName,
132
- })} (${indexColumns.join(", ")})`;
133
-
134
- if (index.conditions) {
135
- const logger = server.getLogger();
136
- const rowFilterOptions = convertModelIndexConditionsToRowFilterOptions(logger, model, index.conditions);
137
- ddl += ` WHERE ${queryBuilder.buildFiltersExpression(model, rowFilterOptions)}`;
138
- }
139
-
140
- return ddl;
141
- }
142
-
143
- export default class MetaService {
144
- #server: IRpdServer;
145
-
146
- constructor(server: IRpdServer) {
147
- this.#server = server;
148
- }
149
-
150
- async syncDatabaseSchema(applicationConfig: RpdApplicationConfig) {
151
- const server = this.#server;
152
- const logger = server.getLogger();
153
- logger.info("Synchronizing database schema...");
154
- const sqlQueryTableInformations = `SELECT table_schema, table_name, obj_description((table_schema||'.'||quote_ident(table_name))::regclass) as table_description FROM information_schema.tables`;
155
- const tablesInDb: TableInformation[] = await server.queryDatabaseObject(sqlQueryTableInformations);
156
- const { queryBuilder } = server;
157
-
158
- for (const model of applicationConfig.models) {
159
- logger.debug(`Checking data table for '${model.namespace}.${model.singularCode}'...`);
160
-
161
- const expectedTableSchema = model.schema || server.databaseConfig.dbDefaultSchema;
162
- const expectedTableName = model.tableName;
163
- const tableInDb = find(tablesInDb, { table_schema: expectedTableSchema, table_name: expectedTableName });
164
- if (!tableInDb) {
165
- await server.queryDatabaseObject(`CREATE TABLE IF NOT EXISTS ${queryBuilder.quoteTable(model)} ()`, []);
166
- }
167
- if (!tableInDb || tableInDb.table_description != model.name) {
168
- await server.tryQueryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
169
- }
170
- }
171
-
172
- const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type, c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
173
- FROM information_schema.columns c
174
- INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
175
- LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
176
- const columnsInDb: ColumnInformation[] = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
177
-
178
- for (const model of applicationConfig.models) {
179
- logger.debug(`Checking data columns for '${model.namespace}.${model.singularCode}'...`);
180
-
181
- for (const property of model.properties) {
182
- let columnDDL = "";
183
- if (isRelationProperty(property)) {
184
- if (property.relation === "one") {
185
- const targetModel = applicationConfig.models.find((item) => item.singularCode === property.targetSingularCode);
186
- if (!targetModel) {
187
- logger.warn(`Cannot find target model with singular code "${property.targetSingularCode}".`);
188
- }
189
-
190
- const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
191
- table_schema: model.schema || "public",
192
- table_name: model.tableName,
193
- column_name: property.targetIdColumnName!,
194
- });
195
-
196
- if (!columnInDb) {
197
- columnDDL = generateCreateColumnDDL(queryBuilder, {
198
- schema: model.schema,
199
- tableName: model.tableName,
200
- name: property.targetIdColumnName!,
201
- type: "integer",
202
- autoIncrement: false,
203
- notNull: property.required,
204
- });
205
- await server.tryQueryDatabaseObject(columnDDL);
206
- }
207
-
208
- if (!columnInDb || columnInDb.description != property.name) {
209
- await server.tryQueryDatabaseObject(
210
- `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
211
- property.targetIdColumnName,
212
- )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
213
- [],
214
- );
215
- }
216
- } else if (property.relation === "many") {
217
- if (property.linkTableName) {
218
- const tableInDb = find(tablesInDb, {
219
- table_schema: property.linkSchema || server.databaseConfig.dbDefaultSchema,
220
- table_name: property.linkTableName,
221
- });
222
- if (!tableInDb) {
223
- columnDDL = generateLinkTableDDL(queryBuilder, {
224
- linkSchema: property.linkSchema,
225
- linkTableName: property.linkTableName,
226
- targetIdColumnName: property.targetIdColumnName!,
227
- selfIdColumnName: property.selfIdColumnName!,
228
- });
229
- }
230
-
231
- const contraintName = `${property.linkTableName}_pk`;
232
- columnDDL += `ALTER TABLE ${queryBuilder.quoteTable({
233
- schema: property.linkSchema,
234
- tableName: property.linkTableName,
235
- })} ADD CONSTRAINT ${queryBuilder.quoteObject(contraintName)} PRIMARY KEY (id);`;
236
- await server.tryQueryDatabaseObject(columnDDL);
237
- } else {
238
- const targetModel = applicationConfig.models.find((item) => item.singularCode === property.targetSingularCode);
239
- if (!targetModel) {
240
- logger.warn(`Cannot find target model with singular code "${property.targetSingularCode}".`);
241
- continue;
242
- }
243
-
244
- const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
245
- table_schema: targetModel.schema || "public",
246
- table_name: targetModel.tableName,
247
- column_name: property.selfIdColumnName!,
248
- });
249
-
250
- if (!columnInDb) {
251
- columnDDL = generateCreateColumnDDL(queryBuilder, {
252
- schema: targetModel.schema,
253
- tableName: targetModel.tableName,
254
- name: property.selfIdColumnName || "",
255
- type: "integer",
256
- autoIncrement: false,
257
- notNull: property.required,
258
- });
259
- await server.tryQueryDatabaseObject(columnDDL);
260
- }
261
- }
262
- } else {
263
- continue;
264
- }
265
- } else {
266
- const columnName = property.columnName || property.code;
267
- const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
268
- table_schema: model.schema || "public",
269
- table_name: model.tableName,
270
- column_name: columnName,
271
- });
272
-
273
- if (!columnInDb) {
274
- // create column if not exists
275
- columnDDL = generateCreateColumnDDL(queryBuilder, {
276
- schema: model.schema,
277
- tableName: model.tableName,
278
- name: columnName,
279
- type: property.type,
280
- autoIncrement: property.autoIncrement,
281
- notNull: property.required,
282
- defaultValue: property.defaultValue,
283
- });
284
- await server.tryQueryDatabaseObject(columnDDL);
285
- } else {
286
- const expectedColumnType = pgPropertyTypeColumnMap[property.type];
287
- if (columnInDb.udt_name !== expectedColumnType) {
288
- const sqlAlterColumnType = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(
289
- columnName,
290
- )} type ${expectedColumnType}`;
291
- await server.tryQueryDatabaseObject(sqlAlterColumnType);
292
- }
293
-
294
- if (property.defaultValue) {
295
- if (!columnInDb.column_default) {
296
- const sqlSetColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set default ${
297
- property.defaultValue
298
- }`;
299
- await server.tryQueryDatabaseObject(sqlSetColumnDefault);
300
- }
301
- } else {
302
- if (columnInDb.column_default && !property.autoIncrement) {
303
- const sqlDropColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} drop default`;
304
- await server.tryQueryDatabaseObject(sqlDropColumnDefault);
305
- }
306
- }
307
-
308
- if (property.required) {
309
- if (columnInDb.is_nullable === "YES") {
310
- const sqlSetColumnNotNull = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set not null`;
311
- await server.tryQueryDatabaseObject(sqlSetColumnNotNull);
312
- }
313
- } else {
314
- if (columnInDb.is_nullable === "NO") {
315
- const sqlDropColumnNotNull = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} drop not null`;
316
- await server.tryQueryDatabaseObject(sqlDropColumnNotNull);
317
- }
318
- }
319
- }
320
-
321
- if (!columnInDb || columnInDb.description != property.name) {
322
- await server.tryQueryDatabaseObject(
323
- `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
324
- property.columnName || property.code,
325
- )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
326
- [],
327
- );
328
- }
329
- }
330
- }
331
- }
332
-
333
- const sqlQueryConstraints = `SELECT table_schema, table_name, constraint_type, constraint_name FROM information_schema.table_constraints WHERE constraint_type = 'PRIMARY KEY';`;
334
- const constraintsInDb: ConstraintInformation[] = await server.queryDatabaseObject(sqlQueryConstraints);
335
- for (const model of applicationConfig.models) {
336
- const expectedTableSchema = model.schema || server.databaseConfig.dbDefaultSchema;
337
- const expectedTableName = model.tableName;
338
- const expectedContraintName = `${expectedTableName}_pk`;
339
- logger.debug(`Checking pk for '${expectedTableSchema}.${expectedTableName}'...`);
340
- const constraintInDb = find(constraintsInDb, {
341
- table_schema: expectedTableSchema,
342
- table_name: expectedTableName,
343
- constraint_type: "PRIMARY KEY",
344
- constraint_name: expectedContraintName,
345
- });
346
- if (!constraintInDb) {
347
- await server.queryDatabaseObject(
348
- `ALTER TABLE ${queryBuilder.quoteTable(model)} ADD CONSTRAINT ${queryBuilder.quoteObject(expectedContraintName)} PRIMARY KEY (id);`,
349
- [],
350
- );
351
- }
352
- }
353
-
354
- // generate indexes
355
- for (const model of applicationConfig.models) {
356
- if (!model.indexes || !model.indexes.length) {
357
- continue;
358
- }
359
-
360
- logger.debug(`Creating indexes of table ${queryBuilder.quoteTable(model)}`);
361
- for (const index of model.indexes) {
362
- const sqlCreateIndex = generateTableIndexDDL(queryBuilder, server, model, index);
363
- try {
364
- await server.queryDatabaseObject(sqlCreateIndex, [], null, true);
365
- } catch (err: any) {
366
- const logger = this.#server.getLogger();
367
- if ((err as Error).message.includes("already exists")) {
368
- logger.warn("Failed to create index.", { errorMessage: err.message, sqlCreateIndex });
369
- } else {
370
- logger.error("Failed to create index.", { errorMessage: err.message, sqlCreateIndex });
371
- }
372
- }
373
- }
374
- }
375
- }
376
- }
1
+ import { IRpdServer } from "~/core/server";
2
+ import { find, isString, map } from "lodash";
3
+ import { RouteContext } from "~/core/routeContext";
4
+ import { getEntityPropertyByCode, isOneRelationProperty, isRelationProperty } from "~/helpers/metaHelper";
5
+ import { IQueryBuilder, RpdApplicationConfig, RpdDataModel, RpdDataModelIndex, RpdDataPropertyTypes } from "~/types";
6
+ import { convertModelIndexConditionsToRowFilterOptions } from "~/helpers/filterHelper";
7
+ import { pgPropertyTypeColumnMap } from "~/dataAccess/columnTypeMapper";
8
+
9
+ type TableInformation = {
10
+ table_schema: string;
11
+ table_name: string;
12
+ table_description: string;
13
+ };
14
+
15
+ type ColumnInformation = {
16
+ table_schema: string;
17
+ table_name: string;
18
+ column_name: string;
19
+ ordinal_position: number;
20
+ description?: string;
21
+ data_type: string;
22
+ udt_name: string;
23
+ is_nullable: "YES" | "NO";
24
+ column_default: string;
25
+ character_maximum_length: number;
26
+ numeric_precision: number;
27
+ numeric_scale: number;
28
+ };
29
+
30
+ type ConstraintInformation = {
31
+ table_schema: string;
32
+ table_name: string;
33
+ constraint_type: string;
34
+ constraint_name: string;
35
+ };
36
+
37
+ function generateCreateColumnDDL(
38
+ queryBuilder: IQueryBuilder,
39
+ options: {
40
+ schema?: string;
41
+ tableName: string;
42
+ name: string;
43
+ type: RpdDataPropertyTypes;
44
+ autoIncrement?: boolean;
45
+ notNull?: boolean;
46
+ defaultValue?: string;
47
+ },
48
+ ) {
49
+ let columnDDL = `ALTER TABLE ${queryBuilder.quoteTable(options)} ADD`;
50
+ columnDDL += ` ${queryBuilder.quoteObject(options.name)}`;
51
+ if (options.type === "integer" && options.autoIncrement) {
52
+ columnDDL += ` serial`;
53
+ } else {
54
+ const columnType = pgPropertyTypeColumnMap[options.type];
55
+ if (!columnType) {
56
+ throw new Error(`Property type "${options.type}" is not supported.`);
57
+ }
58
+ columnDDL += ` ${columnType}`;
59
+ }
60
+ if (options.notNull) {
61
+ columnDDL += " NOT NULL";
62
+ }
63
+
64
+ if (options.defaultValue) {
65
+ columnDDL += ` DEFAULT ${options.defaultValue}`;
66
+ }
67
+
68
+ return columnDDL;
69
+ }
70
+
71
+ function generateLinkTableDDL(
72
+ queryBuilder: IQueryBuilder,
73
+ options: {
74
+ linkSchema?: string;
75
+ linkTableName: string;
76
+ targetIdColumnName: string;
77
+ selfIdColumnName: string;
78
+ },
79
+ ) {
80
+ let columnDDL = `CREATE TABLE ${queryBuilder.quoteTable({
81
+ schema: options.linkSchema,
82
+ tableName: options.linkTableName,
83
+ })} (`;
84
+ columnDDL += `id serial not null,`;
85
+ columnDDL += `${queryBuilder.quoteObject(options.selfIdColumnName)} integer not null,`;
86
+ columnDDL += `${queryBuilder.quoteObject(options.targetIdColumnName)} integer not null);`;
87
+
88
+ return columnDDL;
89
+ }
90
+
91
+ function generateTableIndexDDL(queryBuilder: IQueryBuilder, server: IRpdServer, model: RpdDataModel, index: RpdDataModelIndex) {
92
+ let indexName = index.name;
93
+ if (!indexName) {
94
+ indexName = model.tableName;
95
+ for (const indexProp of index.properties) {
96
+ const propCode = isString(indexProp) ? indexProp : indexProp.code;
97
+ const property = getEntityPropertyByCode(server, model, propCode);
98
+ if (!isRelationProperty(property)) {
99
+ indexName += "_" + property.columnName;
100
+ } else if (isOneRelationProperty(property)) {
101
+ indexName += "_" + property.targetIdColumnName;
102
+ }
103
+ }
104
+ indexName += index.unique ? "_uindex" : "_index";
105
+ }
106
+
107
+ const indexColumns = map(index.properties, (indexProp) => {
108
+ let columnName: string;
109
+ const propCode = isString(indexProp) ? indexProp : indexProp.code;
110
+ const property = getEntityPropertyByCode(server, model, propCode);
111
+ if (!isRelationProperty(property)) {
112
+ columnName = property.columnName;
113
+ } else if (isOneRelationProperty(property)) {
114
+ columnName = property.targetIdColumnName;
115
+ }
116
+
117
+ if (isString(indexProp)) {
118
+ return columnName;
119
+ }
120
+
121
+ if (indexProp.order === "desc") {
122
+ return `${columnName} desc`;
123
+ }
124
+
125
+ return columnName;
126
+ });
127
+
128
+ let ddl = `CREATE ${index.unique ? "UNIQUE" : ""} INDEX ${indexName} `;
129
+ ddl += `ON ${queryBuilder.quoteTable({
130
+ schema: model.schema,
131
+ tableName: model.tableName,
132
+ })} (${indexColumns.join(", ")})`;
133
+
134
+ if (index.conditions) {
135
+ const logger = server.getLogger();
136
+ const rowFilterOptions = convertModelIndexConditionsToRowFilterOptions(logger, model, index.conditions);
137
+ ddl += ` WHERE ${queryBuilder.buildFiltersExpression(model, rowFilterOptions)}`;
138
+ }
139
+
140
+ return ddl;
141
+ }
142
+
143
+ export default class MetaService {
144
+ #server: IRpdServer;
145
+
146
+ constructor(server: IRpdServer) {
147
+ this.#server = server;
148
+ }
149
+
150
+ async syncDatabaseSchema(applicationConfig: RpdApplicationConfig) {
151
+ const server = this.#server;
152
+ const logger = server.getLogger();
153
+ logger.info("Synchronizing database schema...");
154
+ const sqlQueryTableInformations = `SELECT table_schema, table_name, obj_description((table_schema||'.'||quote_ident(table_name))::regclass) as table_description FROM information_schema.tables`;
155
+ const tablesInDb: TableInformation[] = await server.queryDatabaseObject(sqlQueryTableInformations);
156
+ const { queryBuilder } = server;
157
+
158
+ for (const model of applicationConfig.models) {
159
+ logger.info(`Checking data table for '${model.namespace}.${model.singularCode}'...`);
160
+
161
+ const expectedTableSchema = model.schema || server.databaseConfig.dbDefaultSchema;
162
+ const expectedTableName = model.tableName;
163
+ const tableInDb = find(tablesInDb, { table_schema: expectedTableSchema, table_name: expectedTableName });
164
+ if (!tableInDb) {
165
+ await server.queryDatabaseObject(`CREATE TABLE IF NOT EXISTS ${queryBuilder.quoteTable(model)} ()`, []);
166
+ }
167
+ if (!tableInDb || tableInDb.table_description != model.name) {
168
+ await server.tryQueryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
169
+ }
170
+ }
171
+
172
+ const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type, c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
173
+ FROM information_schema.columns c
174
+ INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
175
+ LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
176
+ const columnsInDb: ColumnInformation[] = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
177
+
178
+ for (const model of applicationConfig.models) {
179
+ logger.info(`Checking data columns for '${model.namespace}.${model.singularCode}'...`);
180
+
181
+ for (const property of model.properties) {
182
+ let columnDDL = "";
183
+ if (isRelationProperty(property)) {
184
+ if (property.relation === "one") {
185
+ const targetModel = applicationConfig.models.find((item) => item.singularCode === property.targetSingularCode);
186
+ if (!targetModel) {
187
+ logger.warn(`Cannot find target model with singular code "${property.targetSingularCode}".`);
188
+ }
189
+
190
+ const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
191
+ table_schema: model.schema || "public",
192
+ table_name: model.tableName,
193
+ column_name: property.targetIdColumnName!,
194
+ });
195
+
196
+ if (!columnInDb) {
197
+ columnDDL = generateCreateColumnDDL(queryBuilder, {
198
+ schema: model.schema,
199
+ tableName: model.tableName,
200
+ name: property.targetIdColumnName!,
201
+ type: "integer",
202
+ autoIncrement: false,
203
+ notNull: property.required,
204
+ });
205
+ await server.tryQueryDatabaseObject(columnDDL);
206
+ }
207
+
208
+ if (!columnInDb || columnInDb.description != property.name) {
209
+ await server.tryQueryDatabaseObject(
210
+ `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
211
+ property.targetIdColumnName,
212
+ )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
213
+ [],
214
+ );
215
+ }
216
+ } else if (property.relation === "many") {
217
+ if (property.linkTableName) {
218
+ const tableInDb = find(tablesInDb, {
219
+ table_schema: property.linkSchema || server.databaseConfig.dbDefaultSchema,
220
+ table_name: property.linkTableName,
221
+ });
222
+ if (!tableInDb) {
223
+ columnDDL = generateLinkTableDDL(queryBuilder, {
224
+ linkSchema: property.linkSchema,
225
+ linkTableName: property.linkTableName,
226
+ targetIdColumnName: property.targetIdColumnName!,
227
+ selfIdColumnName: property.selfIdColumnName!,
228
+ });
229
+ }
230
+
231
+ const contraintName = `${property.linkTableName}_pk`;
232
+ columnDDL += `ALTER TABLE ${queryBuilder.quoteTable({
233
+ schema: property.linkSchema,
234
+ tableName: property.linkTableName,
235
+ })} ADD CONSTRAINT ${queryBuilder.quoteObject(contraintName)} PRIMARY KEY (id);`;
236
+ await server.tryQueryDatabaseObject(columnDDL);
237
+ } else {
238
+ const targetModel = applicationConfig.models.find((item) => item.singularCode === property.targetSingularCode);
239
+ if (!targetModel) {
240
+ logger.warn(`Cannot find target model with singular code "${property.targetSingularCode}".`);
241
+ continue;
242
+ }
243
+
244
+ const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
245
+ table_schema: targetModel.schema || "public",
246
+ table_name: targetModel.tableName,
247
+ column_name: property.selfIdColumnName!,
248
+ });
249
+
250
+ if (!columnInDb) {
251
+ columnDDL = generateCreateColumnDDL(queryBuilder, {
252
+ schema: targetModel.schema,
253
+ tableName: targetModel.tableName,
254
+ name: property.selfIdColumnName || "",
255
+ type: "integer",
256
+ autoIncrement: false,
257
+ notNull: property.required,
258
+ });
259
+ await server.tryQueryDatabaseObject(columnDDL);
260
+ }
261
+ }
262
+ } else {
263
+ continue;
264
+ }
265
+ } else {
266
+ const columnName = property.columnName || property.code;
267
+ const columnInDb: ColumnInformation | undefined = find(columnsInDb, {
268
+ table_schema: model.schema || "public",
269
+ table_name: model.tableName,
270
+ column_name: columnName,
271
+ });
272
+
273
+ if (!columnInDb) {
274
+ // create column if not exists
275
+ columnDDL = generateCreateColumnDDL(queryBuilder, {
276
+ schema: model.schema,
277
+ tableName: model.tableName,
278
+ name: columnName,
279
+ type: property.type,
280
+ autoIncrement: property.autoIncrement,
281
+ notNull: property.required,
282
+ defaultValue: property.defaultValue,
283
+ });
284
+ await server.tryQueryDatabaseObject(columnDDL);
285
+ } else {
286
+ const expectedColumnType = pgPropertyTypeColumnMap[property.type];
287
+ if (columnInDb.udt_name !== expectedColumnType) {
288
+ const sqlAlterColumnType = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(
289
+ columnName,
290
+ )} type ${expectedColumnType}`;
291
+ await server.tryQueryDatabaseObject(sqlAlterColumnType);
292
+ }
293
+
294
+ if (property.defaultValue) {
295
+ if (!columnInDb.column_default) {
296
+ const sqlSetColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set default ${
297
+ property.defaultValue
298
+ }`;
299
+ await server.tryQueryDatabaseObject(sqlSetColumnDefault);
300
+ }
301
+ } else {
302
+ if (columnInDb.column_default && !property.autoIncrement) {
303
+ const sqlDropColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} drop default`;
304
+ await server.tryQueryDatabaseObject(sqlDropColumnDefault);
305
+ }
306
+ }
307
+
308
+ if (property.required) {
309
+ if (columnInDb.is_nullable === "YES") {
310
+ const sqlSetColumnNotNull = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set not null`;
311
+ await server.tryQueryDatabaseObject(sqlSetColumnNotNull);
312
+ }
313
+ } else {
314
+ if (columnInDb.is_nullable === "NO") {
315
+ const sqlDropColumnNotNull = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} drop not null`;
316
+ await server.tryQueryDatabaseObject(sqlDropColumnNotNull);
317
+ }
318
+ }
319
+ }
320
+
321
+ if (!columnInDb || columnInDb.description != property.name) {
322
+ await server.tryQueryDatabaseObject(
323
+ `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
324
+ property.columnName || property.code,
325
+ )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
326
+ [],
327
+ );
328
+ }
329
+ }
330
+ }
331
+ }
332
+
333
+ const sqlQueryConstraints = `SELECT table_schema, table_name, constraint_type, constraint_name FROM information_schema.table_constraints WHERE constraint_type = 'PRIMARY KEY';`;
334
+ const constraintsInDb: ConstraintInformation[] = await server.queryDatabaseObject(sqlQueryConstraints);
335
+ for (const model of applicationConfig.models) {
336
+ const expectedTableSchema = model.schema || server.databaseConfig.dbDefaultSchema;
337
+ const expectedTableName = model.tableName;
338
+ const expectedContraintName = `${expectedTableName}_pk`;
339
+ logger.info(`Checking pk for '${expectedTableSchema}.${expectedTableName}'...`);
340
+ const constraintInDb = find(constraintsInDb, {
341
+ table_schema: expectedTableSchema,
342
+ table_name: expectedTableName,
343
+ constraint_type: "PRIMARY KEY",
344
+ constraint_name: expectedContraintName,
345
+ });
346
+ if (!constraintInDb) {
347
+ await server.queryDatabaseObject(
348
+ `ALTER TABLE ${queryBuilder.quoteTable(model)} ADD CONSTRAINT ${queryBuilder.quoteObject(expectedContraintName)} PRIMARY KEY (id);`,
349
+ [],
350
+ );
351
+ }
352
+ }
353
+
354
+ // generate indexes
355
+ for (const model of applicationConfig.models) {
356
+ if (!model.indexes || !model.indexes.length) {
357
+ continue;
358
+ }
359
+
360
+ logger.info(`Creating indexes of table ${queryBuilder.quoteTable(model)}`);
361
+ for (const index of model.indexes) {
362
+ const sqlCreateIndex = generateTableIndexDDL(queryBuilder, server, model, index);
363
+ try {
364
+ await server.queryDatabaseObject(sqlCreateIndex, [], null, true);
365
+ } catch (err: any) {
366
+ const logger = this.#server.getLogger();
367
+ if ((err as Error).message.includes("already exists")) {
368
+ logger.warn("Failed to create index.", { errorMessage: err.message, sqlCreateIndex });
369
+ } else {
370
+ logger.error("Failed to create index.", { errorMessage: err.message, sqlCreateIndex });
371
+ }
372
+ }
373
+ }
374
+ }
375
+ }
376
+ }