@legendapp/state 3.0.0-alpha.1 → 3.0.0-alpha.3

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.
Files changed (327) hide show
  1. package/.DS_Store +0 -0
  2. package/CHANGELOG.md +1 -831
  3. package/LICENSE +1 -21
  4. package/README.md +1 -141
  5. package/as/arrayAsRecord.d.mts +5 -0
  6. package/as/arrayAsRecord.d.ts +5 -0
  7. package/as/arrayAsRecord.js +28 -0
  8. package/as/arrayAsRecord.mjs +26 -0
  9. package/as/arrayAsSet.d.mts +5 -0
  10. package/as/arrayAsSet.d.ts +5 -0
  11. package/as/arrayAsSet.js +13 -0
  12. package/as/arrayAsSet.mjs +11 -0
  13. package/as/arrayAsString.d.mts +5 -0
  14. package/as/arrayAsString.d.ts +5 -0
  15. package/as/arrayAsString.js +13 -0
  16. package/as/arrayAsString.mjs +11 -0
  17. package/as/numberAsString.d.mts +5 -0
  18. package/as/numberAsString.d.ts +5 -0
  19. package/as/numberAsString.js +13 -0
  20. package/as/numberAsString.mjs +11 -0
  21. package/as/recordAsArray.d.mts +5 -0
  22. package/as/recordAsArray.d.ts +5 -0
  23. package/as/recordAsArray.js +25 -0
  24. package/as/recordAsArray.mjs +23 -0
  25. package/as/recordAsString.d.mts +5 -0
  26. package/as/recordAsString.d.ts +5 -0
  27. package/as/recordAsString.js +13 -0
  28. package/as/recordAsString.mjs +11 -0
  29. package/as/setAsArray.d.mts +5 -0
  30. package/as/setAsArray.d.ts +5 -0
  31. package/as/setAsArray.js +13 -0
  32. package/as/setAsArray.mjs +11 -0
  33. package/as/setAsString.d.mts +5 -0
  34. package/as/setAsString.d.ts +5 -0
  35. package/as/setAsString.js +13 -0
  36. package/as/setAsString.mjs +11 -0
  37. package/as/stringAsArray.d.mts +5 -0
  38. package/as/stringAsArray.d.ts +5 -0
  39. package/as/stringAsArray.js +13 -0
  40. package/as/stringAsArray.mjs +11 -0
  41. package/as/stringAsNumber.d.mts +5 -0
  42. package/as/stringAsNumber.d.ts +5 -0
  43. package/as/stringAsNumber.js +16 -0
  44. package/as/stringAsNumber.mjs +14 -0
  45. package/as/stringAsRecord.d.mts +5 -0
  46. package/as/stringAsRecord.d.ts +5 -0
  47. package/as/stringAsRecord.js +15 -0
  48. package/as/stringAsRecord.mjs +13 -0
  49. package/as/stringAsSet.d.mts +5 -0
  50. package/as/stringAsSet.d.ts +5 -0
  51. package/as/stringAsSet.js +13 -0
  52. package/as/stringAsSet.mjs +11 -0
  53. package/babel.d.mts +21 -0
  54. package/babel.d.ts +21 -2
  55. package/babel.js +57 -53
  56. package/babel.mjs +65 -0
  57. package/config/enable$GetSet.js +13 -14
  58. package/config/enable$GetSet.mjs +13 -14
  59. package/config/enableReactComponents.d.mts +9 -0
  60. package/config/enableReactComponents.d.ts +4 -2
  61. package/config/enableReactComponents.js +13 -10
  62. package/config/enableReactComponents.mjs +13 -10
  63. package/config/enableReactNativeComponents.d.mts +22 -0
  64. package/config/enableReactNativeComponents.d.ts +6 -4
  65. package/config/enableReactNativeComponents.js +43 -47
  66. package/config/enableReactNativeComponents.mjs +43 -47
  67. package/config/enableReactTracking.d.mts +7 -0
  68. package/config/enableReactTracking.d.ts +3 -2
  69. package/config/enableReactTracking.js +33 -38
  70. package/config/enableReactTracking.mjs +33 -38
  71. package/config/enableReactUse.d.mts +10 -0
  72. package/config/enableReactUse.d.ts +4 -1
  73. package/config/enableReactUse.js +15 -14
  74. package/config/enableReactUse.mjs +15 -14
  75. package/config/{enable$GetSet.d.ts → enable_GetSet.d.mts} +4 -2
  76. package/config/enable_GetSet.d.ts +10 -0
  77. package/config/enable_PeekAssign.d.mts +10 -0
  78. package/config/enable_PeekAssign.d.ts +4 -2
  79. package/config/enable_PeekAssign.js +13 -14
  80. package/config/enable_PeekAssign.mjs +13 -14
  81. package/helpers/pageHash.d.mts +9 -0
  82. package/helpers/pageHash.d.ts +2 -0
  83. package/helpers/pageHash.js +25 -30
  84. package/helpers/pageHash.mjs +25 -30
  85. package/helpers/pageHashParams.d.mts +9 -0
  86. package/helpers/pageHashParams.d.ts +2 -0
  87. package/helpers/pageHashParams.js +34 -37
  88. package/helpers/pageHashParams.mjs +34 -37
  89. package/helpers/time.d.mts +6 -0
  90. package/helpers/time.d.ts +6 -3
  91. package/helpers/time.js +17 -17
  92. package/helpers/time.mjs +17 -17
  93. package/helpers/trackHistory.d.mts +6 -0
  94. package/helpers/trackHistory.d.ts +4 -2
  95. package/helpers/trackHistory.js +13 -16
  96. package/helpers/trackHistory.mjs +13 -16
  97. package/helpers/undoRedo.d.mts +37 -0
  98. package/helpers/undoRedo.d.ts +5 -3
  99. package/helpers/undoRedo.js +59 -94
  100. package/helpers/undoRedo.mjs +59 -94
  101. package/index.d.mts +404 -0
  102. package/index.d.ts +371 -28
  103. package/index.js +2015 -2166
  104. package/index.mjs +2015 -2166
  105. package/package.json +254 -195
  106. package/persist-plugins/async-storage.d.mts +18 -0
  107. package/persist-plugins/async-storage.d.ts +6 -3
  108. package/persist-plugins/async-storage.js +79 -86
  109. package/persist-plugins/async-storage.mjs +79 -86
  110. package/persist-plugins/indexeddb.d.mts +29 -0
  111. package/persist-plugins/indexeddb.d.ts +6 -3
  112. package/persist-plugins/indexeddb.js +331 -352
  113. package/persist-plugins/indexeddb.mjs +331 -352
  114. package/persist-plugins/local-storage.d.mts +23 -0
  115. package/persist-plugins/local-storage.d.ts +8 -5
  116. package/persist-plugins/local-storage.js +74 -76
  117. package/persist-plugins/local-storage.mjs +74 -76
  118. package/persist-plugins/mmkv.d.mts +18 -0
  119. package/persist-plugins/mmkv.d.ts +6 -3
  120. package/persist-plugins/mmkv.js +82 -86
  121. package/persist-plugins/mmkv.mjs +82 -86
  122. package/react-hooks/createObservableHook.d.mts +5 -0
  123. package/react-hooks/createObservableHook.d.ts +4 -1
  124. package/react-hooks/createObservableHook.js +29 -30
  125. package/react-hooks/createObservableHook.mjs +25 -30
  126. package/react-hooks/useHover.d.mts +5 -0
  127. package/react-hooks/useHover.d.ts +5 -3
  128. package/react-hooks/useHover.js +29 -29
  129. package/react-hooks/useHover.mjs +29 -29
  130. package/react-hooks/useMeasure.d.mts +9 -0
  131. package/react-hooks/useMeasure.d.ts +5 -2
  132. package/react-hooks/useMeasure.js +30 -32
  133. package/react-hooks/useMeasure.mjs +30 -32
  134. package/react-hooks/useObservableNextRouter.d.mts +35 -0
  135. package/react-hooks/useObservableNextRouter.d.ts +9 -7
  136. package/react-hooks/useObservableNextRouter.js +64 -77
  137. package/react-hooks/useObservableNextRouter.mjs +60 -77
  138. package/react.d.mts +157 -0
  139. package/react.d.ts +157 -21
  140. package/react.js +458 -749
  141. package/react.mjs +457 -752
  142. package/sync-plugins/crud.d.mts +54 -0
  143. package/sync-plugins/crud.d.ts +12 -10
  144. package/sync-plugins/crud.js +253 -270
  145. package/sync-plugins/crud.mjs +253 -270
  146. package/sync-plugins/fetch.d.mts +21 -0
  147. package/sync-plugins/fetch.d.ts +7 -4
  148. package/sync-plugins/fetch.js +50 -37
  149. package/sync-plugins/fetch.mjs +50 -37
  150. package/sync-plugins/keel.d.mts +108 -0
  151. package/sync-plugins/keel.d.ts +17 -15
  152. package/sync-plugins/keel.js +229 -462
  153. package/sync-plugins/keel.mjs +227 -464
  154. package/sync-plugins/supabase.d.mts +39 -0
  155. package/sync-plugins/supabase.d.ts +16 -14
  156. package/sync-plugins/supabase.js +128 -128
  157. package/sync-plugins/supabase.mjs +128 -128
  158. package/sync-plugins/tanstack-query.d.mts +14 -0
  159. package/sync-plugins/tanstack-query.d.ts +7 -4
  160. package/sync-plugins/tanstack-query.js +51 -57
  161. package/sync-plugins/tanstack-query.mjs +51 -57
  162. package/sync-plugins/tanstack-react-query.d.mts +8 -0
  163. package/sync-plugins/tanstack-react-query.d.ts +6 -1
  164. package/sync-plugins/tanstack-react-query.js +2 -2
  165. package/sync-plugins/tanstack-react-query.mjs +2 -2
  166. package/sync.d.mts +351 -0
  167. package/sync.d.ts +349 -9
  168. package/sync.js +910 -964
  169. package/sync.mjs +920 -974
  170. package/trace.d.mts +9 -0
  171. package/trace.d.ts +9 -4
  172. package/trace.js +72 -62
  173. package/trace.mjs +72 -62
  174. package/types/babel.d.ts +1 -12
  175. package/babel.js.map +0 -1
  176. package/config/enable$GetSet.js.map +0 -1
  177. package/config/enable$GetSet.mjs.map +0 -1
  178. package/config/enableReactComponents.js.map +0 -1
  179. package/config/enableReactComponents.mjs.map +0 -1
  180. package/config/enableReactNativeComponents.js.map +0 -1
  181. package/config/enableReactNativeComponents.mjs.map +0 -1
  182. package/config/enableReactTracking.js.map +0 -1
  183. package/config/enableReactTracking.mjs.map +0 -1
  184. package/config/enableReactUse.js.map +0 -1
  185. package/config/enableReactUse.mjs.map +0 -1
  186. package/config/enable_PeekAssign.js.map +0 -1
  187. package/config/enable_PeekAssign.mjs.map +0 -1
  188. package/helpers/pageHash.js.map +0 -1
  189. package/helpers/pageHash.mjs.map +0 -1
  190. package/helpers/pageHashParams.js.map +0 -1
  191. package/helpers/pageHashParams.mjs.map +0 -1
  192. package/helpers/time.js.map +0 -1
  193. package/helpers/time.mjs.map +0 -1
  194. package/helpers/trackHistory.js.map +0 -1
  195. package/helpers/trackHistory.mjs.map +0 -1
  196. package/helpers/undoRedo.js.map +0 -1
  197. package/helpers/undoRedo.mjs.map +0 -1
  198. package/history.d.ts +0 -1
  199. package/history.js +0 -24
  200. package/history.js.map +0 -1
  201. package/history.mjs +0 -22
  202. package/history.mjs.map +0 -1
  203. package/index.js.map +0 -1
  204. package/index.mjs.map +0 -1
  205. package/persist-plugins/async-storage.js.map +0 -1
  206. package/persist-plugins/async-storage.mjs.map +0 -1
  207. package/persist-plugins/indexeddb.js.map +0 -1
  208. package/persist-plugins/indexeddb.mjs.map +0 -1
  209. package/persist-plugins/local-storage.js.map +0 -1
  210. package/persist-plugins/local-storage.mjs.map +0 -1
  211. package/persist-plugins/mmkv.js.map +0 -1
  212. package/persist-plugins/mmkv.mjs.map +0 -1
  213. package/react-hooks/createObservableHook.js.map +0 -1
  214. package/react-hooks/createObservableHook.mjs.map +0 -1
  215. package/react-hooks/useHover.js.map +0 -1
  216. package/react-hooks/useHover.mjs.map +0 -1
  217. package/react-hooks/useMeasure.js.map +0 -1
  218. package/react-hooks/useMeasure.mjs.map +0 -1
  219. package/react-hooks/useObservableNextRouter.js.map +0 -1
  220. package/react-hooks/useObservableNextRouter.mjs.map +0 -1
  221. package/react.js.map +0 -1
  222. package/react.mjs.map +0 -1
  223. package/src/ObservableObject.ts +0 -1350
  224. package/src/ObservablePrimitive.ts +0 -62
  225. package/src/babel/index.ts +0 -83
  226. package/src/batching.ts +0 -357
  227. package/src/computed.ts +0 -18
  228. package/src/config/enable$GetSet.ts +0 -30
  229. package/src/config/enableReactComponents.ts +0 -26
  230. package/src/config/enableReactNativeComponents.ts +0 -102
  231. package/src/config/enableReactTracking.ts +0 -62
  232. package/src/config/enableReactUse.ts +0 -32
  233. package/src/config/enable_PeekAssign.ts +0 -31
  234. package/src/config.ts +0 -47
  235. package/src/createObservable.ts +0 -47
  236. package/src/event.ts +0 -26
  237. package/src/globals.ts +0 -235
  238. package/src/helpers/pageHash.ts +0 -41
  239. package/src/helpers/pageHashParams.ts +0 -55
  240. package/src/helpers/time.ts +0 -30
  241. package/src/helpers/trackHistory.ts +0 -29
  242. package/src/helpers/undoRedo.ts +0 -111
  243. package/src/helpers.ts +0 -231
  244. package/src/is.ts +0 -63
  245. package/src/linked.ts +0 -17
  246. package/src/observable.ts +0 -32
  247. package/src/observableInterfaces.ts +0 -151
  248. package/src/observableTypes.ts +0 -232
  249. package/src/observe.ts +0 -89
  250. package/src/old-plugins/firebase.ts +0 -1053
  251. package/src/onChange.ts +0 -146
  252. package/src/persist/configureObservablePersistence.ts +0 -7
  253. package/src/persist/fieldTransformer.ts +0 -149
  254. package/src/persist/observablePersistRemoteFunctionsAdapter.ts +0 -39
  255. package/src/persist/persistObservable.ts +0 -1034
  256. package/src/persist-plugins/async-storage.ts +0 -99
  257. package/src/persist-plugins/indexeddb.ts +0 -439
  258. package/src/persist-plugins/local-storage.ts +0 -86
  259. package/src/persist-plugins/mmkv.ts +0 -91
  260. package/src/proxy.ts +0 -28
  261. package/src/react/Computed.tsx +0 -8
  262. package/src/react/For.tsx +0 -116
  263. package/src/react/Memo.tsx +0 -4
  264. package/src/react/Reactive.tsx +0 -53
  265. package/src/react/Show.tsx +0 -33
  266. package/src/react/Switch.tsx +0 -43
  267. package/src/react/react-globals.ts +0 -3
  268. package/src/react/reactInterfaces.ts +0 -32
  269. package/src/react/reactive-observer.tsx +0 -210
  270. package/src/react/useComputed.ts +0 -36
  271. package/src/react/useEffectOnce.ts +0 -41
  272. package/src/react/useIsMounted.ts +0 -16
  273. package/src/react/useMount.ts +0 -15
  274. package/src/react/useObservable.ts +0 -24
  275. package/src/react/useObservableReducer.ts +0 -52
  276. package/src/react/useObservableState.ts +0 -30
  277. package/src/react/useObserve.ts +0 -54
  278. package/src/react/useObserveEffect.ts +0 -40
  279. package/src/react/usePauseProvider.tsx +0 -16
  280. package/src/react/useSelector.ts +0 -167
  281. package/src/react/useUnmount.ts +0 -8
  282. package/src/react/useWhen.ts +0 -9
  283. package/src/react-hooks/createObservableHook.ts +0 -53
  284. package/src/react-hooks/useHover.ts +0 -40
  285. package/src/react-hooks/useMeasure.ts +0 -48
  286. package/src/react-hooks/useObservableNextRouter.ts +0 -137
  287. package/src/retry.ts +0 -71
  288. package/src/setupTracking.ts +0 -26
  289. package/src/sync/activateSyncedNode.ts +0 -128
  290. package/src/sync/configureObservableSync.ts +0 -7
  291. package/src/sync/persistTypes.ts +0 -216
  292. package/src/sync/syncHelpers.ts +0 -180
  293. package/src/sync/syncObservable.ts +0 -1056
  294. package/src/sync/syncObservableAdapter.ts +0 -31
  295. package/src/sync/syncTypes.ts +0 -189
  296. package/src/sync/synced.ts +0 -21
  297. package/src/sync-plugins/crud.ts +0 -412
  298. package/src/sync-plugins/fetch.ts +0 -80
  299. package/src/sync-plugins/keel.ts +0 -495
  300. package/src/sync-plugins/supabase.ts +0 -249
  301. package/src/sync-plugins/tanstack-query.ts +0 -113
  302. package/src/sync-plugins/tanstack-react-query.ts +0 -12
  303. package/src/trace/traceHelpers.ts +0 -11
  304. package/src/trace/useTraceListeners.ts +0 -34
  305. package/src/trace/useTraceUpdates.ts +0 -24
  306. package/src/trace/useVerifyNotTracking.ts +0 -33
  307. package/src/trace/useVerifyOneRender.ts +0 -10
  308. package/src/trackSelector.ts +0 -52
  309. package/src/tracking.ts +0 -43
  310. package/src/types/babel.d.ts +0 -12
  311. package/src/when.ts +0 -75
  312. package/sync-plugins/crud.js.map +0 -1
  313. package/sync-plugins/crud.mjs.map +0 -1
  314. package/sync-plugins/fetch.js.map +0 -1
  315. package/sync-plugins/fetch.mjs.map +0 -1
  316. package/sync-plugins/keel.js.map +0 -1
  317. package/sync-plugins/keel.mjs.map +0 -1
  318. package/sync-plugins/supabase.js.map +0 -1
  319. package/sync-plugins/supabase.mjs.map +0 -1
  320. package/sync-plugins/tanstack-query.js.map +0 -1
  321. package/sync-plugins/tanstack-query.mjs.map +0 -1
  322. package/sync-plugins/tanstack-react-query.js.map +0 -1
  323. package/sync-plugins/tanstack-react-query.mjs.map +0 -1
  324. package/sync.js.map +0 -1
  325. package/sync.mjs.map +0 -1
  326. package/trace.js.map +0 -1
  327. package/trace.mjs.map +0 -1
@@ -0,0 +1,35 @@
1
+ import { Observable } from '@legendapp/state';
2
+ import { NextRouter } from 'next/router';
3
+
4
+ type ParsedUrlQuery = {
5
+ [key: string]: string | string[] | undefined;
6
+ };
7
+ interface TransitionOptions {
8
+ shallow?: boolean;
9
+ locale?: string | false;
10
+ scroll?: boolean;
11
+ unstable_skipClientCache?: boolean;
12
+ }
13
+ interface ObservableNextRouterState {
14
+ pathname: string;
15
+ hash: string;
16
+ query: ParsedUrlQuery;
17
+ }
18
+ type RouteInfo = Partial<ObservableNextRouterState>;
19
+ interface ParamsUseObservableNextRouterBase {
20
+ transitionOptions?: TransitionOptions;
21
+ method?: 'push' | 'replace';
22
+ subscribe?: boolean;
23
+ }
24
+ interface ParamsUseObservableNextRouter<T extends object> extends ParamsUseObservableNextRouterBase {
25
+ compute: (value: ObservableNextRouterState) => T;
26
+ set: (value: T, previous: T, router: NextRouter) => RouteInfo & {
27
+ transitionOptions?: TransitionOptions;
28
+ method?: 'push' | 'replace';
29
+ };
30
+ }
31
+ declare function useObservableNextRouter(): Observable<ObservableNextRouterState>;
32
+ declare function useObservableNextRouter<T extends object>(params: ParamsUseObservableNextRouter<T>): Observable<T>;
33
+ declare function useObservableNextRouter(params: ParamsUseObservableNextRouterBase): Observable<ObservableNextRouterState>;
34
+
35
+ export { type ObservableNextRouterState, type ParamsUseObservableNextRouter, type ParamsUseObservableNextRouterBase, useObservableNextRouter };
@@ -1,5 +1,6 @@
1
1
  import { Observable } from '@legendapp/state';
2
2
  import { NextRouter } from 'next/router';
3
+
3
4
  type ParsedUrlQuery = {
4
5
  [key: string]: string | string[] | undefined;
5
6
  };
@@ -9,25 +10,26 @@ interface TransitionOptions {
9
10
  scroll?: boolean;
10
11
  unstable_skipClientCache?: boolean;
11
12
  }
12
- export interface ObservableNextRouterState {
13
+ interface ObservableNextRouterState {
13
14
  pathname: string;
14
15
  hash: string;
15
16
  query: ParsedUrlQuery;
16
17
  }
17
18
  type RouteInfo = Partial<ObservableNextRouterState>;
18
- export interface ParamsUseObservableNextRouterBase {
19
+ interface ParamsUseObservableNextRouterBase {
19
20
  transitionOptions?: TransitionOptions;
20
21
  method?: 'push' | 'replace';
21
22
  subscribe?: boolean;
22
23
  }
23
- export interface ParamsUseObservableNextRouter<T extends object> extends ParamsUseObservableNextRouterBase {
24
+ interface ParamsUseObservableNextRouter<T extends object> extends ParamsUseObservableNextRouterBase {
24
25
  compute: (value: ObservableNextRouterState) => T;
25
26
  set: (value: T, previous: T, router: NextRouter) => RouteInfo & {
26
27
  transitionOptions?: TransitionOptions;
27
28
  method?: 'push' | 'replace';
28
29
  };
29
30
  }
30
- export declare function useObservableNextRouter(): Observable<ObservableNextRouterState>;
31
- export declare function useObservableNextRouter<T extends object>(params: ParamsUseObservableNextRouter<T>): Observable<T>;
32
- export declare function useObservableNextRouter(params: ParamsUseObservableNextRouterBase): Observable<ObservableNextRouterState>;
33
- export {};
31
+ declare function useObservableNextRouter(): Observable<ObservableNextRouterState>;
32
+ declare function useObservableNextRouter<T extends object>(params: ParamsUseObservableNextRouter<T>): Observable<T>;
33
+ declare function useObservableNextRouter(params: ParamsUseObservableNextRouterBase): Observable<ObservableNextRouterState>;
34
+
35
+ export { type ObservableNextRouterState, type ParamsUseObservableNextRouter, type ParamsUseObservableNextRouterBase, useObservableNextRouter };
@@ -3,90 +3,77 @@
3
3
  var state = require('@legendapp/state');
4
4
  var Router = require('next/router');
5
5
 
6
+ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
7
+
8
+ var Router__default = /*#__PURE__*/_interopDefault(Router);
9
+
10
+ // src/react-hooks/useObservableNextRouter.ts
6
11
  function isShallowEqual(query1, query2) {
7
- if (!query1 !== !query2) {
8
- return false;
9
- }
10
- const keys1 = Object.keys(query1);
11
- const keys2 = Object.keys(query2);
12
- if (keys1.length !== keys2.length) {
13
- return false;
12
+ if (!query1 !== !query2) {
13
+ return false;
14
+ }
15
+ const keys1 = Object.keys(query1);
16
+ const keys2 = Object.keys(query2);
17
+ if (keys1.length !== keys2.length) {
18
+ return false;
19
+ }
20
+ for (const key of keys1) {
21
+ if (query1[key] !== query2[key]) {
22
+ return false;
14
23
  }
15
- for (const key of keys1) {
16
- if (query1[key] !== query2[key]) {
17
- return false;
18
- }
19
- }
20
- return true;
24
+ }
25
+ return true;
21
26
  }
22
- const routes$ = state.observable({});
23
- let routeParams = {};
24
- let router;
27
+ var routes$ = state.observable({});
28
+ var routeParams = {};
29
+ var router;
25
30
  routes$.onChange(({ value, getPrevious }) => {
26
- // Only run this if being manually changed by the user
27
- let setter = routeParams === null || routeParams === void 0 ? void 0 : routeParams.set;
28
- if (!setter) {
29
- if (value.pathname) {
30
- setter = () => value;
31
- }
32
- else {
33
- console.error('[legend-state]: Must provide a set method to useObservableNextRouter');
34
- }
35
- }
36
- const setReturn = setter(value, getPrevious(), router);
37
- const { pathname, hash, query } = setReturn;
38
- let { transitionOptions, method } = setReturn;
39
- method = method || (routeParams === null || routeParams === void 0 ? void 0 : routeParams.method);
40
- transitionOptions = transitionOptions || (routeParams === null || routeParams === void 0 ? void 0 : routeParams.transitionOptions);
41
- const prevHash = router.asPath.split('#')[1] || '';
42
- const change = {};
43
- // Only include changes that were meant to be changed. For example the user may have
44
- // only changed the hash so we don't need to push a pathname change.
45
- if (pathname !== undefined && pathname !== router.pathname) {
46
- change.pathname = pathname;
47
- }
48
- if (hash !== undefined && hash !== prevHash) {
49
- change.hash = hash;
50
- }
51
- if (query !== undefined && !isShallowEqual(query, router.query)) {
52
- change.query = query;
53
- }
54
- // Only push if there are changes
55
- if (!state.isEmpty(change)) {
56
- const fn = method === 'replace' ? 'replace' : 'push';
57
- router[fn](change, undefined, transitionOptions).catch((e) => {
58
- // workaround for https://github.com/vercel/next.js/issues/37362
59
- if (!e.cancelled)
60
- throw e;
61
- });
31
+ let setter = routeParams == null ? void 0 : routeParams.set;
32
+ if (!setter) {
33
+ if (value.pathname) {
34
+ setter = () => value;
35
+ } else {
36
+ console.error("[legend-state]: Must provide a set method to useObservableNextRouter");
62
37
  }
38
+ }
39
+ const setReturn = setter(value, getPrevious(), router);
40
+ const { pathname, hash, query } = setReturn;
41
+ let { transitionOptions, method } = setReturn;
42
+ method = method || (routeParams == null ? void 0 : routeParams.method);
43
+ transitionOptions = transitionOptions || (routeParams == null ? void 0 : routeParams.transitionOptions);
44
+ const prevHash = router.asPath.split("#")[1] || "";
45
+ const change = {};
46
+ if (pathname !== void 0 && pathname !== router.pathname) {
47
+ change.pathname = pathname;
48
+ }
49
+ if (hash !== void 0 && hash !== prevHash) {
50
+ change.hash = hash;
51
+ }
52
+ if (query !== void 0 && !isShallowEqual(query, router.query)) {
53
+ change.query = query;
54
+ }
55
+ if (!state.isEmpty(change)) {
56
+ const fn = method === "replace" ? "replace" : "push";
57
+ router[fn](change, void 0, transitionOptions).catch((e) => {
58
+ if (!e.cancelled)
59
+ throw e;
60
+ });
61
+ }
63
62
  });
64
63
  function useObservableNextRouter(params) {
65
- const { subscribe, compute } = params || {};
66
- try {
67
- // Use the useRouter hook if we're on the client side and want to subscribe to changes.
68
- // Otherwise use the Router object so that this does not subscribe to router changes.
69
- router = typeof window !== 'undefined' && !subscribe ? Router : Router.useRouter();
70
- }
71
- finally {
72
- router = router || Router.useRouter();
73
- }
74
- // Update the local state with the new functions and options. This can happen when being run
75
- // on a new page or if the user just changes it on the current page.
76
- // It's better for performance than creating new observables or hooks for every use, since there may be
77
- // many uses of useObservableRouter in the lifecycle of a page.
78
- routeParams = params;
79
- // Get the pathname and hash
80
- const { asPath, pathname, query } = router;
81
- const hash = asPath.split('#')[1] || '';
82
- // Run the compute function to get the value of the object
83
- const computeParams = { pathname, hash, query };
84
- const obj = compute ? compute(computeParams) : computeParams;
85
- // Set the object without triggering router.push
86
- state.setSilently(routes$, obj);
87
- // Return the observable with the computed values
88
- return routes$;
64
+ const { subscribe, compute } = params || {};
65
+ try {
66
+ router = typeof window !== "undefined" && !subscribe ? Router__default.default : Router.useRouter();
67
+ } finally {
68
+ router = router || Router.useRouter();
69
+ }
70
+ routeParams = params;
71
+ const { asPath, pathname, query } = router;
72
+ const hash = asPath.split("#")[1] || "";
73
+ const computeParams = { pathname, hash, query };
74
+ const obj = compute ? compute(computeParams) : computeParams;
75
+ state.setSilently(routes$, obj);
76
+ return routes$;
89
77
  }
90
78
 
91
79
  exports.useObservableNextRouter = useObservableNextRouter;
92
- //# sourceMappingURL=useObservableNextRouter.js.map
@@ -1,90 +1,73 @@
1
1
  import { observable, isEmpty, setSilently } from '@legendapp/state';
2
2
  import Router, { useRouter } from 'next/router';
3
3
 
4
+ // src/react-hooks/useObservableNextRouter.ts
4
5
  function isShallowEqual(query1, query2) {
5
- if (!query1 !== !query2) {
6
- return false;
6
+ if (!query1 !== !query2) {
7
+ return false;
8
+ }
9
+ const keys1 = Object.keys(query1);
10
+ const keys2 = Object.keys(query2);
11
+ if (keys1.length !== keys2.length) {
12
+ return false;
13
+ }
14
+ for (const key of keys1) {
15
+ if (query1[key] !== query2[key]) {
16
+ return false;
7
17
  }
8
- const keys1 = Object.keys(query1);
9
- const keys2 = Object.keys(query2);
10
- if (keys1.length !== keys2.length) {
11
- return false;
12
- }
13
- for (const key of keys1) {
14
- if (query1[key] !== query2[key]) {
15
- return false;
16
- }
17
- }
18
- return true;
18
+ }
19
+ return true;
19
20
  }
20
- const routes$ = observable({});
21
- let routeParams = {};
22
- let router;
21
+ var routes$ = observable({});
22
+ var routeParams = {};
23
+ var router;
23
24
  routes$.onChange(({ value, getPrevious }) => {
24
- // Only run this if being manually changed by the user
25
- let setter = routeParams === null || routeParams === void 0 ? void 0 : routeParams.set;
26
- if (!setter) {
27
- if (value.pathname) {
28
- setter = () => value;
29
- }
30
- else {
31
- console.error('[legend-state]: Must provide a set method to useObservableNextRouter');
32
- }
33
- }
34
- const setReturn = setter(value, getPrevious(), router);
35
- const { pathname, hash, query } = setReturn;
36
- let { transitionOptions, method } = setReturn;
37
- method = method || (routeParams === null || routeParams === void 0 ? void 0 : routeParams.method);
38
- transitionOptions = transitionOptions || (routeParams === null || routeParams === void 0 ? void 0 : routeParams.transitionOptions);
39
- const prevHash = router.asPath.split('#')[1] || '';
40
- const change = {};
41
- // Only include changes that were meant to be changed. For example the user may have
42
- // only changed the hash so we don't need to push a pathname change.
43
- if (pathname !== undefined && pathname !== router.pathname) {
44
- change.pathname = pathname;
45
- }
46
- if (hash !== undefined && hash !== prevHash) {
47
- change.hash = hash;
48
- }
49
- if (query !== undefined && !isShallowEqual(query, router.query)) {
50
- change.query = query;
51
- }
52
- // Only push if there are changes
53
- if (!isEmpty(change)) {
54
- const fn = method === 'replace' ? 'replace' : 'push';
55
- router[fn](change, undefined, transitionOptions).catch((e) => {
56
- // workaround for https://github.com/vercel/next.js/issues/37362
57
- if (!e.cancelled)
58
- throw e;
59
- });
25
+ let setter = routeParams == null ? void 0 : routeParams.set;
26
+ if (!setter) {
27
+ if (value.pathname) {
28
+ setter = () => value;
29
+ } else {
30
+ console.error("[legend-state]: Must provide a set method to useObservableNextRouter");
60
31
  }
32
+ }
33
+ const setReturn = setter(value, getPrevious(), router);
34
+ const { pathname, hash, query } = setReturn;
35
+ let { transitionOptions, method } = setReturn;
36
+ method = method || (routeParams == null ? void 0 : routeParams.method);
37
+ transitionOptions = transitionOptions || (routeParams == null ? void 0 : routeParams.transitionOptions);
38
+ const prevHash = router.asPath.split("#")[1] || "";
39
+ const change = {};
40
+ if (pathname !== void 0 && pathname !== router.pathname) {
41
+ change.pathname = pathname;
42
+ }
43
+ if (hash !== void 0 && hash !== prevHash) {
44
+ change.hash = hash;
45
+ }
46
+ if (query !== void 0 && !isShallowEqual(query, router.query)) {
47
+ change.query = query;
48
+ }
49
+ if (!isEmpty(change)) {
50
+ const fn = method === "replace" ? "replace" : "push";
51
+ router[fn](change, void 0, transitionOptions).catch((e) => {
52
+ if (!e.cancelled)
53
+ throw e;
54
+ });
55
+ }
61
56
  });
62
57
  function useObservableNextRouter(params) {
63
- const { subscribe, compute } = params || {};
64
- try {
65
- // Use the useRouter hook if we're on the client side and want to subscribe to changes.
66
- // Otherwise use the Router object so that this does not subscribe to router changes.
67
- router = typeof window !== 'undefined' && !subscribe ? Router : useRouter();
68
- }
69
- finally {
70
- router = router || useRouter();
71
- }
72
- // Update the local state with the new functions and options. This can happen when being run
73
- // on a new page or if the user just changes it on the current page.
74
- // It's better for performance than creating new observables or hooks for every use, since there may be
75
- // many uses of useObservableRouter in the lifecycle of a page.
76
- routeParams = params;
77
- // Get the pathname and hash
78
- const { asPath, pathname, query } = router;
79
- const hash = asPath.split('#')[1] || '';
80
- // Run the compute function to get the value of the object
81
- const computeParams = { pathname, hash, query };
82
- const obj = compute ? compute(computeParams) : computeParams;
83
- // Set the object without triggering router.push
84
- setSilently(routes$, obj);
85
- // Return the observable with the computed values
86
- return routes$;
58
+ const { subscribe, compute } = params || {};
59
+ try {
60
+ router = typeof window !== "undefined" && !subscribe ? Router : useRouter();
61
+ } finally {
62
+ router = router || useRouter();
63
+ }
64
+ routeParams = params;
65
+ const { asPath, pathname, query } = router;
66
+ const hash = asPath.split("#")[1] || "";
67
+ const computeParams = { pathname, hash, query };
68
+ const obj = compute ? compute(computeParams) : computeParams;
69
+ setSilently(routes$, obj);
70
+ return routes$;
87
71
  }
88
72
 
89
73
  export { useObservableNextRouter };
90
- //# sourceMappingURL=useObservableNextRouter.mjs.map
package/react.d.mts ADDED
@@ -0,0 +1,157 @@
1
+ import * as react from 'react';
2
+ import { ReactNode, ReactElement, FC, LegacyRef, ComponentClass, ReducerWithoutAction, ReducerStateWithoutAction, DispatchWithoutAction, Reducer, ReducerState, Dispatch, ReducerAction } from 'react';
3
+ import { ObservableParam, Observable, ObservableBoolean, Selector, RecursiveValueOrFunction, ObserveEvent, ObserveOptions, ObserveEventCallback } from '@legendapp/state';
4
+
5
+ declare function Computed({ children }: {
6
+ children: ObservableParam | (() => ReactNode);
7
+ }): ReactElement;
8
+
9
+ type ForItemProps<T, TProps = {}> = {
10
+ item$: Observable<T>;
11
+ id?: string;
12
+ } & TProps;
13
+ declare function For<T, TProps>({ each, optimized: isOptimized, item, itemProps, sortValues, children, }: {
14
+ each?: ObservableParam<T[] | Record<any, T> | Map<any, T>>;
15
+ optimized?: boolean;
16
+ item?: FC<ForItemProps<T, TProps>>;
17
+ itemProps?: TProps;
18
+ sortValues?: (A: T, B: T, AKey: string, BKey: string) => number;
19
+ children?: (value: Observable<T>, id: string | undefined) => ReactElement;
20
+ }): ReactElement | null;
21
+
22
+ declare function usePauseProvider(): {
23
+ PauseProvider: ({ children }: {
24
+ children: ReactNode;
25
+ }) => react.FunctionComponentElement<react.ProviderProps<ObservableBoolean>>;
26
+ isPaused$: ObservableBoolean;
27
+ };
28
+
29
+ declare const Memo: react.MemoExoticComponent<typeof Computed>;
30
+
31
+ type ShapeWithNew$<T> = Partial<Omit<T, 'children'>> & {
32
+ [K in keyof T as K extends `$${string & K}` ? K : `$${string & K}`]?: Selector<T[K]>;
33
+ } & {
34
+ children?: Selector<ReactNode>;
35
+ };
36
+ interface BindKey<P> {
37
+ handler?: keyof P;
38
+ getValue?: (e: any) => any;
39
+ defaultValue?: any;
40
+ selector?: (propsOut: Record<string, any>, p: Observable<any>) => any;
41
+ }
42
+ type BindKeys<P = any> = Record<keyof P, BindKey<P>>;
43
+ type FCReactiveObject<T> = {
44
+ [K in keyof T]: FC<ShapeWithNew$<T[K]>>;
45
+ };
46
+ type FCReactive<P, P2> = P & FC<ShapeWithNew$<P2> & {
47
+ ref?: LegacyRef<P> | undefined;
48
+ }>;
49
+ interface UseSelectorOptions {
50
+ suspense?: boolean;
51
+ skipCheck?: boolean;
52
+ }
53
+
54
+ interface IReactive {
55
+ }
56
+ declare const Reactive: IReactive;
57
+ declare function configureReactive({ components, binders, }: {
58
+ components?: Record<string, FC | ComponentClass<any>>;
59
+ binders?: Record<string, BindKeys>;
60
+ }): void;
61
+
62
+ interface PropsIf<T> {
63
+ if: Selector<T>;
64
+ ifReady?: never;
65
+ }
66
+ interface PropsIfReady<T> {
67
+ if?: never;
68
+ ifReady: Selector<T>;
69
+ }
70
+ interface PropsBase<T> {
71
+ else?: ReactNode | (() => ReactNode);
72
+ wrap?: FC;
73
+ children: ReactNode | ((value?: T) => ReactNode);
74
+ }
75
+ type Props<T> = PropsBase<T> & (PropsIf<T> | PropsIfReady<T>);
76
+ declare function Show<T>(props: Props<T>): ReactElement;
77
+
78
+ declare function Switch<T extends object>({ value, children, }: {
79
+ value?: Selector<T>;
80
+ children: Partial<Record<keyof T | 'null' | 'undefined' | 'default', () => ReactNode>>;
81
+ }): ReactElement | null;
82
+ declare function Switch<T extends string | number | symbol>({ value, children, }: {
83
+ value?: Selector<T>;
84
+ children: Partial<Record<T | 'null' | 'undefined' | 'default', () => ReactNode>>;
85
+ }): ReactElement | null;
86
+ declare function Switch<T extends boolean>({ value, children, }: {
87
+ value?: Selector<T>;
88
+ children: Partial<Record<'false' | 'true' | 'null' | 'undefined' | 'default', () => ReactNode>>;
89
+ }): ReactElement | null;
90
+ declare function Switch<T>({ value, children, }: {
91
+ value?: Selector<T>;
92
+ children: Partial<Record<'undefined' | 'default', () => ReactNode>>;
93
+ }): ReactElement | null;
94
+
95
+ type ShapeWithPick$<T, T2 extends keyof T = keyof T> = Partial<T> & {
96
+ [K in T2 as K extends `$${string & K}` ? K : `$${string & K}`]?: Selector<T[K]>;
97
+ };
98
+ type ShapeWith$<T> = Partial<T> & {
99
+ [K in keyof T as K extends `$${string & K}` ? K : `$${string & K}`]?: Selector<T[K]>;
100
+ };
101
+ type ObjectShapeWith$<T> = {
102
+ [K in keyof T]: T[K] extends FC<infer P> ? FC<ShapeWith$<P>> : T[K];
103
+ };
104
+ type ExtractFCPropsType<T> = T extends FC<infer P> ? P : never;
105
+ declare const hasSymbol: false | ((key: string) => symbol);
106
+ declare function observer<P extends FC<any>>(component: P): P;
107
+ declare function reactive<T extends FC<any>>(component: T, bindKeys?: BindKeys<ExtractFCPropsType<T>>): T | FC<ShapeWith$<ExtractFCPropsType<T>>>;
108
+ declare function reactive<T extends FC<any>, T2 extends keyof ExtractFCPropsType<T>>(component: T, bindKeys?: BindKeys<ExtractFCPropsType<T>>): T | FC<ShapeWithPick$<ExtractFCPropsType<T>, T2>>;
109
+ declare function reactiveObserver<T extends FC<any>>(component: T, bindKeys?: BindKeys<ExtractFCPropsType<T>>): T | FC<ShapeWith$<ExtractFCPropsType<T>>>;
110
+ declare function reactiveObserver<T extends FC<any>, T2 extends keyof ExtractFCPropsType<T>>(component: T, bindKeys?: BindKeys<ExtractFCPropsType<T>>): T | FC<ShapeWithPick$<ExtractFCPropsType<T>, T2>>;
111
+ declare function reactiveComponents<P extends Record<string, FC>>(components: P): ObjectShapeWith$<P>;
112
+
113
+ declare function useComputed<T>(compute: () => T | Promise<T>): Observable<T>;
114
+ declare function useComputed<T>(compute: () => T | Promise<T>, deps: any[]): Observable<T>;
115
+ declare function useComputed<T, T2 = T>(compute: (() => T | Promise<T>) | ObservableParam<T>, set: (value: T2) => void): Observable<T>;
116
+ declare function useComputed<T, T2 = T>(compute: (() => T | Promise<T>) | ObservableParam<T>, set: (value: T2) => void, deps: any[]): Observable<T>;
117
+
118
+ declare const useEffectOnce: (effect: () => void | (() => void), deps: any[]) => void;
119
+
120
+ declare function useIsMounted(): Observable<boolean>;
121
+
122
+ declare function useMount(fn: () => (void | (() => void)) | Promise<void>): void;
123
+ declare const useMountOnce: typeof useMount;
124
+
125
+ /**
126
+ * A React hook that creates a new observable
127
+ *
128
+ * @param initialValue The initial value of the observable or a function that returns the initial value
129
+ *
130
+ * @see https://www.legendapp.com/dev/state/react/#useObservable
131
+ */
132
+ declare function useObservable<T>(): Observable<T | undefined>;
133
+ declare function useObservable<T>(value: Promise<RecursiveValueOrFunction<T>> | (() => RecursiveValueOrFunction<T>) | RecursiveValueOrFunction<T>): Observable<T>;
134
+ declare function useObservable<T>(value: T): Observable<T>;
135
+ declare function useObservable<T>(value?: T): Observable<any>;
136
+
137
+ declare function useObservableReducer<R extends ReducerWithoutAction<any>, I>(reducer: R, initializerArg: I, initializer: (arg: I) => ReducerStateWithoutAction<R>): [Observable<ReducerStateWithoutAction<R>>, DispatchWithoutAction];
138
+ declare function useObservableReducer<R extends ReducerWithoutAction<any>>(reducer: R, initializerArg: ReducerStateWithoutAction<R>, initializer?: undefined): [Observable<ReducerStateWithoutAction<R>>, DispatchWithoutAction];
139
+ declare function useObservableReducer<R extends Reducer<any, any>, I>(reducer: R, initializerArg: I & ReducerState<R>, initializer: (arg: I & ReducerState<R>) => ReducerState<R>): [Observable<ReducerState<R>>, Dispatch<ReducerAction<R>>];
140
+ declare function useObservableReducer<R extends Reducer<any, any>, I>(reducer: R, initializerArg: I, initializer: (arg: I) => ReducerState<R>): [Observable<ReducerState<R>>, Dispatch<ReducerAction<R>>];
141
+ declare function useObservableReducer<R extends Reducer<any, any>>(reducer: R, initialState: ReducerState<R>, initializer?: undefined): [Observable<ReducerState<R>>, Dispatch<ReducerAction<R>>];
142
+
143
+ declare function useObserve<T>(run: (e: ObserveEvent<T>) => T | void, options?: ObserveOptions): () => void;
144
+ declare function useObserve<T>(selector: Selector<T>, reaction?: (e: ObserveEventCallback<T>) => any, options?: ObserveOptions): () => void;
145
+
146
+ declare function useObserveEffect<T>(run: (e: ObserveEvent<T>) => T | void, options?: ObserveOptions): void;
147
+ declare function useObserveEffect<T>(selector: Selector<T>, reaction?: (e: ObserveEventCallback<T>) => any, options?: ObserveOptions): void;
148
+
149
+ declare function useSelector<T>(selector: Selector<T>, options?: UseSelectorOptions): T;
150
+
151
+ declare function useUnmount(fn: () => void): void;
152
+ declare const useUnmountOnce: typeof useUnmount;
153
+
154
+ declare function useWhen<T>(predicate: Selector<T>, effect: (value: T) => any | (() => any)): Promise<any>;
155
+ declare function useWhenReady<T>(predicate: Selector<T>, effect: (value: T) => any | (() => any)): Promise<any>;
156
+
157
+ export { type BindKey, type BindKeys, Computed, type ExtractFCPropsType, type FCReactive, type FCReactiveObject, For, type IReactive, Memo, type ObjectShapeWith$, Reactive, type ShapeWith$, type ShapeWithNew$, type ShapeWithPick$, Show, Switch, type UseSelectorOptions, configureReactive, hasSymbol, observer, reactive, reactiveComponents, reactiveObserver, useComputed, useEffectOnce, useIsMounted, useMount, useMountOnce, useObservable, useObservableReducer, useObserve, useObserveEffect, usePauseProvider, useSelector, useUnmount, useUnmountOnce, useWhen, useWhenReady };