@simplux/core/esm2015/src/effects.js

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

/**
 * Helper symbol used for identifying simplux effect objects.
 *
 * @public
 */
// should really be a symbol, but as of TypeScript 4.1 there is a bug
// that causes the symbol to not be properly re-exported in type
// definitions when spreading a effect object onto an export, which can
// cause issues with composite builds
export const SIMPLUX_EFFECT = '[SIMPLUX_EFFECT]';
const mocks = [];
/**
 * Create a new effect. An effect is any function that has side effects.
 * The main purpose of this function is to allow simple mocking of the
 * effect.
 *
 * @param effect - the effect to create
 *
 * @returns a function that calls the provided effect and can be mocked
 *
 * @public
 */
export function createEffect(effect) {
    return createEffects({ ['n/a']: effect })['n/a'];
}
/**
 * Create new effects. An effect is any function that has side effects.
 * The main purpose of this function is to allow simple mocking of the
 * effect.
 *
 * @param effects - the effects to create
 *
 * @returns functions that call the provided effects and can be mocked
 *
 * @public
 */
export function createEffects(effects) {
    return Object.keys(effects).reduce((res, key) => (Object.assign(Object.assign({}, res), { [key]: _createEffect(effects[key], key) })), {});
    function _createEffect(effect, effectName) {
        const effectFn = nameFunction(effectName, (...args) => {
            const mockDef = mocks.find(({ effectToMock }) => effectToMock === effectFn);
            if (mockDef) {
                return mockDef.mockFn(...args);
            }
            return effect(...args);
        });
        effectFn.effectName = effectName;
        effectFn[SIMPLUX_EFFECT] = '';
        return effectFn;
        // this helper function allows creating a function with a dynamic name (only works with ES6+)
        function nameFunction(name, body) {
            return {
                [name](...args) {
                    return body(...args);
                },
            }[name];
        }
    }
}
/**
 * This interface is used for mocking support during testing.
 * It is part of the internal simplux API and should not be
 * used directly by application code.
 *
 * @internal
 */
export function _getEffectMocks() {
    return mocks;
}
/**
 * Checks if an object is a simplux effect.
 *
 * @param object - the object to check
 *
 * @returns true if the object is a simplux effect
 *
 * @internal
 */
export function _isSimpluxEffect(object) {
    var _a;
    return ((_a = object) === null || _a === void 0 ? void 0 : _a[SIMPLUX_EFFECT]) === '';
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"effects.js","sources":["@simplux/core/src/effects.ts"],"sourcesContent":["import type { FunctionSignature, Mutable } from './types.js'\r\n\r\n/**\r\n * Helper symbol used for identifying simplux effect objects.\r\n *\r\n * @public\r\n */\r\n// should really be a symbol, but as of TypeScript 4.1 there is a bug\r\n// that causes the symbol to not be properly re-exported in type\r\n// definitions when spreading a effect object onto an export, which can\r\n// cause issues with composite builds\r\nexport const SIMPLUX_EFFECT = '[SIMPLUX_EFFECT]'\r\n\r\n/**\r\n * This interface is used for mocking support during testing.\r\n *\r\n * @internal\r\n */\r\nexport interface _EffectMockDefinition {\r\n  readonly effectToMock: Function\r\n  readonly mockFn: Function\r\n}\r\n\r\n/**\r\n * The functions to turn into effects.\r\n *\r\n * @public\r\n */\r\nexport interface SimpluxEffectDefinitions {\r\n  readonly [name: string]: (...args: any[]) => any\r\n}\r\n\r\n/**\r\n * Interface for efficiently identifying simplux effect objects at compile time.\r\n *\r\n * @public\r\n */\r\nexport interface SimpluxEffectMarker<\r\n  TFunction extends (...args: any[]) => any\r\n> {\r\n  /**\r\n   * A symbol that allows efficient compile-time and run-time identification\r\n   * of simplux effect objects.\r\n   *\r\n   * This property will have an `undefined` value at runtime.\r\n   *\r\n   * @public\r\n   */\r\n  readonly [SIMPLUX_EFFECT]: TFunction\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport interface SimpluxEffectMetadata {\r\n  /**\r\n   * The name of this effect.\r\n   */\r\n  readonly effectName: string\r\n}\r\n\r\n/**\r\n * A function with side-effects that can be easily mocked for testing.\r\n *\r\n * @public\r\n */\r\nexport type SimpluxEffect<\r\n  TFunction extends (...args: any[]) => any\r\n> = FunctionSignature<TFunction> &\r\n  SimpluxEffectMarker<TFunction> &\r\n  SimpluxEffectMetadata\r\n\r\n/**\r\n * A collection of functions with side-effects that can be easily mocked for testing.\r\n *\r\n * @public\r\n */\r\nexport type SimpluxEffects<\r\n  TEffectDefinitions extends SimpluxEffectDefinitions\r\n> = {\r\n  [effectName in keyof TEffectDefinitions]: SimpluxEffect<\r\n    TEffectDefinitions[effectName]\r\n  >\r\n}\r\n\r\nconst mocks: _EffectMockDefinition[] = []\r\n\r\n/**\r\n * Create a new effect. An effect is any function that has side effects.\r\n * The main purpose of this function is to allow simple mocking of the\r\n * effect.\r\n *\r\n * @param effect - the effect to create\r\n *\r\n * @returns a function that calls the provided effect and can be mocked\r\n *\r\n * @public\r\n */\r\nexport function createEffect<TEffectFunction extends (...args: any[]) => any>(\r\n  effect: TEffectFunction,\r\n): SimpluxEffect<TEffectFunction> {\r\n  return createEffects({ ['n/a']: effect })['n/a']\r\n}\r\n\r\n/**\r\n * Create new effects. An effect is any function that has side effects.\r\n * The main purpose of this function is to allow simple mocking of the\r\n * effect.\r\n *\r\n * @param effects - the effects to create\r\n *\r\n * @returns functions that call the provided effects and can be mocked\r\n *\r\n * @public\r\n */\r\nexport function createEffects<\r\n  TEffectDefinitions extends SimpluxEffectDefinitions\r\n>(effects: TEffectDefinitions): SimpluxEffects<TEffectDefinitions> {\r\n  return Object.keys(effects).reduce(\r\n    (res, key) => ({ ...res, [key]: _createEffect(effects[key]!, key) }),\r\n    {} as SimpluxEffects<TEffectDefinitions>,\r\n  )\r\n\r\n  function _createEffect<TEffectFunction extends (...args: any[]) => any>(\r\n    effect: TEffectFunction,\r\n    effectName: string,\r\n  ): SimpluxEffect<TEffectFunction> {\r\n    const effectFn = (nameFunction(effectName, (...args: any[]) => {\r\n      const mockDef = mocks.find(\r\n        ({ effectToMock }) => effectToMock === effectFn,\r\n      )\r\n\r\n      if (mockDef) {\r\n        return mockDef.mockFn(...args)\r\n      }\r\n\r\n      return effect(...args)\r\n    }) as unknown) as Mutable<SimpluxEffect<TEffectFunction>>\r\n\r\n    effectFn.effectName = effectName\r\n    effectFn[SIMPLUX_EFFECT] = '' as any\r\n\r\n    return effectFn as SimpluxEffect<TEffectFunction>\r\n\r\n    // this helper function allows creating a function with a dynamic name (only works with ES6+)\r\n    function nameFunction<T extends (...args: any[]) => any>(\r\n      name: string,\r\n      body: T,\r\n    ): T {\r\n      return {\r\n        [name](...args: any[]) {\r\n          return body(...args)\r\n        },\r\n      }[name] as T\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * This interface is used for mocking support during testing.\r\n * It is part of the internal simplux API and should not be\r\n * used directly by application code.\r\n *\r\n * @internal\r\n */\r\nexport function _getEffectMocks() {\r\n  return mocks\r\n}\r\n\r\n/**\r\n * Checks if an object is a simplux effect.\r\n *\r\n * @param object - the object to check\r\n *\r\n * @returns true if the object is a simplux effect\r\n *\r\n * @internal\r\n */\r\nexport function _isSimpluxEffect<\r\n  TFunction extends (...args: any[]) => any,\r\n  TOther\r\n>(\r\n  object: SimpluxEffectMarker<TFunction> | TOther,\r\n): object is SimpluxEffect<TFunction> {\r\n  return (object as any)?.[SIMPLUX_EFFECT] === ''\r\n}\r\n"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,qEAAqE;AACrE,gEAAgE;AAChE,uEAAuE;AACvE,qCAAqC;AACrC,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAA;AA0EhD,MAAM,KAAK,GAA4B,EAAE,CAAA;AAEzC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAuB;IAEvB,OAAO,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;AAClD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAE3B,OAA2B;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,iCAAM,GAAG,KAAE,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAE,EAAE,GAAG,CAAC,IAAG,EACpE,EAAwC,CACzC,CAAA;IAED,SAAS,aAAa,CACpB,MAAuB,EACvB,UAAkB;QAElB,MAAM,QAAQ,GAAI,YAAY,CAAC,UAAU,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE;YAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CACxB,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,YAAY,KAAK,QAAQ,CAChD,CAAA;YAED,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;aAC/B;YAED,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;QACxB,CAAC,CAAwD,CAAA;QAEzD,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAA;QAChC,QAAQ,CAAC,cAAc,CAAC,GAAG,EAAS,CAAA;QAEpC,OAAO,QAA0C,CAAA;QAEjD,6FAA6F;QAC7F,SAAS,YAAY,CACnB,IAAY,EACZ,IAAO;YAEP,OAAO;gBACL,CAAC,IAAI,CAAC,CAAC,GAAG,IAAW;oBACnB,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;gBACtB,CAAC;aACF,CAAC,IAAI,CAAM,CAAA;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAI9B,MAA+C;;IAE/C,OAAO,CAAA,MAAC,MAAc,0CAAG,cAAc,CAAC,MAAK,EAAE,CAAA;AACjD,CAAC"}