@ruiapp/rapid-core 0.9.9 → 0.10.1

package/src/plugins/sequence/SequencePlugin.ts

@@ -1,146 +1,146 @@
-/**
- * Sequence plugin
- */
-
-import { CreateEntityOptions, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty } from "~/types";
-import {
-  IRpdServer,
-  RapidPlugin,
-  RpdConfigurationItemOptions,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdServerPluginExtendingAbilities,
-} from "~/core/server";
-
-import pluginActionHandlers from "./actionHandlers";
-import pluginModels from "./models";
-import pluginRoutes from "./routes";
-import { PropertySequenceConfig } from "./SequencePluginTypes";
-import { isEqual } from "lodash";
-import SequenceService from "./SequenceService";
-import { isNullOrUndefined } from "~/utilities/typeUtility";
-import { getEntityPropertiesIncludingBase } from "~/helpers/metaHelper";
-
-class SequencePlugin implements RapidPlugin {
-  #sequenceService!: SequenceService;
-
-  get sequenceService() {
-    return this.#sequenceService;
-  }
-
-  get code(): string {
-    return "sequencePlugin";
-  }
-
-  get description(): string {
-    return null;
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async registerActionHandlers(server: IRpdServer): Promise<any> {
-    for (const actionHandler of pluginActionHandlers) {
-      server.registerActionHandler(this, actionHandler);
-    }
-  }
-
-  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ models: pluginModels });
-  }
-
-  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    this.#sequenceService = new SequenceService(server);
-    server.registerService("sequenceService", this.#sequenceService);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({ routes: pluginRoutes });
-  }
-
-  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
-    const models = server.getApplicationConfig().models;
-    for (const model of models) {
-      for (const property of getEntityPropertiesIncludingBase(server, model)) {
-        const propertySequenceConfig: PropertySequenceConfig = property.config?.sequence;
-        if (propertySequenceConfig) {
-          const ruleCode = getSequenceRuleCode(model, property);
-          const ruleConfig = propertySequenceConfig.config;
-
-          const sequenceRuleDataAccessor = server.getDataAccessor({
-            singularCode: "sequence_rule",
-          });
-          const sequenceRule = await sequenceRuleDataAccessor.findOne(
-            {
-              filters: [
-                {
-                  operator: "eq",
-                  field: {
-                    name: "code",
-                  },
-                  value: ruleCode,
-                },
-              ],
-            },
-            null,
-          );
-
-          if (sequenceRule) {
-            if (isEqual(sequenceRule.config, ruleConfig)) {
-              await sequenceRuleDataAccessor.updateById(
-                sequenceRule.id,
-                {
-                  config: ruleConfig,
-                },
-                null,
-              );
-            }
-          } else {
-            await sequenceRuleDataAccessor.create(
-              {
-                code: ruleCode,
-                config: ruleConfig,
-              },
-              null,
-            );
-          }
-        }
-      }
-    }
-  }
-
-  async beforeCreateEntity(server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) {
-    const { routeContext, entity } = options;
-    for (const property of getEntityPropertiesIncludingBase(server, model)) {
-      const sequenceConfig: PropertySequenceConfig = property.config?.sequence;
-      const propertyValue = entity[property.code];
-      if (sequenceConfig && sequenceConfig.enabled && isNullOrUndefined(propertyValue)) {
-        const ruleCode = getSequenceRuleCode(model, property);
-        const numbers = await this.#sequenceService.generateSn(routeContext, server, {
-          ruleCode,
-          amount: 1,
-          parameters: entity,
-        });
-        entity[property.code] = numbers[0];
-      }
-    }
-  }
-}
-
-function getSequenceRuleCode(model: RpdDataModel, property: RpdDataModelProperty) {
-  if (property.isBaseProperty) {
-    return `propertyAutoGenerate.${model.namespace}.${model.base}.${property.code}`;
-  } else {
-    return `propertyAutoGenerate.${model.namespace}.${model.singularCode}.${property.code}`;
-  }
-}
-
-export default SequencePlugin;
+/**
+ * Sequence plugin
+ */
+
+import { CreateEntityOptions, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty } from "~/types";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
+
+import pluginActionHandlers from "./actionHandlers";
+import pluginModels from "./models";
+import pluginRoutes from "./routes";
+import { PropertySequenceConfig } from "./SequencePluginTypes";
+import { isEqual } from "lodash";
+import SequenceService from "./SequenceService";
+import { isNullOrUndefined } from "~/utilities/typeUtility";
+import { getEntityPropertiesIncludingBase } from "~/helpers/metaHelper";
+
+class SequencePlugin implements RapidPlugin {
+  #sequenceService!: SequenceService;
+
+  get sequenceService() {
+    return this.#sequenceService;
+  }
+
+  get code(): string {
+    return "sequencePlugin";
+  }
+
+  get description(): string {
+    return null;
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async registerActionHandlers(server: IRpdServer): Promise<any> {
+    for (const actionHandler of pluginActionHandlers) {
+      server.registerActionHandler(this, actionHandler);
+    }
+  }
+
+  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ models: pluginModels });
+  }
+
+  async configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    this.#sequenceService = new SequenceService(server);
+    server.registerService("sequenceService", this.#sequenceService);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
+    const models = server.getApplicationConfig().models;
+    for (const model of models) {
+      for (const property of getEntityPropertiesIncludingBase(server, model)) {
+        const propertySequenceConfig: PropertySequenceConfig = property.config?.sequence;
+        if (propertySequenceConfig) {
+          const ruleCode = getSequenceRuleCode(model, property);
+          const ruleConfig = propertySequenceConfig.config;
+
+          const sequenceRuleDataAccessor = server.getDataAccessor({
+            singularCode: "sequence_rule",
+          });
+          const sequenceRule = await sequenceRuleDataAccessor.findOne(
+            {
+              filters: [
+                {
+                  operator: "eq",
+                  field: {
+                    name: "code",
+                  },
+                  value: ruleCode,
+                },
+              ],
+            },
+            null,
+          );
+
+          if (sequenceRule) {
+            if (isEqual(sequenceRule.config, ruleConfig)) {
+              await sequenceRuleDataAccessor.updateById(
+                sequenceRule.id,
+                {
+                  config: ruleConfig,
+                },
+                null,
+              );
+            }
+          } else {
+            await sequenceRuleDataAccessor.create(
+              {
+                code: ruleCode,
+                config: ruleConfig,
+              },
+              null,
+            );
+          }
+        }
+      }
+    }
+  }
+
+  async beforeCreateEntity(server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) {
+    const { routeContext, entity } = options;
+    for (const property of getEntityPropertiesIncludingBase(server, model)) {
+      const sequenceConfig: PropertySequenceConfig = property.config?.sequence;
+      const propertyValue = entity[property.code];
+      if (sequenceConfig && sequenceConfig.enabled && isNullOrUndefined(propertyValue)) {
+        const ruleCode = getSequenceRuleCode(model, property);
+        const numbers = await this.#sequenceService.generateSn(routeContext, server, {
+          ruleCode,
+          amount: 1,
+          parameters: entity,
+        });
+        entity[property.code] = numbers[0];
+      }
+    }
+  }
+}
+
+function getSequenceRuleCode(model: RpdDataModel, property: RpdDataModelProperty) {
+  if (property.isBaseProperty) {
+    return `propertyAutoGenerate.${model.namespace}.${model.base}.${property.code}`;
+  } else {
+    return `propertyAutoGenerate.${model.namespace}.${model.singularCode}.${property.code}`;
+  }
+}
+
+export default SequencePlugin;

package/src/plugins/sequence/SequencePluginTypes.ts

@@ -1,69 +1,69 @@
-export type PropertySequenceConfig = {
-  enabled: boolean;
-  config: SequenceRuleConfig;
-};
-
-export type SequenceRuleConfig = {
-  segments: SequenceSegmentConfig[];
-};
-
-export type SequenceSegmentConfig =
-  | SequenceLiteralSegmentConfig
-  | SequenceYearSegmentConfig
-  | SequenceMonthSegmentConfig
-  | SequenceDayOfMonthSegmentConfig
-  | SequenceDayOfWeekSegmentConfig
-  | SequenceDayOfYearSegmentConfig
-  | SequenceParameterSegmentConfig
-  | SequenceAutoIncrementSegmentConfig;
-
-export type SequenceLiteralSegmentConfig = {
-  type: "literal";
-  content: string;
-};
-
-export type SequenceYearSegmentConfig = {
-  type: "year";
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceMonthSegmentConfig = {
-  type: "month";
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceDayOfMonthSegmentConfig = {
-  type: "dayOfMonth";
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceDayOfWeekSegmentConfig = {
-  type: "dayOfWeek";
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceDayOfYearSegmentConfig = {
-  type: "dayOfYear";
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceParameterSegmentConfig = {
-  type: "parameter";
-  parameterName: string;
-  defaultContent?: string;
-  padding?: string;
-  length?: number;
-};
-
-export type SequenceAutoIncrementSegmentConfig = {
-  type: "autoIncrement";
-  scope?: string;
-  period?: "forever" | "day" | "month" | "year";
-  padding?: string;
-  length?: number;
-};
+export type PropertySequenceConfig = {
+  enabled: boolean;
+  config: SequenceRuleConfig;
+};
+
+export type SequenceRuleConfig = {
+  segments: SequenceSegmentConfig[];
+};
+
+export type SequenceSegmentConfig =
+  | SequenceLiteralSegmentConfig
+  | SequenceYearSegmentConfig
+  | SequenceMonthSegmentConfig
+  | SequenceDayOfMonthSegmentConfig
+  | SequenceDayOfWeekSegmentConfig
+  | SequenceDayOfYearSegmentConfig
+  | SequenceParameterSegmentConfig
+  | SequenceAutoIncrementSegmentConfig;
+
+export type SequenceLiteralSegmentConfig = {
+  type: "literal";
+  content: string;
+};
+
+export type SequenceYearSegmentConfig = {
+  type: "year";
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceMonthSegmentConfig = {
+  type: "month";
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceDayOfMonthSegmentConfig = {
+  type: "dayOfMonth";
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceDayOfWeekSegmentConfig = {
+  type: "dayOfWeek";
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceDayOfYearSegmentConfig = {
+  type: "dayOfYear";
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceParameterSegmentConfig = {
+  type: "parameter";
+  parameterName: string;
+  defaultContent?: string;
+  padding?: string;
+  length?: number;
+};
+
+export type SequenceAutoIncrementSegmentConfig = {
+  type: "autoIncrement";
+  scope?: string;
+  period?: "forever" | "day" | "month" | "year";
+  padding?: string;
+  length?: number;
+};

package/src/plugins/sequence/SequenceService.ts

@@ -1,92 +1,92 @@
-import { IRpdServer } from "~/core/server";
-import segmentResolvers from "./segments";
-import { find } from "lodash";
-import { SequenceRuleConfig, SequenceSegmentConfig } from "./SequencePluginTypes";
-import { RouteContext } from "~/core/routeContext";
-
-export interface GenerateSequenceNumbersInput {
-  ruleCode: string;
-  parameters: Record<string, string>;
-  amount: number;
-}
-
-export interface GenerateSequenceNumbersOutput {
-  sequences: string[];
-}
-
-export interface SegmentResolver {
-  segmentType: string;
-  resolveSegmentValue(
-    routeContext: RouteContext,
-    server: IRpdServer,
-    ruleCode: string,
-    config: SequenceSegmentConfig,
-    input: GenerateSequenceNumbersInput,
-  ): Promise<string>;
-}
-
-export default class SequenceService {
-  #server: IRpdServer;
-
-  constructor(server: IRpdServer) {
-    this.#server = server;
-  }
-
-  async generateSn(routeContext: RouteContext | null, 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,
-          },
-        ],
-      },
-      routeContext?.getDbTransactionClient(),
-    );
-
-    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 unknown segment type
-          server.getLogger().warn(`Unknown segment type "${segmentConfig.type}"`);
-          continue;
-        }
-
-        const segment = await segmentResolver.resolveSegmentValue(routeContext, 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";
+import { RouteContext } from "~/core/routeContext";
+
+export interface GenerateSequenceNumbersInput {
+  ruleCode: string;
+  parameters: Record<string, string>;
+  amount: number;
+}
+
+export interface GenerateSequenceNumbersOutput {
+  sequences: string[];
+}
+
+export interface SegmentResolver {
+  segmentType: string;
+  resolveSegmentValue(
+    routeContext: RouteContext,
+    server: IRpdServer,
+    ruleCode: string,
+    config: SequenceSegmentConfig,
+    input: GenerateSequenceNumbersInput,
+  ): Promise<string>;
+}
+
+export default class SequenceService {
+  #server: IRpdServer;
+
+  constructor(server: IRpdServer) {
+    this.#server = server;
+  }
+
+  async generateSn(routeContext: RouteContext | null, 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,
+          },
+        ],
+      },
+      routeContext?.getDbTransactionClient(),
+    );
+
+    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 unknown segment type
+          server.getLogger().warn(`Unknown segment type "${segmentConfig.type}"`);
+          continue;
+        }
+
+        const segment = await segmentResolver.resolveSegmentValue(routeContext, 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: routeContext } = ctx;
-  const { response } = routeContext;
-
-  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(routeContext, 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: routeContext } = ctx;
+  const { response } = routeContext;
+
+  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(routeContext, server, input);
+
+  ctx.output = {
+    sequences,
+  } satisfies GenerateSequenceNumbersOutput;
+}