saga-toolkit 2.1.0 → 2.1.2

package/index.d.ts

@@ -1,50 +1,75 @@
-// generated with chatGTP
+import { createAsyncThunk, ThunkAction, SerializedError, Action } from '@reduxjs/toolkit';
+import { ForkEffect, PutEffect, TakeEffect, Saga, CallEffect, ForkEffectDescriptor } from '@redux-saga/core/effects';
+import { Deferred } from '@redux-saga/deferred';
 
 declare module 'saga-toolkit' {
-  import { createAsyncThunk, ThunkAction } from '@reduxjs/toolkit'
-  import { Dispatch } from 'redux'
-  import { SagaIterator } from 'redux-saga'
-  import { ActionCreatorWithPayload } from '@reduxjs/toolkit/src/createAction'
-  import { AsyncThunkFulfilledActionCreator, AsyncThunkConfig } from '@reduxjs/toolkit/src/createAsyncThunk'
-
-  type AsyncSagaPayloadCreator<Returned, ThunkArg = void> = (
-    arg: ThunkArg,
-    requestId: string
-  ) => Promise<Returned>
-
-  type AsyncSagaActionCreator<
-    Returned,
-    ThunkArg,
-    ThunkApiConfig extends AsyncThunkConfig = {}
-  > = (
-    arg: ThunkArg
-  ) => ActionCreatorWithPayload<
-    Promise<Returned>,
-    ReturnType<Dispatch>,
+  type SagaAction<Arg, ReturnType> = ThunkAction<
+    Promise<ReturnType<Arg>>,
     unknown,
-    ReturnType<
-      AsyncThunkFulfilledActionCreator<Returned, ThunkArg, ThunkApiConfig>
-    >
-  >
-
-  export interface AsyncSagaThunkConfig {
-    requestId: string
-    signal: AbortSignal
-    abort: (reason?: string) => void
+    { requestId: string },
+    Action<string>
+  > & {
+    type: string;
+    requestId: string;
+    abort: () => void;
+    then: (onfulfilled?: (value: SagaActionResult<Arg, ReturnType>) => void) => Promise<SagaActionResult<Arg, ReturnType>>;
+  };
+
+  interface IRequest {
+    requestId: string;
+    deferred: Deferred<any>;
+    onAdd?: (request: IRequest) => void;
+    abort?: () => void;
+  }
+
+  export type SagaActionResult<Arg, ReturnType> = {
+    payload: ReturnType;
+    meta: {
+      requestId: string;
+      arg: Arg;
+    };
+    error?: SerializedError;
   }
 
-  export function createSagaAction<Returned, ThunkArg = void>(
+  export function createSagaAction<PayloadType, ReturnType = void>(
     type: string
-  ): AsyncSagaActionCreator<Returned, ThunkArg> & {
+  ): {  
+    (payload: PayloadType): SagaAction<PayloadType, ReturnType>;
     pending: string;
-    fulfilled: string;
     rejected: string;
+    fulfilled: string;
     typePrefix: string;
     type: string;
-  }
+  };
 
-  export function takeEveryAsync(pattern: any, saga: any, ...args: any[]): any
-  export function takeLatestAsync(pattern: any, saga: any, ...args: any[]): any
-  export function takeAggregateAsync(pattern: any, saga: any, ...args: any[]): any
-  export function putAsync(action: any): any
+  export function* getRequest(requestId: string): Generator<CallEffect, IRequest, any>;
+
+  export function takeEveryAsync<ActionPattern extends string>(
+    pattern: ActionPattern,
+    saga: Saga<[], void>,
+    ...args: any[]
+  ): ForkEffect<void>;
+
+  export function takeLatestAsync<ActionPattern extends string>(
+    pattern: ActionPattern,
+    saga: Saga<[], void>,
+    ...args: any[]
+  ): ForkEffect<void>;
+
+  export function takeAggregateAsync<ActionPattern extends string>(
+    pattern: ActionPattern,
+    saga: Saga<[], void>,
+    ...args: any[]
+  ): ForkEffect<void>;
+
+  export function* putAsync<T>(
+    action: SagaAction<T>
+  ): Generator<PutEffect<SagaAction<T>>, any, any>;
+
+  export type SagaActionFromCreator<Creator extends (...args: any) => any> = SagaActionResult<
+    Parameters<Creator>[0],
+    void
+  > & {
+    action: string
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saga-toolkit",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "An extension for redux-toolkit that allows sagas to resolve async thunk actions.",
   "main": "index.js",
   "scripts": {
@@ -30,7 +30,7 @@
     "@babel/core": "^7.16.12",
     "@babel/node": "^7.16.8",
     "@babel/preset-env": "^7.16.11",
-    "@reduxjs/toolkit": "^1.7.2",
+    "@reduxjs/toolkit": "^1.9.5",
     "redux": "^4.1.2"
   }
 }