@rojaebl/supa-store 0.7.1 → 0.7.2
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/README.md +34 -19
- package/dist/index.d.ts +39 -10
- package/dist/index.js +75 -24
- package/dist/react.js +1 -1
- package/dist/stream/index.js +1 -1
- package/package.json +107 -49
package/README.md
CHANGED
|
@@ -54,13 +54,24 @@ import { count } from "./count";
|
|
|
54
54
|
const { n, inc } = useStore(count, { pick: ["n", "inc"] });
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
React 밖에서는 `
|
|
57
|
+
React 밖에서는 `Store(handle)` 로 지금 상태를 꺼내 읽고 동작을 부른다. `useStore` 처럼 `{ pick }` · `{ omit }` 으로 칸을 고르고, 파생이면 값을 준다. 부르는 순간의 값이고 따라가지 않는다. 핸들 자체는 store 를 가리키는 표지일 뿐 읽고 쓰는 메서드가 없다.
|
|
58
58
|
|
|
59
59
|
```ts
|
|
60
|
-
import {
|
|
61
|
-
|
|
60
|
+
import { Store } from "@rojaebl/supa-store";
|
|
61
|
+
Store(count).inc();
|
|
62
|
+
const { n } = Store(count, { pick: ["n"] });
|
|
62
63
|
```
|
|
63
64
|
|
|
65
|
+
상태를 직접 쓰고 듣는 것도 같은 이름 아래 있다.
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
Store.set(count, { n: 0 }); // 얕게 합친다. 함수를 넘기면 지금 상태를 받는다
|
|
69
|
+
const off = Store.subscribe(count, () => {}); // 파생이면 값이 바뀔 때 부른다. 다시 지어도 이어진다
|
|
70
|
+
Store.getInitial(count); // 처음 지었을 때의 상태
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
`getStore(handle)` 은 deprecated 다. 동작은 그대로다.
|
|
74
|
+
|
|
64
75
|
서버에서 받아 오는 값은 자원으로, store 사이의 알림은 event 로 정의한다.
|
|
65
76
|
|
|
66
77
|
```ts
|
|
@@ -117,7 +128,7 @@ export const b: Store<{ n: number }> = createStore.ofContext((ctx) => ({ n: ctx(
|
|
|
117
128
|
```
|
|
118
129
|
|
|
119
130
|
- **`ofContext` 의 `ctx()`(자기 자신 읽기)는 `unknown` 이다.** 자기 타입을 creator 의 인자에 넣으면 추론이 다시 깨지기 때문이다. 콜백(`onSuccess` 같은 것) 안에서는 자기 핸들로 `ctx(todo)` 처럼 읽으면 된다. **자원의 `select` 처럼 돌려주는 값이 자기 자신을 읽는 자리는 자기 핸들로도 안 된다** — 상태 타입이 자기에게 기대는 순환이 되어 추론이 깨진다. 그런 store 는 `ofContext` 가 아니라 타입을 적는 꼴(`createStore<Resource<…>>((_set, _get, ctx) => …)`)로 정의한다. 아래 「바꾸기」의 `appearance` 가 그 예다.
|
|
120
|
-
- `ofContext` 는 `createStore((_set, _get, ctx) => creator(ctx))` 와 같다. 다시 짓기 · 짓는 동안 건 듣기 · `
|
|
131
|
+
- `ofContext` 는 `createStore((_set, _get, ctx) => creator(ctx))` 와 같다. 다시 짓기 · 짓는 동안 건 듣기 · `Store.override` · `useStore` 의 pick · omit · 이름이 모두 `createStore` 로 지은 store 와 같다. `Store.override` 의 creator 는 `ofContext` 로 지은 store 에도 세 인자 꼴(`(set, get, ctx) => …`)이다.
|
|
121
132
|
- 0.7.0 에서 쓰던 `createStore((_s: unknown, _g: unknown, ctx: Ctx) => …)` 꼴도 그대로 추론된다. 고칠 필요는 없다.
|
|
122
133
|
- 타입 인자로 적을 때 자원 · 스트림 · 파생은 `Resource<A, D, R>`(`@rojaebl/supa-store/query`) · `Stream<V, Cmd>`(`@rojaebl/supa-store/stream`) · `Derived<T>`(`supa-store`) 다. `R` 은 자원에 정의한 객체의 타입이다(바꾸기 함수 칸만 본다). `ctx` 만 쓰면 `ofContext` 가 이것을 대신 추론한다.
|
|
123
134
|
- **오류 문구에 `never` 가 보이면 타입 인자를 적거나, `ctx` 만 쓰면 `ofContext` 로 바꾼다.** 인자를 받는 creator 에 타입 인자를 빠뜨리면 상태가 `never` 로 굳어, creator 가 돌려주는 객체가 `never` 에 맞지 않는다는 오류가 난다(`Type '{ … }' is not assignable to type 'never'`). 상태가 정말 비어 있으면 `createStore<{}>(…)` 로 적는다.
|
|
@@ -126,11 +137,11 @@ export const b: Store<{ n: number }> = createStore.ofContext((ctx) => ({ n: ctx(
|
|
|
126
137
|
|
|
127
138
|
**최신 값이 필요하면 클로저 안에서 `ctx` 로 읽는다.** 정의 안의 코드는 세 공간 가운데 하나에서 돈다.
|
|
128
139
|
|
|
129
|
-
- **짓는 공간** — 정의 함수의 본문. store 를 처음 꺼낼 때 한 번 돌아 인스턴스된 값을 짓는다. 여기서 읽은 값은 다시 지을 때까지 그대로이므로, 이 자리에서는 event 를 잇기만 한다(`ctx(saved).on(fn)`). 여기서 건 듣기는 지금 짓는 store 의 것이 되고, 그 store 를 버릴 때(`
|
|
140
|
+
- **짓는 공간** — 정의 함수의 본문. store 를 처음 꺼낼 때 한 번 돌아 인스턴스된 값을 짓는다. 여기서 읽은 값은 다시 지을 때까지 그대로이므로, 이 자리에서는 event 를 잇기만 한다(`ctx(saved).on(fn)`). 여기서 건 듣기는 지금 짓는 store 의 것이 되고, 그 store 를 버릴 때(`Store.override` · `Store.reset` · `Store.dispose` 의 다시 짓기) 라이브러리가 뗀다. 그래서 다시 지어도 듣기가 겹치지 않는다. 일부러 듣지 않는다는 결정은 `ctx(saved).exempt("까닭")` 으로 남긴다.
|
|
130
141
|
- **동작 · 콜백** — 바꾸기 함수 · `onSuccess` · event 를 받는 함수. 불릴 때 돌고, 그 안의 `ctx` 는 부를 때마다 그 순간을 읽는다.
|
|
131
142
|
- **계산 공간** — `createDerived` 의 계산 함수와 자원 `select`. 그 안에서 `ctx(handle)` 로 읽은 store, `ctx(handle).getData(args)` 로 읽은 자원 칸, 바꾸기 상태가 바뀌면 라이브러리가 다시 부른다. 어느 store 의 `ctx` 로 읽었는지는 가리지 않는다 — 계산 중에 다른 store 의 함수가 자기 `ctx` 로 읽은 것도 입력이다.
|
|
132
143
|
|
|
133
|
-
짓는 공간 밖(React 밖의 코드 같은 곳)에서 `
|
|
144
|
+
짓는 공간 밖(React 밖의 코드 같은 곳)에서 `Store(saved).on(fn)` 으로 건 듣기는 누구의 것도 아니다. 풀기 함수를 돌려주고, 라이브러리가 떼지 않는다. `exempt` 는 짓는 공간 밖에서 부르면 `exempt 는 store 를 짓는 동안에만 부른다` 로 실패한다. `on` 과 `exempt` 를 같은 store 가 같은 event 에 함께 적으면 오류다.
|
|
134
145
|
|
|
135
146
|
`record()`(event 의 상태에 있다)는 그 event 를 누가 듣고 누가 일부러 듣지 않는지를 `{ on: string[]; exempt: { who; why }[] }` 로 준다. 이름은 아래 「store 의 이름」 절의 꼴이다.
|
|
136
147
|
|
|
@@ -154,7 +165,7 @@ export const todoTitle = createStore.ofContext((ctx) =>
|
|
|
154
165
|
|
|
155
166
|
```tsx
|
|
156
167
|
const total = useStore(cartTotal); // 값 그대로
|
|
157
|
-
|
|
168
|
+
Store(cartTotal); // React 밖 — 값 그대로
|
|
158
169
|
```
|
|
159
170
|
|
|
160
171
|
- 읽은 것이 바뀌면 다시 계산하고, 결과가 `Object.is` 로 앞과 같으면 구독자를 깨우지 않는다.
|
|
@@ -175,9 +186,9 @@ export const view = createStore.ofContext((ctx) => createDerived(() => shape(ctx
|
|
|
175
186
|
## 정의를 둘 때 지킬 것
|
|
176
187
|
|
|
177
188
|
- **모듈 최상단에서만 `createStore` 와 `createStore.ofContext` 를 부른다.** 부를 때마다 새 store 가 생긴다. 함수나 컴포넌트 안에서 부르면 부를 때마다 store 가 늘어난다. 라이브러리는 이것을 막지 않는다.
|
|
178
|
-
- **모듈 최상단에서 store 를 꺼내지 않는다.** 최상단의 `
|
|
179
|
-
- **creator 안에서 다른 store 는 `ctx` 로 읽는다.** `
|
|
180
|
-
- **시험에서 정의를 바꾸려면 모듈을 다시 읽지 말고 `
|
|
189
|
+
- **모듈 최상단에서 store 를 꺼내지 않는다.** 최상단의 `Store(x)` 는 import 순환 안에서 아직 평가되지 않은 핸들을 만날 수 있다. 정의 파일끼리 서로 import 하는 것은 괜찮다. creator 는 처음 꺼낼 때 돌고, 그때는 두 모듈이 모두 평가를 마쳤다.
|
|
190
|
+
- **creator 안에서 다른 store 는 `ctx` 로 읽는다.** `Store(x)` 로 읽으면 기댐이 적히지 않아 `x` 를 `Store.override` 해도 다시 지어지지 않고, 파생은 다시 계산하지 않아 오류 없이 낡은 값을 낸다.
|
|
191
|
+
- **시험에서 정의를 바꾸려면 모듈을 다시 읽지 말고 `Store.override(handle, creator)` 를 쓴다.** `vi.resetModules()` 뒤에 정의 파일을 다시 import 하면 새 store 가 따로 생기고, 옛 store 와 그것이 event 에 건 듣기가 남는다. 덮어쓴 정의는 `Store.reset()` 가 지운다.
|
|
181
192
|
|
|
182
193
|
## store 의 이름
|
|
183
194
|
|
|
@@ -185,7 +196,7 @@ store 에 사람이 붙이는 이름은 없다. 오류 문구와 `record()` 에
|
|
|
185
196
|
|
|
186
197
|
- 이 이름으로 store 를 찾는 API 는 없다. 핸들에도 이름 칸이 없다.
|
|
187
198
|
- **`record()` 를 견줄 때 이름을 문자열로 박지 않는다.** 줄 번호는 그 파일을 고치면 바뀐다. 수(`record().on.length`)나 포함 여부(`expect.stringContaining("todo.ts")`)로 견준다.
|
|
188
|
-
- `
|
|
199
|
+
- `Store.registered()` 는 등록한 핸들을 등록한 차례대로 준다. 다시 이어졌을 때 모든 자원을 낡게 하는 것처럼 앱 전체에 거는 일에 쓴다. 어느 한 store 를 골라내는 길이 아니다.
|
|
189
200
|
|
|
190
201
|
## 자원 더 쓰기
|
|
191
202
|
|
|
@@ -373,7 +384,7 @@ useStore(todos, { select: (titles) => titles.length });
|
|
|
373
384
|
```ts
|
|
374
385
|
import type { Cache } from "@rojaebl/supa-store/query";
|
|
375
386
|
|
|
376
|
-
// 캐시를 직접 읽고 쓴다 — store 안에서는 ctx, 밖에서는
|
|
387
|
+
// 캐시를 직접 읽고 쓴다 — store 안에서는 ctx, 밖에서는 Store
|
|
377
388
|
ctx(settings).getData();
|
|
378
389
|
ctx(settings).setData((prev) => ({ ...prev!, theme: "dark" }));
|
|
379
390
|
|
|
@@ -469,7 +480,7 @@ await open.mutateAsync("/repo"); // 실패하면 던진다
|
|
|
469
480
|
```
|
|
470
481
|
|
|
471
482
|
연결의 칸(`data` · `status` · `isFetching` · `error`)과 명령마다의 칸(`mutate` · `mutateAsync` · `pending` · `error` · `data` · `reset` · `retry`)이 있다.
|
|
472
|
-
다른 store 에서는 `
|
|
483
|
+
다른 store 에서는 `Store(terminal).open("/repo")` 처럼 명령 함수로 부르고, 실패하면 던진다.
|
|
473
484
|
|
|
474
485
|
### 연결 상태
|
|
475
486
|
|
|
@@ -567,11 +578,11 @@ export const POST = streamHandler(terminal); // 명령 · ask · answer
|
|
|
567
578
|
### 시험에서
|
|
568
579
|
|
|
569
580
|
```ts
|
|
570
|
-
import {
|
|
571
|
-
afterEach(() =>
|
|
581
|
+
import { Store } from "@rojaebl/supa-store";
|
|
582
|
+
afterEach(() => Store.dispose()); // 열린 연결을 닫는다(store 는 다음에 꺼낼 때 다시 짓는다)
|
|
572
583
|
```
|
|
573
584
|
|
|
574
|
-
`
|
|
585
|
+
`Store.dispose()` 는 그려져 있는 화면을 다시 그리지 않는다 — 시험의 뒷정리에 쓴다.
|
|
575
586
|
|
|
576
587
|
## 프로세스와 다른 서버에 붙기(createJsonRpc)
|
|
577
588
|
|
|
@@ -670,6 +681,10 @@ export default withStore({});
|
|
|
670
681
|
- 동적 `import("@rojaebl/supa-store")`
|
|
671
682
|
- `import def, * as s from "@rojaebl/supa-store"` 처럼 기본 가져오기와 이름 공간 가져오기를 한 줄에 적은 꼴
|
|
672
683
|
|
|
684
|
+
## 0.7.1 에서 옮길 때
|
|
685
|
+
|
|
686
|
+
깨지는 것은 없다. `Store(handle)` 이 더해졌고 `getStore` 는 deprecated 가 되었다. `getStore(x).getState()` 는 `Store(x)` 로 바꾼다. 파생은 `getStore(x).getState().get()` 대신 `Store(x)` 가 값을 준다. `getStore(x).setState(…)` 는 `Store.set(x, …)`, `getStore(x).subscribe(fn)` 은 `Store.subscribe(x, fn)`, `getStore(x).getInitialState()` 는 `Store.getInitial(x)` 로 바꾼다. 파생을 들을 때 쓰던 `getStore(x).getState().subscribe(fn)` 도 `Store.subscribe(x, fn)` 이다. `overrideStore` · `resetStores` · `disposeStores` · `registeredStores` 는 `Store.override` · `Store.reset` · `Store.dispose` · `Store.registered` 로 바꾼다. 옛 이름은 deprecated 로 남아 같은 함수를 가리킨다. 바꾸지 않아도 그대로 돈다.
|
|
687
|
+
|
|
673
688
|
## 0.7.0 에서 옮길 때
|
|
674
689
|
|
|
675
690
|
깨지는 것은 없다. `createStore.ofContext` 가 더해졌다. `ctx` 만 쓰려고 `createStore<Resource<…>>((_set, _get, ctx) => …)` 처럼 타입 인자를 적었거나 `(_s: unknown, _g: unknown, ctx: Ctx) =>` 로 적은 정의는 `createStore.ofContext((ctx) => …)` 로 바꾸면 타입을 지울 수 있다. 바꾸지 않아도 그대로 돈다.
|
|
@@ -679,12 +694,12 @@ export default withStore({});
|
|
|
679
694
|
store 를 key 대신 `createStore` 가 돌려주는 핸들로 가리킨다. 생성 파일 · 설정 파일 · tsserver 플러그인이 없어졌다.
|
|
680
695
|
|
|
681
696
|
- `createStore("k", creator)` 는 `export const k = createStore(creator)` 로 바꾼다. creator 가 인자를 받으면 타입 인자를 적는다(위 「타입 인자를 적어야 하는 꼴」 절)
|
|
682
|
-
- `useStore("k", …)` · `ctx("k", …)` · `getStore("k")` · `
|
|
697
|
+
- `useStore("k", …)` · `ctx("k", …)` · `getStore("k")` · `Store.override("k", …)` 는 핸들을 받는다 — `useStore(k, …)` · `ctx(k, …)` · `getStore(k)` · `Store.override(k, …)`
|
|
683
698
|
- `.on(ctx.key, fn)` 은 `.on(fn)` 으로, `.exempt(ctx.key, why)` 는 `.exempt(why)` 로 바꾼다. `ctx.key` 는 없다
|
|
684
|
-
- `registeredKeys()` 는 `
|
|
699
|
+
- `registeredKeys()` 는 `Store.registered()` 로 바꾼다. 문자열 대신 핸들을 준다
|
|
685
700
|
- 생성 파일(`store.gen.ts`)과 그 import, `store.config.ts`, tsconfig 의 `{ "name": "supa-store/plugin" }` 항목, `store-gen` 을 부르는 스크립트를 지운다. 번들러 장치(`supaStore()` · `withStore`)는 남긴다
|
|
686
701
|
- 닫힌 key(`_` 로 시작하는 key)는 export 경계로 바꾼다 — 닫을 store 의 핸들을 export 하지 않는다
|
|
687
|
-
- `vi.resetModules()` 뒤 정의 파일을 다시 import 해 정의를 갈아 끼우던 시험은 `
|
|
702
|
+
- `vi.resetModules()` 뒤 정의 파일을 다시 import 해 정의를 갈아 끼우던 시험은 `Store.override` 로 바꾼다. 0.7 은 다시 읽은 모듈을 새 store 로 등록한다
|
|
688
703
|
- `record()` 의 `who` 와 오류 문구의 key 자리에는 부른 자리의 이름(`<경로>:<줄>`)이 선다. 그 문자열을 박아 견주던 시험은 수나 포함 여부로 견준다
|
|
689
704
|
|
|
690
705
|
## 라이선스
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { DERIVED, type Channel } from "./track.js";
|
|
|
2
2
|
export { DERIVED };
|
|
3
3
|
/** 상태에 이 표식으로 함수를 두면 useStore 가 꺼내기를 그 함수에 맡긴다 — 그 함수는 훅이다 */
|
|
4
4
|
export declare const USE: unique symbol;
|
|
5
|
-
/** 상태 객체에 `[DISPOSE]: () => void` 가 있으면 그 store 를 다시 짓기 직전과
|
|
5
|
+
/** 상태 객체에 `[DISPOSE]: () => void` 가 있으면 그 store 를 다시 짓기 직전과 Store.dispose 에서 부른다 */
|
|
6
6
|
export declare const DISPOSE: unique symbol;
|
|
7
7
|
export type SetState<T> = (partial: Partial<T> | ((now: T) => Partial<T>)) => void;
|
|
8
8
|
export type GetState<T> = () => T;
|
|
@@ -73,16 +73,45 @@ export declare namespace createStore {
|
|
|
73
73
|
*/
|
|
74
74
|
function ofContext<S extends object>(creator: (ctx: Ctx) => S): Store<S>;
|
|
75
75
|
}
|
|
76
|
-
/**
|
|
77
|
-
|
|
78
|
-
|
|
76
|
+
/**
|
|
77
|
+
* 핸들이 가리키는 store — 핸들이 아니면 `store 핸들이 아니다` 로 실패한다. 다시 지어도 같은 객체다
|
|
78
|
+
* @deprecated `Store(handle)` 과 `Store.set` · `Store.subscribe` · `Store.getInitial` 을 쓴다
|
|
79
|
+
*/
|
|
79
80
|
export declare function getStore<S>(store: Store<S>): StoreApi<S>;
|
|
80
|
-
/**
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
export declare function
|
|
81
|
+
/**
|
|
82
|
+
* React 밖에서 핸들이 가리키는 store 의 지금 상태를 꺼낸다 — useStore 의 훅 아닌 짝이다.
|
|
83
|
+
* 파생이면 그 값을 주고, `{ pick }` / `{ omit }` 으로 칸을 고른다. 부르는 순간의 값이고 따라가지 않는다 —
|
|
84
|
+
* creator 안에서 다른 store 는 `ctx` 로 읽는다
|
|
85
|
+
*/
|
|
86
|
+
export declare function Store<S>(store: Store<S>): ReadOf<S>;
|
|
87
|
+
export declare function Store<S, N extends Names<S>, O extends PickOptions<S, N>>(store: Store<S>, options: O): Picked<S, O>;
|
|
88
|
+
export declare namespace Store {
|
|
89
|
+
/** 상태를 얕게 합친다. 함수를 넘기면 지금 상태를 받는다 — 같은 객체를 돌려주면 알리지 않는다 */
|
|
90
|
+
function set<S>(store: Store<S>, partial: Partial<S> | ((now: S) => Partial<S>)): void;
|
|
91
|
+
/** 처음 지었을 때의 상태를 돌려준다. 바꾸지 않는다 — 다시 지으면(Store.override · Store.reset) 새로 지은 것 */
|
|
92
|
+
function getInitial<S>(store: Store<S>): S;
|
|
93
|
+
/**
|
|
94
|
+
* 바뀌면 부른다. 파생이면 값이 바뀔 때 부른다. 풀기 함수를 돌려준다.
|
|
95
|
+
* 파생인지 알려고 store 를 짓는다. 다시 지어도 듣기가 이어진다
|
|
96
|
+
*/
|
|
97
|
+
function subscribe<S>(store: Store<S>, listener: () => void): () => void;
|
|
98
|
+
/** 처음 등록한 정의 대신 이것으로 짓는다. 그 store 에 기대던 store 도 다시 짓는다. 시험의 가짜는 일부 칸만 돌려줘도 된다 */
|
|
99
|
+
function override<S>(store: Store<S>, creator: (set: SetState<S>, get: GetState<S>, ctx: Ctx<S>) => object): void;
|
|
100
|
+
/** 덮어쓴 정의를 모두 지우고, 전부 무른 뒤 지어져 있던 것을 다시 지어 알린다. 구독자는 남는다 — 시험 사이에 부른다 */
|
|
101
|
+
function reset(): void;
|
|
102
|
+
/** 지어진 모든 store 의 [DISPOSE] 를 부르고 지어지지 않은 상태로 되돌린다. 다시 짓지 않는다(다음에 꺼낼 때 짓는다) — 구독자는 남는다 */
|
|
103
|
+
function dispose(): void;
|
|
104
|
+
/** 등록한 store 전부, 등록한 차례대로 — 앱 전체에 거는 일(다시 이어졌을 때 모든 자원을 낡게 하기 같은)에 쓴다 */
|
|
105
|
+
function registered(): Store<unknown>[];
|
|
106
|
+
}
|
|
107
|
+
/** @deprecated `Store.override` 를 쓴다 */
|
|
108
|
+
export declare const overrideStore: typeof Store.override;
|
|
109
|
+
/** @deprecated `Store.reset` 을 쓴다 */
|
|
110
|
+
export declare const resetStores: typeof Store.reset;
|
|
111
|
+
/** @deprecated `Store.dispose` 를 쓴다 */
|
|
112
|
+
export declare const disposeStores: typeof Store.dispose;
|
|
113
|
+
/** @deprecated `Store.registered` 를 쓴다 */
|
|
114
|
+
export declare const registeredStores: typeof Store.registered;
|
|
86
115
|
/**
|
|
87
116
|
* @internal — 지금 짓고 있는 store. adopt 로 맡긴 함수는 그 store 를 dispose 할 때 [DISPOSE] 뒤에 돈다(query.ts 의 event 가 쓴다).
|
|
88
117
|
* store 를 가리는 것은 handle 이다 — label 은 한 도우미 함수 안에서 지은 store 끼리 겹치므로 문구와 기록에만 쓴다
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@ import { DERIVED, noteRead } from "./track.js";
|
|
|
4
4
|
export { DERIVED };
|
|
5
5
|
/** 상태에 이 표식으로 함수를 두면 useStore 가 꺼내기를 그 함수에 맡긴다 — 그 함수는 훅이다 */
|
|
6
6
|
export const USE = Symbol.for("supa-store.use");
|
|
7
|
-
/** 상태 객체에 `[DISPOSE]: () => void` 가 있으면 그 store 를 다시 짓기 직전과
|
|
7
|
+
/** 상태 객체에 `[DISPOSE]: () => void` 가 있으면 그 store 를 다시 짓기 직전과 Store.dispose 에서 부른다 */
|
|
8
8
|
export const DISPOSE = Symbol.for("supa-store.dispose");
|
|
9
9
|
/** 등록한 차례대로 */
|
|
10
10
|
const entries = [];
|
|
@@ -183,33 +183,84 @@ export function createStore(creator) {
|
|
|
183
183
|
}
|
|
184
184
|
createStore.ofContext = ofContext;
|
|
185
185
|
})(createStore || (createStore = {}));
|
|
186
|
-
/**
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
rebuild([entry]);
|
|
191
|
-
}
|
|
192
|
-
/** 핸들이 가리키는 store — 핸들이 아니면 `store 핸들이 아니다` 로 실패한다. 다시 지어도 같은 객체다 */
|
|
186
|
+
/**
|
|
187
|
+
* 핸들이 가리키는 store — 핸들이 아니면 `store 핸들이 아니다` 로 실패한다. 다시 지어도 같은 객체다
|
|
188
|
+
* @deprecated `Store(handle)` 과 `Store.set` · `Store.subscribe` · `Store.getInitial` 을 쓴다
|
|
189
|
+
*/
|
|
193
190
|
export function getStore(store) {
|
|
194
191
|
return entryOf(store).api;
|
|
195
192
|
}
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
}
|
|
202
|
-
/** 지어진 모든 store 의 [DISPOSE] 를 부르고 지어지지 않은 상태로 되돌린다. 다시 짓지 않는다(다음에 꺼낼 때 짓는다) — 구독자는 남는다 */
|
|
203
|
-
export function disposeStores() {
|
|
204
|
-
entries.forEach((entry) => {
|
|
205
|
-
entry.dispose();
|
|
206
|
-
entry.built = false;
|
|
207
|
-
});
|
|
208
|
-
}
|
|
209
|
-
/** 등록한 store 전부, 등록한 차례대로 — 앱 전체에 거는 일(다시 이어졌을 때 모든 자원을 낡게 하기 같은)에 쓴다 */
|
|
210
|
-
export function registeredStores() {
|
|
211
|
-
return entries.map((entry) => entry.handle);
|
|
193
|
+
export function Store(store, options) {
|
|
194
|
+
const state = entryOf(store).api.getState();
|
|
195
|
+
if (isDerived(state))
|
|
196
|
+
return state.get();
|
|
197
|
+
return pickFrom(state, options);
|
|
212
198
|
}
|
|
199
|
+
const isDerived = (state) => !!state && typeof state === "object" && DERIVED in state;
|
|
200
|
+
(function (Store) {
|
|
201
|
+
/** 상태를 얕게 합친다. 함수를 넘기면 지금 상태를 받는다 — 같은 객체를 돌려주면 알리지 않는다 */
|
|
202
|
+
function set(store, partial) {
|
|
203
|
+
entryOf(store).api.setState(partial);
|
|
204
|
+
}
|
|
205
|
+
Store.set = set;
|
|
206
|
+
/** 처음 지었을 때의 상태를 돌려준다. 바꾸지 않는다 — 다시 지으면(Store.override · Store.reset) 새로 지은 것 */
|
|
207
|
+
function getInitial(store) {
|
|
208
|
+
return entryOf(store).api.getInitialState();
|
|
209
|
+
}
|
|
210
|
+
Store.getInitial = getInitial;
|
|
211
|
+
/**
|
|
212
|
+
* 바뀌면 부른다. 파생이면 값이 바뀔 때 부른다. 풀기 함수를 돌려준다.
|
|
213
|
+
* 파생인지 알려고 store 를 짓는다. 다시 지어도 듣기가 이어진다
|
|
214
|
+
*/
|
|
215
|
+
function subscribe(store, listener) {
|
|
216
|
+
const api = entryOf(store).api;
|
|
217
|
+
let inner = () => { };
|
|
218
|
+
const follow = () => {
|
|
219
|
+
inner();
|
|
220
|
+
const state = api.getState();
|
|
221
|
+
inner = isDerived(state) ? state.subscribe(listener) : () => { };
|
|
222
|
+
};
|
|
223
|
+
follow();
|
|
224
|
+
const off = api.subscribe(() => (follow(), listener()));
|
|
225
|
+
return () => (off(), inner());
|
|
226
|
+
}
|
|
227
|
+
Store.subscribe = subscribe;
|
|
228
|
+
/** 처음 등록한 정의 대신 이것으로 짓는다. 그 store 에 기대던 store 도 다시 짓는다. 시험의 가짜는 일부 칸만 돌려줘도 된다 */
|
|
229
|
+
function override(store, creator) {
|
|
230
|
+
const entry = entryOf(store);
|
|
231
|
+
entry.override = creator;
|
|
232
|
+
rebuild([entry]);
|
|
233
|
+
}
|
|
234
|
+
Store.override = override;
|
|
235
|
+
/** 덮어쓴 정의를 모두 지우고, 전부 무른 뒤 지어져 있던 것을 다시 지어 알린다. 구독자는 남는다 — 시험 사이에 부른다 */
|
|
236
|
+
function reset() {
|
|
237
|
+
entries.forEach((entry) => (entry.override = undefined));
|
|
238
|
+
rebuild(entries);
|
|
239
|
+
resetScopes();
|
|
240
|
+
}
|
|
241
|
+
Store.reset = reset;
|
|
242
|
+
/** 지어진 모든 store 의 [DISPOSE] 를 부르고 지어지지 않은 상태로 되돌린다. 다시 짓지 않는다(다음에 꺼낼 때 짓는다) — 구독자는 남는다 */
|
|
243
|
+
function dispose() {
|
|
244
|
+
entries.forEach((entry) => {
|
|
245
|
+
entry.dispose();
|
|
246
|
+
entry.built = false;
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
Store.dispose = dispose;
|
|
250
|
+
/** 등록한 store 전부, 등록한 차례대로 — 앱 전체에 거는 일(다시 이어졌을 때 모든 자원을 낡게 하기 같은)에 쓴다 */
|
|
251
|
+
function registered() {
|
|
252
|
+
return entries.map((entry) => entry.handle);
|
|
253
|
+
}
|
|
254
|
+
Store.registered = registered;
|
|
255
|
+
})(Store || (Store = {}));
|
|
256
|
+
/** @deprecated `Store.override` 를 쓴다 */
|
|
257
|
+
export const overrideStore = Store.override;
|
|
258
|
+
/** @deprecated `Store.reset` 을 쓴다 */
|
|
259
|
+
export const resetStores = Store.reset;
|
|
260
|
+
/** @deprecated `Store.dispose` 를 쓴다 */
|
|
261
|
+
export const disposeStores = Store.dispose;
|
|
262
|
+
/** @deprecated `Store.registered` 를 쓴다 */
|
|
263
|
+
export const registeredStores = Store.registered;
|
|
213
264
|
/**
|
|
214
265
|
* @internal — 지금 짓고 있는 store. adopt 로 맡긴 함수는 그 store 를 dispose 할 때 [DISPOSE] 뒤에 돈다(query.ts 의 event 가 쓴다).
|
|
215
266
|
* store 를 가리는 것은 handle 이다 — label 은 한 도우미 함수 안에서 지은 store 끼리 겹치므로 문구와 기록에만 쓴다
|
package/dist/react.js
CHANGED
|
@@ -5,7 +5,7 @@ export function useStore(handle, ...args) {
|
|
|
5
5
|
const store = getStore(handle);
|
|
6
6
|
// [USE] 갈래와 pick 갈래는 store 마다 늘 같은 쪽이라 훅 순서가 바뀌지 않는다
|
|
7
7
|
if (USE in store.getInitialState()) {
|
|
8
|
-
// 다시 지으면(
|
|
8
|
+
// 다시 지으면(Store.override · Store.reset) 상태 객체가 바뀐다 — 구독해 두어야 새 상태의 [USE] 로 다시 그린다
|
|
9
9
|
const state = useSyncExternalStore(store.subscribe, store.getState, store.getState);
|
|
10
10
|
return state[USE](...args);
|
|
11
11
|
}
|
package/dist/stream/index.js
CHANGED
|
@@ -34,7 +34,7 @@ export function createStream(o) {
|
|
|
34
34
|
: connect({ ...o, url: absolute(o.url, o.transport) });
|
|
35
35
|
const state = {
|
|
36
36
|
[USE]: makeStreamHook(client, names),
|
|
37
|
-
// 다시 짓기 직전 ·
|
|
37
|
+
// 다시 짓기 직전 · Store.dispose 에서 — 앞 연결의 늦은 메시지는 닫힌 클라이언트가 버린다
|
|
38
38
|
[DISPOSE]: () => client.close(),
|
|
39
39
|
};
|
|
40
40
|
for (const name of names)
|
package/package.json
CHANGED
|
@@ -1,49 +1,107 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@rojaebl/supa-store",
|
|
3
|
-
"version": "0.7.
|
|
4
|
-
"license": "MIT",
|
|
5
|
-
"publishConfig": {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
"
|
|
13
|
-
|
|
14
|
-
"
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
"
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
"
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "@rojaebl/supa-store",
|
|
3
|
+
"version": "0.7.2",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"publishConfig": {
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/RoJaebl/supa-store.git"
|
|
11
|
+
},
|
|
12
|
+
"type": "module",
|
|
13
|
+
"engines": {
|
|
14
|
+
"node": ">=20"
|
|
15
|
+
},
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"tools/*.cjs",
|
|
20
|
+
"tools/*.mjs",
|
|
21
|
+
"tools/*.d.mts",
|
|
22
|
+
"!tools/*.test.mjs"
|
|
23
|
+
],
|
|
24
|
+
"exports": {
|
|
25
|
+
".": {
|
|
26
|
+
"types": "./dist/index.d.ts",
|
|
27
|
+
"default": "./dist/index.js"
|
|
28
|
+
},
|
|
29
|
+
"./react": {
|
|
30
|
+
"types": "./dist/react.d.ts",
|
|
31
|
+
"default": "./dist/react.js"
|
|
32
|
+
},
|
|
33
|
+
"./query": {
|
|
34
|
+
"types": "./dist/query.d.ts",
|
|
35
|
+
"default": "./dist/query.js"
|
|
36
|
+
},
|
|
37
|
+
"./stream": {
|
|
38
|
+
"types": "./dist/stream/index.d.ts",
|
|
39
|
+
"default": "./dist/stream/index.js"
|
|
40
|
+
},
|
|
41
|
+
"./rpc": {
|
|
42
|
+
"types": "./dist/rpc/index.d.ts",
|
|
43
|
+
"default": "./dist/rpc/index.js"
|
|
44
|
+
},
|
|
45
|
+
"./server": {
|
|
46
|
+
"types": "./dist/server/index.d.ts",
|
|
47
|
+
"default": "./dist/server/index.js"
|
|
48
|
+
},
|
|
49
|
+
"./server/node": {
|
|
50
|
+
"types": "./dist/server/node.d.ts",
|
|
51
|
+
"default": "./dist/server/node.js"
|
|
52
|
+
},
|
|
53
|
+
"./server/web": {
|
|
54
|
+
"types": "./dist/server/web.d.ts",
|
|
55
|
+
"default": "./dist/server/web.js"
|
|
56
|
+
},
|
|
57
|
+
"./vite": {
|
|
58
|
+
"types": "./tools/vite.d.mts",
|
|
59
|
+
"default": "./tools/vite.mjs"
|
|
60
|
+
},
|
|
61
|
+
"./next": {
|
|
62
|
+
"types": "./tools/next.d.mts",
|
|
63
|
+
"default": "./tools/next.mjs"
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
"peerDependencies": {
|
|
67
|
+
"next": ">=14",
|
|
68
|
+
"react": ">=18",
|
|
69
|
+
"vite": ">=6",
|
|
70
|
+
"ws": ">=8"
|
|
71
|
+
},
|
|
72
|
+
"peerDependenciesMeta": {
|
|
73
|
+
"next": {
|
|
74
|
+
"optional": true
|
|
75
|
+
},
|
|
76
|
+
"react": {
|
|
77
|
+
"optional": true
|
|
78
|
+
},
|
|
79
|
+
"vite": {
|
|
80
|
+
"optional": true
|
|
81
|
+
},
|
|
82
|
+
"ws": {
|
|
83
|
+
"optional": true
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"devDependencies": {
|
|
87
|
+
"@testing-library/dom": "^10.4.2",
|
|
88
|
+
"@testing-library/react": "^16.3.3",
|
|
89
|
+
"@types/node": "^24.19.2",
|
|
90
|
+
"@types/react": "^19.1.0",
|
|
91
|
+
"@types/react-dom": "^19.1.0",
|
|
92
|
+
"@types/ws": "^8.18.2",
|
|
93
|
+
"jsdom": "^30.1.1",
|
|
94
|
+
"react": "^19.1.0",
|
|
95
|
+
"react-dom": "^19.1.0",
|
|
96
|
+
"typescript": "^5.8.0",
|
|
97
|
+
"vite": "^8.3.5",
|
|
98
|
+
"vitest": "^3.1.0",
|
|
99
|
+
"ws": "^8.22.0"
|
|
100
|
+
},
|
|
101
|
+
"scripts": {
|
|
102
|
+
"build": "tsc -p tsconfig.json && tsc -p tsconfig.server.json",
|
|
103
|
+
"test": "pnpm build && vitest run && node --test \"tools/!(pack).test.mjs\"",
|
|
104
|
+
"test:pack": "node --test tools/pack.test.mjs",
|
|
105
|
+
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.server.json --noEmit && tsc -p tsconfig.test.json"
|
|
106
|
+
}
|
|
107
|
+
}
|