@rootreeweb/js-lib 4.0.10

package/README.md

@@ -0,0 +1,49 @@
+# @rootreeweb/js-lib
+
+## What is This?
+
+The Rootree JS Library is a library of commonly used functions
+in JavaScript and TypeScript applications.
+It provides functions for working with dates, the DOM, and more.
+
+## Installation
+
+1. Make sure that your device is set up to use the `@rootreeweb` npm registry.
+   More details on how to do this can be found on the [Rootree Web Wiki](https://docs.cappy.rootree.ca/guides/packages).
+2. Install the package
+
+   ```bash
+   yarn add @rootreeweb/rt-js-lib
+   ```
+
+3. Import the required functions into your script.
+   For example, if you wanted to use the ready function
+   to display a message when the page is fully loaded, you would write:
+
+   ```typescript
+   import { ready } from "@rootreeweb/rt-js-lib";
+
+   ready(() => console.log("I'm ready!"));
+   ```
+
+## Functions
+
+Here are some functions that are available in the library:
+
+- removeChildren(element: Element)
+- setPropertyOnSelector<T extends HTMLElement>(
+  selector: string,
+  property: keyof T,
+  value: T[keyof T]
+  )
+- ready(callback: () => unknown)
+- waitFor(
+  containerSelector: string,
+  waitingForSelector: string,
+  callback: () => void,
+  runOnce = false
+  )
+- download(filename: string, text: string)
+- downloadBinary(filename: string, binary: ArrayBuffer)
+- getDayNames(format: "long" | "short" | "narrow")
+- and many more!

package/dist/cjs/browser/dom.cjs

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addListenerToSelector = addListenerToSelector;
+exports.ready = ready;
+exports.removeChildren = removeChildren;
+exports.setPropertyOnSelector = setPropertyOnSelector;
+exports.waitFor = waitFor;
+/**
+ * Add an event to all elements that match the provided selector.
+ *
+ * @template T The type of the element to add the event to.
+ * @param selector The CSS selector to match.
+ * @param eventName The event to listen for. Ex. click
+ * @param callback The function to call on the event being triggered.
+ */
+function addListenerToSelector(selector, eventName, callback) {
+    const elements = document.querySelectorAll(selector);
+    elements.forEach((element) => {
+        element.addEventListener(eventName, (e) => callback(e, element));
+    });
+}
+/**
+ * Executes a function once the DOM is ready.
+ *
+ * @param callback The function to execute.
+ */
+function ready(callback) {
+    if (document.readyState !== "loading") {
+        callback();
+    }
+    else {
+        document.addEventListener("DOMContentLoaded", () => {
+            callback();
+        });
+    }
+}
+/**
+ * Removes all the children from the provided element.
+ *
+ * @param element The element to remove the children of.
+ */
+function removeChildren(element) {
+    while (element.firstChild) {
+        element.removeChild(element.firstChild);
+    }
+}
+/**
+ * Sets a property on all elements that match the provided selector. Note: these
+ * are not CSS properties or necessarily HTML attributes.
+ *
+ * @template TElement The type of the element to set the property on.
+ * @template TProperty The property to set.
+ * @param selector The CSS selector to match.
+ * @param property The property to set.
+ * @param value The value to set the property to.
+ */
+function setPropertyOnSelector(selector, property, value) {
+    const elements = document.querySelectorAll(selector);
+    elements.forEach((element) => {
+        element.setAttribute(property, value);
+    });
+}
+/**
+ * Waits for an element to exist before executing a callback.
+ *
+ * @param containerSelector The selector for the container of the element to
+ *   watch for.
+ * @param waitingForSelector The selector for the element to watch for.
+ * @param callback The function to execute once the element exists.
+ * @param runOnce If true, the callback will only be executed once.
+ * @returns False if the container element does not exist. Undefined otherwise.
+ */
+function waitFor(containerSelector, waitingForSelector, callback, runOnce = false) {
+    const observerOptions = {
+        childList: true,
+        subtree: true,
+    };
+    const elementToWatch = document.querySelector(containerSelector);
+    if (!elementToWatch) {
+        return false;
+    }
+    if (elementToWatch.querySelector(waitingForSelector)) {
+        callback();
+    }
+    const observer = new MutationObserver(() => {
+        if (!elementToWatch.querySelector(waitingForSelector))
+            return;
+        if (runOnce) {
+            observer.disconnect();
+        }
+        callback();
+    });
+    observer.observe(elementToWatch, observerOptions);
+}
+//# sourceMappingURL=dom.js.map

package/dist/cjs/browser/dom.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Add an event to all elements that match the provided selector.
+ *
+ * @template T The type of the element to add the event to.
+ * @param selector The CSS selector to match.
+ * @param eventName The event to listen for. Ex. click
+ * @param callback The function to call on the event being triggered.
+ */
+export declare function addListenerToSelector<T extends HTMLElement>(selector: string, eventName: string, callback: (e: Event, element: T) => unknown): void;
+/**
+ * Executes a function once the DOM is ready.
+ *
+ * @param callback The function to execute.
+ */
+export declare function ready(callback: () => unknown): void;
+/**
+ * Removes all the children from the provided element.
+ *
+ * @param element The element to remove the children of.
+ */
+export declare function removeChildren(element: Element): void;
+/**
+ * Sets a property on all elements that match the provided selector. Note: these
+ * are not CSS properties or necessarily HTML attributes.
+ *
+ * @template TElement The type of the element to set the property on.
+ * @template TProperty The property to set.
+ * @param selector The CSS selector to match.
+ * @param property The property to set.
+ * @param value The value to set the property to.
+ */
+export declare function setPropertyOnSelector<TElement extends HTMLElement, TProperty extends keyof TElement & string>(selector: string, property: TProperty, value: string & TElement[TProperty]): void;
+/**
+ * Waits for an element to exist before executing a callback.
+ *
+ * @param containerSelector The selector for the container of the element to
+ *   watch for.
+ * @param waitingForSelector The selector for the element to watch for.
+ * @param callback The function to execute once the element exists.
+ * @param runOnce If true, the callback will only be executed once.
+ * @returns False if the container element does not exist. Undefined otherwise.
+ */
+export declare function waitFor(containerSelector: string, waitingForSelector: string, callback: () => unknown, runOnce?: boolean): false | undefined;
+//# sourceMappingURL=dom.d.ts.map

package/dist/cjs/browser/dom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../../src/browser/dom.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,WAAW,EAC1D,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,OAAO,GACzC,IAAI,CAKN;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAQnD;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAIrD;AACD;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACpC,QAAQ,SAAS,WAAW,EAC5B,SAAS,SAAS,MAAM,QAAQ,GAAG,MAAM,EAEzC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,GACjC,IAAI,CAKN;AACD;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACtB,iBAAiB,EAAE,MAAM,EACzB,kBAAkB,EAAE,MAAM,EAC1B,QAAQ,EAAE,MAAM,OAAO,EACvB,OAAO,UAAQ,GACb,KAAK,GAAG,SAAS,CAqBnB"}

package/dist/cjs/browser/dom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.js","sourceRoot":"","sources":["../../../src/browser/dom.ts"],"names":[],"mappings":";;AAQA,sDASC;AAOD,sBAQC;AAOD,wCAIC;AAWD,sDAYC;AAWD,0BA0BC;AAvGD;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACpC,QAAgB,EAChB,SAAiB,EACjB,QAA2C;IAE3C,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,CAAI,QAAQ,CAAC,CAAC;IACxD,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CAAC,QAAuB;IAC5C,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACvC,QAAQ,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC;QACP,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAClD,QAAQ,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACJ,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,OAAgB;IAC9C,OAAO,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3B,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;AACF,CAAC;AACD;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CAIpC,QAAgB,EAChB,QAAmB,EACnB,KAAmC;IAEnC,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,CAAW,QAAQ,CAAC,CAAC;IAC/D,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACJ,CAAC;AACD;;;;;;;;;GASG;AACH,SAAgB,OAAO,CACtB,iBAAyB,EACzB,kBAA0B,EAC1B,QAAuB,EACvB,OAAO,GAAG,KAAK;IAEf,MAAM,eAAe,GAAG;QACvB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;KACb,CAAC;IACF,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;IACjE,IAAI,CAAC,cAAc,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACd,CAAC;IAED,IAAI,cAAc,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtD,QAAQ,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,GAAG,EAAE;QAC1C,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,kBAAkB,CAAC;YAAE,OAAO;QAC9D,IAAI,OAAO,EAAE,CAAC;YACb,QAAQ,CAAC,UAAU,EAAE,CAAC;QACvB,CAAC;QACD,QAAQ,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AACnD,CAAC","sourcesContent":["/**\n * Add an event to all elements that match the provided selector.\n *\n * @template T The type of the element to add the event to.\n * @param selector The CSS selector to match.\n * @param eventName The event to listen for. Ex. click\n * @param callback The function to call on the event being triggered.\n */\nexport function addListenerToSelector<T extends HTMLElement>(\n\tselector: string,\n\teventName: string,\n\tcallback: (e: Event, element: T) => unknown,\n): void {\n\tconst elements = document.querySelectorAll<T>(selector);\n\telements.forEach((element) => {\n\t\telement.addEventListener(eventName, (e) => callback(e, element));\n\t});\n}\n\n/**\n * Executes a function once the DOM is ready.\n *\n * @param callback The function to execute.\n */\nexport function ready(callback: () => unknown): void {\n\tif (document.readyState !== \"loading\") {\n\t\tcallback();\n\t} else {\n\t\tdocument.addEventListener(\"DOMContentLoaded\", () => {\n\t\t\tcallback();\n\t\t});\n\t}\n}\n\n/**\n * Removes all the children from the provided element.\n *\n * @param element The element to remove the children of.\n */\nexport function removeChildren(element: Element): void {\n\twhile (element.firstChild) {\n\t\telement.removeChild(element.firstChild);\n\t}\n}\n/**\n * Sets a property on all elements that match the provided selector. Note: these\n * are not CSS properties or necessarily HTML attributes.\n *\n * @template TElement The type of the element to set the property on.\n * @template TProperty The property to set.\n * @param selector The CSS selector to match.\n * @param property The property to set.\n * @param value The value to set the property to.\n */\nexport function setPropertyOnSelector<\n\tTElement extends HTMLElement,\n\tTProperty extends keyof TElement & string,\n>(\n\tselector: string,\n\tproperty: TProperty,\n\tvalue: string & TElement[TProperty],\n): void {\n\tconst elements = document.querySelectorAll<TElement>(selector);\n\telements.forEach((element) => {\n\t\telement.setAttribute(property, value);\n\t});\n}\n/**\n * Waits for an element to exist before executing a callback.\n *\n * @param containerSelector The selector for the container of the element to\n *   watch for.\n * @param waitingForSelector The selector for the element to watch for.\n * @param callback The function to execute once the element exists.\n * @param runOnce If true, the callback will only be executed once.\n * @returns False if the container element does not exist. Undefined otherwise.\n */\nexport function waitFor(\n\tcontainerSelector: string,\n\twaitingForSelector: string,\n\tcallback: () => unknown,\n\trunOnce = false,\n): false | undefined {\n\tconst observerOptions = {\n\t\tchildList: true,\n\t\tsubtree: true,\n\t};\n\tconst elementToWatch = document.querySelector(containerSelector);\n\tif (!elementToWatch) {\n\t\treturn false;\n\t}\n\n\tif (elementToWatch.querySelector(waitingForSelector)) {\n\t\tcallback();\n\t}\n\tconst observer = new MutationObserver(() => {\n\t\tif (!elementToWatch.querySelector(waitingForSelector)) return;\n\t\tif (runOnce) {\n\t\t\tobserver.disconnect();\n\t\t}\n\t\tcallback();\n\t});\n\tobserver.observe(elementToWatch, observerOptions);\n}\n"]}

package/dist/cjs/browser/download.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = download;
+exports.downloadBinary = downloadBinary;
+/**
+ * Downloads a text file with the specified file name and content.
+ *
+ * @param fileName - The name of the file to be downloaded.
+ * @param text - The content of the file.
+ * @param raw Bypasses encoding if true.
+ */
+function download(fileName, text, raw = false) {
+    const element = document.createElement("a");
+    element.setAttribute("href", raw ? text : "data:text/plain;charset=utf-8," + encodeURIComponent(text));
+    element.setAttribute("download", fileName);
+    element.style.display = "none";
+    document.body.appendChild(element);
+    element.click();
+    document.body.removeChild(element);
+}
+/**
+ * Downloads a binary file with the specified file name and content.
+ *
+ * @param fileName - The name of the file to be downloaded.
+ * @param binary - The content of the file.
+ */
+function downloadBinary(fileName, binary) {
+    const blob = new Blob([binary], {
+        type: "application/octet-stream",
+    });
+    const blobUrl = URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.href = blobUrl;
+    link.download = fileName;
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+    URL.revokeObjectURL(blobUrl);
+}
+//# sourceMappingURL=download.js.map

package/dist/cjs/browser/download.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Downloads a text file with the specified file name and content.
+ *
+ * @param fileName - The name of the file to be downloaded.
+ * @param text - The content of the file.
+ * @param raw Bypasses encoding if true.
+ */
+export declare function download(fileName: string, text: string, raw?: boolean): void;
+/**
+ * Downloads a binary file with the specified file name and content.
+ *
+ * @param fileName - The name of the file to be downloaded.
+ * @param binary - The content of the file.
+ */
+export declare function downloadBinary(fileName: string, binary: ArrayBuffer): void;
+//# sourceMappingURL=download.d.ts.map

package/dist/cjs/browser/download.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../../src/browser/download.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,UAAQ,GAAG,IAAI,CAc1E;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI,CAe1E"}

package/dist/cjs/browser/download.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.js","sourceRoot":"","sources":["../../../src/browser/download.ts"],"names":[],"mappings":";;AAOA,4BAcC;AAQD,wCAeC;AA5CD;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,QAAgB,EAAE,IAAY,EAAE,GAAG,GAAG,KAAK;IACnE,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,YAAY,CACnB,MAAM,EACN,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gCAAgC,GAAG,kBAAkB,CAAC,IAAI,CAAC,CACxE,CAAC;IACF,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE3C,OAAO,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEnC,OAAO,CAAC,KAAK,EAAE,CAAC;IAEhB,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,QAAgB,EAAE,MAAmB;IACnE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE;QAC/B,IAAI,EAAE,0BAA0B;KAChC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAE1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;IACpB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAEzB,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK,EAAE,CAAC;IAEb,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC","sourcesContent":["/**\n * Downloads a text file with the specified file name and content.\n *\n * @param fileName - The name of the file to be downloaded.\n * @param text - The content of the file.\n * @param raw Bypasses encoding if true.\n */\nexport function download(fileName: string, text: string, raw = false): void {\n\tconst element = document.createElement(\"a\");\n\telement.setAttribute(\n\t\t\"href\",\n\t\traw ? text : \"data:text/plain;charset=utf-8,\" + encodeURIComponent(text),\n\t);\n\telement.setAttribute(\"download\", fileName);\n\n\telement.style.display = \"none\";\n\tdocument.body.appendChild(element);\n\n\telement.click();\n\n\tdocument.body.removeChild(element);\n}\n\n/**\n * Downloads a binary file with the specified file name and content.\n *\n * @param fileName - The name of the file to be downloaded.\n * @param binary - The content of the file.\n */\nexport function downloadBinary(fileName: string, binary: ArrayBuffer): void {\n\tconst blob = new Blob([binary], {\n\t\ttype: \"application/octet-stream\",\n\t});\n\tconst blobUrl = URL.createObjectURL(blob);\n\n\tconst link = document.createElement(\"a\");\n\tlink.href = blobUrl;\n\tlink.download = fileName;\n\n\tdocument.body.appendChild(link);\n\tlink.click();\n\n\tdocument.body.removeChild(link);\n\tURL.revokeObjectURL(blobUrl);\n}\n"]}

package/dist/cjs/browser/index.cjs

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dom.cjs"), exports);
+__exportStar(require("./download.cjs"), exports);
+__exportStar(require("./queryOrThrow.cjs"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/browser/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./dom.js";
+export * from "./download.js";
+export * from "./queryOrThrow.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/browser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}

package/dist/cjs/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,gDAA8B;AAC9B,oDAAkC","sourcesContent":["export * from \"./dom.js\";\nexport * from \"./download.js\";\nexport * from \"./queryOrThrow.js\";\n"]}

package/dist/cjs/browser/queryOrThrow.cjs

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryOrThrow = queryOrThrow;
+/**
+ * Implementation of queryOrThrow. Queries an element and optionally validates
+ * its type.
+ *
+ * @template T The type of the element to query.
+ * @param arg1 The parent element or the selector string.
+ * @param arg2 The selector string or the element type constructor.
+ * @param arg3 The element type constructor.
+ * @returns The element that was found.
+ * @throws {Error} If the element is not found or fails the type validation.
+ */
+function queryOrThrow(arg1, arg2, arg3) {
+    let parent;
+    let selector;
+    let type;
+    if (typeof arg1 === "string") {
+        parent = document;
+        selector = arg1;
+        if (typeof arg2 === "function") {
+            type = arg2;
+        }
+    }
+    else {
+        parent = arg1;
+        selector = arg2; // Overloads guarantee arg2 is a string here.
+        if (typeof arg3 === "function") {
+            type = arg3;
+        }
+    }
+    const el = parent.querySelector(selector);
+    if (!el) {
+        throw new Error(`Element matching selector "${selector}" not found.`);
+    }
+    if (type && !(el instanceof type)) {
+        throw new Error(`Element matching selector "${selector}" is not an instance of "${type.name}". Found "${el.constructor.name}" instead.`);
+    }
+    return el;
+}
+//# sourceMappingURL=queryOrThrow.js.map

package/dist/cjs/browser/queryOrThrow.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Overload for querying with a selector and validating the element type.
+ *
+ * @template T The specific Element type to return.
+ * @param selector The selector to query.
+ * @param type The constructor of the element type to validate against (e.g.,
+ *   HTMLInputElement).
+ * @returns The element that was found and validated.
+ * @throws {Error} If the element is not found or is not of the specified type.
+ */
+export declare function queryOrThrow<T extends Element>(selector: string, type: new () => T): T;
+/**
+ * Overload for querying within a parent element and validating the element
+ * type.
+ *
+ * @template T The specific Element type to return.
+ * @param parent The parent element to query within.
+ * @param selector The selector to query.
+ * @param type The constructor of the element type to validate against (e.g.,
+ *   HTMLInputElement).
+ * @returns The element that was found and validated.
+ * @throws {Error} If the element is not found or is not of the specified type.
+ */
+export declare function queryOrThrow<T extends Element>(parent: Element, selector: string, type: new () => T): T;
+/**
+ * Overload for querying with just a selector.
+ *
+ * @template T The generic Element type to return.
+ * @param selector The selector to query.
+ * @returns The element that was found.
+ * @throws {Error} If the element is not found.
+ */
+export declare function queryOrThrow<T extends Element>(selector: string): T;
+/**
+ * Overload for querying within a parent element with just a selector.
+ *
+ * @template T The generic Element type to return.
+ * @param parent The parent element to query within.
+ * @param selector The selector to query.
+ * @returns The element that was found.
+ * @throws {Error} If the element is not found.
+ */
+export declare function queryOrThrow<T extends Element>(parent: Element, selector: string): T;
+//# sourceMappingURL=queryOrThrow.d.ts.map

package/dist/cjs/browser/queryOrThrow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryOrThrow.d.ts","sourceRoot":"","sources":["../../../src/browser/queryOrThrow.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC7C,QAAQ,EAAE,MAAM,EAEhB,IAAI,EAAE,UAAU,CAAC,GACf,CAAC,CAAC;AACL;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC7C,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,MAAM,EAEhB,IAAI,EAAE,UAAU,CAAC,GACf,CAAC,CAAC;AACL;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAC;AACrE;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC7C,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,MAAM,GACd,CAAC,CAAC"}

package/dist/cjs/browser/queryOrThrow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryOrThrow.js","sourceRoot":"","sources":["../../../src/browser/queryOrThrow.ts"],"names":[],"mappings":";;AAkEA,oCAoCC;AA/CD;;;;;;;;;;GAUG;AACH,SAAgB,YAAY,CAC3B,IAAsB,EACtB,IAA6B,EAC7B,IAAkB;IAElB,IAAI,MAA0B,CAAC;IAC/B,IAAI,QAAgB,CAAC;IACrB,IAAI,IAA+B,CAAC;IAEpC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,QAAQ,CAAC;QAClB,QAAQ,GAAG,IAAI,CAAC;QAChB,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,IAAI,GAAG,IAAI,CAAC;QACb,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,GAAG,IAAI,CAAC;QACd,QAAQ,GAAG,IAAc,CAAC,CAAC,6CAA6C;QACxE,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,IAAI,GAAG,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED,MAAM,EAAE,GAAG,MAAM,CAAC,aAAa,CAAI,QAAQ,CAAC,CAAC;IAE7C,IAAI,CAAC,EAAE,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,cAAc,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,IAAI,IAAI,CAAC,CAAC,EAAE,YAAY,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACd,8BAA8B,QAAQ,4BAA4B,IAAI,CAAC,IAAI,aAAa,EAAE,CAAC,WAAW,CAAC,IAAI,YAAY,CACvH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC","sourcesContent":["/**\n * Overload for querying with a selector and validating the element type.\n *\n * @template T The specific Element type to return.\n * @param selector The selector to query.\n * @param type The constructor of the element type to validate against (e.g.,\n *   HTMLInputElement).\n * @returns The element that was found and validated.\n * @throws {Error} If the element is not found or is not of the specified type.\n */\nexport function queryOrThrow<T extends Element>(\n\tselector: string,\n\t// eslint-disable-next-line @typescript-eslint/unified-signatures\n\ttype: new () => T,\n): T;\n/**\n * Overload for querying within a parent element and validating the element\n * type.\n *\n * @template T The specific Element type to return.\n * @param parent The parent element to query within.\n * @param selector The selector to query.\n * @param type The constructor of the element type to validate against (e.g.,\n *   HTMLInputElement).\n * @returns The element that was found and validated.\n * @throws {Error} If the element is not found or is not of the specified type.\n */\nexport function queryOrThrow<T extends Element>(\n\tparent: Element,\n\tselector: string,\n\t// eslint-disable-next-line @typescript-eslint/unified-signatures\n\ttype: new () => T,\n): T;\n/**\n * Overload for querying with just a selector.\n *\n * @template T The generic Element type to return.\n * @param selector The selector to query.\n * @returns The element that was found.\n * @throws {Error} If the element is not found.\n */\nexport function queryOrThrow<T extends Element>(selector: string): T;\n/**\n * Overload for querying within a parent element with just a selector.\n *\n * @template T The generic Element type to return.\n * @param parent The parent element to query within.\n * @param selector The selector to query.\n * @returns The element that was found.\n * @throws {Error} If the element is not found.\n */\nexport function queryOrThrow<T extends Element>(\n\tparent: Element,\n\tselector: string,\n): T;\n/**\n * Implementation of queryOrThrow. Queries an element and optionally validates\n * its type.\n *\n * @template T The type of the element to query.\n * @param arg1 The parent element or the selector string.\n * @param arg2 The selector string or the element type constructor.\n * @param arg3 The element type constructor.\n * @returns The element that was found.\n * @throws {Error} If the element is not found or fails the type validation.\n */\nexport function queryOrThrow<T extends Element>(\n\targ1: Element | string,\n\targ2?: (new () => T) | string,\n\targ3?: new () => T,\n): T {\n\tlet parent: Document | Element;\n\tlet selector: string;\n\tlet type: (new () => T) | undefined;\n\n\tif (typeof arg1 === \"string\") {\n\t\tparent = document;\n\t\tselector = arg1;\n\t\tif (typeof arg2 === \"function\") {\n\t\t\ttype = arg2;\n\t\t}\n\t} else {\n\t\tparent = arg1;\n\t\tselector = arg2 as string; // Overloads guarantee arg2 is a string here.\n\t\tif (typeof arg3 === \"function\") {\n\t\t\ttype = arg3;\n\t\t}\n\t}\n\n\tconst el = parent.querySelector<T>(selector);\n\n\tif (!el) {\n\t\tthrow new Error(`Element matching selector \"${selector}\" not found.`);\n\t}\n\n\tif (type && !(el instanceof type)) {\n\t\tthrow new Error(\n\t\t\t`Element matching selector \"${selector}\" is not an instance of \"${type.name}\". Found \"${el.constructor.name}\" instead.`,\n\t\t);\n\t}\n\n\treturn el;\n}\n"]}

package/dist/cjs/general/arrays.cjs

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Direction = void 0;
+exports.dedupe = dedupe;
+exports.enforceUniquePositions = enforceUniquePositions;
+exports.getLoopedIndex = getLoopedIndex;
+exports.moveItemInArray = moveItemInArray;
+var Direction;
+(function (Direction) {
+    Direction[Direction["Left"] = 0] = "Left";
+    Direction[Direction["Right"] = 1] = "Right";
+})(Direction || (exports.Direction = Direction = {}));
+/**
+ * Remove duplicates from an array
+ *
+ * @template TData The type of the array
+ * @param data The array to remove duplicates from
+ * @returns The array with duplicates removed
+ */
+function dedupe(data) {
+    return [...new Set(data)];
+}
+/**
+ * Mutates the position field in an array of objects to enforce uniqueness.
+ *
+ * @template TData The type of the objects in the array.
+ * @param array The array of objects.
+ * @throws {Error} If an undefined item is found in the array.
+ */
+function enforceUniquePositions(array) {
+    const newArray = [...array];
+    newArray.sort((a, b) => a.position - b.position);
+    for (let i = 0; i < newArray.length; i++) {
+        const item = getItemAtIndex(newArray, i);
+        item.position = i;
+    }
+}
+/**
+ * Get the next index or previous index in array, looping around if necessary.
+ *
+ * @param currentIndex The current index.
+ * @param direction The direction to move in.
+ * @param items The array of items.
+ * @returns The next index.
+ */
+function getLoopedIndex(currentIndex, direction, items) {
+    const length = Array.isArray(items) ? items.length : items;
+    if (direction === Direction.Left) {
+        return currentIndex - 1 < 0 ? length - 1 : currentIndex - 1;
+    }
+    else {
+        return currentIndex + 2 > length ? 0 : currentIndex + 1;
+    }
+}
+/**
+ * Reassigns the position field in an array of objects.
+ *
+ * @example
+ * 	const array = [
+ * 		{ id: 1, position: 0 },
+ * 		{ id: 2, position: 1 },
+ * 		{ id: 3, position: 2 },
+ * 	];
+ * 	const newArray = moveItemInArray(array, "id", 2, 1);
+ * 	// newArray is now [{ id: 1, position: 0 }, { id: 3, position: 1 }, { id: 2, position: 2 }];
+ *
+ * 	const notIntrinsicallyOrderedArray = [
+ * 		{ id: 1, position: 0 },
+ * 		{ id: 3, position: 2 },
+ * 		{ id: 2, position: 1 },
+ * 		{ id: 4, position: 3 },
+ * 	];
+ * 	const newArray2 = moveItemInArray(
+ * 		notIntrinsicallyOrderedArray,
+ * 		"id",
+ * 		2,
+ * 		-1,
+ * 	);
+ * 	// newArray2 is now [{ id: 1, position: 0 }, { id: 2, position: 1 }, { id: 3, position: 2 }, { id: 4, position: 3 }];
+ *
+ * @template T The type of the objects in the array. The objects must have a
+ *   numeric `position` field.
+ * @template K The key field in an array item.
+ * @param array The array of objects.
+ * @param idField The field to use as the id.
+ * @param id The id of the item to move.
+ * @param direction The direction to move the item in. 1 for down, -1 for up.
+ * @returns An array with the new position values set.
+ */
+function moveItemInArray(array, idField, id, direction) {
+    const newArray = [...array];
+    const index = newArray.findIndex((item) => item[idField] === id);
+    if (index === -1) {
+        return newArray;
+    }
+    const item = getItemAtIndex(newArray, index);
+    const originalPosition = item.position;
+    for (let i = 0; i < newArray.length; i++) {
+        handleItem(i, index, direction, newArray, originalPosition);
+    }
+    return newArray;
+}
+/**
+ * Gets an item at a specific index in an array, throwing an error if the item
+ * is undefined.
+ *
+ * @template TData The type of the items in the array.
+ * @param array The array to get the item from.
+ * @param index The index of the item to get.
+ * @returns The item at the specified index.
+ * @throws {Error} If the item at the specified index is undefined.
+ */
+function getItemAtIndex(array, index) {
+    // eslint-disable-next-line security/detect-object-injection
+    const item = array[index];
+    if (item === undefined) {
+        throw new Error("Undefined item in array at index " + String(index));
+    }
+    return item;
+}
+/**
+ * Handles the movement of each item within an array.
+ *
+ * @template T The type of the array item
+ * @param currentIndex The index of the item who's movement is being handled.
+ * @param indexBeingMoved The index of the item that was moved.
+ * @param direction Whether the indexBeingMoved is moving ahead or back.
+ * @param newArray The array being built.
+ * @param originalPosition The original position of the item being moved.
+ */
+function handleItem(currentIndex, indexBeingMoved, direction, newArray, originalPosition) {
+    const item = getItemAtIndex(newArray, currentIndex);
+    if (currentIndex === indexBeingMoved) {
+        if (direction === -1 || currentIndex < newArray.length - 1) {
+            item.position += direction;
+        }
+    }
+    else if (direction === 1) {
+        if (item.position > originalPosition &&
+            item.position <= originalPosition + 1) {
+            item.position--;
+        }
+    }
+    else {
+        if (item.position < originalPosition &&
+            item.position >= originalPosition - 1) {
+            item.position++;
+        }
+    }
+}
+//# sourceMappingURL=arrays.js.map

package/dist/cjs/general/arrays.d.ts

@@ -0,0 +1,70 @@
+export declare enum Direction {
+    Left = 0,
+    Right = 1
+}
+/**
+ * Remove duplicates from an array
+ *
+ * @template TData The type of the array
+ * @param data The array to remove duplicates from
+ * @returns The array with duplicates removed
+ */
+export declare function dedupe<TData>(data: TData[]): TData[];
+/**
+ * Mutates the position field in an array of objects to enforce uniqueness.
+ *
+ * @template TData The type of the objects in the array.
+ * @param array The array of objects.
+ * @throws {Error} If an undefined item is found in the array.
+ */
+export declare function enforceUniquePositions<TData extends {
+    position: number;
+}>(array: TData[]): void;
+/**
+ * Get the next index or previous index in array, looping around if necessary.
+ *
+ * @param currentIndex The current index.
+ * @param direction The direction to move in.
+ * @param items The array of items.
+ * @returns The next index.
+ */
+export declare function getLoopedIndex(currentIndex: number, direction: Direction, items: number | unknown[]): number;
+/**
+ * Reassigns the position field in an array of objects.
+ *
+ * @example
+ * 	const array = [
+ * 		{ id: 1, position: 0 },
+ * 		{ id: 2, position: 1 },
+ * 		{ id: 3, position: 2 },
+ * 	];
+ * 	const newArray = moveItemInArray(array, "id", 2, 1);
+ * 	// newArray is now [{ id: 1, position: 0 }, { id: 3, position: 1 }, { id: 2, position: 2 }];
+ *
+ * 	const notIntrinsicallyOrderedArray = [
+ * 		{ id: 1, position: 0 },
+ * 		{ id: 3, position: 2 },
+ * 		{ id: 2, position: 1 },
+ * 		{ id: 4, position: 3 },
+ * 	];
+ * 	const newArray2 = moveItemInArray(
+ * 		notIntrinsicallyOrderedArray,
+ * 		"id",
+ * 		2,
+ * 		-1,
+ * 	);
+ * 	// newArray2 is now [{ id: 1, position: 0 }, { id: 2, position: 1 }, { id: 3, position: 2 }, { id: 4, position: 3 }];
+ *
+ * @template T The type of the objects in the array. The objects must have a
+ *   numeric `position` field.
+ * @template K The key field in an array item.
+ * @param array The array of objects.
+ * @param idField The field to use as the id.
+ * @param id The id of the item to move.
+ * @param direction The direction to move the item in. 1 for down, -1 for up.
+ * @returns An array with the new position values set.
+ */
+export declare function moveItemInArray<T extends {
+    position: number;
+}, K extends keyof T>(array: T[], idField: K, id: T[K], direction: -1 | 1): T[];
+//# sourceMappingURL=arrays.d.ts.map

package/dist/cjs/general/arrays.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.d.ts","sourceRoot":"","sources":["../../../src/general/arrays.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACpB,IAAI,IAAA;IACJ,KAAK,IAAA;CACL;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,CAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EACxE,KAAK,EAAE,KAAK,EAAE,GACZ,IAAI,CAON;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC7B,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,GACvB,MAAM,CAOR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,eAAe,CAC9B,CAAC,SAAS;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EAC9B,CAAC,SAAS,MAAM,CAAC,EAChB,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAa1D"}

package/dist/cjs/general/arrays.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrays.js","sourceRoot":"","sources":["../../../src/general/arrays.ts"],"names":[],"mappings":";;;AAYA,wBAEC;AASD,wDASC;AAUD,wCAWC;AAqCD,0CAgBC;AA1GD,IAAY,SAGX;AAHD,WAAY,SAAS;IACpB,yCAAI,CAAA;IACJ,2CAAK,CAAA;AACN,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAED;;;;;;GAMG;AACH,SAAgB,MAAM,CAAQ,IAAa;IAC1C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACrC,KAAc;IAEd,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;IACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IACnB,CAAC;AACF,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC7B,YAAoB,EACpB,SAAoB,EACpB,KAAyB;IAEzB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3D,IAAI,SAAS,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;QAClC,OAAO,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC;IAC7D,CAAC;SAAM,CAAC;QACP,OAAO,YAAY,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC;IACzD,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,eAAe,CAG7B,KAAU,EAAE,OAAU,EAAE,EAAQ,EAAE,SAAiB;IACpD,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACjE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QAClB,OAAO,QAAQ,CAAC;IACjB,CAAC;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,UAAU,CAAI,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,cAAc,CAAQ,KAAc,EAAE,KAAa;IAC3D,4DAA4D;IAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,UAAU,CAClB,YAAoB,EACpB,eAAuB,EACvB,SAAiB,EACjB,QAAa,EACb,gBAAwB;IAExB,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IACpD,IAAI,YAAY,KAAK,eAAe,EAAE,CAAC;QACtC,IAAI,SAAS,KAAK,CAAC,CAAC,IAAI,YAAY,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,QAAQ,IAAI,SAAS,CAAC;QAC5B,CAAC;IACF,CAAC;SAAM,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QAC5B,IACC,IAAI,CAAC,QAAQ,GAAG,gBAAgB;YAChC,IAAI,CAAC,QAAQ,IAAI,gBAAgB,GAAG,CAAC,EACpC,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,CAAC;IACF,CAAC;SAAM,CAAC;QACP,IACC,IAAI,CAAC,QAAQ,GAAG,gBAAgB;YAChC,IAAI,CAAC,QAAQ,IAAI,gBAAgB,GAAG,CAAC,EACpC,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["export enum Direction {\n\tLeft,\n\tRight,\n}\n\n/**\n * Remove duplicates from an array\n *\n * @template TData The type of the array\n * @param data The array to remove duplicates from\n * @returns The array with duplicates removed\n */\nexport function dedupe<TData>(data: TData[]): TData[] {\n\treturn [...new Set(data)];\n}\n\n/**\n * Mutates the position field in an array of objects to enforce uniqueness.\n *\n * @template TData The type of the objects in the array.\n * @param array The array of objects.\n * @throws {Error} If an undefined item is found in the array.\n */\nexport function enforceUniquePositions<TData extends { position: number }>(\n\tarray: TData[],\n): void {\n\tconst newArray = [...array];\n\tnewArray.sort((a, b) => a.position - b.position);\n\tfor (let i = 0; i < newArray.length; i++) {\n\t\tconst item = getItemAtIndex(newArray, i);\n\t\titem.position = i;\n\t}\n}\n\n/**\n * Get the next index or previous index in array, looping around if necessary.\n *\n * @param currentIndex The current index.\n * @param direction The direction to move in.\n * @param items The array of items.\n * @returns The next index.\n */\nexport function getLoopedIndex(\n\tcurrentIndex: number,\n\tdirection: Direction,\n\titems: number | unknown[],\n): number {\n\tconst length = Array.isArray(items) ? items.length : items;\n\tif (direction === Direction.Left) {\n\t\treturn currentIndex - 1 < 0 ? length - 1 : currentIndex - 1;\n\t} else {\n\t\treturn currentIndex + 2 > length ? 0 : currentIndex + 1;\n\t}\n}\n\n/**\n * Reassigns the position field in an array of objects.\n *\n * @example\n * \tconst array = [\n * \t\t{ id: 1, position: 0 },\n * \t\t{ id: 2, position: 1 },\n * \t\t{ id: 3, position: 2 },\n * \t];\n * \tconst newArray = moveItemInArray(array, \"id\", 2, 1);\n * \t// newArray is now [{ id: 1, position: 0 }, { id: 3, position: 1 }, { id: 2, position: 2 }];\n *\n * \tconst notIntrinsicallyOrderedArray = [\n * \t\t{ id: 1, position: 0 },\n * \t\t{ id: 3, position: 2 },\n * \t\t{ id: 2, position: 1 },\n * \t\t{ id: 4, position: 3 },\n * \t];\n * \tconst newArray2 = moveItemInArray(\n * \t\tnotIntrinsicallyOrderedArray,\n * \t\t\"id\",\n * \t\t2,\n * \t\t-1,\n * \t);\n * \t// newArray2 is now [{ id: 1, position: 0 }, { id: 2, position: 1 }, { id: 3, position: 2 }, { id: 4, position: 3 }];\n *\n * @template T The type of the objects in the array. The objects must have a\n *   numeric `position` field.\n * @template K The key field in an array item.\n * @param array The array of objects.\n * @param idField The field to use as the id.\n * @param id The id of the item to move.\n * @param direction The direction to move the item in. 1 for down, -1 for up.\n * @returns An array with the new position values set.\n */\nexport function moveItemInArray<\n\tT extends { position: number },\n\tK extends keyof T,\n>(array: T[], idField: K, id: T[K], direction: -1 | 1): T[] {\n\tconst newArray = [...array];\n\tconst index = newArray.findIndex((item) => item[idField] === id);\n\tif (index === -1) {\n\t\treturn newArray;\n\t}\n\tconst item = getItemAtIndex(newArray, index);\n\tconst originalPosition = item.position;\n\tfor (let i = 0; i < newArray.length; i++) {\n\t\thandleItem<T>(i, index, direction, newArray, originalPosition);\n\t}\n\n\treturn newArray;\n}\n\n/**\n * Gets an item at a specific index in an array, throwing an error if the item\n * is undefined.\n *\n * @template TData The type of the items in the array.\n * @param array The array to get the item from.\n * @param index The index of the item to get.\n * @returns The item at the specified index.\n * @throws {Error} If the item at the specified index is undefined.\n */\nfunction getItemAtIndex<TData>(array: TData[], index: number) {\n\t// eslint-disable-next-line security/detect-object-injection\n\tconst item = array[index];\n\tif (item === undefined) {\n\t\tthrow new Error(\"Undefined item in array at index \" + String(index));\n\t}\n\treturn item;\n}\n\n/**\n * Handles the movement of each item within an array.\n *\n * @template T The type of the array item\n * @param currentIndex The index of the item who's movement is being handled.\n * @param indexBeingMoved The index of the item that was moved.\n * @param direction Whether the indexBeingMoved is moving ahead or back.\n * @param newArray The array being built.\n * @param originalPosition The original position of the item being moved.\n */\nfunction handleItem<T extends { position: number }>(\n\tcurrentIndex: number,\n\tindexBeingMoved: number,\n\tdirection: number,\n\tnewArray: T[],\n\toriginalPosition: number,\n) {\n\tconst item = getItemAtIndex(newArray, currentIndex);\n\tif (currentIndex === indexBeingMoved) {\n\t\tif (direction === -1 || currentIndex < newArray.length - 1) {\n\t\t\titem.position += direction;\n\t\t}\n\t} else if (direction === 1) {\n\t\tif (\n\t\t\titem.position > originalPosition &&\n\t\t\titem.position <= originalPosition + 1\n\t\t) {\n\t\t\titem.position--;\n\t\t}\n\t} else {\n\t\tif (\n\t\t\titem.position < originalPosition &&\n\t\t\titem.position >= originalPosition - 1\n\t\t) {\n\t\t\titem.position++;\n\t\t}\n\t}\n}\n"]}