@tramvai/types-actions-state-context 2.6.2 → 2.10.2

package/lib/actions.d.ts

@@ -1,5 +1,5 @@
 import type { ProvideDepsIterator } from '@tinkoff/dippy';
-import type { ConsumerContext } from './state';
+import type { ConsumerContext, Dispatch, GetState } from './state';
 export declare type ActionContext = ConsumerContext;
 export declare type ActionConditionsParameters = {
     requiredCoreRoles?: string[];
@@ -16,6 +16,7 @@ export interface ActionParameters<Payload, Result, Deps = {}> {
     fn: (context: ActionContext, payload: Payload, deps: ProvideDepsIterator<Deps>) => Result;
     deps?: Deps;
     conditions?: ActionConditionsParameters;
+    conditionsFailResult?: 'reject' | 'empty';
 }
 export declare const ACTION_PARAMETERS = "__action_parameters__";
 export declare type Action<Payload = any, Result = any, Deps = any> = ActionParameters<Payload, Result, Deps>['fn'] & {
@@ -32,5 +33,25 @@ export interface PlatformAction<Payload extends any = any, Result = any, Context
     requiredRoles?: boolean;
     cancelOnUrlChange?: boolean;
 }
+export declare type TramvaiActionType = 'page' | 'standalone';
+export interface TramvaiActionContext<CurrentDeps> {
+    abortSignal: AbortSignal;
+    executeAction<Params extends any[], Result, Deps>(action: TramvaiAction<Params, Result, Deps>, ...params: Params): Result extends Promise<any> ? Result : Promise<Result>;
+    executeAction<Payload, Result, Deps>(action: Action<Payload, Result, Deps>, payload?: Payload): Result extends Promise<any> ? Result : Promise<Result>;
+    deps: ProvideDepsIterator<CurrentDeps>;
+    actionType: TramvaiActionType;
+    dispatch: Dispatch;
+    getState: GetState;
+}
+export interface TramvaiActionDefinition<Params extends any[], Result, Deps> {
+    name: string;
+    fn: (this: TramvaiActionContext<Deps>, ...params: Params) => Result;
+    deps?: Deps;
+    conditions?: ActionConditionsParameters;
+    conditionsFailResult?: 'reject' | 'empty';
+}
+export interface TramvaiAction<Params extends any[], Result, Deps> extends TramvaiActionDefinition<Params, Result, Deps> {
+    tramvaiActionVersion: number;
+}
 export declare type UnknownAction<Result = any> = (...args: any[]) => Result;
 export declare type AnyAction<Payload = any, Result = any, Deps = any> = Action<Payload, Result, Deps> | PlatformAction<Payload, Result> | UnknownAction;

package/lib/state.d.ts

@@ -1,5 +1,5 @@
 import type { AnyEventCreator, EmptyEventCreator, EventCreator1, Event } from './events';
-import type { AnyAction } from './actions';
+import type { AnyAction, TramvaiAction } from './actions';
 export declare type EventHandler<State, Payload = void> = (state: State, payload: Payload) => State;
 /**
  * @deprecated
@@ -37,12 +37,18 @@ export interface Reducer<State, Name extends string = string> {
         [K in keyof Model]: Model[K] extends EventHandler<State, void> ? EmptyEventCreator : Model[K] extends EventHandler<State, infer Payload> ? EventCreator1<Payload, Payload> : null;
     };
 }
+export declare type StoreInstance = InstanceType<StoreClass>;
+export interface GetState {
+    (): Record<string, any>;
+    <S>(reducer: Reducer<S>): S;
+}
+export declare type Dispatch = <Payload>(event: Event<Payload>) => Payload;
 export interface ConsumerContext {
+    executeAction<Params extends any[], Result, Deps>(action: TramvaiAction<Params, Result, Deps>, ...params: Params): Result extends Promise<any> ? Result : Promise<Result>;
     executeAction<Payload extends any = any, Result = any, Deps extends Record<string, any> = any>(action: AnyAction<Payload, Result, Deps>, payload?: Payload): Promise<Result extends PromiseLike<infer U> ? U : Result>;
     dispatch: <Payload extends any = any>(actionOrNameEvent: string | Event<Payload>, payload?: Payload) => Promise<Payload>;
     dispatchWith: <CreateActionOrType extends (...args: unknown[]) => Event | Event = (...args: unknown[]) => Event | Event, Options extends Record<string, any> = Record<string, any>>(createActionOrType: CreateActionOrType, options?: Options) => <Result extends any = any>(...args: any[]) => Promise<Result>;
-    getState(): Record<string, any>;
-    getState<S>(reducer: Reducer<S>): S;
+    getState: GetState;
     /**
      * @deprecated используйте метод `context.getState(reducer)`
      */
@@ -59,3 +65,30 @@ export interface ConsumerContext {
     registerStore(store: Reducer<any>): void;
     unregisterStore(store: Reducer<any>): void;
 }
+export interface StoreClass {
+    handlers: Record<string, Function | string>;
+    storeName: string;
+    dependencies?: Array<StoreClass | string | {
+        store: StoreClass | string;
+        optional: true;
+    }>;
+    new (dispatcher: DispatcherContext<any>['dispatcherInterface']): any;
+}
+export declare type DispatcherContext<TContext> = {
+    getStore<T extends StoreClass>(storeClass: T | string | {
+        store: T | string;
+        optional: true;
+    }): InstanceType<T> | null;
+    subscribe(handler: () => void): () => void;
+    getState: GetState;
+    dispatcherInterface: {
+        getContext: () => TContext;
+        getStore: DispatcherContext<TContext>['getStore'];
+    };
+};
+export interface MiddlewareApi {
+    dispatch: Dispatch;
+    subscribe(handler: () => void): () => void;
+    getState: GetState;
+}
+export declare type Middleware = (api: MiddlewareApi) => (next: Dispatch) => (event: Event) => any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/types-actions-state-context",
-  "version": "2.6.2",
+  "version": "2.10.2",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -21,7 +21,7 @@
     "tslib": "^2.0.3"
   },
   "peerDependencies": {
-    "@tinkoff/dippy": "0.7.44"
+    "@tinkoff/dippy": "0.7.45"
   },
   "devDependencies": {},
   "license": "Apache-2.0",