transmutable/symbols.js

immutable objects that pretend to be mutable

// const WAS_WRITTEN = Symbol();
// const METHOD = Symbol();
// const MUTATION = 'MUTATION'
// const WAS_ACCESSED = 'WAS_ACCESSED'

// TODO all these should be symbols (now some of them are strings)
// TODO there are too many of them!
// WAS_WRITTEN, WAS_ACCESSED - probably they should be removed, but it has to be checked
// DRAFT - doesn't seem to be used
// SELECTOR TODO check

const WAS_WRITTEN = Symbol();
const METHOD = Symbol();
const MUTATION = Symbol('transmutable/mutation');
const WAS_ACCESSED = Symbol();
const DRAFT = Symbol();
const SELECTOR = Symbol();
// TODO change into Symbol (but Transmutable currently does not clone symbols...)
const AUTO = '@@auto'//Symbol();

const symbols = {};
[
    'ENTITY',
    // inspired by Redux: https://redux.js.org/docs/recipes/reducers/NormalizingStateShape.html
    'ENTITIES',
].forEach(name => {
    symbols[name] = '@@transmutable/' + name.toLowerCase();
});

module.exports = Object.assign({ WAS_ACCESSED, WAS_WRITTEN, METHOD, MUTATION, DRAFT, SELECTOR, AUTO }, symbols);