@thefoxieflow/signal-ctx 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +35 -0
- package/dist/index.d.ts +35 -0
- package/dist/index.js +120 -0
- package/dist/index.mjs +99 -0
- package/package.json +36 -0
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
+
import { SetStateAction, ReactNode } from 'react';
|
|
3
|
+
|
|
4
|
+
type Store<T = any> = ReturnType<typeof createStore<T>>;
|
|
5
|
+
type Subscriber = () => void;
|
|
6
|
+
/**
|
|
7
|
+
* @description: create a signal with subscribe and update methods
|
|
8
|
+
*/
|
|
9
|
+
declare function createStore<T = Record<string, any>>(init: () => T): {
|
|
10
|
+
(): T;
|
|
11
|
+
subscribe(subscriber: Subscriber): () => boolean;
|
|
12
|
+
set(action: SetStateAction<T>): void;
|
|
13
|
+
};
|
|
14
|
+
declare const useSignal: <T extends object, Dest = T>(store: Store<T>, selector?: (state: T) => Dest) => Dest;
|
|
15
|
+
declare const useSetSignal: <T extends object = any, Dest extends object = T>(store: Store<T>, selector?: (state: T) => Dest) => (action: SetStateAction<Dest>) => void;
|
|
16
|
+
type StoreOption = {
|
|
17
|
+
storeName?: string;
|
|
18
|
+
};
|
|
19
|
+
declare function createCtx<T extends object>(init: () => T): {
|
|
20
|
+
<Dest = any>(selector: (state: T) => Dest, opt?: StoreOption): Dest;
|
|
21
|
+
provide: (opt?: {
|
|
22
|
+
value?: T;
|
|
23
|
+
storeName?: string;
|
|
24
|
+
}) => ({ children }: {
|
|
25
|
+
children: ReactNode;
|
|
26
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
27
|
+
useSetter: <Dest extends object = T>(selector?: (state: T) => Dest, opt?: StoreOption) => (action: SetStateAction<Dest>) => void;
|
|
28
|
+
useStore: (opt?: StoreOption) => {
|
|
29
|
+
(): T;
|
|
30
|
+
subscribe(subscriber: Subscriber): () => boolean;
|
|
31
|
+
set(action: SetStateAction<T>): void;
|
|
32
|
+
};
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export { type Store, type StoreOption, type Subscriber, createCtx, useSetSignal, useSignal };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
+
import { SetStateAction, ReactNode } from 'react';
|
|
3
|
+
|
|
4
|
+
type Store<T = any> = ReturnType<typeof createStore<T>>;
|
|
5
|
+
type Subscriber = () => void;
|
|
6
|
+
/**
|
|
7
|
+
* @description: create a signal with subscribe and update methods
|
|
8
|
+
*/
|
|
9
|
+
declare function createStore<T = Record<string, any>>(init: () => T): {
|
|
10
|
+
(): T;
|
|
11
|
+
subscribe(subscriber: Subscriber): () => boolean;
|
|
12
|
+
set(action: SetStateAction<T>): void;
|
|
13
|
+
};
|
|
14
|
+
declare const useSignal: <T extends object, Dest = T>(store: Store<T>, selector?: (state: T) => Dest) => Dest;
|
|
15
|
+
declare const useSetSignal: <T extends object = any, Dest extends object = T>(store: Store<T>, selector?: (state: T) => Dest) => (action: SetStateAction<Dest>) => void;
|
|
16
|
+
type StoreOption = {
|
|
17
|
+
storeName?: string;
|
|
18
|
+
};
|
|
19
|
+
declare function createCtx<T extends object>(init: () => T): {
|
|
20
|
+
<Dest = any>(selector: (state: T) => Dest, opt?: StoreOption): Dest;
|
|
21
|
+
provide: (opt?: {
|
|
22
|
+
value?: T;
|
|
23
|
+
storeName?: string;
|
|
24
|
+
}) => ({ children }: {
|
|
25
|
+
children: ReactNode;
|
|
26
|
+
}) => react_jsx_runtime.JSX.Element;
|
|
27
|
+
useSetter: <Dest extends object = T>(selector?: (state: T) => Dest, opt?: StoreOption) => (action: SetStateAction<Dest>) => void;
|
|
28
|
+
useStore: (opt?: StoreOption) => {
|
|
29
|
+
(): T;
|
|
30
|
+
subscribe(subscriber: Subscriber): () => boolean;
|
|
31
|
+
set(action: SetStateAction<T>): void;
|
|
32
|
+
};
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export { type Store, type StoreOption, type Subscriber, createCtx, useSetSignal, useSignal };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
"use client";
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
7
|
+
var __export = (target, all) => {
|
|
8
|
+
for (var name in all)
|
|
9
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
10
|
+
};
|
|
11
|
+
var __copyProps = (to, from, except, desc) => {
|
|
12
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
13
|
+
for (let key of __getOwnPropNames(from))
|
|
14
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
15
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
16
|
+
}
|
|
17
|
+
return to;
|
|
18
|
+
};
|
|
19
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
20
|
+
|
|
21
|
+
// src/index.tsx
|
|
22
|
+
var index_exports = {};
|
|
23
|
+
__export(index_exports, {
|
|
24
|
+
createCtx: () => createCtx,
|
|
25
|
+
useSetSignal: () => useSetSignal,
|
|
26
|
+
useSignal: () => useSignal
|
|
27
|
+
});
|
|
28
|
+
module.exports = __toCommonJS(index_exports);
|
|
29
|
+
var import_react = require("react");
|
|
30
|
+
var import_jsx_runtime = require("react/jsx-runtime");
|
|
31
|
+
var applyAction = (target, action) => {
|
|
32
|
+
return typeof action === "function" ? action(target) : action;
|
|
33
|
+
};
|
|
34
|
+
function createStore(init) {
|
|
35
|
+
let val;
|
|
36
|
+
let isInit = false;
|
|
37
|
+
const subscribers = /* @__PURE__ */ new Set();
|
|
38
|
+
const get = () => {
|
|
39
|
+
if (!isInit) {
|
|
40
|
+
val = init();
|
|
41
|
+
isInit = true;
|
|
42
|
+
}
|
|
43
|
+
return val;
|
|
44
|
+
};
|
|
45
|
+
get.subscribe = (subscriber) => {
|
|
46
|
+
subscribers.add(subscriber);
|
|
47
|
+
const unsubscribe = () => subscribers.delete(subscriber);
|
|
48
|
+
return unsubscribe;
|
|
49
|
+
};
|
|
50
|
+
get.set = (action) => {
|
|
51
|
+
val = applyAction(val, action);
|
|
52
|
+
subscribers.forEach((subscriber) => subscriber());
|
|
53
|
+
};
|
|
54
|
+
return get;
|
|
55
|
+
}
|
|
56
|
+
var useSignal = (store, selector) => {
|
|
57
|
+
const getSnapShot = () => selector ? selector(store()) : store();
|
|
58
|
+
const use = (0, import_react.useSyncExternalStore)(store.subscribe, getSnapShot, getSnapShot);
|
|
59
|
+
return use;
|
|
60
|
+
};
|
|
61
|
+
var useSetSignal = (store, selector) => {
|
|
62
|
+
const setter = (action) => {
|
|
63
|
+
const current = store();
|
|
64
|
+
const target = selector ? selector(current) : current;
|
|
65
|
+
applyAction(target, action);
|
|
66
|
+
store.set(current);
|
|
67
|
+
};
|
|
68
|
+
return setter;
|
|
69
|
+
};
|
|
70
|
+
function createCtx(init) {
|
|
71
|
+
const ctx = (0, import_react.createContext)(createStore(init));
|
|
72
|
+
const stores = /* @__PURE__ */ new Map();
|
|
73
|
+
const initStore = (name, init2) => {
|
|
74
|
+
if (!stores.has(name)) {
|
|
75
|
+
const store = createStore(init2);
|
|
76
|
+
stores.set(name, store);
|
|
77
|
+
}
|
|
78
|
+
return stores.get(name);
|
|
79
|
+
};
|
|
80
|
+
const useStore = (opt) => {
|
|
81
|
+
const store = (0, import_react.useContext)(ctx);
|
|
82
|
+
if (opt?.storeName && stores.has(opt.storeName)) {
|
|
83
|
+
return stores.get(opt.storeName);
|
|
84
|
+
}
|
|
85
|
+
if (!store) throw new Error("useCtx must be used within a Provider");
|
|
86
|
+
return store;
|
|
87
|
+
};
|
|
88
|
+
const provide = (opt = {}) => {
|
|
89
|
+
const value = opt.value || init();
|
|
90
|
+
const storeName = opt.storeName || "ctx__store";
|
|
91
|
+
const Provider = ({ children }) => {
|
|
92
|
+
const store = initStore(storeName, () => value);
|
|
93
|
+
(0, import_react.useEffect)(() => {
|
|
94
|
+
return () => {
|
|
95
|
+
stores.delete(storeName);
|
|
96
|
+
};
|
|
97
|
+
}, []);
|
|
98
|
+
return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(ctx.Provider, { value: store, children });
|
|
99
|
+
};
|
|
100
|
+
return Provider;
|
|
101
|
+
};
|
|
102
|
+
const use = (selector, opt) => {
|
|
103
|
+
const store = useStore(opt);
|
|
104
|
+
return useSignal(store, selector);
|
|
105
|
+
};
|
|
106
|
+
const useSetter = (selector, opt) => {
|
|
107
|
+
const store = useStore(opt);
|
|
108
|
+
return useSetSignal(store, selector);
|
|
109
|
+
};
|
|
110
|
+
use.provide = provide;
|
|
111
|
+
use.useSetter = useSetter;
|
|
112
|
+
use.useStore = useStore;
|
|
113
|
+
return use;
|
|
114
|
+
}
|
|
115
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
116
|
+
0 && (module.exports = {
|
|
117
|
+
createCtx,
|
|
118
|
+
useSetSignal,
|
|
119
|
+
useSignal
|
|
120
|
+
});
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
// src/index.tsx
|
|
4
|
+
import {
|
|
5
|
+
createContext,
|
|
6
|
+
useContext,
|
|
7
|
+
useEffect,
|
|
8
|
+
useSyncExternalStore
|
|
9
|
+
} from "react";
|
|
10
|
+
import { jsx } from "react/jsx-runtime";
|
|
11
|
+
var applyAction = (target, action) => {
|
|
12
|
+
return typeof action === "function" ? action(target) : action;
|
|
13
|
+
};
|
|
14
|
+
function createStore(init) {
|
|
15
|
+
let val;
|
|
16
|
+
let isInit = false;
|
|
17
|
+
const subscribers = /* @__PURE__ */ new Set();
|
|
18
|
+
const get = () => {
|
|
19
|
+
if (!isInit) {
|
|
20
|
+
val = init();
|
|
21
|
+
isInit = true;
|
|
22
|
+
}
|
|
23
|
+
return val;
|
|
24
|
+
};
|
|
25
|
+
get.subscribe = (subscriber) => {
|
|
26
|
+
subscribers.add(subscriber);
|
|
27
|
+
const unsubscribe = () => subscribers.delete(subscriber);
|
|
28
|
+
return unsubscribe;
|
|
29
|
+
};
|
|
30
|
+
get.set = (action) => {
|
|
31
|
+
val = applyAction(val, action);
|
|
32
|
+
subscribers.forEach((subscriber) => subscriber());
|
|
33
|
+
};
|
|
34
|
+
return get;
|
|
35
|
+
}
|
|
36
|
+
var useSignal = (store, selector) => {
|
|
37
|
+
const getSnapShot = () => selector ? selector(store()) : store();
|
|
38
|
+
const use = useSyncExternalStore(store.subscribe, getSnapShot, getSnapShot);
|
|
39
|
+
return use;
|
|
40
|
+
};
|
|
41
|
+
var useSetSignal = (store, selector) => {
|
|
42
|
+
const setter = (action) => {
|
|
43
|
+
const current = store();
|
|
44
|
+
const target = selector ? selector(current) : current;
|
|
45
|
+
applyAction(target, action);
|
|
46
|
+
store.set(current);
|
|
47
|
+
};
|
|
48
|
+
return setter;
|
|
49
|
+
};
|
|
50
|
+
function createCtx(init) {
|
|
51
|
+
const ctx = createContext(createStore(init));
|
|
52
|
+
const stores = /* @__PURE__ */ new Map();
|
|
53
|
+
const initStore = (name, init2) => {
|
|
54
|
+
if (!stores.has(name)) {
|
|
55
|
+
const store = createStore(init2);
|
|
56
|
+
stores.set(name, store);
|
|
57
|
+
}
|
|
58
|
+
return stores.get(name);
|
|
59
|
+
};
|
|
60
|
+
const useStore = (opt) => {
|
|
61
|
+
const store = useContext(ctx);
|
|
62
|
+
if (opt?.storeName && stores.has(opt.storeName)) {
|
|
63
|
+
return stores.get(opt.storeName);
|
|
64
|
+
}
|
|
65
|
+
if (!store) throw new Error("useCtx must be used within a Provider");
|
|
66
|
+
return store;
|
|
67
|
+
};
|
|
68
|
+
const provide = (opt = {}) => {
|
|
69
|
+
const value = opt.value || init();
|
|
70
|
+
const storeName = opt.storeName || "ctx__store";
|
|
71
|
+
const Provider = ({ children }) => {
|
|
72
|
+
const store = initStore(storeName, () => value);
|
|
73
|
+
useEffect(() => {
|
|
74
|
+
return () => {
|
|
75
|
+
stores.delete(storeName);
|
|
76
|
+
};
|
|
77
|
+
}, []);
|
|
78
|
+
return /* @__PURE__ */ jsx(ctx.Provider, { value: store, children });
|
|
79
|
+
};
|
|
80
|
+
return Provider;
|
|
81
|
+
};
|
|
82
|
+
const use = (selector, opt) => {
|
|
83
|
+
const store = useStore(opt);
|
|
84
|
+
return useSignal(store, selector);
|
|
85
|
+
};
|
|
86
|
+
const useSetter = (selector, opt) => {
|
|
87
|
+
const store = useStore(opt);
|
|
88
|
+
return useSetSignal(store, selector);
|
|
89
|
+
};
|
|
90
|
+
use.provide = provide;
|
|
91
|
+
use.useSetter = useSetter;
|
|
92
|
+
use.useStore = useStore;
|
|
93
|
+
return use;
|
|
94
|
+
}
|
|
95
|
+
export {
|
|
96
|
+
createCtx,
|
|
97
|
+
useSetSignal,
|
|
98
|
+
useSignal
|
|
99
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@thefoxieflow/signal-ctx",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Lightweight signal-based React context store",
|
|
5
|
+
"main": "dist/index.cjs",
|
|
6
|
+
"module": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
11
|
+
"scripts": {
|
|
12
|
+
"build": "tsup src/index.tsx --format esm,cjs --dts --out-dir dist",
|
|
13
|
+
"prepublishOnly": "npm run build",
|
|
14
|
+
"publish": "npm publish"
|
|
15
|
+
},
|
|
16
|
+
"repository": {
|
|
17
|
+
"url": "https://github.com/foxie-io/thefoxieflow/tree/main/signal-ctx"
|
|
18
|
+
},
|
|
19
|
+
"sideEffects": false,
|
|
20
|
+
"peerDependencies": {
|
|
21
|
+
"react": ">=18"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"@types/react": "^19.2.8",
|
|
25
|
+
"react": "^18.2.0",
|
|
26
|
+
"tsup": "^8.0.0",
|
|
27
|
+
"typescript": "^5.0.0"
|
|
28
|
+
},
|
|
29
|
+
"keywords": [
|
|
30
|
+
"react",
|
|
31
|
+
"state",
|
|
32
|
+
"store",
|
|
33
|
+
"context",
|
|
34
|
+
"signal"
|
|
35
|
+
]
|
|
36
|
+
}
|