treeloom 0.0.0-stage → 2.0.0

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;

package/dist/domItem/objects/initChildren.js

@@ -0,0 +1,44 @@
+"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 onBodyLoad_1 = __importDefault(require("si-funciona/dist/helpers/functions/onBodyLoad"));
+/**
+ * Initiate the children of Root / DocumentItem. This is a helper for {@link documentDomItem}.
+ */
+const initChildren = () => {
+  const head = document.head;
+  const body = document.body;
+  const children = [(0, createDomItem_1.default)({
+    nodeName: 'head',
+    attributes: {},
+    element: head,
+    children: []
+  }), (0, createDomItem_1.default)({
+    nodeName: 'body',
+    attributes: {},
+    element: body,
+    children: []
+  })];
+  if (!head || !body) {
+    (0, onBodyLoad_1.default)(() => {
+      if (children[1].element === null) {
+        children[0].element = document.head;
+        children[1].element = document.body;
+      }
+      return children;
+    });
+  }
+  return children;
+};
+exports.default = initChildren;

package/dist/domItem/objects/initChildren.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")),onBodyLoad_1=__importDefault(require("si-funciona/dist/helpers/functions/onBodyLoad")),initChildren=()=>{const e=document.head,t=document.body,o=[(0,createDomItem_1.default)({nodeName:"head",attributes:{},element:e,children:[]}),(0,createDomItem_1.default)({nodeName:"body",attributes:{},element:t,children:[]})];return e&&t||(0,onBodyLoad_1.default)(()=>(null===o[1].element&&(o[0].element=document.head,o[1].element=document.body),o)),o};exports.default=initChildren;

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

@@ -0,0 +1,9 @@
+import type { DomItem, DomItemRoot } from '../types';
+import type { ListenerFunction } from '../../events/types';
+/**
+ * Initiate the Root for DocumentItem. This is primary a helper for {@link documentDomItem}.
+ * @param children - Provide an array of Head and Body (usually via {@link initChildren})
+ * @param listeners - An object of all event listeners to be registered in the Dom
+ */
+declare const initRoot: (children?: DomItem[], listeners?: Record<string, ListenerFunction>) => DomItemRoot;
+export default initRoot;

package/dist/domItem/objects/initRoot.js

@@ -0,0 +1,32 @@
+"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"));
+/**
+ * Initiate the Root for DocumentItem. This is primary a helper for {@link documentDomItem}.
+ * @param children - Provide an array of Head and Body (usually via {@link initChildren})
+ * @param listeners - An object of all event listeners to be registered in the Dom
+ */
+const initRoot = (children = [{}, {}], listeners = {}) => (0, createDomItem_1.default)({
+  nodeName: '#document',
+  nodeValue: null,
+  attributes: {},
+  element: document,
+  eventActions: listeners,
+  eventListeners: {},
+  children,
+  parentItem: {},
+  head: children[0],
+  body: children[1]
+});
+exports.default = initRoot;

package/dist/domItem/objects/initRoot.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")),initRoot=(e=[{},{}],t={})=>(0,createDomItem_1.default)({nodeName:"#document",nodeValue:null,attributes:{},element:document,eventActions:t,eventListeners:{},children:e,parentItem:{},head:e[0],body:e[1]});exports.default=initRoot;

package/dist/domItem/query/gatherChildItems.d.ts

@@ -0,0 +1,12 @@
+import type { ChildTest, DomItem } from '../types';
+/**
+ * A selector function for retrieving existing child domGeneral.DomItems from the given parent item.
+ * This function will check all the children starting from and including item, and run the test function on each
+ * child encountered. The return array contains children returned from the test from all levels.
+ * WARNING: This is a recursive function.
+ * @param item - The DomItem which may have child items matching the attribute
+ * criteria
+ * @param test - Assess each child, and return the ones which qualify
+ */
+declare const gatherChildItems: (item: DomItem, test: ChildTest) => DomItem[];
+export default gatherChildItems;

package/dist/domItem/query/gatherChildItems.js

@@ -0,0 +1,19 @@
+"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
+});
+/**
+ * A selector function for retrieving existing child domGeneral.DomItems from the given parent item.
+ * This function will check all the children starting from and including item, and run the test function on each
+ * child encountered. The return array contains children returned from the test from all levels.
+ * WARNING: This is a recursive function.
+ * @param item - The DomItem which may have child items matching the attribute
+ * criteria
+ * @param test - Assess each child, and return the ones which qualify
+ */
+const gatherChildItems = (item, test) => test(item, item.children.reduce((a, b) => a.concat(gatherChildItems(b, test)), []));
+exports.default = gatherChildItems;

package/dist/domItem/query/gatherChildItems.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const gatherChildItems=(e,t)=>t(e,e.children.reduce((e,r)=>e.concat(gatherChildItems(r,t)),[]));exports.default=gatherChildItems;

package/dist/domItem/query/getChildTest.d.ts

@@ -0,0 +1,8 @@
+import type { ChildTest } from '../types';
+/**
+ * Retrieve the {@link module:domGeneral~testChildItem} function by providing an attribute and value to check.
+ * @param attr - Provide the attribute name to be searched
+ * @param value - The attribute value to be compared
+ */
+declare const getChildTest: (attr: string, value: unknown) => ChildTest;
+export default getChildTest;

package/dist/domItem/query/getChildTest.js

@@ -0,0 +1,15 @@
+"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
+});
+/**
+ * Retrieve the {@link module:domGeneral~testChildItem} function by providing an attribute and value to check.
+ * @param attr - Provide the attribute name to be searched
+ * @param value - The attribute value to be compared
+ */
+const getChildTest = (attr, value) => (item, gatheredResults) => item.attributes[attr] && item.attributes[attr] === value ? gatheredResults.concat([item]) : gatheredResults;
+exports.default = getChildTest;

package/dist/domItem/query/getChildTest.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const getChildTest=(t,e)=>(s,r)=>s.attributes[t]&&s.attributes[t]===e?r.concat([s]):r;exports.default=getChildTest;

package/dist/domItem/query/getChildrenByClass.d.ts

@@ -0,0 +1,11 @@
+import type { DomItem } from '../types';
+/**
+ * Helper for getting all domGeneral.DomItems starting at item and carrying the given class, among possibly several
+ * space-separated classes on that item - the same membership check as the real DOM's classList.contains, not an
+ * exact match of the whole className attribute string (which getChildrenFromAttribute does, and which would miss
+ * an item that also carries other classes).
+ * @param className - The one class being searched for
+ * @param item - The DomItem which may have child items carrying the class
+ */
+declare const getChildrenByClass: (className: string, item?: DomItem) => DomItem[];
+export default getChildrenByClass;

package/dist/domItem/query/getChildrenByClass.js

@@ -0,0 +1,26 @@
+"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/. */
+require("core-js/modules/es.array.includes.js");
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const documentItem_1 = __importDefault(require("../objects/documentItem"));
+const gatherChildItems_1 = __importDefault(require("./gatherChildItems"));
+/**
+ * Helper for getting all domGeneral.DomItems starting at item and carrying the given class, among possibly several
+ * space-separated classes on that item - the same membership check as the real DOM's classList.contains, not an
+ * exact match of the whole className attribute string (which getChildrenFromAttribute does, and which would miss
+ * an item that also carries other classes).
+ * @param className - The one class being searched for
+ * @param item - The DomItem which may have child items carrying the class
+ */
+const getChildrenByClass = (className, item = (0, documentItem_1.default)().body) => (0, gatherChildItems_1.default)(item, (child, gatheredResults) => (child.attributes.className ?? '').split(' ').includes(className) ? gatheredResults.concat([child]) : gatheredResults);
+exports.default = getChildrenByClass;

package/dist/domItem/query/getChildrenByClass.min.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/es.array.includes.js");var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const documentItem_1=__importDefault(require("../objects/documentItem")),gatherChildItems_1=__importDefault(require("./gatherChildItems")),getChildrenByClass=(e,t=(0,documentItem_1.default)().body)=>(0,gatherChildItems_1.default)(t,(t,r)=>(t.attributes.className??"").split(" ").includes(e)?r.concat([t]):r);exports.default=getChildrenByClass;

package/dist/domItem/query/getChildrenByName.d.ts

@@ -0,0 +1,9 @@
+import type { DomItem } from '../types';
+/**
+ * Helper for getting all domGeneral.DomItems starting at parent and having specified name attribute
+ * @param name - The name searched for
+ * @param item - The DomItem which may have child items matching the attribute
+ * criteria
+ */
+declare const getChildrenByName: (name: string, item?: DomItem) => DomItem[];
+export default getChildrenByName;

package/dist/domItem/query/getChildrenByName.js

@@ -0,0 +1,23 @@
+"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 getChildrenFromAttribute_1 = __importDefault(require("./getChildrenFromAttribute"));
+/**
+ * Helper for getting all domGeneral.DomItems starting at parent and having specified name attribute
+ * @param name - The name searched for
+ * @param item - The DomItem which may have child items matching the attribute
+ * criteria
+ */
+const getChildrenByName = si_funciona_1.default.curry(getChildrenFromAttribute_1.default)('name');
+exports.default = getChildrenByName;

package/dist/domItem/query/getChildrenByName.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")),getChildrenFromAttribute_1=__importDefault(require("./getChildrenFromAttribute")),getChildrenByName=si_funciona_1.default.curry(getChildrenFromAttribute_1.default)("name");exports.default=getChildrenByName;