totally-tubular 0.3.0 → 0.3.2

package/dist/cjs/index.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Tubular", {
+    enumerable: true,
+    get: function() {
+        return _totallytubular.Tubular;
+    }
+});
+const _totallytubular = require("./totally-tubular.cjs");

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export { Tubular } from './totally-tubular.js';

package/dist/cjs/{totally-tubular-react.cjs → react.cjs}

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "useTubular", {
         return useTubular;
     }
 });
-const _react = require("react");
+const _react = require("./react.cjs");
 function useTubular(tubular, key) {
     /** state */ const [val, setVal] = (0, _react.useState)(()=>tubular.read(key));
     /** callbacks */ const handleUpdateVal = (0, _react.useCallback)((newValOrCallback)=>{

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export { Tubular } from './totally-tubular.js';

package/dist/esm/index.mjs

@@ -0,0 +1 @@
+export { Tubular } from './totally-tubular.mjs';

package/dist/esm/{totally-tubular-react.mjs → react.mjs}

@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useState } from 'react';
+import { useCallback, useEffect, useState } from './react.mjs';
 /**
  * A React hook that binds to a {@link Tubular} instance and a specific key path
  * within its state.

package/package.json

@@ -3,10 +3,10 @@
   "description": "A completely framework-agnostic, JavaScript / TypeScript state management and update broadcasting library wit zero dependencies, solid performance and a micro file size.",
   "name": "totally-tubular",
   "type": "module",
-  "main": "./dist/totally-tubular.js",
-  "types": "./dist/totally-tubular.d.ts",
+  "main": "./dist/cjs/index.cjs",
+  "types": "./dist/cjs/index.d.ts",
   "typings": "./dist/totally-tubular.d.ts",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "keywords": [
     "state",
     "management",
@@ -54,24 +54,24 @@
     "react": ">=18"
   },
   "exports": {
-    "./totally-tubular-react": {
+    ".": {
       "require": {
-        "types": "./dist/cjs/totally-tubular-react.d.ts",
-        "default": "./dist/cjs/totally-tubular-react.cjs"
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
       },
       "import": {
-        "types": "./dist/esm/totally-tubular-react.d.ts",
-        "default": "./dist/esm/totally-tubular-react.mjs"
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.mjs"
       }
     },
-    "./totally-tubular-react.test": {
+    "./react": {
       "require": {
-        "types": "./dist/cjs/totally-tubular-react.test.d.ts",
-        "default": "./dist/cjs/totally-tubular-react.test.cjs"
+        "types": "./dist/cjs/react.d.ts",
+        "default": "./dist/cjs/react.cjs"
       },
       "import": {
-        "types": "./dist/esm/totally-tubular-react.test.d.ts",
-        "default": "./dist/esm/totally-tubular-react.test.mjs"
+        "types": "./dist/esm/react.d.ts",
+        "default": "./dist/esm/react.mjs"
       }
     },
     "./totally-tubular": {
@@ -84,16 +84,6 @@
         "default": "./dist/esm/totally-tubular.mjs"
       }
     },
-    "./totally-tubular.test": {
-      "require": {
-        "types": "./dist/cjs/totally-tubular.test.d.ts",
-        "default": "./dist/cjs/totally-tubular.test.cjs"
-      },
-      "import": {
-        "types": "./dist/esm/totally-tubular.test.d.ts",
-        "default": "./dist/esm/totally-tubular.test.mjs"
-      }
-    },
     "./types": {
       "require": {
         "types": "./dist/cjs/types.d.ts",
@@ -105,5 +95,6 @@
       }
     },
     "./package.json": "./package.json"
-  }
+  },
+  "module": "./dist/esm/index.mjs"
 }

package/dist/cjs/totally-tubular-react.test.cjs

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _buntest = require("bun:test");
-const _react = require("@testing-library/react");
-const _totallytubular = require("./totally-tubular.cjs");
-const _totallytubularreact = require("./totally-tubular-react.cjs");
-const makeInitialState = ()=>({
-        animals: [],
-        drink: {
-            beer: true,
-            kind: 'guiness'
-        },
-        food: {
-            pasta: false,
-            pizza: true
-        }
-    });
-(0, _buntest.describe)('useTubular', ()=>{
-    (0, _buntest.it)('should read an initial value from a Tubular instance', ()=>{
-        const initial = makeInitialState();
-        initial.drink.kind = 'Guiness 0.0%';
-        const t = new _totallytubular.Tubular(initial);
-        const { result } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'drink.kind'));
-        (0, _buntest.expect)(result.current[0]).toBe('Guiness 0.0%');
-    });
-    (0, _buntest.it)('should update a top-level value and reflect the change', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const animals = [
-            'cats',
-            'dogs'
-        ];
-        const { result, rerender } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'animals'));
-        (0, _buntest.expect)(result.current[0]).toEqual([]);
-        (0, _react.act)(()=>{
-            result.current[1](animals);
-        });
-        rerender();
-        (0, _buntest.expect)(result.current[0]).toEqual(animals);
-    });
-    (0, _buntest.it)('should update a nested value using a callback updater', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const { result, rerender } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'food.pasta'));
-        (0, _buntest.expect)(result.current[0]).toBeFalse();
-        (0, _react.act)(()=>{
-            result.current[1]((prev)=>!prev);
-        });
-        rerender();
-        (0, _buntest.expect)(result.current[0]).toBeTrue();
-    });
-    (0, _buntest.it)('should notify all hooks observing the same key when one updates', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const { result: resultA, rerender: rerenderA } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'drink.beer'));
-        const { result: resultB, rerender: rerenderB } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'drink.beer'));
-        (0, _buntest.expect)(resultA.current[0]).toBeTrue();
-        (0, _buntest.expect)(resultB.current[0]).toBeTrue();
-        (0, _react.act)(()=>{
-            resultA.current[1](false);
-        });
-        rerenderA();
-        rerenderB();
-        (0, _buntest.expect)(resultA.current[0]).toBeFalse();
-        (0, _buntest.expect)(resultB.current[0]).toBeFalse();
-    });
-    (0, _buntest.it)('should unobserve when the hook unmounts', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const { result, unmount } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'drink.kind'));
-        (0, _buntest.expect)(result.current[0]).toBe('guiness');
-        unmount();
-        // Update after unmount — the store still works, but the unmounted hook
-        // should no longer be observing so no "update on unmounted component" error occurs.
-        (0, _react.act)(()=>{
-            t.update('drink.kind', ()=>'stella');
-        });
-        // Verify the store update took effect via a fresh hook instance.
-        const { result: freshResult } = (0, _react.renderHook)(()=>(0, _totallytubularreact.useTubular)(t, 'drink.kind'));
-        (0, _buntest.expect)(freshResult.current[0]).toBe('stella');
-    });
-});

package/dist/cjs/totally-tubular-react.test.d.ts

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

package/dist/cjs/totally-tubular.test.cjs

@@ -1,140 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _buntest = require("bun:test");
-const _totallytubular = require("./totally-tubular.cjs");
-const makeInitialState = ()=>({
-        animals: [],
-        drink: {
-            beer: true,
-            kind: 'guiness'
-        },
-        food: {
-            pasta: false,
-            pizza: true
-        }
-    });
-(0, _buntest.describe)('totally-tubular', ()=>{
-    (0, _buntest.test)('should update one single property', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const newVal = 'old speckled hen';
-        t.update('drink.kind', ()=>newVal);
-        (0, _buntest.expect)(t.read('drink.kind')).toBe(newVal);
-    });
-    (0, _buntest.test)('should ensure update is called multiple times', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const initialBeer = t.read('drink.kind');
-        const v1 = 'ginger beer';
-        const v2 = 'corona';
-        const v3 = "London's Pride";
-        const ob = _buntest.vi.fn();
-        t.observe('drink.kind', ob);
-        t.update('drink.kind', ()=>v1);
-        t.update('drink.kind', ()=>v2);
-        t.update('drink.kind', ()=>v3);
-        (0, _buntest.expect)(ob).toHaveBeenNthCalledWith(1, v1, initialBeer, 'drink.kind');
-        (0, _buntest.expect)(ob).toHaveBeenNthCalledWith(2, v2, v1, 'drink.kind');
-        (0, _buntest.expect)(ob).toHaveBeenNthCalledWith(3, v3, v2, 'drink.kind');
-    });
-    (0, _buntest.test)('should update an array', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        t.update('animals', (prev)=>[
-                ...prev,
-                'birds'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'cats'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'dogs'
-            ]);
-        (0, _buntest.expect)(t.read('animals')).toStrictEqual([
-            'birds',
-            'cats',
-            'dogs'
-        ]);
-    });
-    (0, _buntest.test)('should update one item in an array', ()=>{
-        const t = new _totallytubular.Tubular({
-            ...makeInitialState(),
-            animals: [
-                'beagle',
-                'corgie',
-                'dachshund'
-            ]
-        });
-        t.update('animals', (prev)=>prev.toSpliced(1, 1, 'yorkie'));
-        (0, _buntest.expect)(t.read('animals')).toStrictEqual([
-            'beagle',
-            'yorkie',
-            'dachshund'
-        ]);
-    });
-    (0, _buntest.test)('should observe and then disconnect', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const foodOb = _buntest.vi.fn();
-        const pizzaOb = _buntest.vi.fn();
-        t.observe('food.pasta', foodOb);
-        t.observe('food.pizza', pizzaOb);
-        t.update('food.pasta', (prev)=>!prev);
-        t.update('food.pizza', (prev)=>!prev);
-        t.unobserve('food.pasta', foodOb);
-        t.update('food.pasta', (prev)=>!prev);
-        t.update('food.pizza', (prev)=>!prev);
-        (0, _buntest.expect)(t.read('food.pasta')).toBeFalsy();
-        (0, _buntest.expect)(t.read('food.pizza')).toBeTruthy();
-        (0, _buntest.expect)(foodOb).toHaveBeenCalledTimes(1);
-        (0, _buntest.expect)(pizzaOb).toHaveBeenCalledTimes(2);
-    });
-    (0, _buntest.test)('should observe an array and object', ()=>{
-        const t = new _totallytubular.Tubular(makeInitialState());
-        const animalsOb = _buntest.vi.fn();
-        const drinkOb = _buntest.vi.fn();
-        t.observe('animals', animalsOb);
-        t.observe('drink', drinkOb);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'dogs'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'more dogs'
-            ]);
-        t.update('drink', (prev)=>({
-                ...prev,
-                beer: false,
-                kind: 'water'
-            }));
-        t.update('drink', (prev)=>({
-                ...prev,
-                beer: true,
-                kind: 'is not beer'
-            }));
-        (0, _buntest.expect)(animalsOb).toHaveBeenNthCalledWith(1, [
-            'dogs'
-        ], [], 'animals');
-        (0, _buntest.expect)(animalsOb).toHaveBeenNthCalledWith(2, [
-            'dogs',
-            'more dogs'
-        ], [
-            'dogs'
-        ], 'animals');
-        (0, _buntest.expect)(drinkOb).toHaveBeenNthCalledWith(1, {
-            beer: false,
-            kind: 'water'
-        }, {
-            beer: true,
-            kind: 'guiness'
-        }, 'drink');
-        (0, _buntest.expect)(drinkOb).toHaveBeenNthCalledWith(2, {
-            beer: true,
-            kind: 'is not beer'
-        }, {
-            beer: false,
-            kind: 'water'
-        }, 'drink');
-    });
-});

package/dist/cjs/totally-tubular.test.d.ts

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

package/dist/esm/totally-tubular-react.test.d.ts

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

package/dist/esm/totally-tubular-react.test.mjs

@@ -1,76 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-import { act, renderHook } from '@testing-library/react';
-import { Tubular } from './totally-tubular.mjs';
-import { useTubular } from './totally-tubular-react.mjs';
-const makeInitialState = ()=>({
-        animals: [],
-        drink: {
-            beer: true,
-            kind: 'guiness'
-        },
-        food: {
-            pasta: false,
-            pizza: true
-        }
-    });
-describe('useTubular', ()=>{
-    it('should read an initial value from a Tubular instance', ()=>{
-        const initial = makeInitialState();
-        initial.drink.kind = 'Guiness 0.0%';
-        const t = new Tubular(initial);
-        const { result } = renderHook(()=>useTubular(t, 'drink.kind'));
-        expect(result.current[0]).toBe('Guiness 0.0%');
-    });
-    it('should update a top-level value and reflect the change', ()=>{
-        const t = new Tubular(makeInitialState());
-        const animals = [
-            'cats',
-            'dogs'
-        ];
-        const { result, rerender } = renderHook(()=>useTubular(t, 'animals'));
-        expect(result.current[0]).toEqual([]);
-        act(()=>{
-            result.current[1](animals);
-        });
-        rerender();
-        expect(result.current[0]).toEqual(animals);
-    });
-    it('should update a nested value using a callback updater', ()=>{
-        const t = new Tubular(makeInitialState());
-        const { result, rerender } = renderHook(()=>useTubular(t, 'food.pasta'));
-        expect(result.current[0]).toBeFalse();
-        act(()=>{
-            result.current[1]((prev)=>!prev);
-        });
-        rerender();
-        expect(result.current[0]).toBeTrue();
-    });
-    it('should notify all hooks observing the same key when one updates', ()=>{
-        const t = new Tubular(makeInitialState());
-        const { result: resultA, rerender: rerenderA } = renderHook(()=>useTubular(t, 'drink.beer'));
-        const { result: resultB, rerender: rerenderB } = renderHook(()=>useTubular(t, 'drink.beer'));
-        expect(resultA.current[0]).toBeTrue();
-        expect(resultB.current[0]).toBeTrue();
-        act(()=>{
-            resultA.current[1](false);
-        });
-        rerenderA();
-        rerenderB();
-        expect(resultA.current[0]).toBeFalse();
-        expect(resultB.current[0]).toBeFalse();
-    });
-    it('should unobserve when the hook unmounts', ()=>{
-        const t = new Tubular(makeInitialState());
-        const { result, unmount } = renderHook(()=>useTubular(t, 'drink.kind'));
-        expect(result.current[0]).toBe('guiness');
-        unmount();
-        // Update after unmount — the store still works, but the unmounted hook
-        // should no longer be observing so no "update on unmounted component" error occurs.
-        act(()=>{
-            t.update('drink.kind', ()=>'stella');
-        });
-        // Verify the store update took effect via a fresh hook instance.
-        const { result: freshResult } = renderHook(()=>useTubular(t, 'drink.kind'));
-        expect(freshResult.current[0]).toBe('stella');
-    });
-});

package/dist/esm/totally-tubular.test.d.ts

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

package/dist/esm/totally-tubular.test.mjs

@@ -1,136 +0,0 @@
-import { describe, expect, test, vi } from 'bun:test';
-import { Tubular } from './totally-tubular.mjs';
-const makeInitialState = ()=>({
-        animals: [],
-        drink: {
-            beer: true,
-            kind: 'guiness'
-        },
-        food: {
-            pasta: false,
-            pizza: true
-        }
-    });
-describe('totally-tubular', ()=>{
-    test('should update one single property', ()=>{
-        const t = new Tubular(makeInitialState());
-        const newVal = 'old speckled hen';
-        t.update('drink.kind', ()=>newVal);
-        expect(t.read('drink.kind')).toBe(newVal);
-    });
-    test('should ensure update is called multiple times', ()=>{
-        const t = new Tubular(makeInitialState());
-        const initialBeer = t.read('drink.kind');
-        const v1 = 'ginger beer';
-        const v2 = 'corona';
-        const v3 = "London's Pride";
-        const ob = vi.fn();
-        t.observe('drink.kind', ob);
-        t.update('drink.kind', ()=>v1);
-        t.update('drink.kind', ()=>v2);
-        t.update('drink.kind', ()=>v3);
-        expect(ob).toHaveBeenNthCalledWith(1, v1, initialBeer, 'drink.kind');
-        expect(ob).toHaveBeenNthCalledWith(2, v2, v1, 'drink.kind');
-        expect(ob).toHaveBeenNthCalledWith(3, v3, v2, 'drink.kind');
-    });
-    test('should update an array', ()=>{
-        const t = new Tubular(makeInitialState());
-        t.update('animals', (prev)=>[
-                ...prev,
-                'birds'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'cats'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'dogs'
-            ]);
-        expect(t.read('animals')).toStrictEqual([
-            'birds',
-            'cats',
-            'dogs'
-        ]);
-    });
-    test('should update one item in an array', ()=>{
-        const t = new Tubular({
-            ...makeInitialState(),
-            animals: [
-                'beagle',
-                'corgie',
-                'dachshund'
-            ]
-        });
-        t.update('animals', (prev)=>prev.toSpliced(1, 1, 'yorkie'));
-        expect(t.read('animals')).toStrictEqual([
-            'beagle',
-            'yorkie',
-            'dachshund'
-        ]);
-    });
-    test('should observe and then disconnect', ()=>{
-        const t = new Tubular(makeInitialState());
-        const foodOb = vi.fn();
-        const pizzaOb = vi.fn();
-        t.observe('food.pasta', foodOb);
-        t.observe('food.pizza', pizzaOb);
-        t.update('food.pasta', (prev)=>!prev);
-        t.update('food.pizza', (prev)=>!prev);
-        t.unobserve('food.pasta', foodOb);
-        t.update('food.pasta', (prev)=>!prev);
-        t.update('food.pizza', (prev)=>!prev);
-        expect(t.read('food.pasta')).toBeFalsy();
-        expect(t.read('food.pizza')).toBeTruthy();
-        expect(foodOb).toHaveBeenCalledTimes(1);
-        expect(pizzaOb).toHaveBeenCalledTimes(2);
-    });
-    test('should observe an array and object', ()=>{
-        const t = new Tubular(makeInitialState());
-        const animalsOb = vi.fn();
-        const drinkOb = vi.fn();
-        t.observe('animals', animalsOb);
-        t.observe('drink', drinkOb);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'dogs'
-            ]);
-        t.update('animals', (prev)=>[
-                ...prev,
-                'more dogs'
-            ]);
-        t.update('drink', (prev)=>({
-                ...prev,
-                beer: false,
-                kind: 'water'
-            }));
-        t.update('drink', (prev)=>({
-                ...prev,
-                beer: true,
-                kind: 'is not beer'
-            }));
-        expect(animalsOb).toHaveBeenNthCalledWith(1, [
-            'dogs'
-        ], [], 'animals');
-        expect(animalsOb).toHaveBeenNthCalledWith(2, [
-            'dogs',
-            'more dogs'
-        ], [
-            'dogs'
-        ], 'animals');
-        expect(drinkOb).toHaveBeenNthCalledWith(1, {
-            beer: false,
-            kind: 'water'
-        }, {
-            beer: true,
-            kind: 'guiness'
-        }, 'drink');
-        expect(drinkOb).toHaveBeenNthCalledWith(2, {
-            beer: true,
-            kind: 'is not beer'
-        }, {
-            beer: false,
-            kind: 'water'
-        }, 'drink');
-    });
-});