@ruiapp/rapid-core 0.1.63 → 0.1.66

package/src/plugins/metaManage/MetaManagePlugin.ts

@@ -2,15 +2,30 @@
  * Meta manager plugin
  */
 
-import { IQueryBuilder, QuoteTableOptions, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdDataPropertyTypes, RpdEntityCreateEventPayload, RpdEntityDeleteEventPayload, RpdEntityUpdateEventPayload } from "~/types";
-import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "~/core/server";
+import {
+  IQueryBuilder,
+  QuoteTableOptions,
+  RpdApplicationConfig,
+  RpdDataModel,
+  RpdDataModelProperty,
+  RpdDataPropertyTypes,
+  RpdEntityCreateEventPayload,
+  RpdEntityDeleteEventPayload,
+  RpdEntityUpdateEventPayload,
+} from "~/types";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
 
 import * as listMetaModels from "./actionHandlers/listMetaModels";
 import * as listMetaRoutes from "./actionHandlers/listMetaRoutes";
 import * as getMetaModelDetail from "./actionHandlers/getMetaModelDetail";
-import { isRelationProperty } from "~/utilities/rapidUtility";
 import { find } from "lodash";
-import { getEntityPropertiesIncludingBase } from "~/dataAccess/metaHelper";
+import { getEntityPropertiesIncludingBase, isRelationProperty } from "~/helpers/metaHelper";
 
 class MetaManager implements RapidPlugin {
   get code(): string {
@@ -90,7 +105,10 @@ async function handleEntityUpdateEvent(server: IRpdServer, sender: RapidPlugin,
     const modelChanges: Partial<RpdDataModel> = payload.changes;
     if (modelChanges.tableName) {
       const modelBefore: RpdDataModel = payload.before;
-      await server.queryDatabaseObject(`ALTER TABLE ${queryBuilder.quoteTable(modelBefore)} RENAME TO ${queryBuilder.quoteTable(modelChanges as QuoteTableOptions)}`, []);
+      await server.queryDatabaseObject(
+        `ALTER TABLE ${queryBuilder.quoteTable(modelBefore)} RENAME TO ${queryBuilder.quoteTable(modelChanges as QuoteTableOptions)}`,
+        [],
+      );
     }
   }
 }
@@ -220,7 +238,10 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
           }
         } else if (property.relation === "many") {
           if (property.linkTableName) {
-            const tableInDb = find(tablesInDb, { table_schema: property.linkSchema || server.databaseConfig.dbDefaultSchema, table_name: property.linkTableName });
+            const tableInDb = find(tablesInDb, {
+              table_schema: property.linkSchema || server.databaseConfig.dbDefaultSchema,
+              table_name: property.linkTableName,
+            });
             if (!tableInDb) {
               columnDDL = generateLinkTableDDL(queryBuilder, {
                 linkSchema: property.linkSchema,
@@ -289,13 +310,17 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
         } else {
           const expectedColumnType = pgPropertyTypeColumnMap[property.type];
           if (columnInDb.udt_name !== expectedColumnType) {
-            const sqlAlterColumnType = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} type ${expectedColumnType}`;
+            const sqlAlterColumnType = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(
+              columnName,
+            )} type ${expectedColumnType}`;
             await server.tryQueryDatabaseObject(sqlAlterColumnType);
           }
 
           if (property.defaultValue) {
             if (!columnInDb.column_default) {
-              const sqlSetColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set default ${property.defaultValue}`;
+              const sqlSetColumnDefault = `alter table ${queryBuilder.quoteTable(model)} alter column ${queryBuilder.quoteObject(columnName)} set default ${
+                property.defaultValue
+              }`;
               await server.tryQueryDatabaseObject(sqlSetColumnDefault);
             }
           } else {
@@ -335,7 +360,10 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
       constraint_name: expectedContraintName,
     });
     if (!constraintInDb) {
-      await server.queryDatabaseObject(`ALTER TABLE ${queryBuilder.quoteTable(model)} ADD CONSTRAINT ${queryBuilder.quoteObject(expectedContraintName)} PRIMARY KEY (id);`, []);
+      await server.queryDatabaseObject(
+        `ALTER TABLE ${queryBuilder.quoteTable(model)} ADD CONSTRAINT ${queryBuilder.quoteObject(expectedContraintName)} PRIMARY KEY (id);`,
+        [],
+      );
     }
   }
 }

package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts

@@ -1,10 +1,10 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "getMetaModelDetail";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input } = ctx;
-  const model = server.getModel(input);
-  ctx.output = model;
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "getMetaModelDetail";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, input } = ctx;
+  const model = server.getModel(input);
+  ctx.output = model;
+}

package/src/plugins/metaManage/actionHandlers/listMetaModels.ts

@@ -1,9 +1,9 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "listMetaModels";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { applicationConfig } = ctx;
-  ctx.output = { list: applicationConfig.models };
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "listMetaModels";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { applicationConfig } = ctx;
+  ctx.output = { list: applicationConfig.models };
+}

package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts

@@ -1,9 +1,9 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "listMetaRoutes";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { applicationConfig } = ctx;
-  ctx.output = { list: applicationConfig.routes };
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "listMetaRoutes";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { applicationConfig } = ctx;
+  ctx.output = { list: applicationConfig.routes };
+}

package/src/plugins/routeManage/RouteManagePlugin.ts

@@ -3,7 +3,13 @@
  */
 
 import { RpdApplicationConfig } from "~/types";
-import { RpdServerPluginExtendingAbilities, RpdServerPluginConfigurableTargetOptions, RpdConfigurationItemOptions, IRpdServer, RapidPlugin } from "~/core/server";
+import {
+  RpdServerPluginExtendingAbilities,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdConfigurationItemOptions,
+  IRpdServer,
+  RapidPlugin,
+} from "~/core/server";
 import * as httpProxy from "./actionHandlers/httpProxy";
 
 class RouteManager implements RapidPlugin {

package/src/plugins/routeManage/actionHandlers/httpProxy.ts

@@ -1,13 +1,13 @@
-import { RunProxyHandlerOptions } from "~/types";
-import { doProxy } from "~/proxy/mod";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "httpProxy";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
-  const { logger } = ctx;
-  logger.debug(`Running ${code} handler...`);
-
-  await doProxy(ctx.routerContext, options);
-}
+import { RunProxyHandlerOptions } from "~/types";
+import { doProxy } from "~/proxy/mod";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "httpProxy";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
+  const { logger } = ctx;
+  logger.debug(`Running ${code} handler...`);
+
+  await doProxy(ctx.routerContext, options);
+}

package/src/plugins/sequence/SequencePlugin.ts

@@ -3,7 +3,13 @@
  */
 
 import { CreateEntityOptions, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty } from "~/types";
-import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "~/core/server";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
 
 import pluginActionHandlers from "./actionHandlers";
 import pluginModels from "./models";
@@ -12,7 +18,7 @@ import { PropertySequenceConfig } from "./SequencePluginTypes";
 import { isEqual } from "lodash";
 import SequenceService from "./SequenceService";
 import { isNullOrUndefined } from "~/utilities/typeUtility";
-import { getEntityPropertiesIncludingBase } from "~/dataAccess/metaHelper";
+import { getEntityPropertiesIncludingBase } from "~/helpers/metaHelper";
 
 class SequencePlugin implements RapidPlugin {
   #sequenceService!: SequenceService;

package/src/plugins/sequence/SequencePluginTypes.ts

@@ -7,7 +7,15 @@ export type SequenceRuleConfig = {
   segments: SequenceSegmentConfig[];
 };
 
-export type SequenceSegmentConfig = SequenceLiteralSegmentConfig | SequenceYearSegmentConfig | SequenceMonthSegmentConfig | SequenceDayOfMonthSegmentConfig | SequenceDayOfWeekSegmentConfig | SequenceDayOfYearSegmentConfig | SequenceParameterSegmentConfig | SequenceAutoIncrementSegmentConfig;
+export type SequenceSegmentConfig =
+  | SequenceLiteralSegmentConfig
+  | SequenceYearSegmentConfig
+  | SequenceMonthSegmentConfig
+  | SequenceDayOfMonthSegmentConfig
+  | SequenceDayOfWeekSegmentConfig
+  | SequenceDayOfYearSegmentConfig
+  | SequenceParameterSegmentConfig
+  | SequenceAutoIncrementSegmentConfig;
 
 export type SequenceLiteralSegmentConfig = {
   type: "literal";

package/src/plugins/sequence/SequenceService.ts

@@ -1,81 +1,81 @@
-import { IRpdServer } from "~/core/server";
-import segmentResolvers from "./segments";
-import { find } from "lodash";
-import { SequenceRuleConfig, SequenceSegmentConfig } from "./SequencePluginTypes";
-
-export interface GenerateSequenceNumbersInput {
-  ruleCode: string;
-  parameters: Record<string, string>;
-  amount: number;
-}
-
-export interface GenerateSequenceNumbersOutput {
-  sequences: string[];
-}
-
-export interface SegmentResolver {
-  segmentType: string;
-  resolveSegmentValue(server: IRpdServer, ruleCode: string, config: SequenceSegmentConfig, input: GenerateSequenceNumbersInput): Promise<string>;
-}
-
-export default class SequenceService {
-  #server: IRpdServer;
-
-  constructor(server: IRpdServer) {
-    this.#server = server;
-  }
-
-  async generateSn(server: IRpdServer, input: GenerateSequenceNumbersInput): Promise<string[]> {
-    const sequenceNumbers = [];
-    const { ruleCode, parameters } = input;
-    let { amount } = input;
-
-    if (!amount) {
-      amount = 1;
-    }
-
-    const sequenceRuleDataAccessor = server.getDataAccessor({
-      singularCode: "sequence_rule",
-    });
-
-    const sequenceRule = await sequenceRuleDataAccessor.findOne({
-      filters: [
-        {
-          operator: "eq",
-          field: {
-            name: "code",
-          },
-          value: ruleCode,
-        },
-      ],
-    });
-
-    if (!sequenceRule) {
-      throw new Error(`Failed to generate sequence number. Sequence with code '${sequenceRule.code}' not found.`);
-    }
-
-    const sequenceConfig: SequenceRuleConfig = sequenceRule.config;
-    if (!sequenceConfig || !sequenceConfig.segments) {
-      throw new Error("Failed to generate sequence number. Sequence not configured.");
-    }
-
-    for (let i = 0; i < amount; i++) {
-      let sequenceNumber: string = "";
-
-      for (const segmentConfig of sequenceConfig.segments) {
-        const segmentResolver: SegmentResolver = find(segmentResolvers, (item) => item.segmentType === segmentConfig.type);
-        if (!segmentResolver) {
-          // TODO: deal with unkown segment type
-          continue;
-        }
-
-        const segment = await segmentResolver.resolveSegmentValue(server, ruleCode, segmentConfig, input);
-        sequenceNumber += segment;
-      }
-
-      sequenceNumbers.push(sequenceNumber);
-    }
-
-    return sequenceNumbers;
-  }
-}
+import { IRpdServer } from "~/core/server";
+import segmentResolvers from "./segments";
+import { find } from "lodash";
+import { SequenceRuleConfig, SequenceSegmentConfig } from "./SequencePluginTypes";
+
+export interface GenerateSequenceNumbersInput {
+  ruleCode: string;
+  parameters: Record<string, string>;
+  amount: number;
+}
+
+export interface GenerateSequenceNumbersOutput {
+  sequences: string[];
+}
+
+export interface SegmentResolver {
+  segmentType: string;
+  resolveSegmentValue(server: IRpdServer, ruleCode: string, config: SequenceSegmentConfig, input: GenerateSequenceNumbersInput): Promise<string>;
+}
+
+export default class SequenceService {
+  #server: IRpdServer;
+
+  constructor(server: IRpdServer) {
+    this.#server = server;
+  }
+
+  async generateSn(server: IRpdServer, input: GenerateSequenceNumbersInput): Promise<string[]> {
+    const sequenceNumbers = [];
+    const { ruleCode, parameters } = input;
+    let { amount } = input;
+
+    if (!amount) {
+      amount = 1;
+    }
+
+    const sequenceRuleDataAccessor = server.getDataAccessor({
+      singularCode: "sequence_rule",
+    });
+
+    const sequenceRule = await sequenceRuleDataAccessor.findOne({
+      filters: [
+        {
+          operator: "eq",
+          field: {
+            name: "code",
+          },
+          value: ruleCode,
+        },
+      ],
+    });
+
+    if (!sequenceRule) {
+      throw new Error(`Failed to generate sequence number. Sequence with code '${sequenceRule.code}' not found.`);
+    }
+
+    const sequenceConfig: SequenceRuleConfig = sequenceRule.config;
+    if (!sequenceConfig || !sequenceConfig.segments) {
+      throw new Error("Failed to generate sequence number. Sequence not configured.");
+    }
+
+    for (let i = 0; i < amount; i++) {
+      let sequenceNumber: string = "";
+
+      for (const segmentConfig of sequenceConfig.segments) {
+        const segmentResolver: SegmentResolver = find(segmentResolvers, (item) => item.segmentType === segmentConfig.type);
+        if (!segmentResolver) {
+          // TODO: deal with unkown segment type
+          continue;
+        }
+
+        const segment = await segmentResolver.resolveSegmentValue(server, ruleCode, segmentConfig, input);
+        sequenceNumber += segment;
+      }
+
+      sequenceNumbers.push(sequenceNumber);
+    }
+
+    return sequenceNumbers;
+  }
+}

package/src/plugins/sequence/actionHandlers/generateSn.ts

@@ -1,32 +1,32 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import SequenceService, { GenerateSequenceNumbersInput, GenerateSequenceNumbersOutput } from "../SequenceService";
-
-export interface GenerateSequenceNumbersOptions {
-  ruleCode: string;
-}
-
-export const code = "generateSn";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GenerateSequenceNumbersOptions) {
-  const { server, routerContext } = ctx;
-  const { response } = routerContext;
-
-  const input: GenerateSequenceNumbersInput = ctx.input;
-
-  if (options?.ruleCode) {
-    input.ruleCode = options.ruleCode;
-  }
-
-  if (!input.ruleCode) {
-    throw new Error(`Rule code is required when generating sequence numbers.`);
-  }
-
-  const sequenceService = server.getService<SequenceService>("sequenceService");
-
-  const sequences = await sequenceService.generateSn(server, input);
-
-  ctx.output = {
-    sequences,
-  } satisfies GenerateSequenceNumbersOutput;
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import SequenceService, { GenerateSequenceNumbersInput, GenerateSequenceNumbersOutput } from "../SequenceService";
+
+export interface GenerateSequenceNumbersOptions {
+  ruleCode: string;
+}
+
+export const code = "generateSn";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GenerateSequenceNumbersOptions) {
+  const { server, routerContext } = ctx;
+  const { response } = routerContext;
+
+  const input: GenerateSequenceNumbersInput = ctx.input;
+
+  if (options?.ruleCode) {
+    input.ruleCode = options.ruleCode;
+  }
+
+  if (!input.ruleCode) {
+    throw new Error(`Rule code is required when generating sequence numbers.`);
+  }
+
+  const sequenceService = server.getService<SequenceService>("sequenceService");
+
+  const sequences = await sequenceService.generateSn(server, input);
+
+  ctx.output = {
+    sequences,
+  } satisfies GenerateSequenceNumbersOutput;
+}

package/src/plugins/sequence/actionHandlers/index.ts

@@ -1,4 +1,4 @@
-import { IPluginActionHandler } from "~/core/actionHandler";
-import * as generateSn from "./generateSn";
-
-export default [generateSn] satisfies IPluginActionHandler[];
+import { IPluginActionHandler } from "~/core/actionHandler";
+import * as generateSn from "./generateSn";
+
+export default [generateSn] satisfies IPluginActionHandler[];

package/src/plugins/sequence/models/SequenceAutoIncrementRecord.ts

@@ -1,49 +1,49 @@
-import { RpdDataModel } from "~/types";
-
-export default {
-  maintainedBy: "sequencePlugin",
-  namespace: "svc",
-  name: "sequence_auto_increment_record",
-  singularCode: "sequence_auto_increment_record",
-  pluralCode: "sequence_auto_increment_records",
-  schema: "public",
-  tableName: "sequence_auto_increment_records",
-  properties: [
-    {
-      name: "id",
-      code: "id",
-      columnName: "id",
-      type: "integer",
-      required: true,
-      autoIncrement: true,
-    },
-    {
-      name: "ruleCode",
-      code: "ruleCode",
-      columnName: "rule_code",
-      type: "text",
-      required: true,
-    },
-    {
-      name: "scope",
-      code: "scope",
-      columnName: "scope",
-      type: "text",
-      required: false,
-    },
-    {
-      name: "currentValue",
-      code: "currentValue",
-      columnName: "current_value",
-      type: "integer",
-      required: true,
-    },
-    {
-      name: "updatedAt",
-      code: "updatedAt",
-      columnName: "updated_at",
-      type: "datetime",
-      required: true,
-    },
-  ],
-} as RpdDataModel;
+import { RpdDataModel } from "~/types";
+
+export default {
+  maintainedBy: "sequencePlugin",
+  namespace: "svc",
+  name: "sequence_auto_increment_record",
+  singularCode: "sequence_auto_increment_record",
+  pluralCode: "sequence_auto_increment_records",
+  schema: "public",
+  tableName: "sequence_auto_increment_records",
+  properties: [
+    {
+      name: "id",
+      code: "id",
+      columnName: "id",
+      type: "integer",
+      required: true,
+      autoIncrement: true,
+    },
+    {
+      name: "ruleCode",
+      code: "ruleCode",
+      columnName: "rule_code",
+      type: "text",
+      required: true,
+    },
+    {
+      name: "scope",
+      code: "scope",
+      columnName: "scope",
+      type: "text",
+      required: false,
+    },
+    {
+      name: "currentValue",
+      code: "currentValue",
+      columnName: "current_value",
+      type: "integer",
+      required: true,
+    },
+    {
+      name: "updatedAt",
+      code: "updatedAt",
+      columnName: "updated_at",
+      type: "datetime",
+      required: true,
+    },
+  ],
+} as RpdDataModel;

package/src/plugins/sequence/models/SequenceRule.ts

@@ -1,42 +1,42 @@
-import { RpdDataModel } from "~/types";
-
-export default {
-  maintainedBy: "sequencePlugin",
-  namespace: "svc",
-  name: "sequence_rule",
-  singularCode: "sequence_rule",
-  pluralCode: "sequence_rules",
-  schema: "public",
-  tableName: "sequence_rules",
-  properties: [
-    {
-      name: "id",
-      code: "id",
-      columnName: "id",
-      type: "integer",
-      required: true,
-      autoIncrement: true,
-    },
-    {
-      name: "code",
-      code: "code",
-      columnName: "code",
-      type: "text",
-      required: true,
-    },
-    {
-      name: "description",
-      code: "description",
-      columnName: "description",
-      type: "text",
-      required: false,
-    },
-    {
-      name: "config",
-      code: "config",
-      columnName: "config",
-      type: "json",
-      required: false,
-    },
-  ],
-} as RpdDataModel;
+import { RpdDataModel } from "~/types";
+
+export default {
+  maintainedBy: "sequencePlugin",
+  namespace: "svc",
+  name: "sequence_rule",
+  singularCode: "sequence_rule",
+  pluralCode: "sequence_rules",
+  schema: "public",
+  tableName: "sequence_rules",
+  properties: [
+    {
+      name: "id",
+      code: "id",
+      columnName: "id",
+      type: "integer",
+      required: true,
+      autoIncrement: true,
+    },
+    {
+      name: "code",
+      code: "code",
+      columnName: "code",
+      type: "text",
+      required: true,
+    },
+    {
+      name: "description",
+      code: "description",
+      columnName: "description",
+      type: "text",
+      required: false,
+    },
+    {
+      name: "config",
+      code: "config",
+      columnName: "config",
+      type: "json",
+      required: false,
+    },
+  ],
+} as RpdDataModel;