@alcadur/react-events-hook 1.4.0 → 1.5.0

package/build/actions/on-event.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.onEvent = onEvent;
-var shared_events_1 = require("../shared-events");
-var utils_1 = require("../utils");
-function onEvent(event, callback) {
-    var _a;
-    var callbacks = (_a = shared_events_1.sharedEvents[event]) !== null && _a !== void 0 ? _a : [];
-    var newCallbacks = (0, utils_1.getAsArray)(callback);
-    callbacks.push.apply(callbacks, newCallbacks);
-    shared_events_1.sharedEvents[event] = callbacks;
-    if (shared_events_1.lastEmittedValues[event]) {
-        newCallbacks.forEach(function (callback) { return callback.apply(void 0, shared_events_1.lastEmittedValues[event]); });
-    }
-}

package/build/actions/remove-event.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeEvent = removeEvent;
-var shared_events_1 = require("../shared-events");
-var utils_1 = require("../utils");
-function removeEvent(event, callback) {
-    var declaredCallbacks = shared_events_1.sharedEvents[event];
-    if (!declaredCallbacks) {
-        return;
-    }
-    (0, utils_1.getAsArray)(callback).forEach(function (cb) {
-        var index = declaredCallbacks.indexOf(cb);
-        if (index !== -1) {
-            declaredCallbacks.splice(index, 1);
-        }
-    });
-}

package/build/events.model.js

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

package/build/hooks/index.d.ts

@@ -1 +0,0 @@
-export * from './useEvents';

package/build/hooks/index.js

@@ -1,17 +0,0 @@
-"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("./useEvents"), exports);

package/build/hooks/useEvents.js

@@ -1,33 +0,0 @@
-"use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useEvents = void 0;
-var react_1 = require("react");
-var actions_1 = require("../actions");
-var useEvents = function (eventMap) {
-    if (eventMap === void 0) { eventMap = {}; }
-    (0, react_1.useEffect)(function () {
-        if (!eventMap) {
-            return;
-        }
-        var events = __spreadArray(__spreadArray([], Object.keys(eventMap), true), Object.getOwnPropertySymbols(eventMap), true);
-        events.forEach(function (event) {
-            (0, actions_1.onEvent)(event, eventMap[event]);
-        });
-        return function () {
-            events.forEach(function (event) {
-                (0, actions_1.removeEvent)(event, eventMap[event]);
-            });
-        };
-    }, [eventMap]);
-    return { onEvent: actions_1.onEvent, emitEvent: actions_1.emitEvent, removeEvent: actions_1.removeEvent, clearMemo: actions_1.clearMemo };
-};
-exports.useEvents = useEvents;

package/build/hooks/useEvents.test.d.ts

@@ -1 +0,0 @@
-export {};

package/build/hooks/useEvents.test.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("@testing-library/react");
-var useEvents_1 = require("./useEvents");
-var vitest_1 = require("vitest");
-var shared_events_1 = require("../shared-events");
-(0, vitest_1.describe)('useEvents', function () {
-    (0, vitest_1.beforeEach)(function () {
-        Object.keys(shared_events_1.sharedEvents).forEach(function (key) { return delete shared_events_1.sharedEvents[key]; });
-        Object.keys(shared_events_1.lastEmittedValues).forEach(function (key) { return delete shared_events_1.lastEmittedValues[key]; });
-    });
-    (0, vitest_1.it)('should register and emit events', function () {
-        var result = (0, react_1.renderHook)(function () { return (0, useEvents_1.useEvents)(); }).result;
-        var callback = vitest_1.vi.fn();
-        (0, react_1.act)(function () {
-            result.current.onEvent('test-event', callback);
-        });
-        (0, react_1.act)(function () {
-            result.current.emitEvent('test-event', 'data');
-        });
-        (0, vitest_1.expect)(callback).toHaveBeenCalledWith('data');
-    });
-    (0, vitest_1.it)('should remove events', function () {
-        var result = (0, react_1.renderHook)(function () { return (0, useEvents_1.useEvents)(); }).result;
-        var callback = vitest_1.vi.fn();
-        (0, react_1.act)(function () {
-            result.current.onEvent('test-event', callback);
-            result.current.removeEvent('test-event', callback);
-        });
-        (0, react_1.act)(function () {
-            result.current.emitEvent('test-event', 'data');
-        });
-        (0, vitest_1.expect)(callback).not.toHaveBeenCalled();
-    });
-    (0, vitest_1.it)('should register events from init map', function () {
-        var callback = vitest_1.vi.fn();
-        var callbackSymbol = vitest_1.vi.fn();
-        var symbolEvent = Symbol('init-event');
-        (0, react_1.renderHook)(function () {
-            var _a;
-            return (0, useEvents_1.useEvents)((_a = {
-                    'init-event': callback
-                },
-                _a[symbolEvent] = callbackSymbol,
-                _a));
-        });
-        var result = (0, react_1.renderHook)(function () { return (0, useEvents_1.useEvents)(); }).result;
-        (0, react_1.act)(function () {
-            result.current.emitEvent('init-event', 'init-data');
-            result.current.emitEvent(symbolEvent);
-        });
-        (0, vitest_1.expect)(callback).toHaveBeenCalledWith('init-data');
-        (0, vitest_1.expect)(callbackSymbol).toHaveBeenCalled();
-    });
-    (0, vitest_1.it)('should support memoized events', function () {
-        var result = (0, react_1.renderHook)(function () { return (0, useEvents_1.useEvents)(); }).result;
-        var callback = vitest_1.vi.fn();
-        (0, react_1.act)(function () {
-            result.current.emitEvent.memo('memo-event', 'memo-data');
-        });
-        (0, react_1.act)(function () {
-            result.current.onEvent('memo-event', callback);
-        });
-        (0, vitest_1.expect)(callback).toHaveBeenCalledWith('memo-data');
-    });
-    (0, vitest_1.it)('should clear memoized events', function () {
-        var result = (0, react_1.renderHook)(function () { return (0, useEvents_1.useEvents)(); }).result;
-        var callback = vitest_1.vi.fn();
-        (0, react_1.act)(function () {
-            result.current.emitEvent.memo('memo-event', 'memo-data');
-        });
-        (0, react_1.act)(function () {
-            result.current.clearMemo('memo-event');
-        });
-        (0, react_1.act)(function () {
-            result.current.onEvent('memo-event', callback);
-        });
-        (0, vitest_1.expect)(callback).not.toHaveBeenCalled();
-    });
-});

package/build/index.js

@@ -1,19 +0,0 @@
-"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("./hooks"), exports);
-__exportStar(require("./utils"), exports);
-__exportStar(require("./actions"), exports);

package/build/setupTests.d.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom';

package/build/setupTests.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("@testing-library/jest-dom");

package/build/shared-events.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lastEmittedValues = exports.sharedEvents = void 0;
-exports.sharedEvents = {};
-exports.lastEmittedValues = {};

package/build/utils.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAsArray = getAsArray;
-function getAsArray(value) {
-    return Array.isArray(value) ? value : [value];
-}

package/build/utils.test.d.ts

@@ -1 +0,0 @@
-export {};

package/build/utils.test.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var utils_1 = require("./utils");
-var vitest_1 = require("vitest");
-(0, vitest_1.describe)('utils', function () {
-    (0, vitest_1.describe)('getAsArray', function () {
-        (0, vitest_1.it)('should return the same array if an array is passed', function () {
-            var arr = [vitest_1.vi.fn()];
-            (0, vitest_1.expect)((0, utils_1.getAsArray)(arr)).toBe(arr);
-        });
-        (0, vitest_1.it)('should wrap a single value in an array', function () {
-            var callback = vitest_1.vi.fn();
-            (0, vitest_1.expect)((0, utils_1.getAsArray)(callback)).toEqual([callback]);
-        });
-    });
-});

package/index.ts

@@ -1 +0,0 @@
-export * from './src';

package/src/actions/index.test.ts

@@ -1,147 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { lastEmittedValues, sharedEvents } from "../shared-events";
-import { emitEvent } from "./emit-event";
-import { onEvent } from "./on-event";
-import { removeEvent } from "./remove-event";
-import { clearMemo } from "./clear-memo";
-
-describe("actions", () => {
-    beforeEach(() => {
-        Object.keys(sharedEvents).forEach((key) => delete sharedEvents[key]);
-        Object.keys(lastEmittedValues).forEach((key) => delete lastEmittedValues[key]);
-    });
-
-    describe("onEvent", () => {
-        it("registers a single callback", () => {
-            const callback = vi.fn();
-
-            onEvent("test-event", callback);
-
-            expect(sharedEvents["test-event"]).toEqual([callback]);
-        });
-
-        it("registers an array of callbacks", () => {
-            const callback1 = vi.fn();
-            const callback2 = vi.fn();
-
-            onEvent("test-event", [callback1, callback2]);
-
-            expect(sharedEvents["test-event"]).toEqual([callback1, callback2]);
-        });
-    });
-
-    describe("emitEvent", () => {
-        it("invokes all callbacks with provided args", () => {
-            const callback1 = vi.fn();
-            const callback2 = vi.fn();
-
-            onEvent("test-event", [callback1, callback2]);
-            emitEvent("test-event", "data", 1);
-
-            expect(callback1).toHaveBeenCalledWith("data", 1);
-            expect(callback2).toHaveBeenCalledWith("data", 1);
-        });
-
-        it("does nothing when event has no callbacks", () => {
-            expect(() => emitEvent("missing-event", "data")).not.toThrow();
-        });
-
-        describe("memo", () => {
-            it("invokes all callback and stores the value", () => {
-                const callback = vi.fn();
-                onEvent("memo-event", callback);
-
-                emitEvent.memo("memo-event", "memo-data");
-
-                expect(callback).toHaveBeenCalledWith("memo-data");
-                expect(lastEmittedValues["memo-event"]).toEqual(["memo-data"]);
-            });
-
-            it("triggers callback immediately if event was already memoized", () => {
-                const callback = vi.fn();
-
-                emitEvent.memo("memo-event", "old-data");
-                onEvent("memo-event", callback);
-
-                expect(callback).toHaveBeenCalledWith("old-data");
-            });
-
-            it("clears memoized value when emitEvent.memo is called with undefined", () => {
-                const callback = vi.fn();
-                onEvent("memo-event", callback);
-
-                emitEvent.memo("memo-event", "some-data");
-                expect(lastEmittedValues["memo-event"]).toEqual(["some-data"]);
-                expect(callback).toHaveBeenCalledWith("some-data");
-
-                emitEvent.memo("memo-event", undefined);
-                expect(lastEmittedValues["memo-event"]).toBeUndefined();
-                expect(callback).toHaveBeenCalledWith(undefined);
-            });
-
-            it("should not trigger callback immediately when last emitted value is undefined", () => {
-                const callback = vi.fn();
-                const callback2 = vi.fn();
-
-                emitEvent.memo("memo-event", "some-data");
-                onEvent("memo-event", callback);
-                expect(callback).toHaveBeenCalledWith("some-data");
-
-                emitEvent.memo("memo-event", undefined);
-                onEvent("memo-event", callback2);
-                expect(callback).toHaveBeenCalledWith(undefined);
-                expect(callback2).not.toHaveBeenCalled();
-            });
-        });
-    });
-
-    describe("clearMemo", () => {
-        it("removes the memoized value for a given event", () => {
-            emitEvent.memo("test-event", "data");
-            expect(lastEmittedValues["test-event"]).toEqual(["data"]);
-
-            clearMemo("test-event");
-            expect(lastEmittedValues["test-event"]).toBeUndefined();
-        });
-
-        it("does not trigger callbacks", () => {
-            const callback = vi.fn();
-            onEvent("test-event", callback);
-            emitEvent.memo("test-event", "data");
-            callback.mockClear();
-
-            clearMemo("test-event");
-            expect(callback).not.toHaveBeenCalled();
-        });
-    });
-
-    describe("removeEvent", () => {
-        it("removes a single callback", () => {
-            const callback = vi.fn();
-
-            onEvent("test-event", callback);
-            removeEvent("test-event", callback);
-            emitEvent("test-event", "data");
-
-            expect(callback).not.toHaveBeenCalled();
-        });
-
-        it("removes multiple callbacks from array input", () => {
-            const callback1 = vi.fn();
-            const callback2 = vi.fn();
-
-            onEvent("test-event", [callback1, callback2]);
-            removeEvent("test-event", [callback1, callback2]);
-            emitEvent("test-event", "data");
-
-            expect(callback1).not.toHaveBeenCalled();
-            expect(callback2).not.toHaveBeenCalled();
-        });
-
-        it("does nothing when event has no callbacks", () => {
-            const callback = vi.fn();
-
-            expect(() => removeEvent("missing-event", callback)).not.toThrow();
-        });
-    });
-});

package/src/events.model.ts

@@ -1,4 +0,0 @@
-export type EventNameType = string | number | symbol
-export type EventCallbackType = ((...args: any[]) => void) | (() => void)
-
-export type InitEventsType = { [key: EventNameType]: EventCallbackType[] | EventCallbackType }

package/src/hooks/index.ts

@@ -1 +0,0 @@
-export * from './useEvents';

package/src/hooks/useEvents.test.ts

@@ -1,95 +0,0 @@
-import { renderHook, act } from '@testing-library/react';
-import { useEvents } from './useEvents';
-import { describe, it, expect, beforeEach, vi } from "vitest";
-import { lastEmittedValues, sharedEvents } from '../shared-events';
-
-describe('useEvents', () => {
-    beforeEach(() => {
-        Object.keys(sharedEvents).forEach(key => delete sharedEvents[key]);
-        Object.keys(lastEmittedValues).forEach(key => delete lastEmittedValues[key]);
-    });
-
-    it('should register and emit events', () => {
-        const { result } = renderHook(() => useEvents());
-        const callback = vi.fn();
-
-        act(() => {
-            result.current.onEvent('test-event', callback);
-        });
-
-        act(() => {
-            result.current.emitEvent('test-event', 'data');
-        });
-
-        expect(callback).toHaveBeenCalledWith('data');
-    });
-
-    it('should remove events', () => {
-        const { result } = renderHook(() => useEvents());
-        const callback = vi.fn();
-
-        act(() => {
-            result.current.onEvent('test-event', callback);
-            result.current.removeEvent('test-event', callback);
-        });
-
-        act(() => {
-            result.current.emitEvent('test-event', 'data');
-        });
-
-        expect(callback).not.toHaveBeenCalled();
-    });
-
-    it('should register events from init map', () => {
-        const callback = vi.fn();
-        const callbackSymbol = vi.fn();
-        const symbolEvent = Symbol('init-event');
-        renderHook(() => useEvents({
-            'init-event': callback,
-            [symbolEvent]: callbackSymbol
-        }));
-
-        const { result } = renderHook(() => useEvents());
-        act(() => {
-            result.current.emitEvent('init-event', 'init-data');
-            result.current.emitEvent(symbolEvent);
-        });
-
-        expect(callback).toHaveBeenCalledWith('init-data');
-        expect(callbackSymbol).toHaveBeenCalled()
-    });
-
-    it('should support memoized events', () => {
-        const { result } = renderHook(() => useEvents());
-        const callback = vi.fn();
-
-        act(() => {
-            result.current.emitEvent.memo('memo-event', 'memo-data');
-        });
-
-        act(() => {
-            result.current.onEvent('memo-event', callback);
-        });
-
-        expect(callback).toHaveBeenCalledWith('memo-data');
-    });
-
-    it('should clear memoized events', () => {
-        const { result } = renderHook(() => useEvents());
-        const callback = vi.fn();
-
-        act(() => {
-            result.current.emitEvent.memo('memo-event', 'memo-data');
-        });
-
-        act(() => {
-            result.current.clearMemo('memo-event');
-        });
-
-        act(() => {
-            result.current.onEvent('memo-event', callback);
-        });
-
-        expect(callback).not.toHaveBeenCalled();
-    });
-});

package/src/setupTests.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom';

package/src/shared-events.ts

@@ -1,5 +0,0 @@
-import type { EventCallbackType, EventNameType } from "./events.model";
-
-export const sharedEvents: { [key: EventNameType]: EventCallbackType[] } = {};
-
-export const lastEmittedValues: { [key: EventNameType]: any } = {};

package/src/utils.test.ts

@@ -1,16 +0,0 @@
-import { getAsArray } from './utils';
-import { describe, it, expect, vi } from "vitest";
-
-describe('utils', () => {
-    describe('getAsArray', () => {
-        it('should return the same array if an array is passed', () => {
-            const arr = [vi.fn()];
-            expect(getAsArray(arr)).toBe(arr);
-        });
-
-        it('should wrap a single value in an array', () => {
-            const callback = vi.fn();
-            expect(getAsArray(callback)).toEqual([callback]);
-        });
-    });
-});

package/src/utils.ts

@@ -1,5 +0,0 @@
-import { EventCallbackType } from "./events.model";
-
-export function getAsArray(value: EventCallbackType[] | EventCallbackType): EventCallbackType[] {
-    return Array.isArray(value) ? value : [value];
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "build",
-    "jsx": "react",
-    "skipLibCheck": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "lib": ["esnext"],
-    "strictNullChecks": true,
-  },
-  "include": ["src"],
-  "exclude": ["example"]
-}

package/vitest.config.ts

@@ -1,13 +0,0 @@
-import { defineConfig } from 'vitest/config';
-import react from '@vitejs/plugin-react';
-
-export default defineConfig({
-  plugins: [react()],
-  test: {
-    environment: 'jsdom',
-    globals: true,
-    type: 'module',
-    setupFiles: './src/setupTests.ts',
-    exclude: ['dist/**', 'node_modules/**']
-  },
-});