feat: types improvement

Author: FedericoAmura

packages/automation/src/lib/context/machine-context.ts

@@ -7,7 +7,10 @@ function parsePath(path?: string | string[]): string[] {
   return path.split(/\.|\[|\]/).filter(Boolean);
 }
 
-function getFromObject(object: Record<string, any>, path?: string | string[]) {
+function getFromObject(
+  object: Record<string, unknown>,
+  path?: string | string[]
+) {
   if (!path) return object;
 
   const parts = parsePath(path);
@@ -85,7 +88,7 @@ export class MachineContext {
 
   public setFromData(
     location: string | string[],
-    data?: Record<string, any>,
+    data?: Record<string, unknown>,
     path?: string | string[]
   ) {
     if (!data) return;

packages/automation/src/lib/state-machine.ts

@@ -13,7 +13,7 @@ import {
 } from './listeners';
 import { signWithLitActionCode, executeLitAction } from './litActions';
 import { State, StateParams } from './states';
-import { Check, Transition } from './transitions';
+import { CheckFn, Transition } from './transitions';
 import { getEvmChain } from './utils/chain';
 import { getBalanceTransitionCheck, getERC20Balance } from './utils/erc20';
 
@@ -33,7 +33,7 @@ export type MachineStatus = 'running' | 'stopped';
  * A StateMachine class that manages states and transitions between them.
  */
 export class StateMachine {
-  private debug = false;
+  private readonly debug;
   private context: MachineContext;
 
   private litNodeClient: LitNodeClient;
@@ -273,7 +273,7 @@ export class StateMachine {
       };
 
       const listeners: Listener<any>[] = [];
-      const checks: Check[] = [];
+      const checks: CheckFn[] = [];
 
       if (timer) {
         const transitionIndex = checks.length;

packages/automation/src/lib/states/state.ts

@@ -11,12 +11,12 @@ export type StateParams = BaseStateParams;
  * A State class that represents a state with optional entry and exit actions.
  */
 export class State {
-  private debug = false;
+  private readonly debug;
   public readonly key: string;
   public readonly onEnter: (() => Promise<void>) | undefined;
   public readonly onExit: (() => Promise<void>) | undefined;
 
-  constructor(private params: BaseStateParams) {
+  constructor(params: BaseStateParams) {
     this.key = params.key;
     this.onEnter = params.onEnter;
     this.onExit = params.onExit;

packages/automation/src/lib/transitions/transition.ts

@@ -1,25 +1,26 @@
 import { Listener } from '../listeners';
 
-export type Check = (values: (any | undefined)[]) => Promise<boolean>;
+export type CheckFn = (values: (unknown | undefined)[]) => Promise<boolean>;
+export type resultFn = (values: (unknown | undefined)[]) => Promise<void>;
 
 /**
  * A Transition class that manages state transitions based on listeners and conditions.
  */
 export interface BaseTransitionParams {
   debug?: boolean;
-  listeners?: Listener<any>[];
-  check?: (values: (any | undefined)[]) => Promise<boolean>;
-  onMatch: (values: (any | undefined)[]) => Promise<void>;
-  onMismatch?: (values: (any | undefined)[]) => Promise<void>;
+  listeners?: Listener<any>[]; // should be unknown but that makes callers to cast listeners
+  check?: CheckFn;
+  onMatch: resultFn;
+  onMismatch?: resultFn;
 }
 
 export class Transition {
   private readonly debug: boolean;
-  private readonly listeners: Listener<any>[];
-  private readonly values: (any | undefined)[];
-  private readonly check?: Check;
-  private readonly onMatch: (values: (any | undefined)[]) => Promise<void>;
-  private readonly onMismatch?: (values: (any | undefined)[]) => Promise<void>;
+  private readonly listeners: Listener<unknown>[];
+  private readonly values: (unknown | undefined)[];
+  private readonly check?: CheckFn;
+  private readonly onMatch: resultFn;
+  private readonly onMismatch?: resultFn;
 
   /**
    * Creates a new Transition instance. If no listeners are provided, the transition will automatically match on the next event loop.
@@ -47,7 +48,7 @@ export class Transition {
    */
   private setupListeners() {
     this.listeners.forEach((listener, index) => {
-      listener.onStateChange(async (value: any) => {
+      listener.onStateChange(async (value: unknown) => {
         this.values[index] = value;
         const isMatch = this.check ? await this.check(this.values) : true;
         if (isMatch) {
@@ -69,7 +70,7 @@ export class Transition {
     await Promise.all(this.listeners.map((listener) => listener.start()));
 
     if (!this.listeners.length) {
-      // If the transition does not have any listeners it will never emit. Therefore, we "emit" automatically on next event loop
+      // If the transition does not have any listeners it will never emit. Therefore, we "match" automatically on next event loop
       setTimeout(() => {
         this.debug && console.log('Transition without listeners: auto match');
         this.onMatch([]);

packages/automation/src/lib/types.ts

@@ -17,13 +17,13 @@ export interface OnEvmChain {
   evmChainId: ContextOrLiteral<number>;
 }
 
-export interface ReadsContext<T> {
+export interface ContextAccess {
   contextPath: string;
 }
 
-export type ContextOrLiteral<T> = T | ReadsContext<T>;
+export type ContextOrLiteral<T> = T | ContextAccess;
 
-interface ContextUpdate extends ReadsContext<unknown> {
+interface ContextUpdate extends ContextAccess {
   dataPath: string;
 }