hadron-document 8.6.2 → 8.6.3

package/dist/document.d.ts

@@ -4,6 +4,9 @@ import EventEmitter from 'eventemitter3';
 import type { KeyInclusionOptions, ObjectGeneratorOptions } from './object-generator';
 import type { BSONArray, BSONObject, BSONValue } from './utils';
 import type { HadronEJSONOptions } from './utils';
+/**
+ * The event constant.
+ */
 export declare const Events: {
     Cancel: string;
     Expanded: string;
@@ -15,6 +18,9 @@ export declare const Events: {
     DeletionFinished: string;
 };
 export declare const DEFAULT_VISIBLE_ELEMENTS = 25;
+/**
+ * Represents a document.
+ */
 export declare class Document extends EventEmitter {
     uuid: string;
     doc: BSONObject;
@@ -28,11 +34,46 @@ export declare class Document extends EventEmitter {
     maxVisibleElementsCount: number;
     editing: boolean;
     markedForDeletion: boolean;
+    /**
+     * Send cancel event.
+     */
     cancel(): void;
+    /**
+     * Create the new document from the provided object.
+     *
+     * @param {Object} doc - The document.
+     * @param {boolean} cloned - If it is a cloned document.
+     */
     constructor(doc: BSONObject, cloned?: boolean);
     apply(doc: BSONObject | Document): void;
+    /**
+     * Generate the javascript object for this document.
+     *
+     * @returns {Object} The javascript object.
+     */
     generateObject(options?: ObjectGeneratorOptions): BSONObject;
+    /**
+     * Generate the javascript object with the original elements in this document.
+     *
+     * @returns {Object} The original javascript object.
+     */
     generateOriginalObject(options?: ObjectGeneratorOptions): BSONObject;
+    /**
+     * 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.
+     *
+     * `query` and `updateDoc` may use $getField and $setField if field names
+     * contain either `.` or start with `$`. These operators are only available
+     * on MongoDB 5.0+. (Note that field names starting with `$` are also only
+     * allowed in MongoDB 5.0+.)
+     *
+     * @param keyInclusionOptions Specify which fields to include in the
+     *     originalFields list.
+     *
+     * @returns {Object} An object containing the `query` and `updateDoc` to be
+     * used in an update operation.
+     */
     generateUpdateUnlessChangedInBackgroundQuery(opts?: Readonly<KeyInclusionOptions>): {
         query: BSONObject;
         updateDoc: {
@@ -40,25 +81,136 @@ export declare class Document extends EventEmitter {
             $unset?: BSONObject;
         } | BSONArray;
     };
+    /**
+     * Get an element by its key.
+     *
+     * @param {String} key
+     *
+     * @returns {Element} The element.
+     */
     get(key: string): Element | undefined;
+    /**
+     * 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: (string | number)[]): Element | undefined;
+    /**
+     * Get the _id value for the document.
+     *
+     * @returns {Object} The id.
+     */
     getId(): BSONValue;
+    /**
+     * 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 keyInclusionOptions Specify which fields to include in the
+     *     originalFields list.
+     *
+     * @returns {Object} The javascript object.
+     */
     getQueryForOriginalKeysAndValuesForSpecifiedKeys(opts?: Readonly<KeyInclusionOptions>): BSONObject;
+    /**
+     * Get the _id value as a string. Required if _id is not always an ObjectId.
+     *
+     * @returns {String} The string id.
+     */
     getStringId(): null | string;
+    /**
+     * Insert a placeholder element at the end of the document.
+     *
+     * @returns {Element} The placeholder element.
+     */
     insertPlaceholder(): Element;
+    /**
+     * 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: string | number, value: BSONValue): Element;
+    /**
+     * 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: string | number, value: BSONValue): Element;
+    /**
+     * 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: Element, key: string | number, value: BSONValue): Element | undefined;
+    /**
+     * A document always exists, is never added.
+     *
+     * @returns Always false.
+     */
     isAdded(): boolean;
+    /**
+     * Determine if the element is modified at all.
+     *
+     * @returns {Boolean} If the element is modified.
+     */
     isModified(): boolean;
+    /**
+     * A document is never removed
+     *
+     * @returns {false} Always false.
+     */
     isRemoved(): boolean;
+    /**
+     * The document object is always the root object.
+     *
+     * @returns {true} Always true.
+     */
     isRoot(): this is Document;
+    /**
+     * Generates a sequence of elements.
+     *
+     * @returns {Array} The elements.
+     */
     _generateElements(): ElementList;
+    /**
+     * @deprecated Use DocumentEvents import instead
+     */
     static get Events(): typeof Events;
+    /**
+     * Parse a new Document from extended JSON input.
+     */
     static FromEJSON(input: string): Document;
+    /**
+     * Parse multiple Document from extended JSON input.
+     * If the input consists of only a single document without
+     * `[array]` brackets, return an array consisting of only
+     * that document.
+     */
     static FromEJSONArray(input: string): Document[];
+    /**
+     * Convert this Document instance into a human-readable EJSON string.
+     */
     toEJSON(source?: 'original' | 'current', options?: HadronEJSONOptions): string;
+    /**
+     * Expands a document by expanding all of its fields
+     */
     expand(): void;
+    /**
+     * Collapses a document by collapsing all of its fields
+     */
     collapse(): void;
     getVisibleElements(): Element[];
     setMaxVisibleElementsCount(newCount: number): void;

package/dist/document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,WAAW,EAA2B,MAAM,WAAW,CAAC;AACjE,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAMlD,eAAO,MAAM,MAAM;;;;;;;;;CASlB,CAAC;AAOF,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAK3C,qBAAa,QAAS,SAAQ,YAAY;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,WAAW,CAAC;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,UAAU,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC3B,QAAQ,UAAS;IACjB,uBAAuB,SAA4B;IACnD,OAAO,UAAS;IAChB,iBAAiB,UAAS;IAK1B,MAAM,IAAI,IAAI;gBAeF,GAAG,EAAE,UAAU,EAAE,MAAM,UAAQ;IAW3C,KAAK,CAAC,GAAG,EAAE,UAAU,GAAG,QAAQ,GAAG,IAAI;IA6BvC,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,UAAU;IAS5D,sBAAsB,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,UAAU;IAoBpE,4CAA4C,CAC1C,IAAI,GAAE,QAAQ,CAAC,mBAAmB,CAAM,GACvC;QACD,KAAK,EAAE,UAAU,CAAC;QAClB,SAAS,EAAE;YAAE,IAAI,CAAC,EAAE,UAAU,CAAC;YAAC,MAAM,CAAC,EAAE,UAAU,CAAA;SAAE,GAAG,SAAS,CAAC;KACnE;IA+BD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAWrC,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,GAAG,SAAS;IAwBxD,KAAK,IAAI,SAAS;IAgBlB,gDAAgD,CAC9C,IAAI,GAAE,QAAQ,CAAC,mBAAmB,CAAM,GACvC,UAAU;IAab,WAAW,IAAI,IAAI,GAAG,MAAM;IAkB5B,iBAAiB,IAAI,OAAO;IAY5B,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAehE,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAgB1D,WAAW,CACT,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,GAAG,MAAM,EACpB,KAAK,EAAE,SAAS,GACf,OAAO,GAAG,SAAS;IAYtB,OAAO,IAAI,OAAO;IASlB,UAAU,IAAI,OAAO;IAcrB,SAAS,IAAI,OAAO;IASpB,MAAM,IAAI,IAAI,IAAI,QAAQ;IAS1B,iBAAiB,IAAI,WAAW;IAOhC,MAAM,KAAK,MAAM,IAAI,OAAO,MAAM,CAEjC;IAKD,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAWzC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,EAAE;IAUhD,OAAO,CACL,MAAM,GAAE,UAAU,GAAG,SAAqB,EAC1C,OAAO,GAAE,kBAAuB,GAC/B,MAAM;IAWT,MAAM,IAAI,IAAI;IAYd,QAAQ,IAAI,IAAI;IAShB,kBAAkB;IAIlB,0BAA0B,CAAC,QAAQ,EAAE,MAAM;IAK3C,4BAA4B;IAS5B,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI;IAOxE,aAAa;IAOb,aAAa;IAIb,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAK5C,eAAe;IAIf,aAAa,CAAC,KAAK,EAAE,KAAK;IAI1B,eAAe;IAOf,cAAc;IAOd,aAAa;IAIb,eAAe;IAKf,aAAa,CAAC,KAAK,EAAE,KAAK;CAG3B;AAED,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,WAAW,EAA2B,MAAM,WAAW,CAAC;AACjE,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EACV,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEhE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAGlD;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;;CASlB,CAAC;AAOF,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;GAEG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,UAAU,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,WAAW,CAAC;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,WAAW,EAAE,UAAU,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC3B,QAAQ,UAAS;IACjB,uBAAuB,SAA4B;IACnD,OAAO,UAAS;IAChB,iBAAiB,UAAS;IAE1B;;OAEG;IACH,MAAM,IAAI,IAAI;IASd;;;;;OAKG;gBACS,GAAG,EAAE,UAAU,EAAE,MAAM,UAAQ;IAW3C,KAAK,CAAC,GAAG,EAAE,UAAU,GAAG,QAAQ,GAAG,IAAI;IAwBvC;;;;OAIG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,UAAU;IAI5D;;;;OAIG;IACH,sBAAsB,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,UAAU;IAIpE;;;;;;;;;;;;;;;OAeG;IACH,4CAA4C,CAC1C,IAAI,GAAE,QAAQ,CAAC,mBAAmB,CAAM,GACvC;QACD,KAAK,EAAE,UAAU,CAAC;QAClB,SAAS,EAAE;YAAE,IAAI,CAAC,EAAE,UAAU,CAAC;YAAC,MAAM,CAAC,EAAE,UAAU,CAAA;SAAE,GAAG,SAAS,CAAC;KACnE;IAwBD;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAIrC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,GAAG,SAAS;IAmBxD;;;;OAIG;IACH,KAAK,IAAI,SAAS;IAKlB;;;;;;;;;;OAUG;IACH,gDAAgD,CAC9C,IAAI,GAAE,QAAQ,CAAC,mBAAmB,CAAM,GACvC,UAAU;IAQb;;;;OAIG;IACH,WAAW,IAAI,IAAI,GAAG,MAAM;IAa5B;;;;OAIG;IACH,iBAAiB,IAAI,OAAO;IAI5B;;;;;;;OAOG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAOhE;;;;;;;OAOG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAO1D;;;;;;;;OAQG;IACH,WAAW,CACT,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,GAAG,MAAM,EACpB,KAAK,EAAE,SAAS,GACf,OAAO,GAAG,SAAS;IAOtB;;;;OAIG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,UAAU,IAAI,OAAO;IASrB;;;;OAIG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,MAAM,IAAI,IAAI,IAAI,QAAQ;IAI1B;;;;OAIG;IACH,iBAAiB,IAAI,WAAW;IAIhC;;OAEG;IACH,MAAM,KAAK,MAAM,IAAI,OAAO,MAAM,CAEjC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAKzC;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,EAAE;IAOhD;;OAEG;IACH,OAAO,CACL,MAAM,GAAE,UAAU,GAAG,SAAqB,EAC1C,OAAO,GAAE,kBAAuB,GAC/B,MAAM;IAQT;;OAEG;IACH,MAAM,IAAI,IAAI;IASd;;OAEG;IACH,QAAQ,IAAI,IAAI;IAShB,kBAAkB;IAIlB,0BAA0B,CAAC,QAAQ,EAAE,MAAM;IAK3C,4BAA4B;IAS5B,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI;IAOxE,aAAa;IAOb,aAAa;IAIb,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAK5C,eAAe;IAIf,aAAa,CAAC,KAAK,EAAE,KAAK;IAI1B,eAAe;IAOf,cAAc;IAOd,aAAa;IAIb,eAAe;IAKf,aAAa,CAAC,KAAK,EAAE,KAAK;CAG3B;AAED,eAAe,QAAQ,CAAC"}

package/dist/document.js

@@ -10,6 +10,9 @@ const bson_1 = require("bson");
 const object_generator_1 = __importDefault(require("./object-generator"));
 const utils_1 = require("./utils");
 const _1 = require(".");
+/**
+ * The event constant.
+ */
 exports.Events = {
     Cancel: 'Document::Cancel',
     Expanded: 'Document::Expanded',
@@ -20,15 +23,32 @@ exports.Events = {
     MarkedForDeletion: 'Document::MarkedForDeletion',
     DeletionFinished: 'Document::DeletionFinished',
 };
+/**
+ * The id field.
+ */
 const ID = '_id';
 exports.DEFAULT_VISIBLE_ELEMENTS = 25;
+/**
+ * Represents a document.
+ */
 class Document extends eventemitter3_1.default {
+    /**
+     * Send cancel event.
+     */
     cancel() {
+        // Cancel will remove elements from iterator, clone it before iterating
+        // otherwise we will skip items
         for (const element of Array.from(this.elements)) {
             element.cancel();
         }
         this.emit(exports.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 = false) {
         super();
         this.size = null;
@@ -69,13 +89,43 @@ class Document extends eventemitter3_1.default {
             }
         }
     }
+    /**
+     * Generate the javascript object for this document.
+     *
+     * @returns {Object} The javascript object.
+     */
     generateObject(options) {
         return object_generator_1.default.generate(this.elements, options);
     }
+    /**
+     * Generate the javascript object with the original elements in this document.
+     *
+     * @returns {Object} The original javascript object.
+     */
     generateOriginalObject(options) {
         return object_generator_1.default.generateOriginal(this.elements, options);
     }
+    /**
+     * 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.
+     *
+     * `query` and `updateDoc` may use $getField and $setField if field names
+     * contain either `.` or start with `$`. These operators are only available
+     * on MongoDB 5.0+. (Note that field names starting with `$` are also only
+     * allowed in MongoDB 5.0+.)
+     *
+     * @param keyInclusionOptions Specify which fields to include in the
+     *     originalFields list.
+     *
+     * @returns {Object} An object containing the `query` and `updateDoc` to be
+     * used in an update operation.
+     */
     generateUpdateUnlessChangedInBackgroundQuery(opts = {}) {
+        // 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 = object_generator_1.default.getQueryForOriginalKeysAndValuesForSpecifiedFields(this, opts, true);
         const query = {
             _id: this.getId(),
@@ -87,9 +137,23 @@ class Document extends eventemitter3_1.default {
             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;
@@ -108,13 +172,34 @@ class Document extends eventemitter3_1.default {
         }
         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
+     * 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 keyInclusionOptions Specify which fields to include in the
+     *     originalFields list.
+     *
+     * @returns {Object} The javascript object.
+     */
     getQueryForOriginalKeysAndValuesForSpecifiedKeys(opts = {}) {
         return object_generator_1.default.getQueryForOriginalKeysAndValuesForSpecifiedFields(this, opts, false);
     }
+    /**
+     * 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) {
@@ -126,30 +211,70 @@ class Document extends eventemitter3_1.default {
         }
         return String(element.value);
     }
+    /**
+     * 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) {
         const newElement = this.elements.insertBeginning(key, value);
         newElement._bubbleUp(element_1.Events.Added, newElement, this);
         this.emit(exports.Events.VisibleElementsChanged, 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) {
         const newElement = this.elements.insertEnd(key, value);
         newElement._bubbleUp(element_1.Events.Added, newElement, this);
         this.emit(exports.Events.VisibleElementsChanged, 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) {
         const newElement = this.elements.insertAfter(element, key, value);
         newElement?._bubbleUp(element_1.Events.Added, newElement, this);
         this.emit(exports.Events.VisibleElementsChanged, this);
         return newElement;
     }
+    /**
+     * A document always exists, is never added.
+     *
+     * @returns Always false.
+     */
     isAdded() {
         return false;
     }
+    /**
+     * Determine if the element is modified at all.
+     *
+     * @returns {Boolean} If the element is modified.
+     */
     isModified() {
         for (const element of this.elements) {
             if (element.isModified()) {
@@ -158,34 +283,67 @@ class Document extends eventemitter3_1.default {
         }
         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;
     }
+    /**
+     * Generates a sequence of elements.
+     *
+     * @returns {Array} The elements.
+     */
     _generateElements() {
         return new element_1.ElementList(this, this.doc);
     }
+    /**
+     * @deprecated Use DocumentEvents import instead
+     */
     static get Events() {
         return exports.Events;
     }
+    /**
+     * Parse a new Document from extended JSON input.
+     */
     static FromEJSON(input) {
         const parsed = bson_1.EJSON.parse(input, { relaxed: false });
         return new Document(parsed);
     }
+    /**
+     * Parse multiple Document from extended JSON input.
+     * If the input consists of only a single document without
+     * `[array]` brackets, return an array consisting of only
+     * that document.
+     */
     static FromEJSONArray(input) {
         const parsed = bson_1.EJSON.parse(input, { relaxed: false });
         return Array.isArray(parsed)
             ? parsed.map((doc) => new Document(doc))
             : [new Document(parsed)];
     }
+    /**
+     * Convert this Document instance into a human-readable EJSON string.
+     */
     toEJSON(source = 'current', options = {}) {
         const obj = source === 'original'
             ? this.generateOriginalObject()
             : this.generateObject();
         return (0, utils_1.objectToIdiomaticEJSON)(obj, options);
     }
+    /**
+     * Expands a document by expanding all of its fields
+     */
     expand() {
         this.expanded = true;
         for (const element of this.elements) {
@@ -194,6 +352,9 @@ class Document extends eventemitter3_1.default {
         this.emit(exports.Events.Expanded);
         this.emit(exports.Events.VisibleElementsChanged, this);
     }
+    /**
+     * Collapses a document by collapsing all of its fields
+     */
     collapse() {
         this.expanded = false;
         for (const element of this.elements) {

package/dist/document.js.map

@@ -1 +1 @@
-{"version":3,"file":"document.js","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;AAEb,uCAAiE;AACjE,kEAAyC;AACzC,+BAAmC;AAKnC,0EAAiD;AAEjD,mCAAiD;AAEjD,wBAAmC;AAKtB,QAAA,MAAM,GAAG;IACpB,MAAM,EAAE,kBAAkB;IAC1B,QAAQ,EAAE,oBAAoB;IAC9B,SAAS,EAAE,qBAAqB;IAChC,sBAAsB,EAAE,kCAAkC;IAC1D,cAAc,EAAE,0BAA0B;IAC1C,eAAe,EAAE,2BAA2B;IAC5C,iBAAiB,EAAE,6BAA6B;IAChD,gBAAgB,EAAE,4BAA4B;CAC/C,CAAC;AAKF,MAAM,EAAE,GAAG,KAAK,CAAC;AAEJ,QAAA,wBAAwB,GAAG,EAAE,CAAC;AAK3C,MAAa,QAAS,SAAQ,uBAAY;IAiBxC,MAAM;QAGJ,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC/C,OAAO,CAAC,MAAM,EAAE,CAAC;SAClB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAQD,YAAY,GAAe,EAAE,MAAM,GAAG,KAAK;QACzC,KAAK,EAAE,CAAC;QAzBV,SAAI,GAAkB,IAAI,CAAC;QAC3B,aAAQ,GAAG,KAAK,CAAC;QACjB,4BAAuB,GAAG,gCAAwB,CAAC;QACnD,YAAO,GAAG,KAAK,CAAC;QAChB,sBAAiB,GAAG,KAAK,CAAC;QAsBxB,IAAI,CAAC,IAAI,GAAG,IAAI,WAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,GAA0B;QAC9B,IAAI,OAAO,GAAG,EAAE,cAAc,KAAK,UAAU,EAAE;YAC7C,GAAG,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;SAC5B;QACD,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC9C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,KAAkB,CAAC,CAAC;aACzC;iBAAM,IAAI,OAAO,EAAE;gBAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAE,EAAE,GAAG,EAAE,KAAkB,CAAC,CAAC;aAC/D;iBAAM;gBACL,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAkB,CAAC,CAAC;aAC/C;YACD,OAAO,GAAG,GAAG,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACvB;QACD,KAAK,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE;gBACxC,EAAE,CAAC,MAAM,EAAE,CAAC;aACb;SACF;IACH,CAAC;IAOD,cAAc,CAAC,OAAgC;QAC7C,OAAO,0BAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAOD,sBAAsB,CAAC,OAAgC;QACrD,OAAO,0BAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAkBD,4CAA4C,CAC1C,OAAsC,EAAE;QASxC,MAAM,+BAA+B,GACnC,0BAAe,CAAC,kDAAkD,CAChE,IAAI,EACJ,IAAI,EACJ,IAAI,CACL,CAAC;QACJ,MAAM,KAAK,GAAG;YACZ,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE;YACjB,GAAG,+BAA+B;SACnC,CAAC;QAEF,MAAM,SAAS,GAAG,0BAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE1D,OAAO;YACL,KAAK;YACL,SAAS;SACV,CAAC;IACJ,CAAC;IASD,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IASD,QAAQ,CAAC,IAAyB;QAChC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;YACtB,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,OAAO,SAAS,CAAC;aAClB;YACD,OAAO;gBACL,OAAO,CAAC,WAAW,KAAK,OAAO;oBAC7B,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;oBAC/B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;YACrC,CAAC,EAAE,CAAC;SACL;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAOD,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACnD,CAAC;IAaD,gDAAgD,CAC9C,OAAsC,EAAE;QAExC,OAAO,0BAAe,CAAC,kDAAkD,CACvE,IAAI,EACJ,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAOD,WAAW;QACT,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,IAAI,CAAC;SACb;aAAM,IACL,OAAO,CAAC,WAAW,KAAK,OAAO;YAC/B,OAAO,CAAC,WAAW,KAAK,QAAQ,EAChC;YACA,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;SACjD;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAOD,iBAAiB;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAUD,eAAe,CAAC,GAAoB,EAAE,KAAgB;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,UAAU,CAAC,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAUD,SAAS,CAAC,GAAoB,EAAE,KAAgB;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACvD,UAAU,CAAC,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAWD,WAAW,CACT,OAAgB,EAChB,GAAoB,EACpB,KAAgB;QAEhB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAClE,UAAU,EAAE,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAOD,OAAO;QACL,OAAO,KAAK,CAAC;IACf,CAAC;IAOD,UAAU;QACR,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE;gBACxB,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAOD,SAAS;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAOD,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAOD,iBAAiB;QACf,OAAO,IAAI,qBAAW,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAKD,MAAM,KAAK,MAAM;QACf,OAAO,cAAM,CAAC;IAChB,CAAC;IAKD,MAAM,CAAC,SAAS,CAAC,KAAa;QAC5B,MAAM,MAAM,GAAG,YAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,QAAQ,CAAC,MAAoB,CAAC,CAAC;IAC5C,CAAC;IAQD,MAAM,CAAC,cAAc,CAAC,KAAa;QACjC,MAAM,MAAM,GAAG,YAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAC1B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,GAAiB,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,MAAoB,CAAC,CAAC,CAAC;IAC3C,CAAC;IAKD,OAAO,CACL,SAAiC,SAAS,EAC1C,UAA8B,EAAE;QAEhC,MAAM,GAAG,GACP,MAAM,KAAK,UAAU;YACnB,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/B,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,OAAO,IAAA,8BAAsB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAKD,MAAM;QACJ,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACtB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,QAAQ,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAKD,QAAQ;QACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,OAAO,CAAC,QAAQ,EAAE,CAAC;SACpB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,SAAS,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,kBAAkB;QAChB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACnE,CAAC;IAED,0BAA0B,CAAC,QAAgB;QACzC,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,4BAA4B;QAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE;YACnE,OAAO,CACL,yBAAyB,GAAG,CAAC,GAAG,OAAO,CAAC,4BAA4B,EAAE,CACvE,CAAC;QACJ,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC;IAED,YAAY,CAAC,SAAkB,EAAE,KAAgC;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;SAC5D;IACH,CAAC;IAED,aAAa;QACX,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,eAAe,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,eAAe,CAAC,GAA4B;QAC1C,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,KAAY;QACxB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,iBAAiB,CAAC,CAAC;SAC7C;IACH,CAAC;IAED,cAAc;QACZ,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,gBAAgB,CAAC,CAAC;SAC5C;IACH,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,aAAa,CAAC,KAAY;QACxB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CACF;AAldD,4BAkdC;AAED,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;AAEb,uCAAiE;AACjE,kEAAyC;AACzC,+BAAmC;AAKnC,0EAAiD;AAEjD,mCAAiD;AAEjD,wBAAmC;AAEnC;;GAEG;AACU,QAAA,MAAM,GAAG;IACpB,MAAM,EAAE,kBAAkB;IAC1B,QAAQ,EAAE,oBAAoB;IAC9B,SAAS,EAAE,qBAAqB;IAChC,sBAAsB,EAAE,kCAAkC;IAC1D,cAAc,EAAE,0BAA0B;IAC1C,eAAe,EAAE,2BAA2B;IAC5C,iBAAiB,EAAE,6BAA6B;IAChD,gBAAgB,EAAE,4BAA4B;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,EAAE,GAAG,KAAK,CAAC;AAEJ,QAAA,wBAAwB,GAAG,EAAE,CAAC;AAE3C;;GAEG;AACH,MAAa,QAAS,SAAQ,uBAAY;IAcxC;;OAEG;IACH,MAAM;QACJ,uEAAuE;QACvE,+BAA+B;QAC/B,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC/C,OAAO,CAAC,MAAM,EAAE,CAAC;SAClB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,YAAY,GAAe,EAAE,MAAM,GAAG,KAAK;QACzC,KAAK,EAAE,CAAC;QAzBV,SAAI,GAAkB,IAAI,CAAC;QAC3B,aAAQ,GAAG,KAAK,CAAC;QACjB,4BAAuB,GAAG,gCAAwB,CAAC;QACnD,YAAO,GAAG,KAAK,CAAC;QAChB,sBAAiB,GAAG,KAAK,CAAC;QAsBxB,IAAI,CAAC,IAAI,GAAG,IAAI,WAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,KAAK,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,GAA0B;QAC9B,IAAI,OAAO,GAAG,EAAE,cAAc,KAAK,UAAU,EAAE;YAC7C,GAAG,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;SAC5B;QACD,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC9C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,KAAkB,CAAC,CAAC;aACzC;iBAAM,IAAI,OAAO,EAAE;gBAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAE,EAAE,GAAG,EAAE,KAAkB,CAAC,CAAC;aAC/D;iBAAM;gBACL,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAkB,CAAC,CAAC;aAC/C;YACD,OAAO,GAAG,GAAG,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACvB;QACD,KAAK,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE;gBACxC,EAAE,CAAC,MAAM,EAAE,CAAC;aACb;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,OAAgC;QAC7C,OAAO,0BAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,OAAgC;QACrD,OAAO,0BAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,4CAA4C,CAC1C,OAAsC,EAAE;QAKxC,yEAAyE;QACzE,kEAAkE;QAClE,yEAAyE;QACzE,0DAA0D;QAC1D,MAAM,+BAA+B,GACnC,0BAAe,CAAC,kDAAkD,CAChE,IAAI,EACJ,IAAI,EACJ,IAAI,CACL,CAAC;QACJ,MAAM,KAAK,GAAG;YACZ,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE;YACjB,GAAG,+BAA+B;SACnC,CAAC;QAEF,MAAM,SAAS,GAAG,0BAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE1D,OAAO;YACL,KAAK;YACL,SAAS;SACV,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAyB;QAChC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;QACnD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;YACtB,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,OAAO,SAAS,CAAC;aAClB;YACD,OAAO;gBACL,OAAO,CAAC,WAAW,KAAK,OAAO;oBAC7B,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;oBAC/B,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;YACrC,CAAC,EAAE,CAAC;SACL;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACnD,CAAC;IAED;;;;;;;;;;OAUG;IACH,gDAAgD,CAC9C,OAAsC,EAAE;QAExC,OAAO,0BAAe,CAAC,kDAAkD,CACvE,IAAI,EACJ,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,IAAI,CAAC;SACb;aAAM,IACL,OAAO,CAAC,WAAW,KAAK,OAAO;YAC/B,OAAO,CAAC,WAAW,KAAK,QAAQ,EAChC;YACA,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;SACjD;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,GAAoB,EAAE,KAAgB;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7D,UAAU,CAAC,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,GAAoB,EAAE,KAAgB;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACvD,UAAU,CAAC,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,OAAgB,EAChB,GAAoB,EACpB,KAAgB;QAEhB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAClE,UAAU,EAAE,SAAS,CAAC,gBAAa,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE;gBACxB,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,OAAO,IAAI,qBAAW,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,MAAM;QACf,OAAO,cAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAa;QAC5B,MAAM,MAAM,GAAG,YAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,QAAQ,CAAC,MAAoB,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,KAAa;QACjC,MAAM,MAAM,GAAG,YAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAC1B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,GAAiB,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,MAAoB,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,OAAO,CACL,SAAiC,SAAS,EAC1C,UAA8B,EAAE;QAEhC,MAAM,GAAG,GACP,MAAM,KAAK,UAAU;YACnB,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/B,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,OAAO,IAAA,8BAAsB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACtB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,QAAQ,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,OAAO,CAAC,QAAQ,EAAE,CAAC;SACpB;QACD,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,SAAS,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,kBAAkB;QAChB,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACnE,CAAC;IAED,0BAA0B,CAAC,QAAgB;QACzC,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,cAAM,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,4BAA4B;QAC1B,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,yBAAyB,EAAE,OAAO,EAAE,EAAE;YACnE,OAAO,CACL,yBAAyB,GAAG,CAAC,GAAG,OAAO,CAAC,4BAA4B,EAAE,CACvE,CAAC;QACJ,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC;IAED,YAAY,CAAC,SAAkB,EAAE,KAAgC;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;SAC5D;IACH,CAAC;IAED,aAAa;QACX,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,eAAe,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,eAAe,CAAC,GAA4B;QAC1C,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC9B,CAAC;IAED,aAAa,CAAC,KAAY;QACxB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,iBAAiB,CAAC,CAAC;SAC7C;IACH,CAAC;IAED,cAAc;QACZ,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,iBAAc,CAAC,gBAAgB,CAAC,CAAC;SAC5C;IACH,CAAC;IAED,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5B,CAAC;IAED,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,aAAa,CAAC,KAAY;QACxB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CACF;AAldD,4BAkdC;AAED,kBAAe,QAAQ,CAAC"}

package/dist/editor/date.d.ts

@@ -1,12 +1,48 @@
 import type { BSONValue } from '../utils';
 import StandardEditor from './standard';
 import type Element from '../element';
+/**
+ * CRUD editor for date values.
+ */
 export default class DateEditor extends StandardEditor {
+    /**
+     * Create the editor with the element.
+     *
+     * @param {Element} element - The hadron document element.
+     */
     constructor(element: Element);
+    /**
+     * Complete the date edit by converting the valid string to a date
+     * object or leaving as invalid.
+     */
     complete(): void;
+    /**
+     * Edit the element with the provided value.
+     *
+     * @param {Object} value - The new value.
+     */
     edit(value: BSONValue): void;
+    /**
+     * Get the number of characters the value should display.
+     *
+     * @param {Boolean} editMode - If the element is being edited.
+     *
+     * @returns {Number} The number of characters.
+     */
     size(editMode?: boolean): number;
+    /**
+     * Start the date edit.
+     *
+     * @param {Object} value - The value in the field.
+     */
     start(): void;
+    /**
+     * Get the value being edited.
+     *
+     * @param {Boolean} editMode - If the UI is in edit mode.
+     *
+     * @returns {String} The value.
+     */
     value(): string;
     _formattedValue(): string;
 }

package/dist/editor/date.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/editor/date.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,cAAc,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAKtC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,cAAc;gBAMxC,OAAO,EAAE,OAAO;IAQ5B,QAAQ,IAAI,IAAI;IAYhB,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IA0B5B,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM;IAehC,KAAK,IAAI,IAAI;IAcb,KAAK,IAAI,MAAM;IAQf,eAAe,IAAI,MAAM;CAU1B"}
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/editor/date.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,cAAc,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,cAAc;IACpD;;;;OAIG;gBACS,OAAO,EAAE,OAAO;IAI5B;;;OAGG;IACH,QAAQ,IAAI,IAAI;IAOhB;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAmB5B;;;;;;OAMG;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM;IAUhC;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAOb;;;;;;OAMG;IACH,KAAK,IAAI,MAAM;IAQf,eAAe,IAAI,MAAM;CAU1B"}

package/dist/editor/date.js

@@ -7,16 +7,33 @@ const hadron_type_checker_1 = __importDefault(require("hadron-type-checker"));
 const element_events_1 = __importDefault(require("../element-events"));
 const utils_1 = require("../utils");
 const standard_1 = __importDefault(require("./standard"));
+/**
+ * CRUD editor for date values.
+ */
 class DateEditor extends standard_1.default {
+    /**
+     * Create the editor with the element.
+     *
+     * @param {Element} element - The hadron document element.
+     */
     constructor(element) {
         super(element);
     }
+    /**
+     * Complete the date edit by converting the valid string to a date
+     * object or leaving as invalid.
+     */
     complete() {
         super.complete();
         if (this.element.isCurrentTypeValid()) {
             this.element.edit(hadron_type_checker_1.default.cast(this._formattedValue(), 'Date'));
         }
     }
+    /**
+     * Edit the element with the provided value.
+     *
+     * @param {Object} value - The new value.
+     */
     edit(value) {
         try {
             const date = hadron_type_checker_1.default.cast(value, 'Date');
@@ -33,6 +50,13 @@ class DateEditor extends standard_1.default {
             this.element.setInvalid(value, this.element.currentType, e.message);
         }
     }
+    /**
+     * Get the number of characters the value should display.
+     *
+     * @param {Boolean} editMode - If the element is being edited.
+     *
+     * @returns {Number} The number of characters.
+     */
     size(editMode) {
         const value = this.element.currentValue;
         if (editMode) {
@@ -42,12 +66,24 @@ class DateEditor extends standard_1.default {
             ? (0, utils_1.fieldStringLen)(this._formattedValue())
             : (0, utils_1.fieldStringLen)(value);
     }
+    /**
+     * Start the date edit.
+     *
+     * @param {Object} value - The value in the field.
+     */
     start() {
         super.start();
         if (this.element.isCurrentTypeValid()) {
             this.edit(this._formattedValue());
         }
     }
+    /**
+     * Get the value being edited.
+     *
+     * @param {Boolean} editMode - If the UI is in edit mode.
+     *
+     * @returns {String} The value.
+     */
     value() {
         const value = this.element.currentValue;
         if (!this.editing && this.element.isCurrentTypeValid()) {
@@ -56,6 +92,8 @@ class DateEditor extends standard_1.default {
         return String(value);
     }
     _formattedValue() {
+        // BSON Date are uint64_t ms, JS Date only supports float64 ms,
+        // so some valid BSON Dates are not representable in JS.
         const date = new Date(this.element.currentValue);
         try {
             return date.toISOString().replace('Z', '+00:00');