treeloom 0.0.0-stage → 2.0.0

package/dist/events/functions/unassignListener.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 listenerOptions_1 = __importDefault(require("./listenerOptions"));
+/**
+ * Provide compatibility for unassigning listeners.
+ * @param trigger - The name of the event which will trigger the listenerFunction on the element. (keyof HTMLElementEventMap)
+ * @param elem - An element to append the listener onto
+ * @param fn - The function which will be invoked when the
+ * event is triggered
+ * @param options - Additional options to how the event will be
+ * fired
+ */
+const unassignListener = (trigger, elem, fn, options = false) => {
+  // Removing a listener may be done differently based on the browser support
+  if (elem.removeEventListener) {
+    // Latest support is provided from removeEventListener with the options parameter varying slightly
+    elem.removeEventListener(trigger, fn, (0, listenerOptions_1.default)(options));
+  }
+  return fn;
+};
+exports.default = unassignListener;

package/dist/events/functions/unassignListener.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 listenerOptions_1=__importDefault(require("./listenerOptions")),unassignListener=(e,t,n,r=!1)=>(t.removeEventListener&&t.removeEventListener(e,n,(0,listenerOptions_1.default)(r)),n);exports.default=unassignListener;

package/dist/events/index.d.ts

@@ -0,0 +1,37 @@
+declare const _default: {
+    activateListener: (eventName: import("./types").EventName, eventListener: import("./types").ListenerDescriptor, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    addEventListener: (eventName: import("./types").EventName, listenerFunction: string | import("./types").ListenerFunction, customArgs: object | null | undefined, options: import("./types").ListenerOptions | null | undefined, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    applyActiveListeners: (eventName: import("./types").EventName, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    assignListener: (trigger: string, elem: import("./types").ListenerTarget, fn: import("./types").EventHandler, options?: import("./types").ListenerOptions) => import("./types").EventHandler;
+    bindAllListeners: (item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    bindElementListeners: (item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    bindListeners: (item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    deactivateListener: (eventName: import("./types").EventName, eventListener: import("./types").ListenerDescriptor, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    deactivateListeners: (item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    findEventListener: (eventName: import("./types").EventName, listenerFunction: string | import("./types").ListenerFunction, customArgs: object | null | undefined, options: import("./types").ListenerOptions | null | undefined, item: import("../domItem/types").DomItem) => [number, import("./types").ListenerDescriptor | undefined];
+    fullAddEventListener: (eventName: import("./types").EventName, listener: import("./types").ListenerFunction, name: string | null | undefined, customArgs: object | null | undefined, options: import("./types").ListenerOptions | null | undefined, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    fullRemoveEventListener: (eventName: import("./types").EventName, listener: import("./types").ListenerFunction, name: string | null | undefined, customArgs: object | null | undefined, options: import("./types").ListenerOptions | null | undefined, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    listenerOptions: {
+        (options?: import("./types").ListenerOptions | null): import("./types").ListenerOptions | null;
+        supportsOptions?: boolean;
+    };
+    makeEventHandler: (listener: import("./types").ListenerFunction, item: import("../domItem/types").DomItem, ...args: unknown[]) => import("./types").EventHandler;
+    makeForwardingListener: (listenerName: string, transport: import("./types").ForwardEventsFunction) => import("./types").ListenerFunction;
+    receiveForwardedEvent: (root: import("../domItem/types").DomItemRoot, envelope: import("./types").ForwardedEvent, validator?: import("./functions/receiveForwardedEvent").ForwardedEventValidator) => void;
+    registerListener: (listener: import("./types").ListenerFunction, name?: string, parent?: import("../domItem/types").DomItemRoot) => Record<string, import("./types").ListenerFunction>;
+    registerListeners: (listeners: import("./types").ListenerFunction[] | Record<string, import("./types").ListenerFunction>, parent?: import("../domItem/types").DomItemRoot) => import("../domItem/types").DomItemRoot;
+    removeEventListener: (eventName: import("./types").EventName, listenerFunction: string | import("./types").ListenerFunction, customArgs: object | null | undefined, options: import("./types").ListenerOptions | null | undefined, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    retrieveListener: (listenerName: string | import("./types").ListenerFunction, parent?: import("../domItem/types").DomItemRoot) => import("./types").ListenerFunction;
+    revokeActiveListeners: (eventName: import("./types").EventName, item: import("../domItem/types").DomItem) => import("../domItem/types").DomItem;
+    setForwardEvents: (transport: import("./types").ForwardEventsFunction, parent?: import("../domItem/types").DomItemRoot) => import("../domItem/types").DomItemRoot;
+    unassignListener: (trigger: string, elem: import("./types").ListenerTarget, fn: import("./types").EventHandler, options?: import("./types").ListenerOptions) => import("./types").EventHandler;
+    createEventListener: ({ listenerFunc, listenerArgs, listenerOptions, listenerActive }?: Partial<import("./types").ListenerDescriptor>) => import("./types").ListenerDescriptor;
+    createEventProxy: (event: Event, item: import("../domItem/types").DomItem) => import("./types").EventProxy;
+    createEventResponder: (eventHandler: import("./types").EventHandler, abort?: AbortController | boolean | null) => import("./types").EventResponder;
+    options: {
+        getListenerOptions: () => import("./types").OptionsTemplate;
+        numberToOptions: (optionsTemplate: import("./types").OptionsTemplate, binaryOptions: number) => import("./types").OptionsObject;
+        optionsToNumber: (optionsTemplate: import("./types").OptionsTemplate, listenerOptions?: import("./types").ListenerOptions | null) => number;
+    };
+};
+export default _default;

package/dist/events/index.js

@@ -0,0 +1,72 @@
+"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
+});
+/**
+ * Setting up and handling events for items in a Virtual DOM (DomItem tree)
+ */
+const activateListener_1 = __importDefault(require("./functions/activateListener"));
+const addEventListener_1 = __importDefault(require("./functions/addEventListener"));
+const applyActiveListeners_1 = __importDefault(require("./functions/applyActiveListeners"));
+const assignListener_1 = __importDefault(require("./functions/assignListener"));
+const bindAllListeners_1 = __importDefault(require("./functions/bindAllListeners"));
+const bindElementListeners_1 = __importDefault(require("./functions/bindElementListeners"));
+const bindListeners_1 = __importDefault(require("./functions/bindListeners"));
+const deactivateListener_1 = __importDefault(require("./functions/deactivateListener"));
+const deactivateListeners_1 = __importDefault(require("./functions/deactivateListeners"));
+const findEventListener_1 = __importDefault(require("./functions/findEventListener"));
+const fullAddEventListener_1 = __importDefault(require("./functions/fullAddEventListener"));
+const fullRemoveEventListener_1 = __importDefault(require("./functions/fullRemoveEventListener"));
+const listenerOptions_1 = __importDefault(require("./functions/listenerOptions"));
+const makeEventHandler_1 = __importDefault(require("./functions/makeEventHandler"));
+const makeForwardingListener_1 = __importDefault(require("./functions/makeForwardingListener"));
+const receiveForwardedEvent_1 = __importDefault(require("./functions/receiveForwardedEvent"));
+const registerListener_1 = __importDefault(require("./functions/registerListener"));
+const registerListeners_1 = __importDefault(require("./functions/registerListeners"));
+const removeEventListener_1 = __importDefault(require("./functions/removeEventListener"));
+const retrieveListener_1 = __importDefault(require("./functions/retrieveListener"));
+const revokeActiveListeners_1 = __importDefault(require("./functions/revokeActiveListeners"));
+const setForwardEvents_1 = __importDefault(require("./functions/setForwardEvents"));
+const unassignListener_1 = __importDefault(require("./functions/unassignListener"));
+const createEventListener_1 = __importDefault(require("./objects/createEventListener"));
+const createEventProxy_1 = __importDefault(require("./objects/createEventProxy"));
+const createEventResponder_1 = __importDefault(require("./objects/createEventResponder"));
+const options_1 = __importDefault(require("./objects/options"));
+exports.default = {
+  activateListener: activateListener_1.default,
+  addEventListener: addEventListener_1.default,
+  applyActiveListeners: applyActiveListeners_1.default,
+  assignListener: assignListener_1.default,
+  bindAllListeners: bindAllListeners_1.default,
+  bindElementListeners: bindElementListeners_1.default,
+  bindListeners: bindListeners_1.default,
+  deactivateListener: deactivateListener_1.default,
+  deactivateListeners: deactivateListeners_1.default,
+  findEventListener: findEventListener_1.default,
+  fullAddEventListener: fullAddEventListener_1.default,
+  fullRemoveEventListener: fullRemoveEventListener_1.default,
+  listenerOptions: listenerOptions_1.default,
+  makeEventHandler: makeEventHandler_1.default,
+  makeForwardingListener: makeForwardingListener_1.default,
+  receiveForwardedEvent: receiveForwardedEvent_1.default,
+  registerListener: registerListener_1.default,
+  registerListeners: registerListeners_1.default,
+  removeEventListener: removeEventListener_1.default,
+  retrieveListener: retrieveListener_1.default,
+  revokeActiveListeners: revokeActiveListeners_1.default,
+  setForwardEvents: setForwardEvents_1.default,
+  unassignListener: unassignListener_1.default,
+  createEventListener: createEventListener_1.default,
+  createEventProxy: createEventProxy_1.default,
+  createEventResponder: createEventResponder_1.default,
+  options: options_1.default
+};

package/dist/events/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 activateListener_1=__importDefault(require("./functions/activateListener")),addEventListener_1=__importDefault(require("./functions/addEventListener")),applyActiveListeners_1=__importDefault(require("./functions/applyActiveListeners")),assignListener_1=__importDefault(require("./functions/assignListener")),bindAllListeners_1=__importDefault(require("./functions/bindAllListeners")),bindElementListeners_1=__importDefault(require("./functions/bindElementListeners")),bindListeners_1=__importDefault(require("./functions/bindListeners")),deactivateListener_1=__importDefault(require("./functions/deactivateListener")),deactivateListeners_1=__importDefault(require("./functions/deactivateListeners")),findEventListener_1=__importDefault(require("./functions/findEventListener")),fullAddEventListener_1=__importDefault(require("./functions/fullAddEventListener")),fullRemoveEventListener_1=__importDefault(require("./functions/fullRemoveEventListener")),listenerOptions_1=__importDefault(require("./functions/listenerOptions")),makeEventHandler_1=__importDefault(require("./functions/makeEventHandler")),makeForwardingListener_1=__importDefault(require("./functions/makeForwardingListener")),receiveForwardedEvent_1=__importDefault(require("./functions/receiveForwardedEvent")),registerListener_1=__importDefault(require("./functions/registerListener")),registerListeners_1=__importDefault(require("./functions/registerListeners")),removeEventListener_1=__importDefault(require("./functions/removeEventListener")),retrieveListener_1=__importDefault(require("./functions/retrieveListener")),revokeActiveListeners_1=__importDefault(require("./functions/revokeActiveListeners")),setForwardEvents_1=__importDefault(require("./functions/setForwardEvents")),unassignListener_1=__importDefault(require("./functions/unassignListener")),createEventListener_1=__importDefault(require("./objects/createEventListener")),createEventProxy_1=__importDefault(require("./objects/createEventProxy")),createEventResponder_1=__importDefault(require("./objects/createEventResponder")),options_1=__importDefault(require("./objects/options"));exports.default={activateListener:activateListener_1.default,addEventListener:addEventListener_1.default,applyActiveListeners:applyActiveListeners_1.default,assignListener:assignListener_1.default,bindAllListeners:bindAllListeners_1.default,bindElementListeners:bindElementListeners_1.default,bindListeners:bindListeners_1.default,deactivateListener:deactivateListener_1.default,deactivateListeners:deactivateListeners_1.default,findEventListener:findEventListener_1.default,fullAddEventListener:fullAddEventListener_1.default,fullRemoveEventListener:fullRemoveEventListener_1.default,listenerOptions:listenerOptions_1.default,makeEventHandler:makeEventHandler_1.default,makeForwardingListener:makeForwardingListener_1.default,receiveForwardedEvent:receiveForwardedEvent_1.default,registerListener:registerListener_1.default,registerListeners:registerListeners_1.default,removeEventListener:removeEventListener_1.default,retrieveListener:retrieveListener_1.default,revokeActiveListeners:revokeActiveListeners_1.default,setForwardEvents:setForwardEvents_1.default,unassignListener:unassignListener_1.default,createEventListener:createEventListener_1.default,createEventProxy:createEventProxy_1.default,createEventResponder:createEventResponder_1.default,options:options_1.default};

package/dist/events/objects/createEventListener.d.ts

@@ -0,0 +1,13 @@
+import type { ListenerDescriptor } from '../types';
+/**
+ * Prepare an eventListener object to attach to a DOMItem
+ * @param listenerProperties
+ * @param listenerProperties.listenerFunc - The function or name (string) of the listener
+ * action - see {@link EventListener}'s listenerFunc property for when to use which.
+ * @param listenerProperties.listenerArgs - Additional parameters to apply to the function
+ * @param listenerProperties.listenerOptions - The listener options to apply to the element
+ * @param listenerProperties.listenerActive - Flag for listener applied to element
+ * @returns An EventListener descriptor ready to be pushed onto a DomItem's eventListeners
+ */
+declare const createEventListener: ({ listenerFunc, listenerArgs, listenerOptions, listenerActive }?: Partial<ListenerDescriptor>) => ListenerDescriptor;
+export default createEventListener;

package/dist/events/objects/createEventListener.js

@@ -0,0 +1,30 @@
+"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
+});
+/**
+ * Prepare an eventListener object to attach to a DOMItem
+ * @param listenerProperties
+ * @param listenerProperties.listenerFunc - The function or name (string) of the listener
+ * action - see {@link EventListener}'s listenerFunc property for when to use which.
+ * @param listenerProperties.listenerArgs - Additional parameters to apply to the function
+ * @param listenerProperties.listenerOptions - The listener options to apply to the element
+ * @param listenerProperties.listenerActive - Flag for listener applied to element
+ * @returns An EventListener descriptor ready to be pushed onto a DomItem's eventListeners
+ */
+const createEventListener = ({
+  listenerFunc,
+  listenerArgs = null,
+  listenerOptions = false,
+  listenerActive = false
+} = {}) => ({
+  listenerFunc: listenerFunc,
+  listenerArgs,
+  listenerOptions,
+  listenerActive
+});
+exports.default = createEventListener;

package/dist/events/objects/createEventListener.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const createEventListener=({listenerFunc:e,listenerArgs:t=null,listenerOptions:s=!1,listenerActive:n=!1}={})=>({listenerFunc:e,listenerArgs:t,listenerOptions:s,listenerActive:n});exports.default=createEventListener;

package/dist/events/objects/createEventProxy.d.ts

@@ -0,0 +1,10 @@
+import type { DomItem } from '../../domItem/types';
+import type { EventProxy } from '../types';
+/**
+ * Return a modified version of the event: adds domItemTarget and currentDomItemTarget, next to the real DOM's own
+ * target and currentTarget.
+ * @param event
+ * @param item - The DomItem the listener is attached to (this event's currentTarget).
+ */
+declare const createEventProxy: (event: Event, item: DomItem) => EventProxy;
+export default createEventProxy;

package/dist/events/objects/createEventProxy.js

@@ -0,0 +1,48 @@
+"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 getItemByElement_1 = __importDefault(require("../../domItem/query/getItemByElement"));
+/**
+ * Return a modified version of the event: adds domItemTarget and currentDomItemTarget, next to the real DOM's own
+ * target and currentTarget.
+ * @param event
+ * @param item - The DomItem the listener is attached to (this event's currentTarget).
+ */
+const createEventProxy = (event, item) => new Proxy(Object.defineProperties(event, {
+  immediatePropagationStopped: {
+    enumerable: true,
+    value: false,
+    writable: true
+  },
+  currentDomItemTarget: {
+    enumerable: true,
+    value: item,
+    writable: true
+  },
+  domItemTarget: {
+    enumerable: true,
+    value: (0, getItemByElement_1.default)(item, event.target),
+    writable: true
+  }
+}), {
+  get(thisEvent, prop) {
+    if (prop === 'stopImmediatePropagation') {
+      thisEvent.immediatePropagationStopped = true;
+    }
+    // Read from the event itself rather than the proxy: Event's methods and accessors rely on internal slots
+    // (private fields since Node 24), which throw when `this` is the proxy.
+    const value = Reflect.get(thisEvent, prop);
+    return typeof value === 'function' && prop !== 'constructor' ? value.bind(thisEvent) : value;
+  }
+});
+exports.default = createEventProxy;

package/dist/events/objects/createEventProxy.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 getItemByElement_1=__importDefault(require("../../domItem/query/getItemByElement")),createEventProxy=(e,t)=>new Proxy(Object.defineProperties(e,{immediatePropagationStopped:{enumerable:!0,value:!1,writable:!0},currentDomItemTarget:{enumerable:!0,value:t,writable:!0},domItemTarget:{enumerable:!0,value:(0,getItemByElement_1.default)(t,e.target),writable:!0}}),{get(e,t){"stopImmediatePropagation"===t&&(e.immediatePropagationStopped=!0);const r=Reflect.get(e,t);return"function"==typeof r&&"constructor"!==t?r.bind(e):r}});exports.default=createEventProxy;

package/dist/events/objects/createEventResponder.d.ts

@@ -0,0 +1,8 @@
+import type { EventHandler, EventResponder } from '../types';
+/**
+ * Store the handler function and associated abort controller instance if available to be used when events are triggered.
+ * @param eventHandler - The eventHandler wrapped function to be called for the event.
+ * @param abort - Assign an AbortSignal provided or create one (if true), otherwise null.
+ */
+declare const createEventResponder: (eventHandler: EventHandler, abort?: AbortController | boolean | null) => EventResponder;
+export default createEventResponder;

package/dist/events/objects/createEventResponder.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/. */
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+/**
+ * Store the handler function and associated abort controller instance if available to be used when events are triggered.
+ * @param eventHandler - The eventHandler wrapped function to be called for the event.
+ * @param abort - Assign an AbortSignal provided or create one (if true), otherwise null.
+ */
+const createEventResponder = (eventHandler, abort = null) => {
+  if (abort === true) {
+    abort = new AbortController();
+  }
+  if (abort === false) {
+    abort = null;
+  }
+  return Object.assign({}, {
+    handler: eventHandler,
+    abort,
+    assignedHandler: null
+  });
+};
+exports.default = createEventResponder;

package/dist/events/objects/createEventResponder.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const createEventResponder=(e,t=null)=>(!0===t&&(t=new AbortController),!1===t&&(t=null),Object.assign({},{handler:e,abort:t,assignedHandler:null}));exports.default=createEventResponder;

package/dist/events/objects/options/getListenerOptions.d.ts

@@ -0,0 +1,6 @@
+import type { OptionsTemplate } from '../../types';
+/**
+ * Retrieve the OptionsTemplate for EventListenerOptions.
+ */
+declare const getListenerOptions: () => OptionsTemplate;
+export default getListenerOptions;

package/dist/events/objects/options/getListenerOptions.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/. */
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+const CAPTURE = 1;
+const ONCE = 2;
+const PASSIVE = 4;
+const SIGNAL = 8;
+/**
+ * Retrieve the OptionsTemplate for EventListenerOptions.
+ */
+const getListenerOptions = () => ({
+  capture: CAPTURE,
+  once: ONCE,
+  passive: PASSIVE,
+  signal: SIGNAL
+});
+exports.default = getListenerOptions;

package/dist/events/objects/options/getListenerOptions.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const CAPTURE=1,ONCE=2,PASSIVE=4,SIGNAL=8,getListenerOptions=()=>({capture:1,once:2,passive:4,signal:8});exports.default=getListenerOptions;

package/dist/events/objects/options/numberToOptions.d.ts

@@ -0,0 +1,8 @@
+import type { OptionsObject, OptionsTemplate } from '../../types';
+/**
+ * Take an integer representation of the listener options and convert them to the listener options object.
+ * @param optionsTemplate
+ * @param binaryOptions
+ */
+declare const numberToOptions: (optionsTemplate: OptionsTemplate, binaryOptions: number) => OptionsObject;
+export default numberToOptions;

package/dist/events/objects/options/numberToOptions.js

@@ -0,0 +1,21 @@
+"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"));
+/**
+ * Take an integer representation of the listener options and convert them to the listener options object.
+ * @param optionsTemplate
+ * @param binaryOptions
+ */
+const numberToOptions = (optionsTemplate, binaryOptions) => si_funciona_1.default.mapObject(optionsTemplate, flag => !!(binaryOptions & flag));
+exports.default = numberToOptions;

package/dist/events/objects/options/numberToOptions.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")),numberToOptions=(e,t)=>si_funciona_1.default.mapObject(e,e=>!!(t&e));exports.default=numberToOptions;

package/dist/events/objects/options/optionsToNumber.d.ts

@@ -0,0 +1,9 @@
+import type { ListenerOptions, OptionsTemplate } from '../../types';
+/**
+ * Take the given options and convert them (using binary) to an integer. Given listener options, each one is assigned a
+ * bitwise position. The resulting binary number represents any possible combination of the available flags set.
+ * @param optionsTemplate
+ * @param listenerOptions
+ */
+declare const optionsToNumber: (optionsTemplate: OptionsTemplate, listenerOptions?: ListenerOptions | null) => number;
+export default optionsToNumber;

package/dist/events/objects/options/optionsToNumber.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 si_funciona_1 = __importDefault(require("si-funciona"));
+/**
+ * Take the given options and convert them (using binary) to an integer. Given listener options, each one is assigned a
+ * bitwise position. The resulting binary number represents any possible combination of the available flags set.
+ * @param optionsTemplate
+ * @param listenerOptions
+ */
+const optionsToNumber = (optionsTemplate, listenerOptions) => {
+  if (!listenerOptions) {
+    return 0;
+  }
+  return si_funciona_1.default.reduceObject(optionsTemplate, (binaryOptions, flag, name) => listenerOptions[name] ? binaryOptions | flag : binaryOptions, 0);
+};
+exports.default = optionsToNumber;

package/dist/events/objects/options/optionsToNumber.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")),optionsToNumber=(e,t)=>t?si_funciona_1.default.reduceObject(e,(e,o,u)=>t[u]?e|o:e,0):0;exports.default=optionsToNumber;

package/dist/events/objects/options.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    getListenerOptions: () => import("../types").OptionsTemplate;
+    numberToOptions: (optionsTemplate: import("../types").OptionsTemplate, binaryOptions: number) => import("../types").OptionsObject;
+    optionsToNumber: (optionsTemplate: import("../types").OptionsTemplate, listenerOptions?: import("../types").ListenerOptions | null) => number;
+};
+export default _default;

package/dist/events/objects/options.js

@@ -0,0 +1,24 @@
+"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
+});
+/**
+ * Be able to use Flags (Options) in a well-formed way.
+ */
+const getListenerOptions_1 = __importDefault(require("./options/getListenerOptions"));
+const numberToOptions_1 = __importDefault(require("./options/numberToOptions"));
+const optionsToNumber_1 = __importDefault(require("./options/optionsToNumber"));
+exports.default = {
+  getListenerOptions: getListenerOptions_1.default,
+  numberToOptions: numberToOptions_1.default,
+  optionsToNumber: optionsToNumber_1.default
+};

package/dist/events/objects/options.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 getListenerOptions_1=__importDefault(require("./options/getListenerOptions")),numberToOptions_1=__importDefault(require("./options/numberToOptions")),optionsToNumber_1=__importDefault(require("./options/optionsToNumber"));exports.default={getListenerOptions:getListenerOptions_1.default,numberToOptions:numberToOptions_1.default,optionsToNumber:optionsToNumber_1.default};

package/dist/events/types.d.ts

@@ -0,0 +1,87 @@
+import type { DomItem } from '../domItem/types';
+/** The name of a DOM event: click, submit, keydown, ... */
+export type EventName = string;
+/** The old boolean form of the options argument of addEventListener. */
+export type UseCapture = boolean;
+/** The listener options which treeloom understands (each one is a flag, see {@link OptionsTemplate}). */
+export type OptionsObject = {
+    /** Events of this type are dispatched to the listener before any other target beneath it. */
+    capture?: boolean;
+    /** The listener is removed after it has been invoked once. */
+    once?: boolean;
+    /** The listener will never call preventDefault(). */
+    passive?: boolean;
+    /** The listener is removed when the AbortSignal's abort() is called. */
+    signal?: boolean | AbortSignal;
+};
+/** The options given with a listener: an options object, or just the useCapture boolean. */
+export type ListenerOptions = OptionsObject | UseCapture;
+/** An Event which also remembers whether stopImmediatePropagation() was called on it, and carries the DomItems
+ * target/currentTarget correspond to. */
+export type EventProxy = Event & {
+    immediatePropagationStopped: boolean;
+    /** The DomItem whose element matches the real event's target, searched for within currentDomItemTarget's own
+     * subtree (an event's target is always itself or a descendant of the item a listener is attached to - that is
+     * what bubbling means). Null when none is found. */
+    domItemTarget: DomItem | null;
+    /** The DomItem the listener is attached to (the real event's currentTarget). */
+    currentDomItemTarget: DomItem;
+};
+/**
+ * A function which handles an event on a DomItem. It receives the event, the DomItem which owns the listener and any
+ * listenerArgs. (The extra arguments are whatever the listener needs, so they can only be typed by the listener.)
+ */
+export type ListenerFunction = (event: EventProxy | Event, target: DomItem, ...args: any[]) => unknown;
+/** A listenerFunction wrapped so it skips events which stopped propagating, ready to be attached to an element. */
+export type EventHandler = (event?: EventProxy | Event | null) => unknown;
+/** The description of one listener on a DomItem: what to call, with what, and how. */
+export type ListenerDescriptor = {
+    /** Prefer a string name registered with registerListener: it survives being converted to json. */
+    listenerFunc: string | ListenerFunction;
+    /** Additional arguments for the listener function. */
+    listenerArgs?: object | null;
+    listenerOptions?: ListenerOptions;
+    /** Whether this listener has been applied to the element. */
+    listenerActive?: boolean;
+    /** Set while the listener is active: the responder which attaches it to the element and can detach it again. */
+    activeResponder?: EventResponder | null;
+};
+/** All the listeners of one event type. */
+export type EventListeners = ListenerDescriptor[];
+/** What a forwarded event is packaged as in render-only mode. See retrieveListener, makeForwardingListener. */
+export type ForwardedEvent = {
+    /** The id of the item the event fired on (domItemTarget, falling back to the item the listener is attached
+     * to when no domItemTarget was found) - read directly off that item's own id, not computed. Resolution is a
+     * lookup (getItemById) rather than a tree walk, so it still finds the right item even if the receiving end's
+     * own tree does not match the sending end's shape exactly (see getItemById vs the position-based
+     * getItemPath/getItemByPath this replaced). */
+    itemId: number;
+    /** The type of event which fired (event.type). */
+    eventType: EventName;
+    /** The registered name of the listener which would have run locally. */
+    listenerFunc: string;
+    /** The custom args the listener was registered with. */
+    data: unknown[];
+    /** Live state read directly off the real event's target when present - a listener which reads e.g.
+     * (event.target as HTMLInputElement).checked needs this replayed onto the real target on the receiving end
+     * (see receiveForwardedEvent), since the two ends' elements are otherwise independent objects. */
+    targetState?: {
+        checked?: boolean;
+        value?: string;
+    };
+};
+/** Where a forwarded event's envelope is sent, in render-only mode. Set on the root item with setForwardEvents. */
+export type ForwardEventsFunction = (envelope: ForwardedEvent) => unknown;
+/** An event handler and the way to detach it again: the handler as attached, and an optional AbortController. */
+export type EventResponder = {
+    handler: EventHandler;
+    abort: AbortController | null;
+    /** The exact function reference passed to the element's addEventListener, needed to remove it again. */
+    assignedHandler: EventHandler | null;
+};
+/** Bit flags for each of the listener options. */
+export type OptionsTemplate = Record<string, number>;
+/** What treeloom needs from an element to attach a listener, including the very old ways of doing it. */
+export type ListenerTarget = EventTarget & {
+    attachEvent?: (eventName: string, handler: EventHandler) => void;
+};

package/dist/events/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/events/types.min.js

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

package/dist/inflate/index.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    jsonToDomItem: (jsonString: string) => import("../domItem/types").DomItem;
+};
+export default _default;

package/dist/inflate/index.js

@@ -0,0 +1,17 @@
+"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 jsonToDomItem_1 = __importDefault(require("./jsonToDomItem"));
+exports.default = {
+  jsonToDomItem: jsonToDomItem_1.default
+};

package/dist/inflate/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 jsonToDomItem_1=__importDefault(require("./jsonToDomItem"));exports.default={jsonToDomItem:jsonToDomItem_1.default};

package/dist/inflate/jsonToDomItem.d.ts

@@ -0,0 +1,7 @@
+import type { DomItem } from '../domItem/types';
+/**
+ * Convert DOM Item to JSON string.
+ * @param jsonString
+ */
+declare const jsonToDomItem: (jsonString: string) => DomItem;
+export default jsonToDomItem;