@thednp/shorty 2.0.0-alpha16 → 2.0.0-alpha18

package/package.json

@@ -1,66 +1,71 @@
-{
-  "name": "@thednp/shorty",
-  "version": "2.0.0alpha16",
-  "description": "TypeScript shorties for the web",
-  "source": "./src/index.ts",
-  "main": "./dist/shorty.js",
-  "module": "./dist/shorty.mjs",
-  "exports": {
-    ".": {
-      "types": "./dist/shorty.d.ts",
-      "require": "./dist/shorty.cjs",
-      "import": "./dist/shorty.mjs"
-    }
-  },
-  "scripts": {
-    "pre-test": "npm run clean-coverage",
-    "test": "npm run pre-test && npx cypress run",
-    "clean-coverage": "rimraf coverage .nyc_output",
-    "cypress": "npm run pre-test && npx cypress open",
-    "coverage:report": "nyc report --reporter=lcov --reporter=json --reporter=text --reporter=json-summary",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint:ts": "eslint -c .eslintrc.cjs --ext .ts src",
-    "fix:ts": "eslint -c .eslintrc.cjs --ext .ts src --fix",
-    "build": "npm run lint:ts && vite build && npm run dts",
-    "dts": "dts-bundle-generator --config ./dts.config.ts"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thednp/shorty.git"
-  },
-  "keywords": [
-    "shorty",
-    "javascript",
-    "typescript"
-  ],
-  "author": "dnp_theme",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/thednp/shorty/issues"
-  },
-  "homepage": "https://github.com/thednp/shorty",
-  "devDependencies": {
-    "@bahmutov/cypress-esbuild-preprocessor": "^2.2.0",
-    "@cypress/code-coverage": "^3.10.8",
-    "@types/istanbul-lib-instrument": "^1.7.4",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
-    "cypress": "^12.16.0",
-    "dts-bundle-generator": "^8.0.1",
-    "eslint": "^8.44.0",
-    "eslint-plugin-jsdoc": "^46.4.3",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "istanbul-lib-coverage": "^3.2.0",
-    "istanbul-lib-instrument": "^5.2.1",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.8",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.1.6",
-    "vite": "^4.3.9"
-  }
-}
+{
+  "name": "@thednp/shorty",
+  "version": "2.0.0alpha18",
+  "description": "TypeScript shorties for the web",
+  "source": "./src/index.ts",
+  "main": "./dist/shorty.js",
+  "module": "./dist/shorty.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/shorty.d.ts",
+      "require": "./dist/shorty.cjs",
+      "import": "./dist/shorty.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thednp/shorty.git"
+  },
+  "keywords": [
+    "shorty",
+    "javascript",
+    "typescript"
+  ],
+  "author": "thednp",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thednp/shorty/issues"
+  },
+  "homepage": "https://github.com/thednp/shorty",
+  "devDependencies": {
+    "@bahmutov/cypress-esbuild-preprocessor": "^2.2.0",
+    "@cypress/code-coverage": "^3.12.0",
+    "@types/istanbul-lib-instrument": "^1.7.4",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "cypress": "^12.17.4",
+    "dts-bundle-generator": "^8.0.1",
+    "eslint": "^8.48.0",
+    "eslint-plugin-jsdoc": "^46.5.1",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "istanbul-lib-coverage": "^3.2.0",
+    "istanbul-lib-instrument": "^5.2.1",
+    "nyc": "^15.1.0",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.9"
+  },
+  "packageManager": "pnpm@8.6.12",
+  "engines": {
+    "node": ">=16",
+    "pnpm": ">=8.6.0"
+  },
+  "scripts": {
+    "pre-test": "pnpm clean-coverage",
+    "test": "pnpm pre-test && npx cypress run",
+    "clean-coverage": "rimraf coverage .nyc_output",
+    "cypress": "pnpm pre-test && npx cypress open",
+    "coverage:report": "nyc report --reporter=lcov --reporter=json --reporter=text --reporter=json-summary",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint:ts": "eslint -c .eslintrc.cjs --ext .ts src",
+    "fix:ts": "eslint -c .eslintrc.cjs --ext .ts src --fix",
+    "build": "pnpm lint:ts && vite build && pnpm dts",
+    "dts": "dts-bundle-generator --config ./dts.config.ts"
+  }
+}

package/src/event/off.ts

@@ -1,10 +1,12 @@
+import { NativeEventTypes, PossibleEventTarget, SupportedEventHandler } from '../interface/event';
+
 /**
  * Remove eventListener from an `EventTarget` object.
  */
-const off = (
-  element: EventTarget,
-  eventName: string,
-  listener: EventListener,
+const off = <T extends PossibleEventTarget>(
+  element: T,
+  eventName: NativeEventTypes,
+  listener: EventListenerObject & SupportedEventHandler<T>,
   options?: AddEventListenerOptions,
 ) => {
   const ops = options || false;

package/src/event/on.ts

@@ -1,10 +1,12 @@
+import { NativeEventTypes, PossibleEventTarget, SupportedEventHandler } from '../interface/event';
+
 /**
  * Add eventListener to an `EventTarget` object.
  */
-const on = (
-  element: EventTarget,
-  eventName: string,
-  listener: EventListener,
+const on = <T extends PossibleEventTarget>(
+  element: T,
+  eventName: NativeEventTypes,
+  listener: EventListenerObject & SupportedEventHandler<T>,
   options?: AddEventListenerOptions,
 ) => {
   const ops = options || false;

package/src/event/one.ts

@@ -1,3 +1,11 @@
+import {
+  EventHandler,
+  NativeEvent,
+  NativeEventTypes,
+  PossibleEventTarget,
+  SupportedEventHandler,
+} from '../interface/event';
+
 import on from './on';
 import off from './off';
 
@@ -5,21 +13,31 @@ import off from './off';
  * Add an `eventListener` to an `EventTarget`
  * element and remove it once callback is called.
  */
-const one = (
-  element: EventTarget,
-  eventName: string,
-  listener: EventListener,
+const one = <T extends PossibleEventTarget>(
+  element: T,
+  eventName: NativeEventTypes,
+  listener: SupportedEventHandler<T>,
   options?: AddEventListenerOptions,
 ) => {
   /** Wrap the listener for easy on -> off */
-  const handlerWrapper = (e: Event): void => {
+  const handlerWrapper = (e: NativeEvent): void => {
     /* istanbul ignore else */
     if (e.target === element || e.currentTarget === element) {
-      listener.apply(element, [e]);
-      off(element, eventName, handlerWrapper, options);
+      (listener as EventHandler<typeof e>).apply(element, [e]);
+      off(
+        element,
+        eventName,
+        handlerWrapper as unknown as EventListenerObject & SupportedEventHandler<T>,
+        options,
+      );
     }
   };
-  on(element, eventName, handlerWrapper, options);
+  on(
+    element,
+    eventName,
+    handlerWrapper as unknown as EventListenerObject & SupportedEventHandler<T>,
+    options,
+  );
 };
 
 export default one;

package/src/index.ts

@@ -96,6 +96,7 @@ import keyCapsLock from './strings/keyCapsLock';
 import keyControl from './strings/keyControl';
 import keyDelete from './strings/keyDelete';
 import keyEnter from './strings/keyEnter';
+import keyNumpadEnter from './strings/keyNumpadEnter';
 import keyEscape from './strings/keyEscape';
 import keyInsert from './strings/keyInsert';
 import keyMeta from './strings/keyMeta';
@@ -185,6 +186,7 @@ import ObjectEntries from './misc/ObjectEntries';
 import ObjectHasOwn from './misc/ObjectHasOwn';
 import ObjectKeys from './misc/ObjectKeys';
 import ObjectValues from './misc/ObjectValues';
+import ObjectFromEntries from './misc/ObjectFromEntries';
 import createCustomEvent from './misc/createCustomEvent';
 import passiveHandler from './misc/passiveHandler';
 import reflow from './misc/reflow';
@@ -361,6 +363,7 @@ export {
   keyControl,
   keyDelete,
   keyEnter,
+  keyNumpadEnter,
   keyEscape,
   keyInsert,
   keyMeta,
@@ -455,6 +458,7 @@ export {
   ObjectEntries,
   ObjectKeys,
   ObjectValues,
+  ObjectFromEntries,
   getBoundingClientRect,
   getDocument,
   getDocumentBody,