ts-dom-utils 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rafał Całka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# TS Dom Utils
+A lightweight TypeScript library that provides simple wrappers around common DOM manipulation functions.
+It allows you to write less code.
+Although it's written in TypeScript, it can also be used in JavaScript projects.
+
+## Installation
+
+```shell
+# npm
+npm install ts-dom-utils
+# or Yarn
+yarn add ts-dom-utils
+```
+
+## Features
+- Strong TypeScript typings for better editor autocompletion and error checking.
+- Compatible with both TypeScript and JavaScript projects.
+- Simple and intuitive API.
+
+
+## Functions
+
+### `createElement`
+Creates a new element with the provided options.
+
+Example
+```typescript
+import { createElement } from 'ts-dom-utils';
+
+const button = createElement('button', {
+  id: 'my-button',
+  'aria-expandended': 'false',
+  class: ['btn', 'btn-primary'],
+  text: 'Click me',
+  dataset: {
+    action: 'open-modal',
+  },
+});
+
+document.body.appendChild(button);
+```
+
+| Param   | Default   | Description                                                                                                                                                                                    |
+|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| tagName | undefined | The tag name of the element type to create.                                                                                                                                                    |
+| options | {}        | The options to use when creating the element. Options can include any attributes that can be passed to `setAttribute`, with `class`, `dataset`, and `text` as special options for enhancement. |
+| target  | document  | The Document in which to create the element.                                                                                                                                                   |
+---
+
+### `qs`
+A wrapper function for `document.querySelector`.
+
+Example
+```typescript
+import { qs } from 'ts-dom-utils';
+
+const wrapper = qs<HTMLDivElement>('.footer > .buttons');
+const button = qs<HTMLButtonElement>('button', wrapper);
+```
+| Param    | Default    | Description                                         |
+|----------|------------|-----------------------------------------------------|
+| selector | undefined  | The selector to match against.                      |
+| parent   | document   | The ParentNode in which to search for the selector. |
+
+---
+
+### `qsa`
+A wrapper function for `document.querySelectorAll`.
+
+Example
+```typescript
+import { qsa } from 'ts-dom-utils';
+
+const buttons = qsa<HTMLButtonElement>('.btn');
+```
+
+| Param    | Default   | Description                                         |
+|----------|-----------|-----------------------------------------------------|
+| selector | undefined | The selector to match against.                      |
+| parent   | document  | The ParentNode in which to search for the selector. |

package/dist/chunk-2CYKZHHS.js

@@ -0,0 +1,32 @@
+// src/createElement.ts
+function createElement(tagName, options = {}, target = document) {
+  const element = target.createElement(tagName);
+  Object.entries(options).forEach(([key, value]) => {
+    if (key === "class") {
+      if (Array.isArray(value)) {
+        element.classList.add(...value);
+      } else {
+        element.classList.add(value);
+      }
+      return;
+    }
+    if (key === "dataset" && typeof value === "object" && value !== null) {
+      Object.entries(value).forEach(
+        ([dataKey, dataValue]) => {
+          element.dataset[dataKey] = dataValue;
+        }
+      );
+      return;
+    }
+    if (key === "text") {
+      element.textContent = value;
+      return;
+    }
+    element.setAttribute(key, value);
+  });
+  return element;
+}
+
+export {
+  createElement
+};

package/dist/chunk-MRTNZYZJ.js

@@ -0,0 +1,8 @@
+// src/qsa.ts
+function qsa(selector, parent = document) {
+  return parent.querySelectorAll(selector);
+}
+
+export {
+  qsa
+};

package/dist/chunk-QUWBOENH.js

@@ -0,0 +1,8 @@
+// src/qs.ts
+function qs(selector, parent = document) {
+  return parent.querySelector(selector);
+}
+
+export {
+  qs
+};

package/dist/createElement.cjs

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/createElement.ts
+var createElement_exports = {};
+__export(createElement_exports, {
+  default: () => createElement
+});
+module.exports = __toCommonJS(createElement_exports);
+function createElement(tagName, options = {}, target = document) {
+  const element = target.createElement(tagName);
+  Object.entries(options).forEach(([key, value]) => {
+    if (key === "class") {
+      if (Array.isArray(value)) {
+        element.classList.add(...value);
+      } else {
+        element.classList.add(value);
+      }
+      return;
+    }
+    if (key === "dataset" && typeof value === "object" && value !== null) {
+      Object.entries(value).forEach(
+        ([dataKey, dataValue]) => {
+          element.dataset[dataKey] = dataValue;
+        }
+      );
+      return;
+    }
+    if (key === "text") {
+      element.textContent = value;
+      return;
+    }
+    element.setAttribute(key, value);
+  });
+  return element;
+}

package/dist/createElement.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Create a new element with the provided options.
+ * @param tagName - The name of the element type to create.
+ * @param options - The options to use when creating the element.
+ * @param target - The Document in which to create the element. Defaults to the current document.
+ */
+declare function createElement<K extends keyof HTMLElementTagNameMap>(tagName: K, options?: CreateElementOptions, target?: Document): HTMLElementTagNameMap[K];
+type CreateElementOptions = {
+    [key: string]: any;
+    class?: string | string[];
+    dataset?: Record<string, string>;
+    text?: string;
+};
+
+export { CreateElementOptions, createElement as default };

package/dist/createElement.js

@@ -0,0 +1,6 @@
+import {
+  createElement
+} from "./chunk-2CYKZHHS.js";
+export {
+  createElement as default
+};

package/dist/index.cjs

@@ -0,0 +1,72 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createElement: () => createElement,
+  qs: () => qs,
+  qsa: () => qsa
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/createElement.ts
+function createElement(tagName, options = {}, target = document) {
+  const element = target.createElement(tagName);
+  Object.entries(options).forEach(([key, value]) => {
+    if (key === "class") {
+      if (Array.isArray(value)) {
+        element.classList.add(...value);
+      } else {
+        element.classList.add(value);
+      }
+      return;
+    }
+    if (key === "dataset" && typeof value === "object" && value !== null) {
+      Object.entries(value).forEach(
+        ([dataKey, dataValue]) => {
+          element.dataset[dataKey] = dataValue;
+        }
+      );
+      return;
+    }
+    if (key === "text") {
+      element.textContent = value;
+      return;
+    }
+    element.setAttribute(key, value);
+  });
+  return element;
+}
+
+// src/qs.ts
+function qs(selector, parent = document) {
+  return parent.querySelector(selector);
+}
+
+// src/qsa.ts
+function qsa(selector, parent = document) {
+  return parent.querySelectorAll(selector);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createElement,
+  qs,
+  qsa
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default as createElement } from './createElement.js';
+export { default as qs } from './qs.js';
+export { default as qsa } from './qsa.js';

package/dist/index.js

@@ -0,0 +1,14 @@
+import {
+  createElement
+} from "./chunk-2CYKZHHS.js";
+import {
+  qs
+} from "./chunk-QUWBOENH.js";
+import {
+  qsa
+} from "./chunk-MRTNZYZJ.js";
+export {
+  createElement,
+  qs,
+  qsa
+};

package/dist/qs.cjs

@@ -0,0 +1,28 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/qs.ts
+var qs_exports = {};
+__export(qs_exports, {
+  default: () => qs
+});
+module.exports = __toCommonJS(qs_exports);
+function qs(selector, parent = document) {
+  return parent.querySelector(selector);
+}

package/dist/qs.d.ts

@@ -0,0 +1,9 @@
+/**
+ * QuerySelector wrapper function.
+ * @param selector The selector to match against.
+ * @param parent The ParentNode in which to search for the selector.
+ * @returns The first Element within the document that matches the specified selector, or group of selectors.
+ */
+declare function qs<E extends Element>(selector: string, parent?: ParentNode): E | null;
+
+export { qs as default };

package/dist/qs.js

@@ -0,0 +1,6 @@
+import {
+  qs
+} from "./chunk-QUWBOENH.js";
+export {
+  qs as default
+};

package/dist/qsa.cjs

@@ -0,0 +1,28 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/qsa.ts
+var qsa_exports = {};
+__export(qsa_exports, {
+  default: () => qsa
+});
+module.exports = __toCommonJS(qsa_exports);
+function qsa(selector, parent = document) {
+  return parent.querySelectorAll(selector);
+}

package/dist/qsa.d.ts

@@ -0,0 +1,8 @@
+/**
+ * QuerySelectorAll wrapper function.
+ * @param selector - The selector to match against.
+ * @param parent - The ParentNode in which to search for the selector. Defaults to the entire document.
+ */
+declare function qsa<E extends Element>(selector: string, parent?: ParentNode): NodeListOf<E>;
+
+export { qsa as default };

package/dist/qsa.js

@@ -0,0 +1,6 @@
+import {
+  qsa
+} from "./chunk-MRTNZYZJ.js";
+export {
+  qsa as default
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "ts-dom-utils",
+  "version": "1.0.0",
+  "description": "A simple, typeful utility library for DOM manipulation in TypeScript.",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup --dts",
+    "lint": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rafaucau/ts-dom-utils.git"
+  },
+  "keywords": [
+    "dom",
+    "typescript",
+    "utilities"
+  ],
+  "author": "rafaucau",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rafaucau/ts-dom-utils/issues"
+  },
+  "homepage": "https://github.com/rafaucau/ts-dom-utils#readme",
+  "devDependencies": {
+    "prettier": "^2.8.8",
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.4"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noUncheckedIndexedAccess": true,
+    "noEmit": true
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  format: ['cjs', 'esm'],
+  entry: ['src/**/*.ts'],
+  clean: true,
+});