hadron-document 7.9.0 → 7.10.0

package/lib/index.js

@@ -1,7 +0,0 @@
-"use strict";
-
-module.exports = require('./document');
-module.exports.DocumentEvents = module.exports.Events;
-module.exports.Element = require('./element');
-module.exports.ElementEvents = module.exports.Element.Events;
-module.exports.ElementEditor = require('./editor');

package/lib/object-generator.js

@@ -1,180 +0,0 @@
-'use strict';
-/**
- * Generates javascript objects from elements.
- */
-
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
-
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-var ObjectGenerator = /*#__PURE__*/function () {
-  function ObjectGenerator() {
-    _classCallCheck(this, ObjectGenerator);
-  }
-
-  _createClass(ObjectGenerator, [{
-    key: "generate",
-    value:
-    /**
-     * Generate a javascript object from the elements.
-     *
-     * @param {Array} elements - The elements.
-     *
-     * @returns {Object} The javascript object.
-     */
-    function generate(elements) {
-      if (elements) {
-        var object = {};
-
-        var _iterator = _createForOfIteratorHelper(elements),
-            _step;
-
-        try {
-          for (_iterator.s(); !(_step = _iterator.n()).done;) {
-            var element = _step.value;
-
-            if (!element.isRemoved() && element.currentKey !== '') {
-              object[element.currentKey] = element.generateObject();
-            }
-          }
-        } catch (err) {
-          _iterator.e(err);
-        } finally {
-          _iterator.f();
-        }
-
-        return object;
-      }
-
-      return elements;
-    }
-    /**
-     * Generate a javascript object from the elements with their original keys
-     * and values. This can be used in a query with an update to
-     * ensure the values on the document to edit are still up to date.
-     *
-     * @param {Array} elements - The elements.
-     *
-     * @returns {Object} The javascript object.
-     */
-
-  }, {
-    key: "generateOriginal",
-    value: function generateOriginal(elements) {
-      if (elements) {
-        var object = {};
-
-        var _iterator2 = _createForOfIteratorHelper(elements),
-            _step2;
-
-        try {
-          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-            var element = _step2.value;
-
-            if (!element.isAdded()) {
-              object[element.key] = element.generateOriginalObject();
-            }
-          }
-        } catch (err) {
-          _iterator2.e(err);
-        } finally {
-          _iterator2.f();
-        }
-
-        return object;
-      }
-
-      return elements;
-    }
-    /**
-     * Generate an array from the elements.
-     *
-     * @param {Array} elements - The elements.
-     *
-     * @returns {Array} The array.
-     */
-
-  }, {
-    key: "generateArray",
-    value: function generateArray(elements) {
-      if (elements) {
-        var array = [];
-
-        var _iterator3 = _createForOfIteratorHelper(elements),
-            _step3;
-
-        try {
-          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
-            var element = _step3.value;
-
-            if (!element.isRemoved()) {
-              if (element.elements) {
-                array.push(element.generateObject());
-              } else {
-                array.push(element.currentValue);
-              }
-            }
-          }
-        } catch (err) {
-          _iterator3.e(err);
-        } finally {
-          _iterator3.f();
-        }
-
-        return array;
-      }
-
-      return elements;
-    }
-    /**
-     * Generate an array from the elements using their original values.
-     *
-     * @param {Array} elements - The elements.
-     *
-     * @returns {Array} The array.
-     */
-
-  }, {
-    key: "generateOriginalArray",
-    value: function generateOriginalArray(elements) {
-      if (elements) {
-        var array = [];
-
-        var _iterator4 = _createForOfIteratorHelper(elements),
-            _step4;
-
-        try {
-          for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
-            var element = _step4.value;
-
-            if (element.originalExpandableValue) {
-              array.push(element.generateOriginalObject());
-            } else if (!element.isAdded()) {
-              array.push(element.value);
-            }
-          }
-        } catch (err) {
-          _iterator4.e(err);
-        } finally {
-          _iterator4.f();
-        }
-
-        return array;
-      }
-
-      return elements;
-    }
-  }]);
-
-  return ObjectGenerator;
-}();
-
-module.exports = new ObjectGenerator();

package/lib/utils.js

@@ -1,10 +0,0 @@
-"use strict";
-
-var fieldStringLen = function fieldStringLen(value) {
-  var length = String(value).length;
-  return length === 0 ? 1 : length;
-};
-
-module.exports = {
-  fieldStringLen: fieldStringLen
-};

package/src/document.js

@@ -1,432 +0,0 @@
-'use strict';
-
-const EventEmitter = require('eventemitter3');
-const uuid = require('uuid');
-const Element = require('./element');
-const LinkedList = Element.LinkedList;
-const ObjectGenerator = require('./object-generator');
-
-/**
- * The event constant.
- */
-const Events = {
-  'Cancel': 'Document::Cancel'
-};
-
-/**
- * The id field.
- */
-const ID = '_id';
-
-/**
- * Represents a document.
- */
-class Document extends EventEmitter {
-  /**
-   * Send cancel event.
-   */
-  cancel() {
-    // Cancel will remove elements from iterator, clone it before iterating
-    // otherwise we will skip items
-    for (let element of Array.from(this.elements)) {
-      element.cancel();
-    }
-    this.emit(Events.Cancel);
-  }
-
-  /**
-   * Create the new document from the provided object.
-   *
-   * @param {Object} doc - The document.
-   * @param {boolean} cloned - If it is a cloned document.
-   */
-  constructor(doc, cloned) {
-    super();
-    this.uuid = uuid.v4();
-    this.doc = doc;
-    this.cloned = cloned || false;
-    this.isUpdatable = true;
-    this.elements = this._generateElements();
-    this.type = 'Document';
-    this.currentType = 'Document';
-  }
-
-  apply(doc) {
-    let updatedKeys = [];
-    let prevKey = null;
-    for (const [key, value] of Object.entries(doc)) {
-      if (this.get(key)) {
-        this.get(key).edit(value);
-      } else if (prevKey) {
-        this.insertAfter(this.get(prevKey), key, value);
-      } else {
-        this.insertBeginning(key, value);
-      }
-      prevKey = key;
-      updatedKeys.push(key);
-    }
-    for (const el of [...this.elements]) {
-      if (!updatedKeys.includes(el.currentKey)) {
-        el.remove();
-      }
-    }
-  }
-
-  /**
-   * Generate the javascript object for this document.
-   *
-   * @returns {Object} The javascript object.
-   */
-  generateObject() {
-    return ObjectGenerator.generate(this.elements);
-  }
-
-  /**
-   * Generate the javascript object with the original elements in this document.
-   *
-   * @returns {Object} The original javascript object.
-   */
-  generateOriginalObject() {
-    return ObjectGenerator.generateOriginal(this.elements);
-  }
-
-  /**
-   * Generate the `query` and `updateDoc` to be used in an update operation
-   * where the update only succeeds when the changed document's elements have
-   * not been changed in the background.
-   *
-   * @param {Object} alwaysIncludeKeys - An object whose keys are used as keys
-   *     that are always included in the generated query.
-   *
-   * @returns {Object} An object containing the `query` and `updateDoc` to be
-   * used in an update operation.
-   */
-  generateUpdateUnlessChangedInBackgroundQuery(
-    alwaysIncludeKeys = null
-  ) {
-    // Build a query that will find the document to update only if it has the
-    // values of elements that were changed with their original value.
-    // This query won't find the document if an updated element's value isn't
-    // the same value as it was when it was originally loaded.
-    const originalFieldsThatWillBeUpdated = this.getOriginalKeysAndValuesForFieldsThatWereUpdated(
-      alwaysIncludeKeys
-    );
-    const query = {
-      _id: this.getId(),
-      ...originalFieldsThatWillBeUpdated
-    };
-
-    // Build the update document to be used in an update operation with `$set`
-    // and `$unset` reflecting the changes that have occured in the document.
-    const setUpdateObject = this.getSetUpdateForDocumentChanges();
-    const unsetUpdateObject = this.getUnsetUpdateForDocumentChanges();
-    const updateDoc = { };
-    if (setUpdateObject && Object.keys(setUpdateObject).length > 0) {
-      updateDoc.$set = setUpdateObject;
-    }
-    if (unsetUpdateObject && Object.keys(unsetUpdateObject).length > 0) {
-      updateDoc.$unset = unsetUpdateObject;
-    }
-
-    return {
-      query,
-      updateDoc
-    };
-  }
-
-  /**
-   * Get an element by its key.
-   *
-   * @param {String} key
-   *
-   * @returns {Element} The element.
-   */
-  get(key) {
-    return this.elements.get(key);
-  }
-
-  /**
-   * Get an element by a series of segment names.
-   *
-   * @param {Array} path - The series of fieldnames. Cannot be empty.
-   *
-   * @returns {Element} The element.
-   */
-  getChild(path) {
-    if (!path) {
-      return undefined;
-    }
-    let element = (this.currentType === 'Array') ? this.elements.at(path[0]) : this.elements.get(path[0]);
-    let i = 1;
-    while (i < path.length) {
-      if (element === undefined) {
-        return undefined;
-      }
-      element = element.currentType === 'Array' ? element.at(path[i]) : element.get(path[i]);
-      i++;
-    }
-    return element;
-  }
-
-  /**
-   * Get the _id value for the document.
-   *
-   * @returns {Object} The id.
-   */
-  getId() {
-    const element = this.get(ID);
-    return element ? element.generateObject() : null;
-  }
-
-  /**
-   * Generate the query javascript object reflecting the elements that
-   * were updated in this document. The values of this object are the original
-   * values, this can be used when querying for an update to see if the original
-   * document was changed in the background while it was being updated elsewhere.
-   *
-   * @param {Object} alwaysIncludeKeys - An object whose keys are used as keys
-   *     that are always included in the generated query.
-   *
-   * @returns {Object} The javascript object.
-   */
-  getOriginalKeysAndValuesForFieldsThatWereUpdated(
-    alwaysIncludeKeys = null
-  ) {
-    const object = {};
-
-    if (this.elements) {
-      for (const element of this.elements) {
-        if ((element.isModified() && !element.isAdded()) ||
-            (alwaysIncludeKeys && element.key in alwaysIncludeKeys)) {
-          // Using `.key` instead of `.currentKey` to ensure we look at
-          // the original field's value.
-          object[element.key] = element.generateOriginalObject();
-        }
-        if (element.isAdded() && element.currentKey !== '') {
-          // When a new field is added, check if that field
-          // was already added in the background.
-          object[element.currentKey] = { $exists: false };
-        }
-      }
-    }
-
-    return object;
-  }
-
-  /**
-   * Generate the query javascript object reflecting the elements that
-   * are specified by the keys listed in `keys`. The values of this object are
-   * the original values, this can be used when querying for an update based
-   * on multiple criteria.
-   *
-   * @param {Object} keys - An object whose keys are used as keys
-   *     that are included in the generated query.
-   *
-   * @returns {Object} The javascript object.
-   */
-  getOriginalKeysAndValuesForSpecifiedKeys(keys) {
-    const object = {};
-
-    if (this.elements) {
-      for (const element of this.elements) {
-        if (element.key in keys) {
-          // Using `.key` instead of `.currentKey` to ensure we look at
-          // the original field's value.
-          object[element.key] = element.generateOriginalObject();
-        }
-      }
-    }
-
-    return object;
-  }
-
-  /**
-   * Generate an $set javascript object, that can be used in update operations to
-   * set the changes which have occured in the document since it was loaded.
-   *
-   * @returns {Object} The javascript update object.
-  **/
-  getSetUpdateForDocumentChanges() {
-    const object = {};
-
-    if (this.elements) {
-      for (const element of this.elements) {
-        if (
-          !element.isRemoved()
-          && element.currentKey !== ''
-          && element.isModified()
-        ) {
-          // Include the full modified element.
-          // We don't individually set nested fields because we can't guarantee a
-          // path to the element using '.' dot notation will update
-          // the correct field, because field names can contain dots as of 3.6.
-          // When a nested field has been altered (changed/added/removed) it is
-          // set at the top level field. This means we overwrite possible
-          // background changes that occur within sub documents.
-          object[element.currentKey] = element.generateObject();
-        }
-      }
-    }
-    return object;
-  }
-
-  /**
-   * Get the _id value as a string. Required if _id is not always an ObjectId.
-   *
-   * @returns {String} The string id.
-   */
-  getStringId() {
-    const element = this.get(ID);
-    if (!element) {
-      return null;
-    } else if (element.currentType === 'Array' || element.currentType === 'Object') {
-      return JSON.stringify(element.generateObject());
-    }
-    return '' + element.value;
-  }
-
-  /**
-   * Generate an $unset javascript object, that can be used in update
-   * operations, with the removals from the document.
-   *
-   * @returns {Object} The javascript update object.
-  **/
-  getUnsetUpdateForDocumentChanges() {
-    const object = {};
-
-    if (this.elements) {
-      for (const element of this.elements) {
-        if (!element.isAdded() && element.isRemoved() && element.key !== '') {
-          object[element.key] = true;
-        }
-        if (!element.isAdded() && element.isRenamed() && element.key !== '') {
-          // Remove the original field when an element is renamed.
-          object[element.key] = true;
-        }
-      }
-    }
-    return object;
-  }
-
-  /**
-   * Insert a placeholder element at the end of the document.
-   *
-   * @returns {Element} The placeholder element.
-   */
-  insertPlaceholder() {
-    return this.insertEnd('', '');
-  }
-
-  /**
-   * Add a new element to this document.
-   *
-   * @param {String} key - The element key.
-   * @param {Object} value - The value.
-   *
-   * @returns {Element} The new element.
-   */
-  insertBeginning(key, value) {
-    var newElement = this.elements.insertBeginning(key, value, true, this);
-    newElement._bubbleUp(Element.Events.Added, newElement, this);
-    return newElement;
-  }
-
-  /**
-   * Add a new element to this document.
-   *
-   * @param {String} key - The element key.
-   * @param {Object} value - The value.
-   *
-   * @returns {Element} The new element.
-   */
-  insertEnd(key, value) {
-    var newElement = this.elements.insertEnd(key, value, true, this);
-    newElement._bubbleUp(Element.Events.Added, newElement, this);
-    return newElement;
-  }
-
-  /**
-   * Insert an element after the provided element.
-   *
-   * @param {Element} element - The element to insert after.
-   * @param {String} key - The key.
-   * @param {Object} value - The value.
-   *
-   * @returns {Element} The new element.
-   */
-  insertAfter(element, key, value) {
-    var newElement = this.elements.insertAfter(element, key, value, true, this);
-    newElement._bubbleUp(Element.Events.Added, newElement, this);
-    return newElement;
-  }
-
-  /**
-   * A document always exists, is never added.
-   *
-   * @returns {false} Always false.
-   */
-  isAdded() {
-    return false;
-  }
-
-  /**
-   * Determine if the element is modified at all.
-   *
-   * @returns {Boolean} If the element is modified.
-   */
-  isModified() {
-    for (let element of this.elements) {
-      if (element.isModified()) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  /**
-   * A document is never removed
-   *
-   * @returns {false} Always false.
-   */
-  isRemoved() {
-    return false;
-  }
-
-  /**
-   * The document object is always the root object.
-   *
-   * @returns {true} Always true.
-   */
-  isRoot() {
-    return true;
-  }
-
-  /**
-   * Handle the next element in the document.
-   */
-  next() {
-    this.elements.flush();
-    const lastElement = this.elements.lastElement;
-    if (lastElement && lastElement.isAdded()) {
-      if (lastElement.isBlank()) {
-        lastElement.remove();
-      } else {
-        this.insertPlaceholder();
-      }
-    } else {
-      this.insertPlaceholder();
-    }
-  }
-
-  /**
-   * Generates a sequence of elements.
-   *
-   * @returns {Array} The elements.
-   */
-  _generateElements() {
-    return new LinkedList(this, this.doc);
-  }
-}
-
-module.exports = Document;
-module.exports.Events = Events;