@simplux/core/esm2015/index.js

The core package of simplux. Contains everything to manage your application state in a simple way.

import { createStore } from 'redux';
import { createModule, } from './src/module.js';
import { simpluxStore, _setReduxStore } from './src/store.js';
// we create and set a default redux store for simple scenarios
setReduxStoreForSimplux(createStore(getSimpluxReducer()), (s) => s);
export { createEffect, createEffects, SIMPLUX_EFFECT, _getEffectMocks, _isSimpluxEffect, } from './src/effects.js';
export { SIMPLUX_MODULE, _isSimpluxModule } from './src/module.js';
export { createMutations, SIMPLUX_MUTATION, _isSimpluxMutation, } from './src/mutations.js';
export { createSelectors, SIMPLUX_SELECTOR, _isSimpluxSelector, } from './src/selectors.js';
export { _getStoreProxy } from './src/store.js';
export * from './src/types.js';
// tslint:disable: max-line-length (cannot line break the links)
/**
 * Returns the root reducer that manages all simplux state.
 * This reducer should be combined with all the other reducers
 * your application has.
 *
 * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).
 *
 * @returns the simplux root reducer
 *
 * @public
 */
export function getSimpluxReducer() {
    return simpluxStore.rootReducer;
}
export function createSimpluxModule(configOrName, initialState) {
    if (typeof configOrName === 'string') {
        const config = {
            name: configOrName,
            initialState: initialState,
        };
        return createModule(simpluxStore, config);
    }
    return createModule(simpluxStore, configOrName);
}
/**
 * Set the redux store that simplux should use. It is required to call
 * this function before any created simplux module can be used.
 *
 * The second parameter must be a function that maps from the redux store's
 * root state to the simplux root state.
 *
 * If this function is called again with a new store, simplux will safely
 * switch over to the new store. However, no state is transferred and
 * therefore all modules are reset to their initial state. This is primarily
 * useful in server-side rendering scenarios.
 *
 * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).
 *
 * @param storeToUse - the redux store that simplux should use
 * @param simpluxStateGetter - a mapper function from the redux root state
 * to the simplux root state
 *
 * @returns a cleanup function that when called disconnects simplux from the
 * redux store (but it does not remove any of the simplux state from the store)
 *
 * @public
 */
export function setReduxStoreForSimplux(storeToUse, simpluxStateGetter) {
    return _setReduxStore(storeToUse, simpluxStateGetter);
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sources":["@simplux/core/index.ts"],"sourcesContent":["import { createStore, Reducer, Store } from 'redux'\r\nimport {\r\n  createModule,\r\n  SimpluxModule,\r\n  SimpluxModuleConfig,\r\n} from './src/module.js'\r\nimport { simpluxStore, _setReduxStore } from './src/store.js'\r\n\r\n// we create and set a default redux store for simple scenarios\r\nsetReduxStoreForSimplux(createStore(getSimpluxReducer()), (s) => s)\r\n\r\nexport {\r\n  createEffect,\r\n  createEffects,\r\n  SIMPLUX_EFFECT,\r\n  _getEffectMocks,\r\n  _isSimpluxEffect,\r\n} from './src/effects.js'\r\nexport type {\r\n  SimpluxEffect,\r\n  SimpluxEffectDefinitions,\r\n  SimpluxEffectMarker,\r\n  SimpluxEffectMetadata,\r\n  SimpluxEffects,\r\n  _EffectMockDefinition,\r\n} from './src/effects.js'\r\nexport { SIMPLUX_MODULE, _isSimpluxModule } from './src/module.js'\r\nexport type {\r\n  ResolvedStateChangeHandler,\r\n  SimpluxModule,\r\n  SimpluxModuleConfig,\r\n  SimpluxModuleMarker,\r\n  StateChangeHandler,\r\n  StateChangeHandlerOptions,\r\n  StateChangeSubscription,\r\n  SubscribeToStateChanges,\r\n  Subscription,\r\n  _SimpluxModuleInternals,\r\n} from './src/module.js'\r\nexport {\r\n  createMutations,\r\n  SIMPLUX_MUTATION,\r\n  _isSimpluxMutation,\r\n} from './src/mutations.js'\r\nexport type {\r\n  MutationDefinition,\r\n  MutationDefinitions,\r\n  ResolvedMutation,\r\n  SimpluxMutation,\r\n  SimpluxMutationMarker,\r\n  SimpluxMutations,\r\n} from './src/mutations.js'\r\nexport {\r\n  createSelectors,\r\n  SIMPLUX_SELECTOR,\r\n  _isSimpluxSelector,\r\n} from './src/selectors.js'\r\nexport type {\r\n  ResolvedSelector,\r\n  SelectorDefinition,\r\n  SelectorDefinitions,\r\n  SimpluxSelector,\r\n  SimpluxSelectorMarker,\r\n  SimpluxSelectors,\r\n} from './src/selectors.js'\r\nexport { _getStoreProxy } from './src/store.js'\r\nexport type { _InternalReduxStoreProxy, _SimpluxStore } from './src/store.js'\r\nexport * from './src/types.js'\r\n\r\n// tslint:disable: max-line-length (cannot line break the links)\r\n\r\n/**\r\n * Returns the root reducer that manages all simplux state.\r\n * This reducer should be combined with all the other reducers\r\n * your application has.\r\n *\r\n * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).\r\n *\r\n * @returns the simplux root reducer\r\n *\r\n * @public\r\n */\r\nexport function getSimpluxReducer(): Reducer {\r\n  return simpluxStore.rootReducer\r\n}\r\n\r\n/**\r\n * Create a new simplux module.\r\n *\r\n * A module has a unique name (provided via the `config` parameter)\r\n * and a type of state it contains (the initial state is provided via\r\n * the `config` parameter).\r\n *\r\n * The returned module contains functions for basic interaction with\r\n * the module as well as any other functions that are provided by the\r\n * extension packages you have loaded.\r\n *\r\n * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).\r\n *\r\n * @param config - the configuration values for the module\r\n *\r\n * @returns the created module\r\n *\r\n * @public\r\n */\r\nexport function createSimpluxModule<TState>(\r\n  config: SimpluxModuleConfig<TState>,\r\n): SimpluxModule<TState>\r\n\r\n/**\r\n * Create a new simplux module.\r\n *\r\n * A module has a unique name and a type of state it contains.\r\n *\r\n * The returned module contains functions for basic interaction with\r\n * the module as well as any other functions that are provided by the\r\n * extension packages you have loaded.\r\n *\r\n * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).\r\n *\r\n * @param name - the unique name of the module\r\n * @param initialState - the initial state of the module\r\n *\r\n * @returns the created module\r\n *\r\n * @public\r\n */\r\nexport function createSimpluxModule<TState>(\r\n  name: string,\r\n  initialState: TState,\r\n): SimpluxModule<TState>\r\n\r\nexport function createSimpluxModule<TState>(\r\n  configOrName: SimpluxModuleConfig<TState> | string,\r\n  initialState?: TState,\r\n): SimpluxModule<TState> {\r\n  if (typeof configOrName === 'string') {\r\n    const config: SimpluxModuleConfig<TState> = {\r\n      name: configOrName,\r\n      initialState: initialState!,\r\n    }\r\n\r\n    return createModule(simpluxStore, config)\r\n  }\r\n\r\n  return createModule(simpluxStore, configOrName)\r\n}\r\n\r\n/**\r\n * Set the redux store that simplux should use. It is required to call\r\n * this function before any created simplux module can be used.\r\n *\r\n * The second parameter must be a function that maps from the redux store's\r\n * root state to the simplux root state.\r\n *\r\n * If this function is called again with a new store, simplux will safely\r\n * switch over to the new store. However, no state is transferred and\r\n * therefore all modules are reset to their initial state. This is primarily\r\n * useful in server-side rendering scenarios.\r\n *\r\n * To learn more, have a look at the [getting started recipe](https://github.com/MrWolfZ/simplux/tree/master/recipes/basics/getting-started).\r\n *\r\n * @param storeToUse - the redux store that simplux should use\r\n * @param simpluxStateGetter - a mapper function from the redux root state\r\n * to the simplux root state\r\n *\r\n * @returns a cleanup function that when called disconnects simplux from the\r\n * redux store (but it does not remove any of the simplux state from the store)\r\n *\r\n * @public\r\n */\r\nexport function setReduxStoreForSimplux<TState>(\r\n  storeToUse: Store<TState>,\r\n  simpluxStateGetter: (rootState: TState) => any,\r\n) {\r\n  return _setReduxStore(storeToUse, simpluxStateGetter)\r\n}\r\n"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAkB,MAAM,OAAO,CAAA;AACnD,OAAO,EACL,YAAY,GAGb,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE7D,+DAA+D;AAC/D,uBAAuB,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;AAEnE,OAAO,EACL,YAAY,EACZ,aAAa,EACb,cAAc,EACd,eAAe,EACf,gBAAgB,GACjB,MAAM,kBAAkB,CAAA;AASzB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAalE,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,oBAAoB,CAAA;AAS3B,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,oBAAoB,CAAA;AAS3B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,cAAc,gBAAgB,CAAA;AAE9B,gEAAgE;AAEhE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO,YAAY,CAAC,WAAW,CAAA;AACjC,CAAC;AAgDD,MAAM,UAAU,mBAAmB,CACjC,YAAkD,EAClD,YAAqB;IAErB,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;QACpC,MAAM,MAAM,GAAgC;YAC1C,IAAI,EAAE,YAAY;YAClB,YAAY,EAAE,YAAa;SAC5B,CAAA;QAED,OAAO,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;KAC1C;IAED,OAAO,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAyB,EACzB,kBAA8C;IAE9C,OAAO,cAAc,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAA;AACvD,CAAC"}