@ruiapp/rapid-core 0.11.7 → 0.12.0

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,54 +1,54 @@
-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: routeContext } = ctx;
-  const { response } = routeContext;
-
-  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,
-        },
-      ],
-    },
-    routeContext?.getDbTransactionClient(),
-  );
-
-  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: routeContext } = ctx;
+  const { response } = routeContext;
+
+  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,
+        },
+      ],
+    },
+    routeContext?.getDbTransactionClient(),
+  );
+
+  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/stateMachine/stateMachineHelper.ts

@@ -1,36 +1,36 @@
-import { DefaultStateMachineSnapshot, GetStateMachineNextSnapshotOptions, TryGetStateMachineNextSnapshotResult } from "./StateMachinePluginTypes";
-import { createMachine, getInitialSnapshot, getNextSnapshot } from "xstate";
-
-export async function getStateMachineNextSnapshot(options: GetStateMachineNextSnapshotOptions) {
-  const { machineConfig, currentState, event } = options;
-  machineConfig.initial = currentState;
-
-  const machine = createMachine(machineConfig);
-  const snapshot = getInitialSnapshot(machine);
-
-  if (!snapshot.can(event)) {
-    throw new Error(`'${event.type}' action is not allowed at '${currentState}' state.`);
-  }
-
-  const nextSnapshot = getNextSnapshot(machine, snapshot, event);
-  return nextSnapshot;
-}
-
-export async function tryGetStateMachineNextSnapshot(options: GetStateMachineNextSnapshotOptions): Promise<TryGetStateMachineNextSnapshotResult> {
-  const { machineConfig, currentState, event } = options;
-  machineConfig.initial = currentState;
-
-  const machine = createMachine(machineConfig);
-  const snapshot = getInitialSnapshot(machine);
-
-  const canTransfer = snapshot.can(event);
-  let nextSnapshot: DefaultStateMachineSnapshot;
-  if (canTransfer) {
-    nextSnapshot = getNextSnapshot(machine, snapshot, event);
-  }
-
-  return {
-    canTransfer,
-    nextSnapshot,
-  };
-}
+import { DefaultStateMachineSnapshot, GetStateMachineNextSnapshotOptions, TryGetStateMachineNextSnapshotResult } from "./StateMachinePluginTypes";
+import { createMachine, getInitialSnapshot, getNextSnapshot } from "xstate";
+
+export async function getStateMachineNextSnapshot(options: GetStateMachineNextSnapshotOptions) {
+  const { machineConfig, currentState, event } = options;
+  machineConfig.initial = currentState;
+
+  const machine = createMachine(machineConfig);
+  const snapshot = getInitialSnapshot(machine);
+
+  if (!snapshot.can(event)) {
+    throw new Error(`'${event.type}' action is not allowed at '${currentState}' state.`);
+  }
+
+  const nextSnapshot = getNextSnapshot(machine, snapshot, event);
+  return nextSnapshot;
+}
+
+export async function tryGetStateMachineNextSnapshot(options: GetStateMachineNextSnapshotOptions): Promise<TryGetStateMachineNextSnapshotResult> {
+  const { machineConfig, currentState, event } = options;
+  machineConfig.initial = currentState;
+
+  const machine = createMachine(machineConfig);
+  const snapshot = getInitialSnapshot(machine);
+
+  const canTransfer = snapshot.can(event);
+  let nextSnapshot: DefaultStateMachineSnapshot;
+  if (canTransfer) {
+    nextSnapshot = getNextSnapshot(machine, snapshot, event);
+  }
+
+  return {
+    canTransfer,
+    nextSnapshot,
+  };
+}