@wiggindev/utils 0.2.12 → 0.2.13

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wiggindev/utils",
     "description": "Various utilities that I use in my projects",
-    "version": "0.2.12",
+    "version": "0.2.13",
     "author": {
         "name": "Andrew Wiggin",
         "email": "andrew@wiggin.dev",
@@ -12,6 +12,10 @@
         "url": "https://github.com/wiggindev/-wiggindev.git",
         "directory": "packages/utils"
     },
+    "files": [
+        "dist",
+        "README.md"
+    ],
     "type": "module",
     "source": "src/index.ts",
     "exports": {
@@ -23,8 +27,9 @@
     "unpkg": "dist/index.umd.js",
     "types": "dist/index.d.ts",
     "scripts": {
-        "build": "rm -rf dist && microbundle",
-        "dev": "rm -rf dist && microbundle watch"
+        "clean": "rm -rf dist",
+        "build": "yarn clean && microbundle",
+        "dev": "microbundle watch"
     },
     "devDependencies": {
         "microbundle": "^0.15.0"

package/__tests__/events.test.ts

@@ -1,30 +0,0 @@
-import { EventName, events, EventListener, noop } from '../src';
-
-type DocumentEventName = EventName<DocumentEventMap>;
-type DocumentEventListener = EventListener<DocumentEventMap, DocumentEventName>;
-
-describe('document events', () => {
-    let eventMap: Partial<Record<DocumentEventName, DocumentEventListener>> =
-        {};
-
-    beforeEach(() => {
-        eventMap = {};
-
-        document.addEventListener = jest.fn(
-            (event: DocumentEventName, callback: DocumentEventListener) =>
-                (eventMap[event] = callback)
-        );
-        document.removeEventListener = jest.fn(
-            (event: DocumentEventName, callback: DocumentEventListener) =>
-                delete eventMap[event]
-        );
-    });
-
-    it('should add an event listener to the document', () => {
-        jest.spyOn(document, 'addEventListener');
-        events.document.on('testEvent', noop);
-        expect(eventMap['testEvent']).toBeDefined();
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        expect(document.addEventListener).toHaveBeenCalled();
-    });
-});

package/src/events/document.ts

@@ -1,31 +0,0 @@
-import { EventListener, EventName, DomEventListener } from './eventTypes';
-
-export const on = <E extends EventName<DocumentEventMap>>(
-    event: E,
-    listener: EventListener<DocumentEventMap, E>
-) => {
-    document.addEventListener(event, listener as DomEventListener);
-};
-
-export const off = <E extends EventName<DocumentEventMap>>(
-    event: E,
-    listener: EventListener<DocumentEventMap, E>
-) => {
-    document.removeEventListener(event, listener as DomEventListener);
-};
-
-export const once = <E extends EventName<DocumentEventMap>>(
-    event: E,
-    listener: EventListener<DocumentEventMap, E>
-) => {
-    const wrappedListener: EventListener<DocumentEventMap, E> = e => {
-        listener(e);
-        off(event, wrappedListener);
-    };
-    on(event, wrappedListener);
-};
-
-export const trigger = (event: string) => {
-    const customEvent = new CustomEvent(event);
-    document.dispatchEvent(customEvent);
-};

package/src/events/element.ts

@@ -1,34 +0,0 @@
-import { EventListener, EventName, DomEventListener } from './eventTypes';
-
-export const on = <E extends EventName<HTMLElementEventMap>>(
-    element: HTMLElement,
-    event: E,
-    listener: EventListener<HTMLElementEventMap, E>
-) => {
-    element.addEventListener(event, listener as DomEventListener);
-};
-
-export const off = <E extends EventName<HTMLElementEventMap>>(
-    element: HTMLElement,
-    event: E,
-    listener: EventListener<HTMLElementEventMap, E>
-) => {
-    element.removeEventListener(event, listener as DomEventListener);
-};
-
-export const once = <E extends EventName<HTMLElementEventMap>>(
-    element: HTMLElement,
-    event: E,
-    listener: EventListener<HTMLElementEventMap, E>
-) => {
-    const wrappedListener: EventListener<HTMLElementEventMap, E> = e => {
-        listener(e);
-        off(element, event, wrappedListener);
-    };
-    on(element, event, wrappedListener);
-};
-
-export const trigger = (element: HTMLElement, event: string) => {
-    const customEvent = new CustomEvent(event);
-    element.dispatchEvent(customEvent);
-};

package/src/events/eventTypes.ts

@@ -1,9 +0,0 @@
-import { LiteralUnion } from '../types';
-
-type EventMap = WindowEventMap | DocumentEventMap | HTMLElementEventMap;
-
-export type EventName<M extends EventMap> = LiteralUnion<keyof M, string>;
-export type EventListener<M extends EventMap, N extends EventName<M>> = (
-    event: N extends keyof M ? M[N] : Event
-) => void;
-export type DomEventListener = (event: Event) => void;

package/src/events/index.ts

@@ -1,11 +0,0 @@
-import * as documentEvents from './document';
-import * as windowEvents from './window';
-import * as elementEvents from './element';
-
-export const events = {
-    document: documentEvents,
-    window: windowEvents,
-    element: elementEvents,
-};
-
-export type { EventListener, EventName } from './eventTypes';

package/src/events/window.ts

@@ -1,31 +0,0 @@
-import { EventListener, EventName, DomEventListener } from './eventTypes';
-
-export const on = <E extends EventName<WindowEventMap>>(
-    event: E,
-    listener: EventListener<WindowEventMap, E>
-) => {
-    window.addEventListener(event, listener as DomEventListener);
-};
-
-export const off = <E extends EventName<WindowEventMap>>(
-    event: E,
-    listener: EventListener<WindowEventMap, E>
-) => {
-    window.removeEventListener(event, listener as DomEventListener);
-};
-
-export const once = <E extends EventName<WindowEventMap>>(
-    event: E,
-    listener: EventListener<WindowEventMap, E>
-) => {
-    const wrappedListener: EventListener<WindowEventMap, E> = e => {
-        listener(e);
-        off(event, wrappedListener);
-    };
-    on(event, wrappedListener);
-};
-
-export const trigger = (event: string) => {
-    const customEvent = new CustomEvent(event);
-    window.dispatchEvent(customEvent);
-};

package/src/index.ts

@@ -1,5 +0,0 @@
-export { events } from './events';
-export type { EventName, EventListener } from './events';
-export type { LiteralUnion, Callback } from './types';
-export { throttle } from './throttle';
-export { noop } from './noop';

package/src/noop.ts

@@ -1 +0,0 @@
-export const noop = () => undefined;

package/src/throttle.ts

@@ -1,22 +0,0 @@
-import { Callback } from './types';
-
-type ThrottledFunction<C extends Callback> = (
-    ...args: Parameters<C>
-) => ReturnType<C>;
-
-export const throttle = <C extends Callback>(
-    callback: C,
-    limit: number
-): ThrottledFunction<C> => {
-    let waiting: boolean;
-    let prev: ReturnType<C>;
-    return (...args: Parameters<C>) => {
-        if (!waiting) {
-            waiting = true;
-            setTimeout(() => (waiting = false), limit);
-            prev = callback.apply(this, args) as ReturnType<C>;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-        return prev;
-    };
-};

package/src/types/Callback.ts

@@ -1,2 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Callback = (...args: any) => any;

package/src/types/LiteralUnion.ts

@@ -1,7 +0,0 @@
-/** from type-fest: https://github.com/sindresorhus/type-fest/blob/main/source/literal-union.d.ts */
-
-type Primitive = null | undefined | string | number | boolean | symbol | bigint;
-
-export type LiteralUnion<LiteralType, BaseType extends Primitive> =
-    | LiteralType
-    | (BaseType & Record<never, never>);

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export type { LiteralUnion } from './LiteralUnion';
-export type { Callback } from './Callback';

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "compilerOptions": {
-        "outDir": "dist"
-    },
-    "include": ["src/**/*"],
-    "exclude": ["dist"]
-}