Fix a bug that caused history semantics to be followed when reentering a region that did not have history defined.
Fix bug in transtions originating from pseudo states that cross composite state boundaries; this necessitates the following breaking changes:
- Make IInstance.setCurrent and IInstance.getCurrent set and get the last known Vertex for a given Region (was State previously);
- Add IInstance.getLastKnownState to return the last active State of an instance.
Note: any custom implementations of IInstance will need changing.
Added a JSONInsance class to allowing saving/load of state machine state as a JSON string
Acknowledge that IInstance.getCurrent could return undefined if the Region had not previously been entered.
Replace a few let declarations with const where the value is not changed.
Deprecate FinalStateClass as it is just a State that has no outbound transitions; this will be droped in the 6.0 release.
Remove IConsole interface and made it an implicit.
Moved to TypeScript 2.0:
- protected constructors on abstract claseses;
- made readonly properties readonly;
- compile with strictNullChecks set to true;
- exploit dotted type guards;
- add a setProperty as where ther were previourly read/write properties:
consoleaugmented withsetConsolemethod;randomaugmented withsetRandommethod;internalTransitionsTriggerCompletionaugmented withsetInternalTransitionsTriggerCompletionmethod;
- explicitly define types that may be undefined.
Fixed a few issues based on TypeScript Do's and Don'ts:
- Return boolean rather than Boolean;
- Return void from
visit...and accept methods rather thanany. - Remove optional parameters from callbacks.
Moved isHistory and isInitial methods back to PseudoState class as the extension methods to the enum feels like a bit of a hack.
Remove the untyped arg2 and arg3 from the Visitor pattern; if more information is required use a class as arg1.
BREAKING CHANGE: reorganised the lib directory; the lib/node directory is provides a CommonJS version and lib/web directory provides a web based version.
Bug fix: trace output was not produced for all state entry and state exit.
Refactoring and minor API changes:
- defaultRegion method reanmed getDefaultRegion.
Refactoring of the TypeScript code to remove unnecessary internals from the public API; this is follow-on activity from release 5.6.10.
Change the API for controlling random number generation to be more aligned with the API for console.
Enable state.js to be used as a TypeSript module and imported using:
import * as state from "state";Fix an omission in history semantics allowing regions to contain history pseudo states with no outbound transitions.
Exploit recent TypeScript language enhancements.
Fix bug #22.
Add a switch to enable internal transitions to generate completion events, thereby causing completion transitions to be evaluated. Add the following to your code before initialising any state machines:
state.internalTransitionsTriggerCompletion = true;Fix bug #21.
Add experimental support for subtractive dynamic models (via remove methos).
Fix a bug in the p3pp3r test - the assertions would always pass.
Minor refactoring of tests.
Refactor the dual implementations of the ancestor function into a single method on Vertex.
Other refactoring for readability and code consistency.
First attempt at using with Bower.
Minor refactoring and tidy of the repo.
Revert ElementBehavior to a class from an array.
Fix minor bug in error text when multiple guards return true at a junction psudo state.
Other minor refactoring.
Rename all occurances of behaviour to behavior.
Upgrade to TypeScript 1.6
Use Element.namespaceSeperator in the construction of fully qualified names.
Remove unnecessary template parameters to methods that accept behaviour callbacks.
Add documentation for Transition.source and Transition.target.
Other minor refactoring.
Fix a possible issue where deep history semantics were not properly propigated through the state machine model initialisation.
Remove Region.getInitial and inline the code to the region bootstrap as it was really an internal use method.
Remove logging, warning and errors from state machine class; move to the module scope under the name console.
Add a Behavior class and refactor all Element behaviour.
Refactoring.
Added a more testg in the validator:
- Check there are not multiple regions with the default region name.
Fix an issue in the 5.5.1 release with the sequence of logging across state and region entry.
More refactoring.
Minor refactoring post 5.5.0 release.
A rollup release of all the public API changes I've been wanting to do for a while; many of these are small and will probably not impact a well writtern machine.
Added a Validator class (implementation of a Visitor) and moved any validation logic there. Better validation can be performed after the full model is built. A call of validate(stateMachine) will perform validation.
Remove the unnecessary TypeScript overloads from Vertex constructor and all derived class constructors.
Tidy the creation of qualifiedName.
Rename Vertex.transitions to Vertex.outgoing to more closely align to UML specification.
Remove Region.initial property and replaced with Region.getInitial() method that selects the initial pseudo state from the set of vertices.
Remove Element.getRoot and implement it as Vertex.getRoot and Region.getRoot; thereby making Element closer to NamedElement in UML.
Remove Element.parent and rely on Region.state and Vertex.region.
Remove Elemenet.accept and implement to remove state machine specifics from Element.
Add Vertex.accept.
Rename LogTo, WarnTo and ErrorTo interfaces to ILogTo, IWarnTo and IErrorTo respectively.
Tidy up some of unnecessary methods in the model interface
- Remove Element.getParent, relpace with parent attribute.
- Remove Element.getAncestors.
Reduce use of any type.
Move a litte logic from Vertex.to to Transition constructor to allow explicit creation of Transitions as well as Vertex.to.
Other internal general refactoring.
Fix issue where final state calls the error method instead of a warning.
Refactor logging, wanrings and errors; remove need for casting in TypeScript and ensure the logging, wanring and error object passed will have the correct methods.
Fix a bug where completion transitions of states could be checked muptiple times if the transition to the state was via a choice pseudo state.
Expose isActive in the public API; allow it to be called for both Regions and States.
Remove the isChoice and isJunction methods on Vertex and children.
Allow isComplete function to be called for both Regions and Vertices.
Remove unnecessary casts following instanceof tests.
General refactoring
Bug fix: there was an issue with external transitions whose target was a child of a composite state; the composite state was exited but not reentered.
Added a test for local vs. external transitions.
Experimental support for Local transitions:
- Added kind parameter to the Transtion constructor and Vertex.to methods.
- First iteration of the implementation to adhere to local transition semantics; as usual, there's a lot more completity than the UML specification implies (in particular, the parent region of the first non active state in the target state ancestry needs its sibling active state exiting before entering).
Add a folder structure to the src directory.
Much code refactoring post the 5.4 release.
Fix internal transition bug.
Add an internal transition test case.
Remove a litte redundant from the runtime given the refactoring of Choice and Junction pseudp states; a little post 5.4 refactoring.
Added explicit testing of static conditional branch implementation for junction pseudo states.
Addded StateMachine.setError to enable custom handlers for errors; defaults to throwing an exception.
Renamed Element.ancestors to Element.getAncestors in line with other getter methods. This is not supposed to be a part of the public API hence no breaking change.
NOTE: while the API to state.js has not explicitly changes in this release, the changes made may impact the behaviour of your state machines hence the bump to 5.4 indicating a potentially breaking change. See the release notes pertaining to Junction and Choice pseudo states where the message passed to guards and user defined transition effect behaviour will be the same for transitions after the pseudo state as transitions before the pseudo state (previously, the message was the pseudo state itself).
Fixed bug #13 - Junction transitions now properly implement a static dynamic branch (guards on transitions before and after the junction pseudo state are evaluated before traversing the transition before the junction pseudo state) rather than a dynamic conditional branch (where the transition effect on prior to the pseudo state can be observed in the guards after the pseudo state).
For consistency with Junction, re-implemented the logic for Choice transitions to ensure that the message passed into guards and user supplied behaviour is the triggering message and not the source vertex.
Added a TransitionKind enumeration ready for future support for local transitions in addition to external transitions.
Add a kind member to Transition which defaults to External (or Internal if no target vertex is supplied in constructor).
Re-worked transition initialisation logic based on transition kind.
Addded StateMachine.setWarning to enable handlers for warnings.
Fix a minor bug in choice pseudo states; where multiple transitions are found not all are chosen equally.
Fix a bug in terminate pseudo states where isTerminated was not being set when reaching a terminate pseudo state.
Let PseudoStateKind.Initial be the default for the kind parameter in the PseudoState constructor.
Improve testing workflow: use mocha and istanbul; send findings to code climate.
Add tests to improde coverage of untested capability:
- user defined behaviour
- choice pseudo states
Split source into smaller files.
Minor refactoring based on Code Climate findings.
Fix versioning errors
Remove declaration of Behavior as it was only for internal use and was cluttering the exported API.
Remove the version history as it was baggage within releases (esp. within Node.js); this can be recreated from GitHub if required.
Tidy the browser example:
- Pre-load images and jquery to show/hide images
- Direct logging output to the DOM to display state transitions.
Use the target attribute in the script element to define the global object to bind the state.js API to (fall back to fsm if not supplied).
Fix common.js packaging issue for use in Node.js!
Please use the following files in the following ways:
- src/state.node.js - this is the CommonJS module for use in Node.js; either reference this manually, or if you npm install state.js, this is the target when using require("state.js").
- src/state.web.js - this is a version for use in browsers; all the classes and functions will be available under the fsm object as in earlier v5 versions.
Renamed public method root to getRoot.
Added an option to turn on log messages programatically rather than (un)commenting code.
Added Behavior interface in place of using Array of Action.
Revert the Evaulator class to a singleton as its stateless and therefore thread-safe.
Minor performance improvements.
Better code comments in Runtime.ts
Extract the last pieces of the runtime from the model classes to a set of independant functions. This is the cause for a breaking change to the API.
Use public keyword to distinguish public interface; the lack of a protection keyword is used to imply package private.
Changed the visitor implementation to accept multiple parameters after the template parameter.
Moved the message evaluation and transition selection / execution to a visitor to free up core model classes.
- note that the intent is to remove all the executable elements of the code from the core model claseses.
Move Vertex.accept to Element.accept.
Refactor isActive and isComplete out of state machine model.
Use built-in array iterating functions where possible.
Created singletons for bootstrapping rather than static method in StateMachine and Bootstrap classes.
Inline invoke method and remove Dictionary interface.
Break up the source across mutliple files for managability using tsconfig.json to pull them back together into the same state.js output.
Fixes a bug that would cause completion transitions to fire for composite states that were not complete.
Changed the file management for releases: the latest version will always be lib/state.js, lib/state.min.js, and lib/state.d.ts; files with version numbers will also be available in lib/versions.
Renamed IContext to IActiveStateConfiguration, Context to StateMachineInstance.
Added an optional name parameter to the StateMachineInstance constructor and a toString method to return that name.
Cache the fully qualified element name during the bootstrap process (as its used in the StateMachineInstance class).
Simplify transition bootstrap logic by inlining bootstrapEnter.
Removed explicit var typing where implicit is sufficient.
Removed Behaviour type and just used Array of Action in place.
Remove Selector type and functions; replace with virtual methods on Vertex subtypes.
Implement a visitor pattern for state machine models.
Migtated transition bootstrap to a visitor.
Minor changes to StateMachine to enable it to be embedded within other state machines.
Remove evaluateCompletions method and just inline the code where used given its simplicity.
Remove assert function as it was used only once.
Fix bug relating to external transitions and orthogonal regions that could result in an invalid current active state.
Remove protected keywords due to a lack of tool support for it.
Version 5 is a complete re-write from version 4.x.x:
- Much better performance by pre-computing all steps required during a state change. A clean/diry state is maintained and re-computing possible if the machine strucutre changes.
- The API has changed to a fluent style enabling transitions to be defined in a more natural way.
- The code is authored in TypeScript; this hopefully will lead to better quality code. State machines using state.js can be authored in JavaScript of TypeScript.