treeloom 0.0.0-stage → 2.1.0

package/dist/diff/elementHasAttribute.js

@@ -0,0 +1,70 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const getAssignedStyles_1 = __importDefault(require("./getAssignedStyles"));
+const si_funciona_1 = __importDefault(require("si-funciona"));
+/**
+ * For attributes which are objects or multi-part strings -1 = remove attribute, 0 = no change, 1 = add attribute
+ * @param element
+ * @param attr
+ */
+const checkStyles = (element, attr = {}) => {
+  const assignedStyles = (0, getAssignedStyles_1.default)(element.style) ?? {};
+  if (si_funciona_1.default.emptyObject(assignedStyles)) {
+    return 1;
+  }
+  return si_funciona_1.default.compareArrays(Object.keys(attr).map(si_funciona_1.default.kabobCase), Object.keys(assignedStyles));
+};
+/**
+ * For attributes which are objects or multi-part strings -1 = remove attribute, 0 = no change, 1 = add attribute
+ * @param element
+ * @param attr
+ */
+const checkClasses = (element, attr = '') => {
+  if (typeof attr !== 'string') {
+    // Somehow an empty object got in here one time
+    attr = '';
+  }
+  const assignedClasses = Array.from(element.classList);
+  if (!assignedClasses.length) {
+    return 1;
+  }
+  return si_funciona_1.default.compareArrays(attr.split(' '), assignedClasses);
+};
+/**
+ * Check if the provided Element has the provided attributes.
+ * Returns a boolean, or an array of 1 / 0 / -1 based on the comparison status.
+ * @param element - Receive the element to be assessed
+ * @param key - The attribute name to search for
+ * @param attr - The expected value of the attribute to compare against
+ */
+const elementHasAttribute = (element, key, attr) => {
+  if (!element) {
+    return 1;
+  }
+  if (key === 'style') {
+    return checkStyles(element, attr);
+  }
+  if (key === 'class') {
+    return checkClasses(element, attr);
+  }
+  const kabobKey = si_funciona_1.default.kabobCase(key);
+  if (!element.hasAttribute(kabobKey)) {
+    return 1;
+  }
+  if (element.getAttribute(kabobKey) === attr) {
+    return 0;
+  }
+  return 1;
+};
+exports.default = elementHasAttribute;

package/dist/diff/elementHasAttribute.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const getAssignedStyles_1=__importDefault(require("./getAssignedStyles")),si_funciona_1=__importDefault(require("si-funciona")),checkStyles=(e,t={})=>{const s=(0,getAssignedStyles_1.default)(e.style)??{};return si_funciona_1.default.emptyObject(s)?1:si_funciona_1.default.compareArrays(Object.keys(t).map(si_funciona_1.default.kabobCase),Object.keys(s))},checkClasses=(e,t="")=>{"string"!=typeof t&&(t="");const s=Array.from(e.classList);return s.length?si_funciona_1.default.compareArrays(t.split(" "),s):1},elementHasAttribute=(e,t,s)=>{if(!e)return 1;if("style"===t)return checkStyles(e,s);if("class"===t)return checkClasses(e,s);const r=si_funciona_1.default.kabobCase(t);return e.hasAttribute(r)&&e.getAttribute(r)===s?0:1};exports.default=elementHasAttribute;

package/dist/diff/getAssignedStyles.d.ts

@@ -0,0 +1,9 @@
+import type { StyleValues } from '../domItem/types';
+/**
+ * Get all the styles which have been assigned to this element. Assigned styles are indicated as numeric-key
+ * properties with a value indicating the string-key property which has been assigned. The string-key properties
+ * have the assigned values.
+ * @param elementStyles
+ */
+declare const getAssignedStyles: (elementStyles: CSSStyleDeclaration | StyleValues) => StyleValues;
+export default getAssignedStyles;

package/dist/diff/getAssignedStyles.js

@@ -0,0 +1,22 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const si_funciona_1 = __importDefault(require("si-funciona"));
+/**
+ * Get all the styles which have been assigned to this element. Assigned styles are indicated as numeric-key
+ * properties with a value indicating the string-key property which has been assigned. The string-key properties
+ * have the assigned values.
+ * @param elementStyles
+ */
+const getAssignedStyles = elementStyles => si_funciona_1.default.reduceObject(elementStyles, (styles, attr, key) => Number.isNaN(Number(key)) ? styles : si_funciona_1.default.setValue(attr, elementStyles[attr], styles), {});
+exports.default = getAssignedStyles;

package/dist/diff/getAssignedStyles.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const si_funciona_1=__importDefault(require("si-funciona")),getAssignedStyles=e=>si_funciona_1.default.reduceObject(e,(t,u,s)=>Number.isNaN(Number(s))?t:si_funciona_1.default.setValue(u,e[u],t),{});exports.default=getAssignedStyles;

package/dist/diff/index.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    createChangeList: ({ removed, added }?: Partial<Pick<import("./types").ChangeList, "removed" | "added">>) => import("./types").ChangeList;
+    domItemChanges: (domItem: import("../domItem/types").DomItem) => import("./types").ChangeList;
+    domItemHasAttribute: (domItem: import("../domItem/types").DomItem, key: string, attr: unknown) => import("./types").AttributeComparison;
+    elementChanges: (domItem: import("../domItem/types").DomItem) => import("./types").ChangeList;
+    elementHasAttribute: (element: HTMLElement | null | undefined, key: string, attr: unknown) => import("./types").AttributeComparison;
+    getAssignedStyles: (elementStyles: CSSStyleDeclaration | import("../domItem/types").StyleValues) => import("../domItem/types").StyleValues;
+};
+export default _default;

package/dist/diff/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const createChangeList_1 = __importDefault(require("./createChangeList"));
+const domItemChanges_1 = __importDefault(require("./domItemChanges"));
+const domItemHasAttribute_1 = __importDefault(require("./domItemHasAttribute"));
+const elementChanges_1 = __importDefault(require("./elementChanges"));
+const elementHasAttribute_1 = __importDefault(require("./elementHasAttribute"));
+const getAssignedStyles_1 = __importDefault(require("./getAssignedStyles"));
+exports.default = {
+  createChangeList: createChangeList_1.default,
+  domItemChanges: domItemChanges_1.default,
+  domItemHasAttribute: domItemHasAttribute_1.default,
+  elementChanges: elementChanges_1.default,
+  elementHasAttribute: elementHasAttribute_1.default,
+  getAssignedStyles: getAssignedStyles_1.default
+};

package/dist/diff/index.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const createChangeList_1=__importDefault(require("./createChangeList")),domItemChanges_1=__importDefault(require("./domItemChanges")),domItemHasAttribute_1=__importDefault(require("./domItemHasAttribute")),elementChanges_1=__importDefault(require("./elementChanges")),elementHasAttribute_1=__importDefault(require("./elementHasAttribute")),getAssignedStyles_1=__importDefault(require("./getAssignedStyles"));exports.default={createChangeList:createChangeList_1.default,domItemChanges:domItemChanges_1.default,domItemHasAttribute:domItemHasAttribute_1.default,elementChanges:elementChanges_1.default,elementHasAttribute:elementHasAttribute_1.default,getAssignedStyles:getAssignedStyles_1.default};

package/dist/diff/types.d.ts

@@ -0,0 +1,17 @@
+import type { compareArrayResultMap } from 'si-funciona/dist/helpers/arrays/compareArrays';
+/** An object whose keys are dot notated paths (attributes.style.color) and whose values are what is at that path. */
+export type DotNotated = Record<string, any>;
+/** Which of the two lists a change is appended to. */
+export type ChangeType = 'added' | 'removed';
+/** What has to be added and removed to make one side match the other. */
+export type ChangeList = {
+    removed: DotNotated;
+    added: DotNotated;
+    /** Merge more changes into the removed or added list, and return the merged list. */
+    appendChanges: (changeType: ChangeType, changes: DotNotated) => DotNotated;
+};
+/**
+ * The outcome of comparing one attribute: 0 when it is the same, 1 when it is missing or different, or - for the
+ * multi-part attributes (style, class) - the list of what each part of it looks like (see compareArrays).
+ */
+export type AttributeComparison = 0 | 1 | compareArrayResultMap;

package/dist/diff/types.js

@@ -0,0 +1,8 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/diff/types.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/domItem/index.d.ts

@@ -0,0 +1,34 @@
+declare const _default: {
+    addDomItemProperties: (item: import("./types").DomItemConfig) => import("./types").DomItem;
+    appendChild: (parent: import("./types").DomItem, child: import("./types").DomItem) => import("./types").DomItem;
+    createCoreItem: (item?: import("./types").DomItemConfig) => import("./types").CoreItem;
+    createDomItem: (item?: import("./types").DomItemConfig) => import("./types").DomItem;
+    defineTrait: (name: string, definition: import("./types").TraitDefinition) => import("./types").TraitDefinition;
+    documentDomItem: (listeners?: Record<string, import("../events/types").ListenerFunction>, rootItem?: import("./types").DomItemRoot) => import("./types").DomItemRoot;
+    getDocumentItem: () => import("./types").DomItemRoot;
+    gatherChildItems: (item: import("./types").DomItem, test: import("./types").ChildTest) => import("./types").DomItem[];
+    getChildrenByClass: (className: string, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getChildrenByName: (name: string, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getChildrenFromAttribute: (attr: string, value: unknown, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getChildTest: (attr: string, value: unknown) => import("./types").ChildTest;
+    getItemByElement: (item: import("./types").DomItem, element: EventTarget | null) => import("./types").DomItem | null;
+    getItemById: (root: import("./types").DomItemRoot, id: number) => import("./types").DomItem;
+    getItemByPath: (root: import("./types").DomItem, path: import("./types").ItemPath) => import("./types").DomItem;
+    getItemPath: (item: import("./types").DomItem) => import("./types").ItemPath;
+    getParentsByClass: (className: string, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getParentsByName: (name: string, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getParentsByTagName: (nodeName: string, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getParentsFromAttribute: (attr: string, value: unknown, item?: import("./types").DomItem) => import("./types").DomItem[];
+    getTopParentItem: (item: import("./types").DomItem) => import("./types").DomItemRoot;
+    getTraitDefinition: (name: string) => import("./types").TraitDefinition | undefined;
+    hasTrait: <Trait extends import("./types").TraitName>(item: import("./types").CoreItem, trait: Trait) => item is import("./types").CoreItem & import("./types").WithTraits<Trait>;
+    hasTraits: <Trait extends import("./types").TraitName>(item: import("./types").CoreItem, ...traits: Trait[]) => item is import("./types").CoreItem & import("./types").WithTraits<Trait>;
+    initChildren: () => import("./types").DomItem[];
+    initRoot: (children?: import("./types").DomItem[], listeners?: Record<string, import("../events/types").ListenerFunction>) => import("./types").DomItemRoot;
+    insertChild: (parent: import("./types").DomItem, child: import("./types").DomItem, index: number) => import("./types").DomItem;
+    isDomItem: (item: import("./types").CoreItem) => item is import("./types").DomItem;
+    removeChild: (parent: import("./types").DomItem, child: import("./types").DomItem) => import("./types").DomItem[];
+    setParentItemReferences: (item: import("./types").DomItem) => import("./types").DomItem;
+    withTrait: <Item extends import("./types").CoreItem, Trait extends import("./types").TraitName>(item: Item, trait: Trait, data: import("./types").TraitRegistry[Trait]) => Item & import("./types").WithTraits<Trait>;
+};
+export default _default;

package/dist/domItem/index.js

@@ -0,0 +1,81 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+/**
+ * Core Virtual DOM (DomItem tree) management: building items, the traits they carry, and finding and changing
+ * items in a tree.
+ */
+const addDomItemProperties_1 = __importDefault(require("./objects/addDomItemProperties"));
+const appendChild_1 = __importDefault(require("./tree/appendChild"));
+const createCoreItem_1 = __importDefault(require("./objects/createCoreItem"));
+const createDomItem_1 = __importDefault(require("./objects/createDomItem"));
+const defineTrait_1 = __importDefault(require("./traits/defineTrait"));
+const documentDomItem_1 = __importDefault(require("./objects/documentDomItem"));
+const documentItem_1 = __importDefault(require("./objects/documentItem"));
+const gatherChildItems_1 = __importDefault(require("./query/gatherChildItems"));
+const getChildrenByClass_1 = __importDefault(require("./query/getChildrenByClass"));
+const getChildrenByName_1 = __importDefault(require("./query/getChildrenByName"));
+const getChildrenFromAttribute_1 = __importDefault(require("./query/getChildrenFromAttribute"));
+const getChildTest_1 = __importDefault(require("./query/getChildTest"));
+const getItemByElement_1 = __importDefault(require("./query/getItemByElement"));
+const itemIdIndex_1 = require("./tree/itemIdIndex");
+const getItemByPath_1 = __importDefault(require("./tree/getItemByPath"));
+const getItemPath_1 = __importDefault(require("./tree/getItemPath"));
+const getParentsByClass_1 = __importDefault(require("./query/getParentsByClass"));
+const getParentsByName_1 = __importDefault(require("./query/getParentsByName"));
+const getParentsByTagName_1 = __importDefault(require("./query/getParentsByTagName"));
+const getParentsFromAttribute_1 = __importDefault(require("./query/getParentsFromAttribute"));
+const getTopParentItem_1 = __importDefault(require("./tree/getTopParentItem"));
+const getTraitDefinition_1 = __importDefault(require("./traits/getTraitDefinition"));
+const hasTrait_1 = __importDefault(require("./traits/hasTrait"));
+const hasTraits_1 = __importDefault(require("./traits/hasTraits"));
+const initChildren_1 = __importDefault(require("./objects/initChildren"));
+const initRoot_1 = __importDefault(require("./objects/initRoot"));
+const insertChild_1 = __importDefault(require("./tree/insertChild"));
+const isDomItem_1 = __importDefault(require("./traits/isDomItem"));
+const removeChild_1 = __importDefault(require("./tree/removeChild"));
+const setParentItemReferences_1 = __importDefault(require("./tree/setParentItemReferences"));
+const withTrait_1 = __importDefault(require("./traits/withTrait"));
+exports.default = {
+  addDomItemProperties: addDomItemProperties_1.default,
+  appendChild: appendChild_1.default,
+  createCoreItem: createCoreItem_1.default,
+  createDomItem: createDomItem_1.default,
+  defineTrait: defineTrait_1.default,
+  documentDomItem: documentDomItem_1.default,
+  getDocumentItem: documentItem_1.default,
+  gatherChildItems: gatherChildItems_1.default,
+  getChildrenByClass: getChildrenByClass_1.default,
+  getChildrenByName: getChildrenByName_1.default,
+  getChildrenFromAttribute: getChildrenFromAttribute_1.default,
+  getChildTest: getChildTest_1.default,
+  getItemByElement: getItemByElement_1.default,
+  getItemById: itemIdIndex_1.getItemById,
+  getItemByPath: getItemByPath_1.default,
+  getItemPath: getItemPath_1.default,
+  getParentsByClass: getParentsByClass_1.default,
+  getParentsByName: getParentsByName_1.default,
+  getParentsByTagName: getParentsByTagName_1.default,
+  getParentsFromAttribute: getParentsFromAttribute_1.default,
+  getTopParentItem: getTopParentItem_1.default,
+  getTraitDefinition: getTraitDefinition_1.default,
+  hasTrait: hasTrait_1.default,
+  hasTraits: hasTraits_1.default,
+  initChildren: initChildren_1.default,
+  initRoot: initRoot_1.default,
+  insertChild: insertChild_1.default,
+  isDomItem: isDomItem_1.default,
+  removeChild: removeChild_1.default,
+  setParentItemReferences: setParentItemReferences_1.default,
+  withTrait: withTrait_1.default
+};

package/dist/domItem/index.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const addDomItemProperties_1=__importDefault(require("./objects/addDomItemProperties")),appendChild_1=__importDefault(require("./tree/appendChild")),createCoreItem_1=__importDefault(require("./objects/createCoreItem")),createDomItem_1=__importDefault(require("./objects/createDomItem")),defineTrait_1=__importDefault(require("./traits/defineTrait")),documentDomItem_1=__importDefault(require("./objects/documentDomItem")),documentItem_1=__importDefault(require("./objects/documentItem")),gatherChildItems_1=__importDefault(require("./query/gatherChildItems")),getChildrenByClass_1=__importDefault(require("./query/getChildrenByClass")),getChildrenByName_1=__importDefault(require("./query/getChildrenByName")),getChildrenFromAttribute_1=__importDefault(require("./query/getChildrenFromAttribute")),getChildTest_1=__importDefault(require("./query/getChildTest")),getItemByElement_1=__importDefault(require("./query/getItemByElement")),itemIdIndex_1=require("./tree/itemIdIndex"),getItemByPath_1=__importDefault(require("./tree/getItemByPath")),getItemPath_1=__importDefault(require("./tree/getItemPath")),getParentsByClass_1=__importDefault(require("./query/getParentsByClass")),getParentsByName_1=__importDefault(require("./query/getParentsByName")),getParentsByTagName_1=__importDefault(require("./query/getParentsByTagName")),getParentsFromAttribute_1=__importDefault(require("./query/getParentsFromAttribute")),getTopParentItem_1=__importDefault(require("./tree/getTopParentItem")),getTraitDefinition_1=__importDefault(require("./traits/getTraitDefinition")),hasTrait_1=__importDefault(require("./traits/hasTrait")),hasTraits_1=__importDefault(require("./traits/hasTraits")),initChildren_1=__importDefault(require("./objects/initChildren")),initRoot_1=__importDefault(require("./objects/initRoot")),insertChild_1=__importDefault(require("./tree/insertChild")),isDomItem_1=__importDefault(require("./traits/isDomItem")),removeChild_1=__importDefault(require("./tree/removeChild")),setParentItemReferences_1=__importDefault(require("./tree/setParentItemReferences")),withTrait_1=__importDefault(require("./traits/withTrait"));exports.default={addDomItemProperties:addDomItemProperties_1.default,appendChild:appendChild_1.default,createCoreItem:createCoreItem_1.default,createDomItem:createDomItem_1.default,defineTrait:defineTrait_1.default,documentDomItem:documentDomItem_1.default,getDocumentItem:documentItem_1.default,gatherChildItems:gatherChildItems_1.default,getChildrenByClass:getChildrenByClass_1.default,getChildrenByName:getChildrenByName_1.default,getChildrenFromAttribute:getChildrenFromAttribute_1.default,getChildTest:getChildTest_1.default,getItemByElement:getItemByElement_1.default,getItemById:itemIdIndex_1.getItemById,getItemByPath:getItemByPath_1.default,getItemPath:getItemPath_1.default,getParentsByClass:getParentsByClass_1.default,getParentsByName:getParentsByName_1.default,getParentsByTagName:getParentsByTagName_1.default,getParentsFromAttribute:getParentsFromAttribute_1.default,getTopParentItem:getTopParentItem_1.default,getTraitDefinition:getTraitDefinition_1.default,hasTrait:hasTrait_1.default,hasTraits:hasTraits_1.default,initChildren:initChildren_1.default,initRoot:initRoot_1.default,insertChild:insertChild_1.default,isDomItem:isDomItem_1.default,removeChild:removeChild_1.default,setParentItemReferences:setParentItemReferences_1.default,withTrait:withTrait_1.default};

package/dist/domItem/objects/addDomItemProperties.d.ts

@@ -0,0 +1,7 @@
+import type { DomItem, DomItemConfig } from '../types';
+/**
+ * Ensure all basic properties of the DomItem are present.
+ * @param item - The object that will be formatted as a DomItem.
+ */
+declare const addDomItemProperties: (item: DomItemConfig) => DomItem;
+export default addDomItemProperties;

package/dist/domItem/objects/addDomItemProperties.js

@@ -0,0 +1,27 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const createDomItem_1 = __importDefault(require("./createDomItem"));
+/**
+ * Ensure all basic properties of the DomItem are present.
+ * @param item - The object that will be formatted as a DomItem.
+ */
+const addDomItemProperties = item => {
+  if (typeof item.children !== 'undefined') {
+    item.children.forEach(child => {
+      addDomItemProperties(child);
+    });
+  }
+  return (0, createDomItem_1.default)(item);
+};
+exports.default = addDomItemProperties;

package/dist/domItem/objects/addDomItemProperties.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const createDomItem_1=__importDefault(require("./createDomItem")),addDomItemProperties=e=>(void 0!==e.children&&e.children.forEach(e=>{addDomItemProperties(e)}),(0,createDomItem_1.default)(e));exports.default=addDomItemProperties;

package/dist/domItem/objects/createCoreItem.d.ts

@@ -0,0 +1,9 @@
+import type { CoreItem, DomItemConfig } from '../types';
+/**
+ * Create the generic item, without the render trait. Every property which is not given gets its default. The given
+ * object is completed and returned (it is not copied). Children which are plain objects are completed the same way, all
+ * the way down; a child which already has a has map is taken to be complete and is left alone.
+ * @param item - Item-like object to be formatted as a CoreItem
+ */
+declare const createCoreItem: (item?: DomItemConfig) => CoreItem;
+export default createCoreItem;

package/dist/domItem/objects/createCoreItem.js

@@ -0,0 +1,53 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const si_funciona_1 = __importDefault(require("si-funciona"));
+const appendChild_1 = __importDefault(require("../tree/appendChild"));
+const removeChild_1 = __importDefault(require("../tree/removeChild"));
+const itemIdIndex_1 = require("../tree/itemIdIndex");
+/**
+ * Create the generic item, without the render trait. Every property which is not given gets its default. The given
+ * object is completed and returned (it is not copied). Children which are plain objects are completed the same way, all
+ * the way down; a child which already has a has map is taken to be complete and is left alone.
+ * @param item - Item-like object to be formatted as a CoreItem
+ */
+const createCoreItem = (item = {}) => {
+  if (Array.isArray(item.children)) {
+    item.children.forEach(child => {
+      if (typeof child === 'object' && child !== null && !child.has) {
+        createCoreItem(child);
+      }
+    });
+  }
+  const newItem = si_funciona_1.default.reduceObject({
+    attributes: {},
+    children: [],
+    eventListeners: {},
+    has: {},
+    id: (0, itemIdIndex_1.generateItemId)(),
+    jsonExclusions: [],
+    nodeName: 'div',
+    nodeValue: null,
+    parentItem: null
+  }, (coreItem, defaultValue, prop) => {
+    if (!(prop in coreItem)) {
+      coreItem[prop] = defaultValue;
+      return coreItem;
+    }
+    return coreItem;
+  }, item);
+  newItem.appendChild = si_funciona_1.default.curry(appendChild_1.default)(newItem);
+  newItem.removeChild = si_funciona_1.default.curry(removeChild_1.default)(newItem);
+  return newItem;
+};
+exports.default = createCoreItem;

package/dist/domItem/objects/createCoreItem.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const si_funciona_1=__importDefault(require("si-funciona")),appendChild_1=__importDefault(require("../tree/appendChild")),removeChild_1=__importDefault(require("../tree/removeChild")),itemIdIndex_1=require("../tree/itemIdIndex"),createCoreItem=(e={})=>{Array.isArray(e.children)&&e.children.forEach(e=>{"object"!=typeof e||null===e||e.has||createCoreItem(e)});const r=si_funciona_1.default.reduceObject({attributes:{},children:[],eventListeners:{},has:{},id:(0,itemIdIndex_1.generateItemId)(),jsonExclusions:[],nodeName:"div",nodeValue:null,parentItem:null},(e,r,t)=>(t in e||(e[t]=r),e),e);return r.appendChild=si_funciona_1.default.curry(appendChild_1.default)(r),r.removeChild=si_funciona_1.default.curry(removeChild_1.default)(r),r};exports.default=createCoreItem;

package/dist/domItem/objects/createDomItem.d.ts

@@ -0,0 +1,10 @@
+import type { DomItem, DomItemConfig } from '../types';
+/**
+ * This is the basic Object for representing a node in treeloom's Virtual DOM (DomItem tree): a generic item (see
+ * {@link createCoreItem}) with the render trait. All incoming attributes will be merged to the specified format, and the
+ * given object is completed and returned (it is not copied). Children which are plain objects are completed the same way,
+ * all the way down; a child which already has a has map is already an item, and is left alone.
+ * @param item - DomItem-like object to be formatted as DomItem
+ */
+declare const createDomItem: (item?: DomItemConfig) => DomItem;
+export default createDomItem;

package/dist/domItem/objects/createDomItem.js

@@ -0,0 +1,40 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const createCoreItem_1 = __importDefault(require("./createCoreItem"));
+const withTrait_1 = __importDefault(require("../traits/withTrait"));
+/**
+ * A plain child is an object which is not an item yet (an item always has a has map).
+ * @private
+ */
+const isPlainChild = child => typeof child === 'object' && child !== null && !child.has;
+/**
+ * This is the basic Object for representing a node in treeloom's Virtual DOM (DomItem tree): a generic item (see
+ * {@link createCoreItem}) with the render trait. All incoming attributes will be merged to the specified format, and the
+ * given object is completed and returned (it is not copied). Children which are plain objects are completed the same way,
+ * all the way down; a child which already has a has map is already an item, and is left alone.
+ * @param item - DomItem-like object to be formatted as DomItem
+ */
+const createDomItem = (item = {}) => {
+  if (Array.isArray(item.children)) {
+    item.children.forEach(child => {
+      if (isPlainChild(child)) {
+        createDomItem(child);
+      }
+    });
+  }
+  return (0, withTrait_1.default)((0, createCoreItem_1.default)(item), 'render', {
+    element: item.element ?? null
+  });
+};
+exports.default = createDomItem;

package/dist/domItem/objects/createDomItem.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const createCoreItem_1=__importDefault(require("./createCoreItem")),withTrait_1=__importDefault(require("../traits/withTrait")),isPlainChild=e=>"object"==typeof e&&null!==e&&!e.has,createDomItem=(e={})=>(Array.isArray(e.children)&&e.children.forEach(e=>{isPlainChild(e)&&createDomItem(e)}),(0,withTrait_1.default)((0,createCoreItem_1.default)(e),"render",{element:e.element??null}));exports.default=createDomItem;

package/dist/domItem/objects/documentDomItem.d.ts

@@ -0,0 +1,12 @@
+import type { DomItemRoot } from '../types';
+import type { ListenerFunction } from '../../events/types';
+/**
+ * Return the root DomItem of a Virtual DOM (DomItem tree) for the document. The rootItem argument is a system
+ * variable and not necessary to implement.
+ * @param listeners - An object of all event
+ * listeners to be registered in the Dom
+ * @param rootItem - This is a
+ * reference to DomItemRoot which will be defaulted with {@link initRoot}
+ */
+declare const documentDomItem: (listeners?: Record<string, ListenerFunction>, rootItem?: DomItemRoot) => DomItemRoot;
+export default documentDomItem;

package/dist/domItem/objects/documentDomItem.js

@@ -0,0 +1,36 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const createDomItem_1 = __importDefault(require("./createDomItem"));
+const initChildren_1 = __importDefault(require("./initChildren"));
+const initRoot_1 = __importDefault(require("./initRoot"));
+const updateDomItems_1 = __importDefault(require("../../sync/updateDomItems"));
+/**
+ * Return the root DomItem of a Virtual DOM (DomItem tree) for the document. The rootItem argument is a system
+ * variable and not necessary to implement.
+ * @param listeners - An object of all event
+ * listeners to be registered in the Dom
+ * @param rootItem - This is a
+ * reference to DomItemRoot which will be defaulted with {@link initRoot}
+ */
+const documentDomItem = (listeners = {}, rootItem = (0, initRoot_1.default)((0, initChildren_1.default)(), listeners)) => {
+  rootItem.children = rootItem.children.map(child => (0, createDomItem_1.default)(child));
+  rootItem.children.map(child => {
+    child.parentItem = rootItem;
+    return child;
+  });
+  rootItem.head = rootItem.children[0];
+  rootItem.body = rootItem.children[1];
+  return (0, updateDomItems_1.default)((0, createDomItem_1.default)(rootItem));
+};
+exports.default = documentDomItem;

package/dist/domItem/objects/documentDomItem.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const createDomItem_1=__importDefault(require("./createDomItem")),initChildren_1=__importDefault(require("./initChildren")),initRoot_1=__importDefault(require("./initRoot")),updateDomItems_1=__importDefault(require("../../sync/updateDomItems")),documentDomItem=(e={},t=(0,initRoot_1.default)((0,initChildren_1.default)(),e))=>(t.children=t.children.map(e=>(0,createDomItem_1.default)(e)),t.children.map(e=>(e.parentItem=t,e)),t.head=t.children[0],t.body=t.children[1],(0,updateDomItems_1.default)((0,createDomItem_1.default)(t)));exports.default=documentDomItem;

package/dist/domItem/objects/documentItem.d.ts

@@ -0,0 +1,18 @@
+import type { DomItemRoot } from '../types';
+/**
+ * The shared root DomItem of the Virtual DOM (DomItem tree) for this environment's real document. It is built on the
+ * first call, not when treeloom loads, so treeloom can be required where there is no document (Node, a server) as
+ * long as nothing asks for it. Every later call returns the same root.
+ * @returns {DomItemRoot}
+ */
+declare const getDocumentItem: () => DomItemRoot;
+/**
+ * Add the public `documentItem` property to an API object: a getter, so the root is still only built when it is first
+ * read. Added after the API is assembled, since Object.assign would read (and so build) it.
+ * @param api The assembled API object
+ * @returns {T & { readonly documentItem: DomItemRoot }} The same object
+ */
+export declare const withDocumentItem: <T extends object>(api: T) => T & {
+    readonly documentItem: DomItemRoot;
+};
+export default getDocumentItem;

package/dist/domItem/objects/documentItem.js

@@ -0,0 +1,40 @@
+"use strict";
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withDocumentItem = void 0;
+const documentDomItem_1 = __importDefault(require("./documentDomItem"));
+let existingItem = null;
+/**
+ * The shared root DomItem of the Virtual DOM (DomItem tree) for this environment's real document. It is built on the
+ * first call, not when treeloom loads, so treeloom can be required where there is no document (Node, a server) as
+ * long as nothing asks for it. Every later call returns the same root.
+ * @returns {DomItemRoot}
+ */
+const getDocumentItem = () => {
+  if (existingItem === null) {
+    existingItem = (0, documentDomItem_1.default)();
+  }
+  return existingItem;
+};
+/**
+ * Add the public `documentItem` property to an API object: a getter, so the root is still only built when it is first
+ * read. Added after the API is assembled, since Object.assign would read (and so build) it.
+ * @param api The assembled API object
+ * @returns {T & { readonly documentItem: DomItemRoot }} The same object
+ */
+const withDocumentItem = api => Object.defineProperty(api, 'documentItem', {
+  enumerable: true,
+  get: getDocumentItem
+});
+exports.withDocumentItem = withDocumentItem;
+exports.default = getDocumentItem;

package/dist/domItem/objects/documentItem.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.withDocumentItem=void 0;const documentDomItem_1=__importDefault(require("./documentDomItem"));let existingItem=null;const getDocumentItem=()=>(null===existingItem&&(existingItem=(0,documentDomItem_1.default)()),existingItem),withDocumentItem=e=>Object.defineProperty(e,"documentItem",{enumerable:!0,get:getDocumentItem});exports.withDocumentItem=withDocumentItem,exports.default=getDocumentItem;

package/dist/domItem/objects/initChildren.d.ts

@@ -0,0 +1,6 @@
+import type { DomItem } from '../types';
+/**
+ * Initiate the children of Root / DocumentItem. This is a helper for {@link documentDomItem}.
+ */
+declare const initChildren: () => DomItem[];
+export default initChildren;