sam-pattern/lib/sam-actions.js

SAM Pattern library

// ISC License (ISC)
// Copyright 2019 Jean-Jacques Dubray

// Permission to use, copy, modify, and/or distribute this software for any purpose
// with or without fee is hereby granted, provided that the above copyright notice
// and this permission notice appear in all copies.

// 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 def from './SAM'
import { F } from './sam-utils'

// A set of methods to use the SAM pattern
export default (SAM = def) => ({
  // Core SAM API
  addInitialState: initialState => SAM({ initialState }),
  addComponent: component => SAM({ component }),
  setRender: (render) => {
    if (Array.isArray(render)) {
      const [display, representation] = render
      render = state => display(typeof representation === 'function' ? representation(state) : state)
    }
    SAM({ render: F(render) })
  },
  addHandler: (event, handler) => SAM({ event: [event, handler] }),
  getIntents: actions => SAM({ component: { actions } }),
  addAcceptors: (acceptors, privateModel) => SAM({ component: { acceptors, privateModel } }),
  addReactors: (reactors, privateModel) => SAM({ component: { reactors, privateModel } }),
  addNAPs: (naps, privateModel) => SAM({ component: { naps, privateModel } }),
  addSafetyConditions: (safety, privateModel) => SAM({ component: { safety, privateModel } }),
  hasError: () => SAM({}).hasError,
  allow: actions => SAM({ allowed: { actions } }),
  clearAllowedActions: () => SAM({ allowed: { clear: true } }),
  allowedActions: () => SAM({ allowed: {} }),

  // Time Travel
  addTimeTraveler: (history = []) => SAM({ history }),
  travel: (index = 0) => SAM({ travel: { index } }),
  next: () => SAM({ travel: { next: true } }),
  last: () => SAM({ travel: { endOfTime: true } }),
  hasNext: () => SAM({}).hasNext,
  reset: initialState => (initialState ? SAM({ initialState }) : SAM({ travel: { reset: true } })),

  // Checker
  beginCheck: render => SAM({ check: { begin: { render } } }),
  endCheck: () => SAM({ check: { end: true } })
})