piral-containers/src/create.ts

Plugin for creating a pilet state container in Piral.

import * as actions from './actions';
import { buildName, PiralPlugin, StateDispatcher } from 'piral-core';
import { withPiletState } from './withPiletState';
import { PiletContainersApi } from './types';

/**
 * Available configuration options for the container plugin.
 */
export interface ContainersConfig {}

/**
 * Creates new Pilet API extensions for supporting pilet global state containers.
 */
export function createContainersApi(config: ContainersConfig = {}): PiralPlugin<PiletContainersApi> {
  return (context) => {
    context.defineActions(actions);

    context.dispatch((state) => ({
      ...state,
      containers: {},
    }));

    return (api, target) => {
      let containers = 0;

      return {
        createState(options) {
          if (!options || typeof options.actions !== 'object' || typeof options.state !== 'object') {
            throw new Error('Missing options. "state" and "actions" are required.');
          }

          const actions = {};
          const id = buildName(target.name, containers++);
          const cb = (dispatch: StateDispatcher<any>) => context.replaceState(id, dispatch);
          context.createState(id, options.state);

          Object.keys(options.actions).forEach((key) => {
            const action = options.actions[key];
            actions[key] = (...args) => action.call(api, cb, ...args);
          });

          return (component) => withPiletState(component, id, actions) as any;
        },
      };
    };
  };
}