diff --git a/.gitignore b/.gitignore index 3e61db4..bbdb61b 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ desktop.ini report/ coverage/ bower/ +.vscode diff --git a/package.json b/package.json index deedbde..291a02f 100644 --- a/package.json +++ b/package.json @@ -137,7 +137,8 @@ "open": "~0.0.4", "should": "^6.0.3", "sinon": "~1.11.0", - "source-map-loader": "^0.1.5" + "source-map-loader": "^0.1.5", + "typescript": "^3.5.2" }, "licenses": [ { @@ -151,6 +152,7 @@ ], "scripts": { "build": "gulp", + "build-types": "tsc", "start": "gulp server", "test": "./node_modules/mocha/bin/mocha -r spec/helpers/node-setup.js spec", "mocha": "gulp mocha", @@ -159,5 +161,6 @@ "lint": "gulp lint", "format": "gulp format", "watch": "gulp watch" - } + }, + "types": "./types/index.d.ts" } diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..cc429e8 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,63 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + "rootDir": "./types", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + } +} diff --git a/types/BehaviorialFsmTests.ts b/types/BehaviorialFsmTests.ts new file mode 100644 index 0000000..387c16d --- /dev/null +++ b/types/BehaviorialFsmTests.ts @@ -0,0 +1,118 @@ +import { + BehavioralFsm, + BehavioralFsmInstance, + StateTransitions, + BehavioralFsmHandler +} from 'machina'; + +type SignalStates = 'uninitialized' + | 'green' + | 'green-interruptible' + | 'yellow' + | 'red'; + +interface LightInstance extends BehavioralFsmInstance { + location: string; + direction: string; + timer?: number; +} + +const states: StateTransitions = { + uninitialized: { + '*': function(client) { + this.deferUntilTransition(client); + this.transition(client, 'green'); + } + }, + + green: { + _onEnter: function(client) { + client.timer = setTimeout(() => { + this.handle(client, 'timeout'); + }, 30000); + + this.emit('vehicles', { client: client, status: 'green' }); + }, + + timeout: 'green-interruptible', + + pedestrianWaiting: function(client) { + this.deferUntilTransition(client, 'green-interruptible'); + }, + + _onExit: function(client) { + clearTimeout(client.timer); + } + }, + + 'green-interruptible': { + pedestrianWaiting: 'yellow' + }, + + yellow: { + _onEnter: function(client) { + client.timer = setTimeout(() => { + this.handle(client, 'timeout'); + }, 5000); + + this.emit('vehicles', { client: client, status: 'yellow' }); + }, + + timeout: 'red', + + _onExit: function(client) { + clearTimeout(client.timer); + } + }, + + red: { + _onEnter: function(client) { + client.timer = setTimeout(() => { + this.handle(client, 'timeout'); + }, 1000); + }, + + _reset: 'green', + + _onExit: function(client) { + clearTimeout(client.timer); + } + } +} + +interface Handlers { + reset: BehavioralFsmHandler; + pedestrianWaiting: BehavioralFsmHandler; +} + +const handlers: Handlers = { + reset: function(client) { + this.handle(client, '_reset'); + }, + + pedestrianWaiting: function(client) { + this.handle(client, 'pedestrianWaiting'); + } +} + +type VehicleSignalFsm = Handlers & BehavioralFsm; + +const vehicleSignal = new BehavioralFsm({ + initialize: function(options: object) { + for (const key in options) { + console.log(key); + } + }, + + namespace: 'vehicle-signal', + initialState: 'unitialized', + states, + + ...handlers +}) as VehicleSignalFsm; + +const light1: LightInstance = { location: 'Dijsktra Ave & Hunt Blvd', direction: 'north-south' }; +const light2: LightInstance = { location: 'Dijsktra Ave & Hunt Blvd', direction: 'east-west' }; + +vehicleSignal.pedestrianWaiting(light1); +vehicleSignal.pedestrianWaiting(light2); diff --git a/types/index.d.ts b/types/index.d.ts new file mode 100644 index 0000000..1f80ab4 --- /dev/null +++ b/types/index.d.ts @@ -0,0 +1,61 @@ +declare module 'machina' { + interface BehavioralFsmInstance { + __machina__?: { + [namespace: string]: { + targetReplayState: S; + state: S; + priorState: S; + priorAction: string; + currentAction: string; + currentActionArgs: any[]; + inputQueue: any[]; + inExitHandler: boolean; + } + } + } + + type TransitionHandler = BehavioralFsmHandler | S; + + interface StateTransitions { + [state: string]: { + '*'?: TransitionHandler; + _onEnter?: TransitionHandler; + _onExit?: TransitionHandler; + timeout?: TransitionHandler; + + [handler: string]: TransitionHandler | undefined; + } + } + + interface BehavioralFsmHandler, S> { + (this: BehavioralFsm, client: T, ...additionalProps: any[]): any; + } + + interface BehavioralFsmOptions, S, M = StateTransitions> { + namespace: string; + initialState: string; + + states: M; + + [handler: string]: string | M | BehavioralFsmHandler; + } + + class BehavioralFsm, S> { + constructor(options: BehavioralFsmOptions); + + static extend + , S> + (options: object): BehavioralFsm; + + initialize(options: object): void; + + deferUntilTransition(client: T, state?: S): void; + + handle(client: T, action: string, ...additionalProps: any[]): void; + transition(client: T, state: S): void; + + emit(event: string, options?: any): void; + off(event: string, callback?: (data?: any) => void): void; + on(event: string, callback: (data?: any) => void): void; + } +}