Documentation.

Author: hyperandroid

automata.d.ts

@@ -1,5 +1,39 @@
 declare module FSM {
 
+    export interface FSMDefinitionStateTimer {
+        timeout : number;
+        event : FSM.TransitionMessage;
+    }
+
+    export interface FSMDefinitionState {
+        name : string;
+        initial : boolean;
+        onTimer : FSMDefinitionStateTimer;
+        onEnter : string|FSM.StateCallback;
+        onExit : string|StateCallback;
+    }
+
+    export interface FSMDefinitionSubState {
+        name : string;
+    }
+
+    export interface FSMDefinitionTransition {
+        event :string;
+        from : string;
+        to : string;
+        onTransition : string|TransitionCallback;
+        onPreGuard : string|TransitionCallback;
+        onPostGuard : string|TransitionCallback;
+    }
+
+    export interface FSMDefinition {
+        name : string;
+        state : FSMDefinitionState[] | FSMDefinitionSubState[];
+        transition : FSMDefinitionTransition[];
+        onEnter : string | StateCallback;
+        onExit : string | StateCallback;
+    }
+
     export interface TransitionMessage {
         msgId : string;
         data? : any;
@@ -9,6 +43,14 @@ declare module FSM {
         (session:Session):void
     }
 
+    export interface TransitionCallback {
+        (state:State, transition:Transition, message:TransitionMessage):void;
+    }
+
+    export interface StateCallback {
+        (state:State, transition:Transition, message:TransitionMessage):void;
+    }
+
     class Session {
 
         consume( message : TransitionMessage, consumeCallback? : FSM.ConsumeCallback  );
@@ -53,10 +95,10 @@ declare module FSM {
 
 declare module Automata {
 
-    export function registerFSM( object:any );
-    export function registerFDA( object:any );
-    export function createSession( fda_name : string, controller:any ) :       FSM.Session;
-    export function newGuardException( message : string ) :    FSM.GuardException;
-    export function newSessionListener( obj : any ) :          FSM.SessionListener;
+    export function registerFSM( object:FSM.FSMDefinition );
+    export function registerFDA( object:FSM.FSMDefinition );
+    export function createSession( fda_name : string, controller : any ) : FSM.Session;
+    export function newGuardException( message : string ) : FSM.GuardException;
+    export function newSessionListener( obj : any ) : FSM.SessionListener;
 
 }

automata.js

@@ -25,14 +25,14 @@
      * @callback TransitionCallback
      * @param state {FSM.State}
      * @param transition {FSM.Transition}
-     * @param message {object}
+     * @param message {FSM.TransitionMessage}
      */
 
     /**
      * @callback StateCallback
      * @param state {FSM.State}
      * @param transition {FSM.Transition}
-     * @param message {object}
+     * @param message {FSM.TransitionMessage}
      */
 
 
@@ -60,7 +60,7 @@
     FSM.TransitionMessage;
 
     /**
-     * @typedef {{ fda : string, controller : any }}
+     * @typedef {{ fda : string, controller? : Object }}
      */
     FSM.SessionCreationData;