@ruiapp/rapid-core 0.1.83 → 0.2.1

package/src/plugins/stateMachine/StateMachinePluginTypes.ts

@@ -1,48 +1,48 @@
-import { AnyActorRef, AnyEventObject, EventObject, MachineConfig, MachineContext, MachineSnapshot, MetaObject, StateValue } from "xstate";
-
-export type PropertyStateMachineConfig = {
-  enabled: boolean;
-  config: MachineConfig<any, any>;
-  transferControl?: boolean;
-};
-
-export type SendStateMachineEventOptions = {
-  code: string;
-};
-
-export type StateMachineEvent = AnyEventObject;
-
-export type SendStateMachineEventInput = {
-  code?: string;
-  context: any;
-  currentState: string;
-  event: StateMachineEvent;
-};
-
-export type GetStateMachineNextSnapshotOptions = {
-  machineConfig: MachineConfig<any, any>;
-  context: any;
-  currentState: string;
-  event: StateMachineEvent;
-};
-
-export type DefaultStateMachineSnapshot = MachineSnapshot<
-  MachineContext,
-  EventObject,
-  Record<string, AnyActorRef | undefined>,
-  StateValue,
-  string,
-  unknown,
-  MetaObject
->;
-
-export type TryGetStateMachineNextSnapshotResult = TryGetStateMachineNextSnapshotPositiveResult | TryGetStateMachineNextSnapshotNegativeResult;
-
-export type TryGetStateMachineNextSnapshotPositiveResult = {
-  canTransfer: true;
-  nextSnapshot: DefaultStateMachineSnapshot;
-};
-
-export type TryGetStateMachineNextSnapshotNegativeResult = {
-  canTransfer: false;
-};
+import { AnyActorRef, AnyEventObject, EventObject, MachineConfig, MachineContext, MachineSnapshot, MetaObject, StateValue } from "xstate";
+
+export type PropertyStateMachineConfig = {
+  enabled: boolean;
+  config: MachineConfig<any, any>;
+  transferControl?: boolean;
+};
+
+export type SendStateMachineEventOptions = {
+  code: string;
+};
+
+export type StateMachineEvent = AnyEventObject;
+
+export type SendStateMachineEventInput = {
+  code?: string;
+  context: any;
+  currentState: string;
+  event: StateMachineEvent;
+};
+
+export type GetStateMachineNextSnapshotOptions = {
+  machineConfig: MachineConfig<any, any>;
+  context: any;
+  currentState: string;
+  event: StateMachineEvent;
+};
+
+export type DefaultStateMachineSnapshot = MachineSnapshot<
+  MachineContext,
+  EventObject,
+  Record<string, AnyActorRef | undefined>,
+  StateValue,
+  string,
+  unknown,
+  MetaObject
+>;
+
+export type TryGetStateMachineNextSnapshotResult = TryGetStateMachineNextSnapshotPositiveResult | TryGetStateMachineNextSnapshotNegativeResult;
+
+export type TryGetStateMachineNextSnapshotPositiveResult = {
+  canTransfer: true;
+  nextSnapshot: DefaultStateMachineSnapshot;
+};
+
+export type TryGetStateMachineNextSnapshotNegativeResult = {
+  canTransfer: false;
+};

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

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

package/src/plugins/stateMachine/actionHandlers/sendStateMachineEvent.ts

@@ -1,51 +1,51 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import { SendStateMachineEventInput, SendStateMachineEventOptions } from "../StateMachinePluginTypes";
-import { getStateMachineNextSnapshot } from "../stateMachineHelper";
-
-export const code = "sendStateMachineEvent";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: SendStateMachineEventOptions) {
-  const { server, routerContext } = ctx;
-  const { response } = routerContext;
-
-  const input: SendStateMachineEventInput = ctx.input;
-  if (options?.code) {
-    input.code = options.code;
-  }
-
-  if (!input.code) {
-    throw new Error(`State machine code is required when sending event.`);
-  }
-
-  const stateMachineDataAccessor = server.getDataAccessor({
-    singularCode: "state_machine",
-  });
-
-  const stateMachine = await stateMachineDataAccessor.findOne({
-    filters: [
-      {
-        operator: "eq",
-        field: "code",
-        value: input.code,
-      },
-    ],
-  });
-
-  if (!stateMachine) {
-    throw new Error(`State machine with code '${input.code}' was not found.`);
-  }
-
-  stateMachine.config.id = input.code;
-
-  const snapshot = await getStateMachineNextSnapshot({
-    machineConfig: stateMachine.config,
-    context: input.context,
-    currentState: input.currentState,
-    event: input.event,
-  });
-
-  response.json({
-    state: snapshot.value,
-  });
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import { SendStateMachineEventInput, SendStateMachineEventOptions } from "../StateMachinePluginTypes";
+import { getStateMachineNextSnapshot } from "../stateMachineHelper";
+
+export const code = "sendStateMachineEvent";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: SendStateMachineEventOptions) {
+  const { server, routerContext } = ctx;
+  const { response } = routerContext;
+
+  const input: SendStateMachineEventInput = ctx.input;
+  if (options?.code) {
+    input.code = options.code;
+  }
+
+  if (!input.code) {
+    throw new Error(`State machine code is required when sending event.`);
+  }
+
+  const stateMachineDataAccessor = server.getDataAccessor({
+    singularCode: "state_machine",
+  });
+
+  const stateMachine = await stateMachineDataAccessor.findOne({
+    filters: [
+      {
+        operator: "eq",
+        field: "code",
+        value: input.code,
+      },
+    ],
+  });
+
+  if (!stateMachine) {
+    throw new Error(`State machine with code '${input.code}' was not found.`);
+  }
+
+  stateMachine.config.id = input.code;
+
+  const snapshot = await getStateMachineNextSnapshot({
+    machineConfig: stateMachine.config,
+    context: input.context,
+    currentState: input.currentState,
+    event: input.event,
+  });
+
+  response.json({
+    state: snapshot.value,
+  });
+}

package/src/plugins/stateMachine/models/StateMachine.ts

@@ -1,42 +1,42 @@
-import { RpdDataModel } from "~/types";
-
-export default {
-  maintainedBy: "stateMachinePlugin",
-  namespace: "svc",
-  name: "state_machine",
-  singularCode: "state_machine",
-  pluralCode: "state_machines",
-  schema: "public",
-  tableName: "state_machines",
-  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: "stateMachinePlugin",
+  namespace: "svc",
+  name: "state_machine",
+  singularCode: "state_machine",
+  pluralCode: "state_machines",
+  schema: "public",
+  tableName: "state_machines",
+  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;

package/src/plugins/stateMachine/models/index.ts

@@ -1,3 +1,3 @@
-import StateMachine from "./StateMachine";
-
-export default [StateMachine];
+import StateMachine from "./StateMachine";
+
+export default [StateMachine];

package/src/plugins/stateMachine/routes/index.ts

@@ -1,3 +1,3 @@
-import sendStateMachineEvent from "./sendStateMachineEvent";
-
-export default [sendStateMachineEvent];
+import sendStateMachineEvent from "./sendStateMachineEvent";
+
+export default [sendStateMachineEvent];

package/src/plugins/stateMachine/routes/sendStateMachineEvent.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "svc",
-  name: "svc.sendStateMachineEvent",
-  code: "svc.sendStateMachineEvent",
-  type: "RESTful",
-  method: "POST",
-  endpoint: "/svc/sendStateMachineEvent",
-  actions: [
-    {
-      code: "sendStateMachineEvent",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "svc",
+  name: "svc.sendStateMachineEvent",
+  code: "svc.sendStateMachineEvent",
+  type: "RESTful",
+  method: "POST",
+  endpoint: "/svc/sendStateMachineEvent",
+  actions: [
+    {
+      code: "sendStateMachineEvent",
+    },
+  ],
+} satisfies RpdRoute;

package/src/plugins/webhooks/WebhooksPlugin.ts

@@ -1,148 +1,148 @@
-/**
- * Webhooks plugin
- */
-
-import { RpdApplicationConfig, RpdEntityCreateEventPayload, RpdEntityDeleteEventPayload, RpdEntityUpdateEventPayload, RpdServerEventTypes } from "~/types";
-import {
-  RpdServerPluginExtendingAbilities,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdConfigurationItemOptions,
-  IRpdServer,
-  RapidPlugin,
-} from "~/core/server";
-import { fetchWithTimeout } from "~/utilities/httpUtility";
-import pluginConfig from "./pluginConfig";
-import { indexOf } from "lodash";
-
-export interface Webhook {
-  name: string;
-  url: string;
-  secret: string;
-  namespace: string;
-  modelSingularCode: string;
-  events: string[];
-  properties: string[];
-  enabled: boolean;
-}
-
-function listWebhooks(server: IRpdServer) {
-  const logger = server.getLogger();
-  logger.info("Loading meta of webhooks...");
-
-  try {
-    const entityManager = server.getEntityManager("webhook");
-    return entityManager.findEntities({
-      filters: [
-        {
-          field: "enabled",
-          operator: "eq",
-          value: true,
-        },
-      ],
-    });
-  } catch (error) {
-    logger.crit("Failed to load meta of webhooks.", { error });
-  }
-}
-
-class WebhooksPlugin implements RapidPlugin {
-  #webhooks: Webhook[];
-
-  constructor() {
-    this.#webhooks = [];
-  }
-
-  get code(): string {
-    return "webhooks";
-  }
-
-  get description(): string {
-    return null;
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async registerEventHandlers(server: IRpdServer): Promise<any> {
-    const events: (keyof RpdServerEventTypes)[] = ["entity.create", "entity.update", "entity.delete"];
-    for (const event of events) {
-      server.registerEventHandler(event, this.handleEntityEvent.bind(this, server, event));
-    }
-  }
-
-  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    server.appendApplicationConfig({
-      models: pluginConfig.models,
-    });
-  }
-
-  async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
-
-  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    this.#webhooks = await listWebhooks(server);
-  }
-
-  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
-
-  async handleEntityEvent(
-    server: IRpdServer,
-    event: keyof RpdServerEventTypes,
-    sender: RapidPlugin,
-    payload: RpdEntityCreateEventPayload | RpdEntityUpdateEventPayload | RpdEntityDeleteEventPayload,
-  ) {
-    if (sender === this) {
-      return;
-    }
-
-    if (payload.namespace === "sys" && payload.modelSingularCode === "webhook") {
-      this.#webhooks = await listWebhooks(server);
-      return;
-    }
-
-    // We will not trigger webhooks if entity changed is in "meta" or "sys" namespaces.
-    if (payload.namespace === "meta" || payload.namespace === "sys") {
-      return;
-    }
-
-    const logger = server.getLogger();
-
-    for (const webhook of this.#webhooks) {
-      if (indexOf(webhook.events, event) === -1) {
-        continue;
-      }
-
-      if (webhook.namespace != payload.namespace || webhook.modelSingularCode !== payload.modelSingularCode) {
-        continue;
-      }
-
-      logger.debug(`Triggering webhook. ${webhook.url}`);
-      // TODO: It's better to trigger webhook through message queue.
-      const requestBody = { event, payload };
-      try {
-        await fetchWithTimeout(webhook.url, {
-          method: "post",
-          headers: {
-            "Content-Type": "application/json",
-            "x-webhook-secret": webhook.secret || "",
-          },
-          body: JSON.stringify(requestBody),
-        });
-      } catch (error) {
-        logger.error("Failed to call webhook.", { error, webhookUrl: webhook.url, requestBody });
-      }
-    }
-  }
-}
-
-export default WebhooksPlugin;
+/**
+ * Webhooks plugin
+ */
+
+import { RpdApplicationConfig, RpdEntityCreateEventPayload, RpdEntityDeleteEventPayload, RpdEntityUpdateEventPayload, RpdServerEventTypes } from "~/types";
+import {
+  RpdServerPluginExtendingAbilities,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdConfigurationItemOptions,
+  IRpdServer,
+  RapidPlugin,
+} from "~/core/server";
+import { fetchWithTimeout } from "~/utilities/httpUtility";
+import pluginConfig from "./pluginConfig";
+import { indexOf } from "lodash";
+
+export interface Webhook {
+  name: string;
+  url: string;
+  secret: string;
+  namespace: string;
+  modelSingularCode: string;
+  events: string[];
+  properties: string[];
+  enabled: boolean;
+}
+
+function listWebhooks(server: IRpdServer) {
+  const logger = server.getLogger();
+  logger.info("Loading meta of webhooks...");
+
+  try {
+    const entityManager = server.getEntityManager("webhook");
+    return entityManager.findEntities({
+      filters: [
+        {
+          field: "enabled",
+          operator: "eq",
+          value: true,
+        },
+      ],
+    });
+  } catch (error) {
+    logger.crit("Failed to load meta of webhooks.", { error });
+  }
+}
+
+class WebhooksPlugin implements RapidPlugin {
+  #webhooks: Webhook[];
+
+  constructor() {
+    this.#webhooks = [];
+  }
+
+  get code(): string {
+    return "webhooks";
+  }
+
+  get description(): string {
+    return null;
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async registerEventHandlers(server: IRpdServer): Promise<any> {
+    const events: (keyof RpdServerEventTypes)[] = ["entity.create", "entity.update", "entity.delete"];
+    for (const event of events) {
+      server.registerEventHandler(event, this.handleEntityEvent.bind(this, server, event));
+    }
+  }
+
+  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({
+      models: pluginConfig.models,
+    });
+  }
+
+  async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    this.#webhooks = await listWebhooks(server);
+  }
+
+  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {}
+
+  async handleEntityEvent(
+    server: IRpdServer,
+    event: keyof RpdServerEventTypes,
+    sender: RapidPlugin,
+    payload: RpdEntityCreateEventPayload | RpdEntityUpdateEventPayload | RpdEntityDeleteEventPayload,
+  ) {
+    if (sender === this) {
+      return;
+    }
+
+    if (payload.namespace === "sys" && payload.modelSingularCode === "webhook") {
+      this.#webhooks = await listWebhooks(server);
+      return;
+    }
+
+    // We will not trigger webhooks if entity changed is in "meta" or "sys" namespaces.
+    if (payload.namespace === "meta" || payload.namespace === "sys") {
+      return;
+    }
+
+    const logger = server.getLogger();
+
+    for (const webhook of this.#webhooks) {
+      if (indexOf(webhook.events, event) === -1) {
+        continue;
+      }
+
+      if (webhook.namespace != payload.namespace || webhook.modelSingularCode !== payload.modelSingularCode) {
+        continue;
+      }
+
+      logger.debug(`Triggering webhook. ${webhook.url}`);
+      // TODO: It's better to trigger webhook through message queue.
+      const requestBody = { event, payload };
+      try {
+        await fetchWithTimeout(webhook.url, {
+          method: "post",
+          headers: {
+            "Content-Type": "application/json",
+            "x-webhook-secret": webhook.secret || "",
+          },
+          body: JSON.stringify(requestBody),
+        });
+      } catch (error) {
+        logger.error("Failed to call webhook.", { error, webhookUrl: webhook.url, requestBody });
+      }
+    }
+  }
+}
+
+export default WebhooksPlugin;

package/src/plugins/webhooks/pluginConfig.ts

@@ -70,5 +70,6 @@ export default {
       ],
     },
   ],
+  dataDictionaries: [],
   routes: [],
 } satisfies RpdApplicationConfig;

package/src/polyfill.ts

@@ -1,5 +1,5 @@
-export function fixBigIntJSONSerialize() {
-  (BigInt.prototype as any).toJSON = function () {
-    return this.toString();
-  };
-}
+export function fixBigIntJSONSerialize() {
+  (BigInt.prototype as any).toJSON = function () {
+    return this.toString();
+  };
+}