feat(api): add generic for action input and output

Author: tmorin

src/driver.ts

@@ -12,7 +12,7 @@ export * from './interfaces';
  */
 export function makeActionsDriver(handlers: ActionHandlers = {}) {
 
-  async function executeAction(request: Action): Promise<ActionResult> {
+  async function executeAction(request: Action<any>): Promise<ActionResult<any, any>> {
     try {
       // when the handler is not found the
       if (!handlers[request.type]) {

src/interfaces.ts

@@ -3,35 +3,35 @@ import {Stream} from 'xstream';
 /**
  * An action handler executes an action.
  */
-export interface ActionHandler {
+export interface ActionHandler<I, O> {
   /**
    * The handler.
    * @param action the action
    * @return an optional output which can be embedded within a Promise
    */
-  (action: Action): any | void | Promise<any | void>
+  (action: Action<I>): O | Promise<O>
 }
 
 /**
  * The map of action handlers.
  * To be handled, the {@link Action.type} of the {@link Action} must match the key of the {@link ActionHandlers} object.
  */
 export type ActionHandlers = {
-  [k: string]: ActionHandler
+  [k: string]: ActionHandler<any, any>
 }
 
 /**
  * An action is a message which will be handled by an {@link ActionHandler}.
  */
-export interface Action {
+export interface Action<P> {
   /**
    * The type of the message.
    */
   type: string
   /**
    * The optional payload.
    */
-  payload?: any
+  payload?: P
   /**
    * The category is used to select action's results via {@link ActionsSource.select}.
    */
@@ -46,15 +46,15 @@ export interface Action {
 /**
  * An action result is used internally to build the source part.
  */
-export interface ActionResult {
+export interface ActionResult<I, O> {
   /**
    * The request.
    */
-  request: Action
+  request: Action<I>
   /**
    * The response related to the handled action.
    */
-  response?: any
+  response?: O
   /**
    * The error raised during the handling of the action.
    */
@@ -64,12 +64,12 @@ export interface ActionResult {
 /**
  * A stream of actions.
  */
-export type ActionStream = Stream<Action>
+export type ActionStream = Stream<Action<any>>
 
 /**
  * A stream of action result.
  */
-export interface ActionResultStream extends Stream<ActionResult> {
+export interface ActionResultStream extends Stream<ActionResult<any, any>> {
 }
 
 /**

src/source.ts

@@ -66,7 +66,7 @@ export class ActionsSource {
       return action$;
     }
     return adapt(
-      xs.fromObservable<Action>(action$).map(action => {
+      xs.fromObservable<Action<any>>(action$).map(action => {
         action.namespace = action.namespace || [];
         action.namespace.unshift(scope);
         return action;
@@ -81,7 +81,7 @@ export class ActionsSource {
    * @return a new {@link ActionsSource}
    */
   public filter(
-    predicate: (action: Action) => boolean,
+    predicate: (action: Action<any>) => boolean,
     scope?: string
   ): ActionsSource {
 

test/driver.spec.ts

@@ -2,11 +2,11 @@ import run from '@cycle/run';
 import xs, {Stream} from 'xstream';
 import {Action, ActionResult, ActionsSource, makeActionsDriver, SelectedResults} from '../src/driver';
 
-function syncAction(action: Action): any {
+function syncAction(action: Action<string>): any {
   return action.payload
 }
 
-async function asyncAction(action: Action): Promise<any> {
+async function asyncAction(action: Action<string>): Promise<any> {
   return syncAction(action);
 }
 
@@ -15,11 +15,11 @@ function failedAction(): any {
 }
 
 describe('driver', () => {
-  let actions: Array<Action>;
-  let actions$: Stream<Action>;
+  let actions: Array<Action<any>>;
+  let actions$: Stream<Action<any>>;
   let readResponses: Array<any>;
   let readErrors: Array<any>;
-  let readResults: Array<ActionResult>;
+  let readResults: Array<ActionResult<any, any>>;
 
   function read({result$, response$, error$}: SelectedResults) {
     response$.subscribe({
@@ -33,7 +33,7 @@ describe('driver', () => {
       }
     });
     result$.subscribe({
-      next(result: ActionResult) {
+      next(result: ActionResult<any, any>) {
         readResults.push(result)
       }
     })
@@ -173,7 +173,7 @@ describe('driver', () => {
       });
 
       return {
-        ACTIONS: xs.of<Action>({
+        ACTIONS: xs.of<Action<any>>({
           type: 'unknown'
         })
       };

test/source.isolateSink.spec.ts

@@ -2,7 +2,7 @@ import {Action, ActionsSource, ActionStream} from '../src/driver';
 import xs from 'xstream';
 
 describe('ActionsSource.isolateSink', () => {
-  let actions: Array<Action>;
+  let actions: Array<Action<any>>;
   let streamOfActions: ActionStream;
 
   beforeEach(() => {
@@ -15,7 +15,7 @@ describe('ActionsSource.isolateSink', () => {
 
   it('should isolate source', (done) => {
     const isolatedStream = ActionsSource.isolateSink(streamOfActions, 'ns1');
-    const readActions: Array<Action> = [];
+    const readActions: Array<Action<any>> = [];
     isolatedStream.subscribe({
       next(action) {
         readActions.push(action);
@@ -33,7 +33,7 @@ describe('ActionsSource.isolateSink', () => {
 
   it('should not isolate source when no scope', (done) => {
     const isolatedStream = ActionsSource.isolateSink(streamOfActions, null);
-    const readActions: Array<Action> = [];
+    const readActions: Array<Action<any>> = [];
     isolatedStream.subscribe({
       next(action) {
         readActions.push(action);

test/source.isolateSource.spec.ts

@@ -2,12 +2,12 @@ import {Action, ActionResult, ActionResultStream, ActionsSource} from '../src/dr
 import xs from 'xstream';
 
 interface Transaction {
-  request: Action,
-  result: ActionResult
+  request: Action<any>,
+  result: ActionResult<any, any>
 }
 
 describe('ActionsSource.isolateSource', () => {
-  let actions: Array<Action>;
+  let actions: Array<Action<any>>;
   let transactions: Array<Transaction>;
   let streamOfActionResults: ActionResultStream;
 
@@ -32,10 +32,10 @@ describe('ActionsSource.isolateSource', () => {
   it('should isolate source', (done) => {
     const main = new ActionsSource(streamOfActionResults);
 
-    const readActionResults: Array<ActionResult> = [];
+    const readActionResults: Array<ActionResult<any, any>> = [];
 
     ActionsSource.isolateSource(main, 'ns1').select().result$.subscribe({
-      next(result: ActionResult) {
+      next(result: ActionResult<any, any>) {
         readActionResults.push(result);
       }
     });
@@ -51,10 +51,10 @@ describe('ActionsSource.isolateSource', () => {
   it('should not isolate source when no scope', (done) => {
     const main = new ActionsSource(streamOfActionResults);
 
-    const readActionResults: Array<ActionResult> = [];
+    const readActionResults: Array<ActionResult<any, any>> = [];
 
     ActionsSource.isolateSource(main, null).select().result$.subscribe({
-      next(result: ActionResult) {
+      next(result: ActionResult<any, any>) {
         readActionResults.push(result);
       }
     });