state-decorator 7.0.0-beta.0 → 7.0.0-beta.10-dev

package/dist/shallow.d.ts

@@ -1,15 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) GlobalSport SAS.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-export default function shallow<T extends any, U extends any>(objA: T, objB: U): boolean;

package/dist/test.d.ts

@@ -1,134 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) GlobalSport SAS.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-import { ErrorMap, StoreActions, StoreApi, StoreOptions } from '.';
-import { DerivedState, SetStateFunc, Ref } from './impl';
-import { DecoratedActions } from './types';
-declare type MockActions<A, MockAction> = {
-    [k in keyof A]: MockAction;
-};
-declare type MockResult<S, A extends DecoratedActions, P, DS> = {
-    readonly prevState: S & DS;
-    readonly state: S & DS;
-    readonly props: P;
-    readonly actions: MockActions<A, any>;
-    readonly errorMap: ErrorMap<A>;
-};
-declare type MockActionImpl<A> = Partial<Record<keyof A, (...args: any[]) => any>>;
-declare type MockResultWithTest<S, A extends DecoratedActions, P, DS> = MockResult<S, A, P, DS> & {
-    /**
-     * Execute function passed as parameter to test state/props/actions called.
-     */
-    test: (f: (res: MockResult<S, A, P, DS>) => void) => void;
-};
-declare type MockStoreAction<S, A extends DecoratedActions, F extends (...args: any[]) => any, P, DS> = {
-    /**
-     * Creates a new store action with specified state.
-     */
-    setState: (state: S) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Creates a new store action with specified props.
-     */
-    setProps: (props: P) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Creates a new store action using store state overriden by specified state.
-     */
-    setPartialState: (state: Partial<S>) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Creates a new store action using store props overriden by specified props.
-     */
-    setPartialProps: (props: Partial<P>) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Set implementations to some actions to test side effects.
-     */
-    setMockActions: (implementation: MockActionImpl<A>) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * If action is asynchronous, mock the getPromise call to be resolved with specified object.
-     */
-    promiseResolves: (res: any) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * If action is asynchronous, mock the getPromise call to be rejected with specified error.
-     */
-    promiseRejects: (err: Error) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Executes passed function to test state and/or props
-     */
-    test: (f: (state: S & DS, props: P) => void) => MockStoreAction<S, A, F, P, DS>;
-    /**
-     * Calls the action with specified parameters.
-     * @returns a promise with state/props/actions to assert
-     */
-    call: (...args: Parameters<F>) => Promise<MockResult<S, A, P, DS>>;
-};
-declare type MockStore<S, A extends DecoratedActions, P, DS> = {
-    /**
-     * Creates a new store with specified state.
-     */
-    setState: (state: S) => MockStore<S, A, P, DS>;
-    /**
-     * Creates a new store with specified props.
-     */
-    setProps: (props: P) => MockStore<S, A, P, DS>;
-    /**
-     * Creates a new store using store state overriden by specified state.
-     */
-    setPartialState: (state: Partial<S>) => MockStore<S, A, P, DS>;
-    /**
-     * Creates a new store using store props overriden by specified props.
-     */
-    setPartialProps: (props: Partial<P>) => MockStore<S, A, P, DS>;
-    /**
-     * Set implementations to some actions to test side effects.
-     */
-    setMockActions: (implementation: MockActionImpl<A>) => MockStore<S, A, P, DS>;
-    /**
-     * Executes passed function to test state and/or props
-     */
-    test: (f: (state: S & DS, props: P) => void) => MockStore<S, A, P, DS>;
-    /**
-     * Test options.onMount
-     * @deprecated Use init() instead
-     */
-    onMount: (props: Partial<P>) => MockResultWithTest<S, A, P, DS>;
-    /**
-     * Test state and side effect actions after inbound props have changed.
-     */
-    onPropsChange: (props: Partial<P>, init?: boolean) => MockResultWithTest<S, A, P, DS>;
-    /**
-     * Test store at initialization time:
-     * - options.onPropsChange with onMount set to true
-     * - options.onMount
-     */
-    onInit: (props?: Partial<P>) => MockResultWithTest<S, A, P, DS>;
-    /** @internal */
-    onPropsChangeImpl: (newStateRef: Ref<S>, newPropsRef: Ref<P>, newDerivedStateRef: Ref<DerivedState<DS>>, newActionsRef: Ref<StoreActions<S, A, P, DS, S>>, setState: SetStateFunc<S, A>, init?: boolean) => MockResult<S, A, P, DS>;
-    getAction: <K extends keyof A>(name: K) => MockStoreAction<S, A, A[K], P, DS>;
-};
-export declare function createMockFromStore<S, A extends DecoratedActions, P, DS>(store: StoreApi<S, A, P, DS>, props?: P): MockStore<S, A, P, DS>;
-export declare function createMockStore<S, A extends DecoratedActions, P = {}, DS = {}>(initialState: S | ((p: P) => S), actions: StoreActions<S, A, P, DS>, props?: P, options?: StoreOptions<S, A, P, DS>, mockActions?: MockActionImpl<A>): MockStore<S, A, P, DS>;
-/**
- * Set the mock factory. Each mock action will be created using this factory.
- * @param factory the mock factory
- */
-export declare function setMockFactory(factory: (impl?: (...args: any[]) => any) => any): void;
-export declare class ActionError<S = any, P = any, A = any> extends Error {
-    sourceError: Error;
-    prevState: S;
-    state: S;
-    props: P;
-    actions: MockActions<A, any>;
-    constructor(sourceError: Error, prevState: S, state: S, props: P, actions: MockActions<A, any>);
-}
-export declare function createMockStoreAction<S, A extends DecoratedActions, F extends (...args: any[]) => any, P, DS>(state: S, actionName: keyof A, actions: StoreActions<S, A, P, DS, S>, props: P, promiseRes: Promise<F> | Error, options: StoreOptions<S, A, P, DS>, mockActions: Partial<Record<keyof A, (...args: any[]) => any>>): MockStoreAction<S, A, F, P, DS>;
-export {};

package/dist/test.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var t=require("./impl"),e=function(t,r){return(e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,e){t.__proto__=e}||function(t,e){for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&(t[r]=e[r])})(t,r)};var r=function(){return(r=Object.assign||function(t){for(var e,r=1,n=arguments.length;r<n;r++)for(var o in e=arguments[r])Object.prototype.hasOwnProperty.call(e,o)&&(t[o]=e[o]);return t}).apply(this,arguments)};function n(e,c,i,a,s){void 0===i&&(i={}),void 0===a&&(a={});var f=t.createRef(),l=t.createRef(i);function p(t,e,r){return n(null!=t?t:f.current,c,null!=e?e:l.current,a,null!=r?r:s)}function v(e,n){void 0===e&&(e=void 0),void 0===n&&(n=void 0);var o=t.createRef({state:null,deps:{}});return t.computeDerivedValues(e||f,n||l,o,a),r(r({},(null==e?void 0:e.current)||f.current),o.current.state||{})}return f.current="function"==typeof e?e(i):e,{test:function(t){return t(v(),l.current),this},setMockActions:function(t){return p(void 0,void 0,t)},onMount:function(t){return void 0===t&&(t={}),this.onInit(t)},setState:function(t){return p(t,void 0)},setProps:function(t){return p(void 0,t)},setPartialState:function(t){return p(r(r({},f.current),t),void 0)},setPartialProps:function(t){return p(void 0,r(r({},l.current),t))},onPropsChange:function(e,n){void 0===n&&(n=!1);var i=t.createRef(f.current),u=t.createRef(r(r({},l.current),e)),a=t.createRef({state:null,deps:{}}),p=o(c,s),v=this.onPropsChangeImpl(i,u,a,p,(function(t,e,r,n,o){null!=t&&(i.current=t)}),n);return r(r({},v),{test:function(t){t(v)}})},onPropsChangeImpl:function(e,r,n,o,c,i){return t.computeDerivedValues(f,l,n,a),t.onPropChange(e,n,r,l.current,o,a,c,i),{prevState:v(f,l),state:v(e,r),props:r.current,actions:o.current,errorMap:{}}},onInit:function(n){void 0===n&&(n={});var u="function"==typeof e?e(i):e,f=t.createRef(u),p=t.createRef(r(r({},l.current),n)),d=t.createRef({state:null,deps:{}}),R=o(c,s);this.onPropsChangeImpl(f,p,d,R,(function(t,e,r,n,o){null!=t&&(f.current=t)}),!0),(null==a?void 0:a.onMount)&&a.onMount(t.buildOnMountInvocationContext(f,d,p,R));var m={prevState:null,state:v(f,p),props:p.current,actions:R.current,errorMap:{}};return r(r({},m),{test:function(t){t(m)}})},getAction:function(t){return u(f.current,t,c,l.current,null,a,void 0)}}}function o(e,r){var n=Object.keys(e);return t.createRef(n.reduce((function(t,e){return t[e]=c(null==r?void 0:r[e]),t}),{}))}var c=function(t){return jest.fn(t)};var i=function(t){function r(e,n,o,c,i){var u=t.call(this,e.message)||this;return Object.setPrototypeOf(u,r.prototype),u.sourceError=e,u.prevState=n,u.props=c,u.state=o,u.actions=i,Error.captureStackTrace&&Error.captureStackTrace(u,r),u}return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}(r,t),r}(Error);function u(e,n,c,a,s,f,l){var p=t.createRef(e),v=t.createRef(a),d=s;function R(t,e,r,o){return void 0===o&&(o=l),u(null!=t?t:p.current,n,c,null!=e?e:v.current,null!=r?r:d,f,o)}function m(e,n){void 0===e&&(e=void 0),void 0===n&&(n=void 0);var o=t.createRef({state:null,deps:{}});return t.computeDerivedValues(null!=e?e:p,null!=n?n:v,o,f),r(r({},(null==e?void 0:e.current)||p.current),o.current.state||{})}return{setMockActions:function(t){return R(void 0,void 0,void 0,t)},setState:function(t){return R(t,void 0,void 0)},setProps:function(t){return R(void 0,t,void 0)},setPartialState:function(t){return R(r(r({},p.current),t),void 0,void 0)},setPartialProps:function(t){return R(void 0,r(r({},v.current),t),void 0)},promiseResolves:function(t){return R(void 0,void 0,Promise.resolve(t))},promiseRejects:function(t){return R(void 0,void 0,Promise.reject(t))},test:function(t){return t(m(),v.current),this},call:function(){for(var e=[],u=0;u<arguments.length;u++)e[u]=arguments[u];var a=t.createRef(r({},p.current)),s=t.createRef({state:null,deps:{}});t.computeDerivedValues(a,v,s,f);var R=o(c,l),y=t.createRef({}),P=t.createRef({}),S=function(t){null!=t&&(a.current=t)},h=c[n],A=null;if(t.isSimpleSyncAction(h))t.decorateSimpleSyncAction(n,h,a,s,v,t.createRef(!0),S).apply(void 0,e),A=Promise.resolve();else if(t.isSyncAction(h))t.decorateSyncAction(n,r(r({},h),{debounceSideEffectsTimeout:0,debounceTimeout:0}),a,s,v,R,t.createRef(!0),null,f,S).apply(void 0,e),A=Promise.resolve();else if(t.isAsyncAction(h)){var M=t.createRef({}),g=t.createRef({}),O=t.createRef(!0),b=r({},t.computeAsyncActionInput(h));d&&(b.getPromise=function(){return d}),b.optimisticEffects&&(b.effects=b.optimisticEffects,delete b.optimisticEffects),A=t.decorateAsyncAction({actionName:n,derivedStateRef:s,propsRef:v,loadingMapRef:y,errorMapRef:P,promisesRef:M,conflictActionsRef:g,initializedRef:O,options:f,setState:S,stateRef:a,actionsRef:R,action:b}).apply(void 0,e)}return(null!=A?A:Promise.resolve()).then((function(){return y.current={},{prevState:m(p),state:m(a),props:v.current,errorMap:t.buildErrorMap(P.current),actions:R.current}})).catch((function(t){return Promise.reject(new i(t,m(p),m(a),v.current,R.current))}))}}}exports.ActionError=i,exports.createMockFromStore=function(t,e){void 0===e&&(e={});var r=t.getConfig();return n(r.getInitialState,r.actions,e,r.options)},exports.createMockStore=n,exports.createMockStoreAction=u,exports.setMockFactory=function(t){c=t};
-//# sourceMappingURL=test.js.map

package/dist/types.d.ts

@@ -1,352 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) GlobalSport SAS.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-export declare type PromiseResult<Type> = Type extends Promise<infer X> ? X : null;
-export declare type NotifyFunc = (msg: string) => void;
-export declare type PromiseIdMap = {
-    [promiseId: string]: boolean;
-};
-export declare type LoadingMap<A> = {
-    [pId in keyof A]?: boolean;
-};
-export declare type LoadingParallelMap<A> = {
-    [P in keyof A]?: PromiseIdMap;
-};
-export declare type InternalLoadingMap<A> = LoadingParallelMap<A>;
-export declare type LoadingProps<A> = {
-    loading: boolean;
-    loadingMap: LoadingMap<A>;
-    loadingParallelMap: LoadingParallelMap<A>;
-};
-export declare type PromiseIdErrorMap = {
-    [promiseId: string]: Error;
-};
-export declare type ErrorMap<A> = {
-    [pId in keyof A]?: Error;
-};
-export declare type ErrorParallelMap<A> = {
-    [P in keyof A]?: PromiseIdErrorMap;
-};
-export interface DecoratedActions {
-    [name: string]: (...args: any[]) => Promise<any> | void;
-}
-/**
- * The State decorator can manage only one asynchronous action of same name at a time.
- * This enum is enumertaing all the policies in such case.
- */
-export declare enum ConflictPolicy {
-    /**
-     * Reject the promise.
-     */
-    REJECT = "reject",
-    /**
-     * Return a resolved promise with no result.
-     */
-    IGNORE = "ignore",
-    /**
-     * Execute only the last call that conflicts after the one ongoing.
-     */
-    KEEP_LAST = "keepLast",
-    /**
-     * Execute all calls one after another.
-     */
-    KEEP_ALL = "keepAll",
-    /**
-     * Execute all calls one after another.
-     * @see getPromiseId
-     */
-    PARALLEL = "parallel",
-    /**
-     * Reuse the ongoing promise if any and if possible (same arguments). Only for GET requests!
-     */
-    REUSE = "reuse"
-}
-export declare type PromiseProvider<S, DS, F extends (...args: any[]) => any, A, P> = (ctx: GetPromiseInvocationContext<S, DS, F, P, A>) => ReturnType<F> | null;
-/**
- * Simple form of a synchronous action.
- */
-export declare type SimpleSyncAction<S, F extends (...args: any[]) => any, P, DS, FxRes = S> = (ctx: InvocationContext<S, DS, F, P>) => FxRes | null;
-export declare type SyncAction<S, F extends (...args: any[]) => any, A, P, DS, FxRes = S> = {
-    /**
-     * Function that update the state when the action is called.
-     */
-    effects?: (ctx: EffectsInvocationContext<S, DS, F, P>) => FxRes | null;
-    /**
-     * Debounces the action if this parameter is defined.
-     */
-    debounceTimeout?: number;
-    /**
-     * Debounces the action side effects if this parameter is defined.
-     */
-    debounceSideEffectsTimeout?: number;
-    /**
-     * Function that calls side effects, ie. effects that are not changing the state directly.
-     */
-    sideEffects?: (ctx: SideEffectsInvocationContext<S, DS, F, P, A>) => void;
-};
-/**
- * Try to abort an action, if the action is <code>abortable</code>.
- * @param actionName The action name
- * @param promiseId If the action conflict type is <code>ConflictType.PARALLEL</code>, the identifier of the promise.
- * @returns <code>true</code> if the action is abortable and an action is ongoing, <code>false</code> otherwise.
- */
-export declare type AbortActionCallback<A> = (actionName: keyof A, promiseId?: string) => boolean;
-export declare type GetErrorMessage<S, DS, F extends (...args: any[]) => any, P> = (ctx: ErrorMessageInvocationContext<S, DS, F, P>) => string;
-export declare type ContextState<S> = {
-    state: S;
-    s: S;
-};
-export declare type ContextDerivedStateState<DS> = {
-    derived: DS;
-    ds: DS;
-};
-export declare type ContextBase<S, P> = ContextState<S> & {
-    props: P;
-    p: P;
-};
-export declare type ContextWithDerived<S, DS, P> = ContextBase<S, P> & ContextDerivedStateState<DS>;
-export declare type InvocationContextActions<A> = {
-    actions: A;
-    a: A;
-};
-export declare type WarningNotifyFunc = {
-    notifyWarning?: NotifyFunc;
-};
-export declare type InvocationContext<S, DS, F extends (...args: any[]) => any, P> = ContextWithDerived<S, DS, P> & {
-    args: Parameters<F>;
-    promiseId: string;
-};
-export declare type EffectsInvocationContext<S, DS, F extends (...args: any[]) => any, P> = InvocationContext<S, DS, F, P> & {
-    result: PromiseResult<ReturnType<F>>;
-    res: PromiseResult<ReturnType<F>>;
-};
-export declare type GetPromiseInvocationContext<S, DS, F extends (...args: any[]) => any, P, A> = InvocationContextActions<A> & InvocationContext<S, DS, F, P> & {
-    abortSignal: AbortSignal;
-};
-export declare type ErrorEffectsInvocationContext<S, DS, F extends (...args: any[]) => any, P> = InvocationContext<S, DS, F, P> & {
-    error: Error;
-    err: Error;
-};
-export declare type SuccessMessageInvocationContext<S, DS, F extends (...args: any[]) => any, P> = EffectsInvocationContext<S, DS, F, P>;
-export declare type ErrorMessageInvocationContext<S, DS, F extends (...args: any[]) => any, P> = ErrorEffectsInvocationContext<S, DS, F, P>;
-export declare type SideEffectsInvocationContext<S, DS, F extends (...args: any[]) => any, P, A> = EffectsInvocationContext<S, DS, F, P> & InvocationContextActions<A> & WarningNotifyFunc;
-export declare type ErrorSideEffectsInvocationContext<S, DS, F extends (...args: any[]) => any, P, A> = ErrorEffectsInvocationContext<S, DS, F, P> & InvocationContextActions<A> & WarningNotifyFunc;
-export declare type OnMountInvocationContext<S, A, P> = ContextBase<S, P> & InvocationContextActions<A>;
-export declare type EffectsType = 'preEffects' | 'effects' | 'errorEffects' | 'optimisticEffects' | null;
-export declare type MiddlewareActionContext<S, A, P> = {
-    name: keyof A;
-    type: EffectsType;
-    isAsync: boolean;
-    context: InvocationContext<S, any, any, P>;
-};
-export declare type MiddlewareStoreContext<S, A extends DecoratedActions, P> = {
-    actions: StoreActions<S, A, P, any, any>;
-    state: S;
-    setState: (s: S) => void;
-    options: StoreOptions<S, A, P, any>;
-};
-export declare type MiddlewareFactory<S, A extends DecoratedActions, P> = () => Middleware<S, A, P>;
-/**
- * A state change middleware.
- * Allow to listen and change a state change on the fly.
- */
-export declare type Middleware<S, A extends DecoratedActions, P> = {
-    /**
-     * Initializes the middleware. Called when the store is initializing.
-     */
-    init: (storeContext: MiddlewareStoreContext<S, A, P>) => void;
-    /**
-     * Invoked on a state change has occurred and returns a new state or <code>null</code> if unchanged.
-     */
-    effects: (actionContext: MiddlewareActionContext<S, A, P>, oldState: S, newState: S, loading: boolean) => null | {
-        state: S;
-        loading: boolean;
-    };
-    /**
-     * Destroys the middleware. Called when the store is being destroyed.
-     */
-    destroy: () => void;
-};
-export declare type AsyncActionBase<S, F extends (...args: any[]) => any, A, P, DS, FxRes = S> = {
-    /**
-     * This action can be aborted. An abortSignal will be injected to the <code>promise</code> / <code>promiseGet</code>.
-     */
-    abortable?: boolean;
-    /**
-     * A function that provides the success message to pass to the notifySuccess function passed as property to the StateDecorator.
-     */
-    getSuccessMessage?: (ctx: SuccessMessageInvocationContext<S, DS, F, P>) => string;
-    /**
-     * A function that provides the error message to pass to the notifyError function passed as property to the StateDecorator.
-     */
-    getErrorMessage?: GetErrorMessage<S, DS, F, P>;
-    /**
-     * If set, called with the result of the promise to update the current state.
-     */
-    effects?: (ctx: EffectsInvocationContext<S, DS, F, P>) => FxRes | null;
-    /**
-     * If set, called with the error of the promise to update the current state.
-     */
-    errorEffects?: (ctx: ErrorEffectsInvocationContext<S, DS, F, P>) => FxRes | null;
-    /**
-     * Whether reject the promise instead of handling it.
-     */
-    rejectPromiseOnError?: boolean;
-    /**
-     * When the error will not be managed by an errorEffect, errorSideEffect, getErrorMessage,
-     * the state decorator will not display an error message and will not return a failed promise
-     * (unless <code>rejectPromiseOnError</code>) is set.
-     */
-    isErrorManaged?: boolean;
-    /**
-     * Handle side effects when the request succeeded.
-     * @param result The result of the request
-     * @param newData The data after the reducer is applied
-     * @param args The argument during the call of the request function
-     * @param props The props passed to the state decorator
-     * @param actions The actions available
-     * @param notifyWarning If specified, a notify function to indicate that the action is a semi success (use successMessage / getSuccessMessage otherwise).
-     */
-    sideEffects?: (ctx: SideEffectsInvocationContext<S, DS, F, P, A>) => void;
-    /**
-     * Handle side effects when the request failed.
-     * @param error The error of the request
-     * @param args The argument during the call of the request function
-     * @param props The props passed to the state decorator
-     * @param actions The actions available
-     * @param notifyWarning If specified, a notify function to indicate that the action is a semi failure (use errorMessage / getErrorMessage otherwise).
-     */
-    errorSideEffects?: (ctx: ErrorSideEffectsInvocationContext<S, DS, F, P, A>) => void;
-    /**
-     * Retrieve the state to set as current data before the promise is resolved.
-     * If the there's no reducer, this data will be used after the promise is done.
-     */
-    preEffects?: (ctx: InvocationContext<S, DS, F, P>) => FxRes | null;
-    /**
-     * Retrieve the state to set as current data before the promise is resolved.
-     * If the there's no reducer, this data will be used after the promise is done.
-     */
-    optimisticEffects?: (ctx: InvocationContext<S, DS, F, P>) => FxRes | null;
-    /**
-     * Policy to apply when a call to an asynchronous action is done but a previous call is still not resolved.
-     */
-    conflictPolicy?: ConflictPolicy;
-    /**
-     * Get an identifier for an action call. Used only when conflictPolicy is ConflictPolicy.PARALLEL.
-     * This information will be available in loadingMap. loadingMap[actionName] will be an array of promise identifiers.
-     */
-    getPromiseId?: (...args: Parameters<F>) => string;
-    /**
-     * Number of retries in case of error (failed to fetch).
-     * Do not use this if you are creating objects...
-     * Default value is 0 (no retry).
-     */
-    retryCount?: number;
-    /**
-     * Seed of delay between each retry in milliseconds.
-     * The applied delay is retryDelaySeed * retry count.
-     * Default value is 1000 (1 second).
-     */
-    retryDelaySeed?: number;
-    /**
-     * Function to test if the error will trigger an action retry or will fail directly.
-     */
-    isTriggerRetryError?: (e: Error) => boolean;
-};
-export declare type AsyncActionPromise<S, F extends (...args: any[]) => any, A, P, DS = {}, FxRes = S> = AsyncActionBase<S, F, A, P, DS, FxRes> & {
-    /**
-     * The request, returns a promise
-     */
-    getPromise: PromiseProvider<S, DS, F, A, P>;
-};
-export declare type AsyncActionPromiseGet<S, F extends (...args: any[]) => any, A, P, DS, FxRes = S> = AsyncActionBase<S, F, A, P, DS, FxRes> & {
-    /**
-     * The request, returns a promise that is a GET request.
-     * A shortcut to set:
-     *   - retryCount: 3
-     *   - conflictPolicy: ConflictPolicy.REUSE
-     */
-    getGetPromise: PromiseProvider<S, DS, F, A, P>;
-};
-export declare type AsyncAction<S, F extends (...args: any[]) => any, A, P, DS = {}, FxRes = S> = AsyncActionPromise<S, F, A, P, DS, FxRes> | AsyncActionPromiseGet<S, F, A, P, DS, FxRes>;
-export declare type StoreAction<S, F extends (...args: any[]) => any, A, P, DS = {}, FxRes = S> = AsyncAction<S, F, A, P, DS, FxRes> | SimpleSyncAction<S, F, P, DS, FxRes> | SyncAction<S, F, A, P, DS, FxRes>;
-/**
- * S: The type of the state
- * A: The type of the actions to pass to the children (used to check keys only).
- */
-export declare type StoreActions<S, A extends DecoratedActions, P = {}, DS = {}, FxRes = S> = {
-    [Prop in keyof A]: StoreAction<S, A[Prop], A, P, DS, FxRes>;
-};
-export declare type OnPropsChangeEffectsContext<S, DS, P> = ContextWithDerived<S, DS, P> & {
-    indices: number[];
-    index: number;
-    isInit: boolean;
-};
-export declare type OnPropsChangeSideEffectsContext<S, P, A, DS = {}> = OnPropsChangeEffectsContext<S, DS, P> & {
-    actions: A;
-    a: A;
-};
-declare type DerivedStateOption<S, P, DS> = {
-    [k in keyof DS]: {
-        getDeps: (ctx: ContextBase<S, P>) => any[];
-        get: (ctx: ContextBase<S, P>) => DS[k];
-    };
-};
-export declare type OnPropsChangeOptions<S, DS, A, P> = {
-    onMount?: boolean;
-    getDeps: (p: P) => any[];
-    effects?: (ctx: OnPropsChangeEffectsContext<S, DS, P>) => S;
-    sideEffects?: (ctx: OnPropsChangeSideEffectsContext<S, P, A>) => void;
-};
-export declare type StoreOptions<S, A, P = {}, DS = {}> = {
-    /**
-     * The state decorator name. Use in debug traces to identify the useStateDecorator instance.
-     */
-    name?: string;
-    /**
-     * List of action names that are marked as loading at initial time.
-     * If you must start your initial actions in a useSideEffect, a render is done before
-     * first actions can be trigerred, some actions can be marked as loading at initial time.
-     */
-    initialActionsMarkedLoading?: (keyof A)[];
-    /**
-     * One or several configurations of inbound properties change managements.
-     */
-    onPropsChange?: OnPropsChangeOptions<S, DS, A, P> | OnPropsChangeOptions<S, DS, A, P>[];
-    /**
-     * The callback function called if an asynchronous function succeeded and a success messsage is defined.
-     */
-    notifySuccess?: NotifyFunc;
-    /**
-     * The callback function called if an asynchronous function fails and an error messsage is defined.
-     */
-    notifyError?: NotifyFunc;
-    /**
-     * The callback function injected in onDone and onFail of asynchronous functions to notify a semi success / failed request.
-     */
-    notifyWarning?: NotifyFunc;
-    /**
-     * Initial actions.
-     */
-    onMount?: (ctx: OnMountInvocationContext<S, A, P>) => void;
-    /**
-     * Callback on store destruction.
-     */
-    onUnmount?: (ctx: OnMountInvocationContext<S, A, P>) => Promise<any> | void;
-    /**
-     * Compute derived state
-     */
-    derivedState?: DerivedStateOption<S, P, DS>;
-};
-export {};

package/dist/v5.d.ts

@@ -1,58 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) GlobalSport SAS.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-import { DecoratedActions, MiddlewareFactory } from './types';
-import { setGlobalConfig, ConflictPolicy } from './index';
-import { AdvancedSynchAction, AsynchActionPromiseGet, StateDecoratorAction, StateDecoratorActions, StateDecoratorOptions, AsynchActionPromise, SynchAction, LoadingMap, LoadingProps, LoadingMapParallelActions, AsynchAction } from './v5_types';
-export { AdvancedSynchAction, AsynchActionPromiseGet, StateDecoratorAction, StateDecoratorActions, StateDecoratorOptions, AsynchActionPromise, SynchAction, LoadingMap, LoadingMapParallelActions, LoadingProps, ConflictPolicy, setGlobalConfig, };
-/**
- * Type guard function to test if an action is a asynchronous action.
- */
-export declare function isAsyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AsynchAction<S, F, A, P>;
-/**
- * Type guard function to test if an action is a asynchronous action.
- */
-export declare function isAsyncPromiseGetAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AsynchActionPromiseGet<S, F, A, P>;
-/**
- * Type guard function to test if an action is a synchronous action.
- */
-export declare function isSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is SynchAction<S, F, P>;
-/**
- * Type guard function to test if an action is a synchronous action.
- */
-export declare function isAdvancedSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AdvancedSynchAction<S, F, A, P>;
-declare function useStateDecorator<S, A extends DecoratedActions, P>(getInitialState: (props: P) => S, actions: StateDecoratorActions<S, A, P>, props: P, options?: StateDecoratorOptions<S, A, P>, middlewares?: MiddlewareFactory<S, A, P>[]): {
-    state: S & {};
-    actions: A;
-    loading: boolean;
-    loadingMap: import("./types").LoadingMap<A>;
-    loadingParallelMap: import("./types").LoadingParallelMap<A>;
-    abortAction: (actionName: keyof A, promiseId?: string) => boolean;
-};
-export default useStateDecorator;
-/**
- * Hook to execute a function when hook is mounted.
- * @param onMount function to execute on the hook nount
- */
-export declare function useOnMount(onMount: () => any): void;
-/**
- * Hook to execute a function when hook is unmounted.
- * @param onUnMount function to execute on the hook nount
- */
-export declare function useOnUnmount(onUnmount: () => void, propList?: any[]): void;
-/**
- * Hook to execute a function when hook is unmounted.
- * @param onUnMount function to execute on the hook nount
- */
-export declare function useOnUnload(onUnload: () => void): void;

package/dist/v5.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("./index"),r=require("react"),n=require("./middlewares");function t(e){return!(e instanceof Function)&&e.hasOwnProperty("promiseGet")}function o(e){return e instanceof Function}function s(e){return!(e instanceof Function||e.hasOwnProperty("promise")||e.hasOwnProperty("promiseGet"))}function i(r){return Object.keys(r).reduce((function(n,i){var c=r[i];if(o(c))n[i]=function(e){return c(e.s,e.args,e.p)};else if(s(c)){var u={effects:function(e){return c.action(e.s,e.args,e.p)}};c.onActionDone&&(u.sideEffects=function(e){var r=e.s,n=e.p,t=e.args,o=e.a,s=e.notifyWarning;c.onActionDone(r,t,n,o,s)}),n[i]=u}else if(function(e){return!(e instanceof Function)&&e.hasOwnProperty("promise")}(c)||t(c)){var a;a=t(c)?{getPromise:function(e){var r=e.s,n=e.p,t=e.a,o=e.args,s=e.abortSignal;return c.promiseGet(o,r,n,t,s)},retryCount:3,conflictPolicy:e.ConflictPolicy.REUSE}:{getPromise:function(e){var r=e.s,n=e.p,t=e.a,o=e.args,s=e.abortSignal;return c.promise(o,r,n,t,s)}},["abortable","conflictPolicy","getPromiseId","isTriggerRetryError","rejectPromiseOnError","retryCount","debounceTimeout","debounceSideEffectsTimeout","retryDelaySeed"].forEach((function(e){null!=c[e]&&(a[e]=c[e])})),c.successMessage&&(a.getSuccessMessage=function(){return c.successMessage}),c.errorMessage&&(a.getSuccessMessage=function(){return c.errorMessage}),c.getSuccessMessage&&(a.getSuccessMessage=function(e){var r=e.res,n=e.args,t=e.p;return c.getSuccessMessage(r,n,t)}),c.getErrorMessage&&(a.getErrorMessage=function(e){var r=e.err,n=e.args,t=e.p;return c.getErrorMessage(r,n,t)}),c.preReducer&&(a.preEffects=function(e){var r=e.s,n=e.p,t=e.args;return c.preReducer(r,t,n)}),c.optimisticReducer&&(a.optimisticEffects=function(e){var r=e.s,n=e.p,t=e.args;return c.optimisticReducer(r,t,n)}),c.reducer&&(a.effects=function(e){var r=e.s,n=e.res,t=e.p,o=e.args;return c.reducer(r,n,o,t)}),c.errorReducer&&(a.errorEffects=function(e){var r=e.s,n=e.err,t=e.p,o=e.args;return c.errorReducer(r,n,o,t)}),c.onDone&&(a.sideEffects=function(e){var r=e.s,n=e.res,t=e.p,o=e.args,s=e.a,i=e.notifyWarning;return c.onDone(r,n,o,t,s,i)}),c.onFail&&(a.errorSideEffects=function(e){var r=e.s,n=e.err,t=e.p,o=e.args,s=e.a,i=e.notifyWarning;return c.onFail(r,n,o,t,s,i)}),n[i]=a}return n}),{})}Object.defineProperty(exports,"ConflictPolicy",{enumerable:!0,get:function(){return e.ConflictPolicy}}),Object.defineProperty(exports,"setGlobalConfig",{enumerable:!0,get:function(){return e.setGlobalConfig}}),exports.default=function(t,o,s,c,u){void 0===c&&(c={});var a,f,p,g,l=r.useReducer((function(e){return e>100?0:e+1}),0)[1],d=r.useRef(),P=r.useRef();null==d.current&&(d.current=i(o)),null==P.current&&(P.current=(a=c,f={},p=Object.keys(a),g=["onPropsChange","onPropsChangeReducer","getPropsRefValues","onMount","initialActionsMarkedLoading"],p.forEach((function(e){g.includes(e)||(f[e]=a[e])})),a.onMount&&(f.onMount=function(e){var r=e.s,n=e.p,t=e.a;return a.onMount(t,n,r)}),a.getPropsRefValues&&(f.onPropsChange={getDeps:a.getPropsRefValues,effects:function(e){var r=e.s,n=e.p,t=e.indices;return a.onPropsChangeReducer?a.onPropsChangeReducer(r,n,t):null},sideEffects:function(e){var r=e.s,n=e.p,t=e.a,o=e.indices;return null==a.onPropsChange?null:a.onPropsChange(r,n,t,o)}}),a.initialActionsMarkedLoading&&(f.initialActionsMarkedLoading=a.initialActionsMarkedLoading),f));var y=r.useRef();if(null==y.current){var v=u;c.logEnabled&&v.push(n.logDetailedEffects()),y.current=e.createStore(t,d.current,P.current,v)}y.current.setProps(s),r.useLayoutEffect((function(){return y.current.addStateListener((function(){l()}))}),[]);var m=y.current;return{state:m.state,actions:m.actions,loading:m.loading,loadingMap:m.loadingMap,loadingParallelMap:m.loadingParallelMap,abortAction:m.abortAction}},exports.isAdvancedSyncAction=s,exports.isAsyncAction=function(e){return!(e instanceof Function)&&(e.hasOwnProperty("promise")||e.hasOwnProperty("promiseGet"))},exports.isAsyncPromiseGetAction=function(e){return!(e instanceof Function||e.hasOwnProperty("promise")&&e.hasOwnProperty("promiseGet"))},exports.isSyncAction=o,exports.useOnMount=function(e){r.useEffect((function(){var r=e();return"function"==typeof r?r:void 0}),[])},exports.useOnUnload=function(e){r.useEffect((function(){return document.addEventListener("beforeunload",e),function(){document.removeEventListener("beforeunload",e)}}),[])},exports.useOnUnmount=function(e,n){void 0===n&&(n=[]),r.useEffect((function(){return e}),n)};
-//# sourceMappingURL=v5.js.map

package/dist/v5.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"v5.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/v5_test.d.ts

@@ -1,70 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) GlobalSport SAS.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-import type { StoreAction } from './types';
-import { setGlobalConfig, ConflictPolicy } from './index';
-import { AdvancedSynchAction, AsynchActionPromiseGet, StateDecoratorAction, StateDecoratorActions, StateDecoratorOptions, AsynchActionPromise, SynchAction, LoadingMap, LoadingProps, LoadingMapParallelActions, AsynchAction } from './v5_types';
-export { AdvancedSynchAction, AsynchActionPromiseGet, StateDecoratorAction, StateDecoratorActions, StateDecoratorOptions, AsynchActionPromise, SynchAction, LoadingMap, LoadingMapParallelActions, LoadingProps, ConflictPolicy, setGlobalConfig, };
-/**
- * Type guard function to test if an action is a asynchronous action.
- */
-export declare function isAsyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AsynchAction<S, F, A, P>;
-/**
- * Type guard function to test if an action is a asynchronous action.
- */
-export declare function isAsyncPromiseGetAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AsynchActionPromiseGet<S, F, A, P>;
-/**
- * Type guard function to test if an action is a synchronous action.
- */
-export declare function isSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is SynchAction<S, F, P>;
-/**
- * Type guard function to test if an action is a synchronous action.
- */
-export declare function isAdvancedSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>): action is AdvancedSynchAction<S, F, A, P>;
-/**
- * Utility to test an asynchronous action.
- * @param action The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testAsyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>, test: (action: AsynchActionPromise<S, F, A, P>) => any | Promise<any>): any;
-/**
- * Utility to test an synchronous action.
- * @param action The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>, test: (action: SynchAction<S, F, P>) => any | Promise<any>): any;
-/**
- * Utility to test an advanced synchronous action.
- * @param action The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testAdvancedSyncAction<S, F extends (...args: any[]) => any, A, P>(action: StateDecoratorAction<S, F, A, P>, test: (action: AdvancedSynchAction<S, F, A, P>) => any | Promise<any>): any;
-/**
- * Utility to test a V6 synchronous action using v5 test.
- * @param action The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testV6SyncAction<S, F extends (...args: any[]) => any, A, P>(action: StoreAction<S, F, A, P>, test: (action: SynchAction<S, F, P>) => any | Promise<any>): Promise<void>;
-/**
- * Utility to test a V6 synchronous action using v5 test.
- * @param actionIn The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testV6AdvancedSyncAction<S, F extends (...args: any[]) => any, A, P>(actionIn: StoreAction<S, F, A, P>, test: (action: AdvancedSynchAction<S, F, A, P>) => any | Promise<any>): Promise<void>;
-/**
- * Utility to test a V6 synchronous action using v5 test.
- * @param actionIn The action to test
- * @param test The test function that takes the discrimined action type and cam return a promise
- */
-export declare function testV6AsyncAction<S, F extends (...args: any[]) => any, A, P>(actionIn: StoreAction<S, F, A, P>, test: (action: AsynchAction<S, F, A, P>) => any | Promise<any>): any;