feat: add state helper

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+coverage
+docs

README.md

@@ -75,7 +75,7 @@ class BaseEntity extends TypeOrmBaseEntity {
 
 @Entity('order')
 class Order extends StateMachineEntity({
-    itemsStatus: {
+    itemsStatus: state({
       id: 'orderItemsStatus',
       initial: OrderItemState.draft,
       persistContext: true,
@@ -111,7 +111,7 @@ class Order extends StateMachineEntity({
           OrderItemState.delivered,
         ),
       ],
-    },
+    }),
   },
   BaseEntity, // It's optional
 ) {

package.json

@@ -37,6 +37,7 @@
     "@commitlint/config-conventional": "^17.7.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
+    "@swc/core": "^1.3.87",
     "@types/better-sqlite3": "^7.6.4",
     "@typescript-eslint/eslint-plugin": "^6.4.1",
     "@typescript-eslint/parser": "^6.4.1",
@@ -46,6 +47,7 @@
     "eslint": "^8.47.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-node": "^0.3.9",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-lodash": "^7.4.0",
     "eslint-plugin-node": "^11.1.0",
@@ -57,7 +59,6 @@
     "typedoc": "^0.25.0",
     "typedoc-plugin-mermaid": "^1.10.0",
     "typescript": "^5.2.2",
-    "@swc/core": "^1.3.87",
     "unplugin-swc": "^1.4.2",
     "vitest": "^0.34.5"
   },

src/__tests__/examples/file-upload.spec.ts

@@ -1,12 +1,7 @@
+import { Column, DataSource, Entity, PrimaryGeneratedColumn } from 'typeorm';
 import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest';
-import {
-  Column,
-  DataSource,
-  Entity,
-  PrimaryGeneratedColumn,
-  BaseEntity as TypeOrmBaseEntity,
-} from 'typeorm';
-import { StateMachineEntity,t } from '../..';
+
+import { StateMachineEntity, t, state } from '../..';
 
 /**
  * First, user submits a file to the server.
@@ -28,20 +23,24 @@ enum FileEvent {
 
 @Entity('file')
 class File extends StateMachineEntity({
-  status: {
+  status: state({
     id: 'fileStatus',
     initial: FileState.pending,
     transitions: [
       t(FileState.pending, FileEvent.start, FileState.uploading),
-      t(FileState.uploading, FileEvent.finish, FileState.completed,{
-        async onEnter(this: File, _ctx, url: string | null){
+      t(FileState.uploading, FileEvent.finish, FileState.completed, {
+        async onEnter(this: File, _context, url: string | null) {
           this.url = url;
-        }
+        },
       }),
-      t([FileState.pending, FileState.uploading], FileEvent.fail, FileState.failed),
+      t(
+        [FileState.pending, FileState.uploading],
+        FileEvent.fail,
+        FileState.failed,
+      ),
     ],
-  },
-}){
+  }),
+}) {
   @PrimaryGeneratedColumn()
   id: string;
 
@@ -82,7 +81,7 @@ describe('File upload', () => {
         id,
       },
     });
-  }
+  };
 
   it('should change state', async () => {
     const file = new File();

src/__tests__/fsm.entity.spec.ts

@@ -1,14 +1,21 @@
-import { describe, expect, it, vi, afterEach, beforeAll, afterAll } from 'vitest';
-
 import {
   Column,
   DataSource,
   Entity,
   PrimaryGeneratedColumn,
   BaseEntity as TypeOrmBaseEntity,
 } from 'typeorm';
+import {
+  describe,
+  expect,
+  it,
+  vi,
+  afterEach,
+  beforeAll,
+  afterAll,
+} from 'vitest';
 
-import { StateMachineEntity, t } from '../';
+import { StateMachineEntity, state, t } from '../';
 
 enum OrderState {
   draft = 'draft',
@@ -51,7 +58,7 @@ class BaseEntity extends TypeOrmBaseEntity {
 @Entity('order')
 class Order extends StateMachineEntity(
   {
-    status: {
+    status: state({
       id: 'orderStatus',
       initial: OrderState.draft,
       transitions: [
@@ -60,8 +67,8 @@ class Order extends StateMachineEntity(
         t(OrderState.paid, OrderEvent.ship, OrderState.shipped),
         t(OrderState.shipped, OrderEvent.complete, OrderState.completed),
       ],
-    },
-    itemsStatus: {
+    }),
+    itemsStatus: state({
       id: 'orderItemsStatus',
       initial: OrderItemState.draft,
       persistContext: true,
@@ -99,7 +106,7 @@ class Order extends StateMachineEntity(
           OrderItemState.delivered,
         ),
       ],
-    },
+    }),
   },
   BaseEntity,
 ) {

src/fsm.entity.ts

@@ -31,8 +31,8 @@ type ExtractState<
   Column extends keyof Parameters,
 > = Parameters[Column] extends IStateMachineEntityColumnParameters<
   infer State,
-  AllowedNames,
-  object
+  any,
+  any
 >
   ? State extends AllowedNames
     ? State
@@ -43,9 +43,9 @@ type ExtractEvent<
   Parameters extends object,
   Column extends keyof Parameters,
 > = Parameters[Column] extends IStateMachineEntityColumnParameters<
-  AllowedNames,
+  any,
   infer Event,
-  object
+  any
 >
   ? Event extends AllowedNames
     ? Event
@@ -56,8 +56,8 @@ type ExtractContext<
   Parameters extends object,
   Column extends keyof Parameters,
 > = Parameters[Column] extends IStateMachineEntityColumnParameters<
-  AllowedNames,
-  AllowedNames,
+  any,
+  any,
   infer Context
 >
   ? Context extends object
@@ -183,12 +183,8 @@ function initializeStateMachine<
  * }}) {}
  */
 export const StateMachineEntity = function <
-  Parameters extends {
-    [Column in Columns]: IStateMachineEntityColumnParameters<
-      AllowedNames,
-      AllowedNames,
-      any
-    >;
+  const Parameters extends {
+    [Column in Columns]: IStateMachineEntityColumnParameters<any, any, any>;
   },
   Entity extends BaseEntity,
   const Columns extends keyof Parameters = keyof Parameters,
@@ -292,6 +288,7 @@ export const StateMachineEntity = function <
   return _StateMachineEntity as unknown as {
     new (): BaseEntity &
       Entity & {
+        params: Parameters;
         fsm: {
           [Column in keyof Parameters]: IStateMachine<
             ExtractState<Parameters, Column>,

src/index.ts

@@ -6,3 +6,4 @@ export {
   isStateMachineError,
 } from 'fsmoothy';
 export { StateMachineEntity } from './fsm.entity';
+export { state } from './state';

src/state.ts

@@ -0,0 +1,11 @@
+import { AllowedNames } from 'fsmoothy/types';
+
+import { IStateMachineEntityColumnParameters } from './fsm.entity';
+
+export const state = <
+  const State extends AllowedNames,
+  const Event extends AllowedNames,
+  const Context extends object,
+>(
+  parameters: IStateMachineEntityColumnParameters<State, Event, Context>,
+) => parameters;