react-dataflow/dist/index.js

A dataflow execution format for React.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.withWires = exports.useWire = exports.useWires = exports.withDataflow = exports.Sequences = void 0;

var _react = _interopRequireWildcard(require("react"));

var _immutable = require("immutable");

var _events = _interopRequireDefault(require("events"));

var _v = _interopRequireDefault(require("uuid/v4"));

var _reactUseMutator = require("react-use-mutator");

var _Classical = _interopRequireDefault(require("./Sequences/Classical"));

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }

function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }

function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }

function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest(); }

function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); }

function _iterableToArrayLimit(arr, i) { if (!(Symbol.iterator in Object(arr) || Object.prototype.toString.call(arr) === "[object Arguments]")) { return; } var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }

function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }

function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }

function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }

var EVENT_SIGNALS_CHANGED = 'dataflowSignalsChanged';

var Signals = _react["default"].createContext(null);

var SignalsMutator = _react["default"].createContext(null);

var Elements = _react["default"].createContext(null);

var ElementsMutator = _react["default"].createContext(null);

var Sequences = Object.freeze({
  Classical: _Classical["default"]
});
exports.Sequences = Sequences;

var Dataflow = function Dataflow(_ref) {
  var Component = _ref.Component,
      extraProps = _objectWithoutProperties(_ref, ["Component"]);

  var signalsMutator = (0, _react.useContext)(SignalsMutator);
  (0, _react.useEffect)(function () {
    if (signalsMutator) {
      throw new Error('Dataflow: It is not possible to nest components wrapped withDataflow.');
    }
  }, [signalsMutator]);

  var _useMutator = (0, _reactUseMutator.useMutator)((0, _immutable.Map)({})),
      _useMutator2 = _slicedToArray(_useMutator, 2),
      useSignals = _useMutator2[0],
      mutateSignals = _useMutator2[1];

  var _useMutator3 = (0, _reactUseMutator.useMutator)((0, _immutable.Set)([])),
      _useMutator4 = _slicedToArray(_useMutator3, 2),
      useElements = _useMutator4[0],
      mutateElements = _useMutator4[1];

  var _useState = (0, _react.useState)(function () {
    return new _events["default"]();
  }),
      _useState2 = _slicedToArray(_useState, 1),
      Emitter = _useState2[0]; // XXX: Allow the parent to listen to changes in signals.


  var _useState3 = (0, _react.useState)(function () {
    return function (fn) {
      return Emitter.on(EVENT_SIGNALS_CHANGED, fn);
    };
  }),
      _useState4 = _slicedToArray(_useState3, 1),
      subscribe = _useState4[0];

  var _useState5 = (0, _react.useState)(function () {
    return _react["default"].createElement(Component, _extends({}, extraProps, {
      subscribe: subscribe
    }));
  }),
      _useState6 = _slicedToArray(_useState5, 1),
      children = _useState6[0];

  Emitter.emit(EVENT_SIGNALS_CHANGED, useSignals(), useElements());
  return _react["default"].createElement(ElementsMutator.Provider, {
    value: mutateElements
  }, _react["default"].createElement(SignalsMutator.Provider, {
    value: mutateSignals
  }, _react["default"].createElement(Elements.Provider, {
    value: useElements
  }, _react["default"].createElement(Signals.Provider, {
    value: useSignals,
    children: children
  }))));
};

var withDataflow = function withDataflow(Component) {
  return function (_ref2) {
    var extraProps = _extends({}, _ref2);

    return _react["default"].createElement(Dataflow, _extends({
      Component: Component
    }, extraProps));
  };
};

exports.withDataflow = withDataflow;

var useSignals = function useSignals() {
  return (0, _react.useContext)(Signals);
};

var useSignalsMutator = function useSignalsMutator() {
  return (0, _react.useContext)(SignalsMutator);
};

var useElementsMutator = function useElementsMutator() {
  return (0, _react.useContext)(ElementsMutator);
}; // XXX: This is a convenience method, which permits callers to
//      passively inspect wire states *without* registering 
//      for updates.


var useWires = function useWires() {
  return useSignalsMutator()();
};

exports.useWires = useWires;

var useWire = function useWire() {
  var mutateSignals = useSignalsMutator();

  var _useState7 = (0, _react.useState)(function () {
    var wireId = (0, _v["default"])();
    mutateSignals(function (signals) {
      return signals.set(wireId, (0, _immutable.Map)({
        value: null,
        signalIn: (0, _immutable.Map)({}),
        signalOut: (0, _immutable.Map)({})
      }));
    });
    return wireId;
  }),
      _useState8 = _slicedToArray(_useState7, 1),
      wireId = _useState8[0];

  return wireId;
};

exports.useWire = useWire;

var Exporter = function Exporter(_ref3) {
  var outputWires = _ref3.outputWires,
      children = _ref3.children,
      dataflowId = _ref3.dataflowId,
      extraProps = _objectWithoutProperties(_ref3, ["outputWires", "children", "dataflowId"]);

  var mutateSignals = useSignalsMutator();
  mutateSignals(function (signals) {
    return Object.entries(extraProps).filter(function (_ref4) {
      var _ref5 = _slicedToArray(_ref4, 1),
          k = _ref5[0];

      return outputWires.hasOwnProperty(k);
    }).reduce(function (map, _ref6) {
      var _ref7 = _slicedToArray(_ref6, 2),
          k = _ref7[0],
          v = _ref7[1];

      return map.setIn([outputWires[k], 'value'], v).setIn([outputWires[k], 'signalIn', dataflowId], (map.get([outputWires[k], 'signalIn', dataflowId]) || (0, _immutable.Set)([])).add(k));
    }, signals);
  });
  return _react["default"].createElement(_react["default"].Fragment, {
    children: children
  });
};

var WiredComponent = function WiredComponent(_ref8) {
  var Component = _ref8.Component,
      Export = _ref8.Export,
      outputKeys = _ref8.outputKeys,
      dataflowId = _ref8.dataflowId,
      extraProps = _objectWithoutProperties(_ref8, ["Component", "Export", "outputKeys", "dataflowId"]);

  var getState = useSignals();
  var mutateSignals = useSignalsMutator();

  var _useState9 = (0, _react.useState)(function () {
    return function (_ref9) {
      var extraProps = _extends({}, _ref9);

      return _react["default"].createElement(Component, _extends({}, extraProps, Object.entries(extraProps).filter(function (_ref10) {
        var _ref11 = _slicedToArray(_ref10, 1),
            k = _ref11[0];

        return outputKeys.indexOf(k) < 0;
      }).reduce(function (obj, _ref12) {
        var _ref13 = _slicedToArray(_ref12, 2),
            k = _ref13[0],
            v = _ref13[1];

        if (getState().has(v)) {
          // XXX: Mark this element as a consumer.
          mutateSignals(function (signals) {
            return signals.setIn([v, 'signalOut', dataflowId], (signals.get([v, 'signalOut', dataflowId]) || (0, _immutable.Set)([])).add(k));
          });
          return _objectSpread({}, obj, _defineProperty({}, k, getState().getIn([v, 'value'])));
        }

        return obj;
      }, {}), {
        Export: Export
      }));
    };
  }),
      _useState10 = _slicedToArray(_useState9, 1),
      Wired = _useState10[0];

  return _react["default"].createElement(Wired, extraProps);
};

var withWires = function withWires(Component) {
  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  return function (props) {
    if (!options || _typeof(options) !== 'object') {
      throw new Error("Dataflow: When wrapping a <Component /> withWires, you must pass either a valid configuration object, or undefined. Encountered: ".concat(options, "."));
    }

    var _useState11 = (0, _react.useState)( // TODO: Validate that the supplied key is an appropriate unique type.
    function () {
      return options.key || (0, _v["default"])();
    }),
        _useState12 = _slicedToArray(_useState11, 1),
        dataflowId = _useState12[0];

    var mutateElements = useElementsMutator(); // XXX: Register this dataflowId as an element on the graph.

    (0, _react.useEffect)(function () {
      return mutateElements(function (elements) {
        return elements.add(dataflowId);
      }) && undefined;
    }, [mutateElements, dataflowId]);
    var exportPropTypes = Component.exportPropTypes,
        exportDefaultProps = Component.exportDefaultProps;

    var _useState13 = (0, _react.useState)(function () {
      if (exportPropTypes && _typeof(exportPropTypes) === 'object') {
        return Object.keys(exportPropTypes);
      }

      return [];
    }),
        _useState14 = _slicedToArray(_useState13, 1),
        outputKeys = _useState14[0];

    var _useState15 = (0, _react.useState)(function () {
      if (outputKeys.length) {
        var outputWires = outputKeys.reduce(function (obj, k) {
          if (props[k]) {
            return _objectSpread({}, obj, _defineProperty({}, k, props[k]));
          }

          return obj;
        }, {});

        var WiredExporter = function WiredExporter(props) {
          return _react["default"].createElement(Exporter, _extends({}, props, {
            dataflowId: dataflowId,
            outputWires: outputWires
          }));
        };

        WiredExporter.propTypes = exportPropTypes;
        WiredExporter.defaultProps = exportDefaultProps;
        return _react["default"].memo(WiredExporter);
      }

      return function () {
        throw new Error("Dataflow: You have attempted to use an <Export /> for a component withWires which has not defined any exportPropTypes. (Expected object, encountered ".concat(JSON.stringify(exportPropTypes), ".)"));
      };
    }),
        _useState16 = _slicedToArray(_useState15, 1),
        Export = _useState16[0];

    return _react["default"].createElement(WiredComponent, _extends({}, props, {
      Component: Component,
      Export: Export,
      outputKeys: outputKeys,
      dataflowId: dataflowId
    }));
  };
};

exports.withWires = withWires;