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

package/dist/v5_test.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var r=require("./index"),e=require("./impl"),n=function(){return(n=Object.assign||function(r){for(var e,n=1,t=arguments.length;n<t;n++)for(var o in e=arguments[n])Object.prototype.hasOwnProperty.call(e,o)&&(r[o]=e[o]);return r}).apply(this,arguments)};function t(r,e,n){if(n||2===arguments.length)for(var t,o=0,s=e.length;o<s;o++)!t&&o in e||(t||(t=Array.prototype.slice.call(e,0,o)),t[o]=e[o]);return r.concat(t||Array.prototype.slice.call(e))}function o(r){return!(r instanceof Function)&&(r.hasOwnProperty("promise")||r.hasOwnProperty("promiseGet"))}function s(r){return r instanceof Function}function i(r){return!(r instanceof Function||r.hasOwnProperty("promise")||r.hasOwnProperty("promiseGet"))}Object.defineProperty(exports,"ConflictPolicy",{enumerable:!0,get:function(){return r.ConflictPolicy}}),Object.defineProperty(exports,"setGlobalConfig",{enumerable:!0,get:function(){return r.setGlobalConfig}}),exports.isAdvancedSyncAction=i,exports.isAsyncAction=o,exports.isAsyncPromiseGetAction=function(r){return!(r instanceof Function||r.hasOwnProperty("promise")&&r.hasOwnProperty("promiseGet"))},exports.isSyncAction=s,exports.testAdvancedSyncAction=function(r,e){return i(r)?e(r):Promise.reject(new Error("This action is not a synchronous advanced action"))},exports.testAsyncAction=function(e,t){return o(e)?t(function(e){return"promiseGet"in e?n(n({},e),{promise:e.promiseGet,retryCount:3,conflictPolicy:r.ConflictPolicy.REUSE}):e}(e)):Promise.reject(new Error("This action is not an asynchronous action"))},exports.testSyncAction=function(r,e){return s(r)?e(r):Promise.reject(new Error("This action is not a synchronous action"))},exports.testV6AdvancedSyncAction=function(r,n){return e.isSyncAction(r)?(n({action:function(e,n,t){return r.effects({s:e,args:n,p:t,ds:null,derived:null,state:e,props:t,res:null,result:null,promiseId:null})},onActionDone:function(e,n,t,o,s){r.sideEffects({s:e,args:n,p:t,a:o,notifyWarning:s,ds:null,derived:null,state:e,props:t,actions:o,res:null,result:null,promiseId:null})}}),Promise.resolve()):Promise.reject(new Error("This action is not a synchronous action"))},exports.testV6AsyncAction=function(r,n){return e.isAsyncAction(r)?n({abortable:r.abortable,rejectPromiseOnError:r.rejectPromiseOnError,retryCount:r.retryCount,retryDelaySeed:r.retryDelaySeed,isTriggerRetryError:r.isTriggerRetryError,conflictPolicy:r.conflictPolicy,getPromiseId:r.getPromiseId,promise:function(n,t,o,s,i){return e.isAsyncGetPromiseAction(r)?r.getPromise({s:t,args:n,p:o,a:s,abortSignal:i,ds:null,derived:null,state:t,props:o,actions:s,promiseId:null}):r.getGetPromise({s:t,args:n,p:o,a:s,abortSignal:i,ds:null,derived:null,state:t,props:o,actions:s,promiseId:null})},promiseGet:function(n,t,o,s,i){return e.isAsyncGetPromiseGetAction(r)?r.getGetPromise({s:t,args:n,p:o,a:s,abortSignal:i,ds:null,derived:null,state:t,props:o,actions:s,promiseId:null}):null},reducer:function(e,n,t,o){return r.effects?r.effects({s:e,args:t,p:o,res:n,ds:null,derived:null,state:e,props:o,result:n,promiseId:null}):null},preReducer:function(e,n,t){return r.preEffects?r.preEffects({s:e,args:n,p:t,ds:null,derived:null,state:e,props:t,promiseId:null}):null},optimisticReducer:function(e,n,o){var s;return r.optimisticEffects?r.optimisticEffects({s:e,args:n,p:o,ds:null,derived:null,state:e,props:o,promiseId:null===(s=r.getPromiseId)||void 0===s?void 0:s.call.apply(s,t([r],n))}):null},errorReducer:function(e,n,o,s){var i;return r.errorEffects?r.errorEffects({s:e,args:o,p:s,err:n,ds:null,derived:null,state:e,props:s,error:n,promiseId:null===(i=r.getPromiseId)||void 0===i?void 0:i.call.apply(i,t([r],o))}):null},onDone:function(e,n,o,s,i,l){var c,u;null===(c=r.sideEffects)||void 0===c||c.call(r,{s:e,args:o,p:s,a:i,res:n,notifyWarning:l,ds:null,derived:null,state:e,props:s,actions:i,result:n,promiseId:null===(u=r.getPromiseId)||void 0===u?void 0:u.call.apply(u,t([r],o))})},onFail:function(e,n,o,s,i,l){var c,u;null===(c=r.errorSideEffects)||void 0===c||c.call(r,{s:e,args:o,p:s,a:i,err:n,notifyWarning:l,ds:null,derived:null,state:e,props:s,actions:i,error:n,promiseId:null===(u=r.getPromiseId)||void 0===u?void 0:u.call.apply(u,t([r],o))})},getErrorMessage:function(e,n,o){var s,i;return null===(s=r.getErrorMessage)||void 0===s?void 0:s.call(r,{err:e,p:o,args:n,ds:null,derived:null,state:null,s:null,error:e,props:o,promiseId:null===(i=r.getPromiseId)||void 0===i?void 0:i.call.apply(i,t([r],n))})},getSuccessMessage:function(e,n,o){var s,i;return null===(s=r.getSuccessMessage)||void 0===s?void 0:s.call(r,{res:e,args:n,p:o,ds:null,derived:null,state:null,s:null,result:e,props:o,promiseId:null===(i=r.getPromiseId)||void 0===i?void 0:i.call.apply(i,t([r],n))})}}):Promise.reject(new Error("This action is not a synchronous action"))},exports.testV6SyncAction=function(r,n){if(e.isSimpleSyncAction(r)){return n((function(e,n,t){return r({s:e,args:n,p:t,ds:null,derived:null,state:e,props:t,promiseId:null})})),Promise.resolve()}return Promise.reject(new Error("This action is not a synchronous action"))};
-//# sourceMappingURL=v5_test.js.map

package/dist/v5_types.d.ts

@@ -1,227 +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 { ConflictPolicy, DecoratedActions, NotifyFunc, PromiseResult } from './types';
-export declare type PromiseProvider<S, F extends (...args: any[]) => any, A, P> = (args: Parameters<F>, state: S, props: P, actions: A, abortSignal: AbortSignal) => ReturnType<F> | null;
-/**
- * Simple form of a synchronous action.
- */
-export declare type SynchAction<S, F extends (...args: any[]) => any, P> = (state: S, args: Parameters<F>, props: P) => S | null;
-/**
- * Advanced synchronous action.
- * Allows to set advanced properties to a synchronous action.
- */
-export declare type AdvancedSynchAction<S, F extends (...args: any[]) => any, A, P> = {
-    /**
-     * The action to execute.
-     */
-    action: (state: S, args: Parameters<F>, props: P) => S | null;
-    /**
-     * Debounces the side effects if this parameter is defined.
-     */
-    debounceSideEffectsTimeout?: number;
-    /**
-     * Debounces the action if this parameter is defined.
-     */
-    debounceTimeout?: number;
-    /**
-     * Action to call when the action is done. Used to trigger other actions (even asynchronous),
-     */
-    onActionDone?: (state: S, args: Parameters<F>, props: P, actions: A, notifyWarning: NotifyFunc) => void;
-};
-export declare type PromiseIdMap = {
-    [promiseId: string]: boolean;
-};
-export declare type InternalLoadingMap<A> = {
-    [name: string]: undefined | boolean | PromiseIdMap;
-};
-export declare type LoadingMap<A> = {
-    [P in keyof A]?: undefined | boolean;
-};
-export declare type LoadingMapParallelActions<A> = {
-    [P in keyof A]?: PromiseIdMap;
-};
-export declare type LoadingProps<A> = {
-    loading: boolean;
-    loadingMap: LoadingMap<A>;
-    loadingParallelMap: LoadingMapParallelActions<A>;
-};
-/**
- * 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<F extends (...args: any[]) => any, P> = (e: any, args: Parameters<F>, props: P) => string;
-export interface AsynchActionBase<S, F extends (...args: any[]) => any, A, P> {
-    /**
-     * This action can be aborted. An abortSignal will be injected to the <code>promise</code> / <code>promiseGet</code>.
-     */
-    abortable?: boolean;
-    /**
-     * The success message to pass to the notifySuccess function passed as property to the StateDecorator.
-     */
-    successMessage?: string;
-    /**
-     * A function that provides the success message to pass to the notifySuccess function passed as property to the StateDecorator.
-     */
-    getSuccessMessage?: (result: PromiseResult<ReturnType<F>>, args: Parameters<F>, props: P) => string;
-    /**
-     * The error message to pass to the notifyError function passed as property to the StateDecorator.
-     */
-    errorMessage?: string;
-    /**
-     * A function that provides the error message to pass to the notifyError function passed as property to the StateDecorator.
-     */
-    getErrorMessage?: GetErrorMessage<F, P>;
-    /**
-     * If set, called with the result of the promise to update the current state.
-     */
-    reducer?: (state: S, result: PromiseResult<ReturnType<F>>, args: Parameters<F>, props: P) => S | null;
-    /**
-     * If set, called with the error of the promise to update the current state.
-     */
-    errorReducer?: (state: S, error: any, args: Parameters<F>, props: P) => S | null;
-    /**
-     * Whether reject the promise instead of handling it.
-     */
-    rejectPromiseOnError?: 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).
-     */
-    onDone?: (state: S, result: PromiseResult<ReturnType<F>>, args: Parameters<F>, props: P, actions: A, notifyWarning: NotifyFunc) => 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).
-     */
-    onFail?: (state: S, error: Error, args: Parameters<F>, props: P, actions: A, notifyWarning: NotifyFunc) => 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.
-     */
-    preReducer?: (state: S, args: Parameters<F>, props: P) => S | 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.
-     */
-    optimisticReducer?: (state: S, args: Parameters<F>, props: P) => S | 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 interface AsynchActionPromise<S, F extends (...args: any[]) => any, A, P> extends AsynchActionBase<S, F, A, P> {
-    /**
-     * The request, returns a promise
-     */
-    promise: PromiseProvider<S, F, A, P>;
-}
-export interface AsynchActionPromiseGet<S, F extends (...args: any[]) => any, A, P> extends AsynchActionBase<S, F, A, P> {
-    /**
-     * The request, returns a promise that is a GET request.
-     * A shortcut to set:
-     *   - retryCount: 3
-     *   - conflictPolicy: ConflictPolicy.REUSE
-     */
-    promiseGet: PromiseProvider<S, F, A, P>;
-}
-export declare type AsynchAction<S, F extends (...args: any[]) => any, A, P> = AsynchActionPromise<S, F, A, P> | AsynchActionPromiseGet<S, F, A, P>;
-export declare type StateDecoratorAction<S, F extends (...args: any[]) => any, A, P> = AsynchAction<S, F, A, P> | SynchAction<S, F, P> | AdvancedSynchAction<S, F, A, P>;
-/**
- * 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 StateDecoratorActions<S, A extends DecoratedActions, P = {}> = {
-    [Prop in keyof A]: StateDecoratorAction<S, A[Prop], A, P>;
-};
-declare type OnPropsChangeReducer<S, P> = (s: S, newProps: P, updatedIndices: number[]) => S;
-export declare type StateDecoratorOptions<S, A, P = {}> = {
-    /**
-     * The state decorator name. Use in debug traces to identify the useStateDecorator instance.
-     */
-    name?: string;
-    /**
-     * Show logs in the console in development mode.
-     */
-    logEnabled?: boolean;
-    /**
-     * List of action names that are marked as loading at initial time.
-     * As a render is done before first actions can be trigerred, some actions can be marked as loading at
-     * initial time.
-     */
-    initialActionsMarkedLoading?: (keyof A)[];
-    /**
-     * Get a list of values that will be use as reference values.
-     * If they are different (shallow compare), onPropsChangeReducer then onPropsChange will be called.
-     */
-    getPropsRefValues?: (props: P) => any[];
-    /**
-     * Triggered when values of reference from props have changed. Allow to call actions after a prop change.
-     */
-    onPropsChange?: (s: S, newProps: any, actions: A, updatedIndices: number[]) => void;
-    /**
-     * Triggered when values of reference from props have changed. Allow to update state after a prop change.
-     * <b>null</b> means no change.
-     */
-    onPropsChangeReducer?: OnPropsChangeReducer<S, 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. They are executed outside of a side effect to trigger asynchronous actions.
-     */
-    onMount?: (actions: A, props: P, state: S) => void;
-};
-export {};