@shadow-js/core 0.1.0 → 1.0.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.
Files changed (387) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +2 -2
  3. package/README.md +134 -331
  4. package/dist/dev/action.d.ts +36 -0
  5. package/dist/dev/action.js +90 -0
  6. package/dist/dev/action.js.map +1 -0
  7. package/dist/dev/cache.d.ts +35 -0
  8. package/dist/dev/cache.js +62 -0
  9. package/dist/dev/cache.js.map +1 -0
  10. package/dist/dev/context.d.ts +106 -0
  11. package/dist/dev/context.js +111 -0
  12. package/dist/dev/context.js.map +1 -0
  13. package/dist/dev/effect.d.ts +122 -0
  14. package/dist/dev/effect.js +111 -0
  15. package/dist/dev/effect.js.map +1 -0
  16. package/dist/dev/env.d.ts +29 -0
  17. package/dist/dev/env.js +31 -0
  18. package/dist/dev/env.js.map +1 -0
  19. package/dist/dev/events.d.ts +28 -0
  20. package/dist/dev/events.js +33 -0
  21. package/dist/dev/events.js.map +1 -0
  22. package/dist/dev/extend/index.d.ts +331 -0
  23. package/dist/dev/extend/index.js +317 -0
  24. package/dist/dev/extend/index.js.map +1 -0
  25. package/dist/dev/external-store.d.ts +60 -0
  26. package/dist/dev/external-store.js +60 -0
  27. package/dist/dev/external-store.js.map +1 -0
  28. package/dist/dev/index.d.ts +29 -0
  29. package/dist/dev/index.js +26 -0
  30. package/dist/dev/internal/concurrency.d.ts +213 -0
  31. package/dist/dev/internal/concurrency.js +632 -0
  32. package/dist/dev/internal/concurrency.js.map +1 -0
  33. package/dist/dev/internal/devtools.d.ts +71 -0
  34. package/dist/dev/internal/devtools.js +77 -0
  35. package/dist/dev/internal/devtools.js.map +1 -0
  36. package/dist/dev/internal/diagnostics.d.ts +90 -0
  37. package/dist/dev/internal/diagnostics.js +102 -0
  38. package/dist/dev/internal/diagnostics.js.map +1 -0
  39. package/dist/dev/internal/dispose.d.ts +28 -0
  40. package/dist/dev/internal/dispose.js +49 -0
  41. package/dist/dev/internal/dispose.js.map +1 -0
  42. package/dist/dev/internal/flags.js +11 -0
  43. package/dist/dev/internal/flags.js.map +1 -0
  44. package/dist/dev/internal/graph.d.ts +233 -0
  45. package/dist/dev/internal/graph.js +578 -0
  46. package/dist/dev/internal/graph.js.map +1 -0
  47. package/dist/dev/internal/hydration-flag.d.ts +33 -0
  48. package/dist/dev/internal/hydration-flag.js +46 -0
  49. package/dist/dev/internal/hydration-flag.js.map +1 -0
  50. package/dist/dev/internal/messages.d.ts +56 -0
  51. package/dist/dev/internal/messages.js +54 -0
  52. package/dist/dev/internal/messages.js.map +1 -0
  53. package/dist/dev/internal/owner.d.ts +142 -0
  54. package/dist/dev/internal/owner.js +290 -0
  55. package/dist/dev/internal/owner.js.map +1 -0
  56. package/dist/dev/internal/queue.js +46 -0
  57. package/dist/dev/internal/queue.js.map +1 -0
  58. package/dist/dev/internal/scheduler.d.ts +113 -0
  59. package/dist/dev/internal/scheduler.js +287 -0
  60. package/dist/dev/internal/scheduler.js.map +1 -0
  61. package/dist/dev/internal/state.d.ts +141 -0
  62. package/dist/dev/internal/state.js +28 -0
  63. package/dist/dev/internal/state.js.map +1 -0
  64. package/dist/dev/internal/suspension.d.ts +43 -0
  65. package/dist/dev/internal/suspension.js +45 -0
  66. package/dist/dev/internal/suspension.js.map +1 -0
  67. package/dist/dev/internal/types.d.ts +46 -0
  68. package/dist/dev/list.d.ts +93 -0
  69. package/dist/dev/list.js +282 -0
  70. package/dist/dev/list.js.map +1 -0
  71. package/dist/dev/memo.d.ts +60 -0
  72. package/dist/dev/memo.js +41 -0
  73. package/dist/dev/memo.js.map +1 -0
  74. package/dist/dev/optimistic.d.ts +26 -0
  75. package/dist/dev/optimistic.js +45 -0
  76. package/dist/dev/optimistic.js.map +1 -0
  77. package/dist/dev/ownership.d.ts +204 -0
  78. package/dist/dev/ownership.js +261 -0
  79. package/dist/dev/ownership.js.map +1 -0
  80. package/dist/dev/props.d.ts +134 -0
  81. package/dist/dev/props.js +282 -0
  82. package/dist/dev/props.js.map +1 -0
  83. package/dist/dev/reaction.d.ts +29 -0
  84. package/dist/dev/reaction.js +61 -0
  85. package/dist/dev/reaction.js.map +1 -0
  86. package/dist/dev/reducer.d.ts +41 -0
  87. package/dist/dev/reducer.js +39 -0
  88. package/dist/dev/reducer.js.map +1 -0
  89. package/dist/dev/refs.d.ts +52 -0
  90. package/dist/dev/refs.js +58 -0
  91. package/dist/dev/refs.js.map +1 -0
  92. package/dist/dev/resource.d.ts +135 -0
  93. package/dist/dev/resource.js +177 -0
  94. package/dist/dev/resource.js.map +1 -0
  95. package/dist/dev/selector.d.ts +34 -0
  96. package/dist/dev/selector.js +118 -0
  97. package/dist/dev/selector.js.map +1 -0
  98. package/dist/dev/signal.d.ts +42 -0
  99. package/dist/dev/signal.js +39 -0
  100. package/dist/dev/signal.js.map +1 -0
  101. package/dist/dev/store/index.d.ts +5 -0
  102. package/dist/dev/store/index.js +4 -0
  103. package/dist/dev/store/nodes.js +192 -0
  104. package/dist/dev/store/nodes.js.map +1 -0
  105. package/dist/dev/store/proxies.js +160 -0
  106. package/dist/dev/store/proxies.js.map +1 -0
  107. package/dist/dev/store/read.d.ts +39 -0
  108. package/dist/dev/store/read.js +72 -0
  109. package/dist/dev/store/read.js.map +1 -0
  110. package/dist/dev/store/reconcile.d.ts +73 -0
  111. package/dist/dev/store/reconcile.js +186 -0
  112. package/dist/dev/store/reconcile.js.map +1 -0
  113. package/dist/dev/store/types.d.ts +106 -0
  114. package/dist/dev/store/use-store.d.ts +60 -0
  115. package/dist/dev/store/use-store.js +168 -0
  116. package/dist/dev/store/use-store.js.map +1 -0
  117. package/dist/dev/suspense.d.ts +101 -0
  118. package/dist/dev/suspense.js +45 -0
  119. package/dist/dev/suspense.js.map +1 -0
  120. package/dist/dev/transitions.d.ts +77 -0
  121. package/dist/dev/transitions.js +101 -0
  122. package/dist/dev/transitions.js.map +1 -0
  123. package/dist/prod/action.js +2 -0
  124. package/dist/prod/action.js.map +1 -0
  125. package/dist/prod/cache.js +2 -0
  126. package/dist/prod/cache.js.map +1 -0
  127. package/dist/prod/context.js +2 -0
  128. package/dist/prod/context.js.map +1 -0
  129. package/dist/prod/effect.js +2 -0
  130. package/dist/prod/effect.js.map +1 -0
  131. package/dist/prod/env.js +2 -0
  132. package/dist/prod/env.js.map +1 -0
  133. package/dist/prod/events.js +2 -0
  134. package/dist/prod/events.js.map +1 -0
  135. package/dist/prod/extend/index.js +2 -0
  136. package/dist/prod/extend/index.js.map +1 -0
  137. package/dist/prod/external-store.js +2 -0
  138. package/dist/prod/external-store.js.map +1 -0
  139. package/dist/prod/index.js +1 -0
  140. package/dist/prod/internal/concurrency.js +2 -0
  141. package/dist/prod/internal/concurrency.js.map +1 -0
  142. package/dist/prod/internal/devtools.js +2 -0
  143. package/dist/prod/internal/devtools.js.map +1 -0
  144. package/dist/prod/internal/diagnostics.js +2 -0
  145. package/dist/prod/internal/diagnostics.js.map +1 -0
  146. package/dist/prod/internal/dispose.js +2 -0
  147. package/dist/prod/internal/dispose.js.map +1 -0
  148. package/dist/prod/internal/flags.js +2 -0
  149. package/dist/prod/internal/flags.js.map +1 -0
  150. package/dist/prod/internal/graph.js +2 -0
  151. package/dist/prod/internal/graph.js.map +1 -0
  152. package/dist/prod/internal/hydration-flag.js +2 -0
  153. package/dist/prod/internal/hydration-flag.js.map +1 -0
  154. package/dist/prod/internal/messages.js +2 -0
  155. package/dist/prod/internal/messages.js.map +1 -0
  156. package/dist/prod/internal/owner.js +2 -0
  157. package/dist/prod/internal/owner.js.map +1 -0
  158. package/dist/prod/internal/queue.js +2 -0
  159. package/dist/prod/internal/queue.js.map +1 -0
  160. package/dist/prod/internal/scheduler.js +2 -0
  161. package/dist/prod/internal/scheduler.js.map +1 -0
  162. package/dist/prod/internal/state.js +2 -0
  163. package/dist/prod/internal/state.js.map +1 -0
  164. package/dist/prod/internal/suspension.js +2 -0
  165. package/dist/prod/internal/suspension.js.map +1 -0
  166. package/dist/prod/list.js +2 -0
  167. package/dist/prod/list.js.map +1 -0
  168. package/dist/prod/memo.js +2 -0
  169. package/dist/prod/memo.js.map +1 -0
  170. package/dist/prod/optimistic.js +2 -0
  171. package/dist/prod/optimistic.js.map +1 -0
  172. package/dist/prod/ownership.js +2 -0
  173. package/dist/prod/ownership.js.map +1 -0
  174. package/dist/prod/props.js +2 -0
  175. package/dist/prod/props.js.map +1 -0
  176. package/dist/prod/reaction.js +2 -0
  177. package/dist/prod/reaction.js.map +1 -0
  178. package/dist/prod/reducer.js +2 -0
  179. package/dist/prod/reducer.js.map +1 -0
  180. package/dist/prod/refs.js +2 -0
  181. package/dist/prod/refs.js.map +1 -0
  182. package/dist/prod/resource.js +2 -0
  183. package/dist/prod/resource.js.map +1 -0
  184. package/dist/prod/selector.js +2 -0
  185. package/dist/prod/selector.js.map +1 -0
  186. package/dist/prod/signal.js +2 -0
  187. package/dist/prod/signal.js.map +1 -0
  188. package/dist/prod/store/index.js +1 -0
  189. package/dist/prod/store/nodes.js +2 -0
  190. package/dist/prod/store/nodes.js.map +1 -0
  191. package/dist/prod/store/proxies.js +2 -0
  192. package/dist/prod/store/proxies.js.map +1 -0
  193. package/dist/prod/store/read.js +2 -0
  194. package/dist/prod/store/read.js.map +1 -0
  195. package/dist/prod/store/reconcile.js +2 -0
  196. package/dist/prod/store/reconcile.js.map +1 -0
  197. package/dist/prod/store/use-store.js +2 -0
  198. package/dist/prod/store/use-store.js.map +1 -0
  199. package/dist/prod/suspense.js +2 -0
  200. package/dist/prod/suspense.js.map +1 -0
  201. package/dist/prod/transitions.js +2 -0
  202. package/dist/prod/transitions.js.map +1 -0
  203. package/dist/server/action.js +2 -0
  204. package/dist/server/action.js.map +1 -0
  205. package/dist/server/cache.js +2 -0
  206. package/dist/server/cache.js.map +1 -0
  207. package/dist/server/context.js +2 -0
  208. package/dist/server/context.js.map +1 -0
  209. package/dist/server/effect.js +2 -0
  210. package/dist/server/effect.js.map +1 -0
  211. package/dist/server/env.js +2 -0
  212. package/dist/server/env.js.map +1 -0
  213. package/dist/server/events.js +2 -0
  214. package/dist/server/events.js.map +1 -0
  215. package/dist/server/extend/index.js +2 -0
  216. package/dist/server/extend/index.js.map +1 -0
  217. package/dist/server/external-store.js +2 -0
  218. package/dist/server/external-store.js.map +1 -0
  219. package/dist/server/index.js +1 -0
  220. package/dist/server/internal/concurrency.js +2 -0
  221. package/dist/server/internal/concurrency.js.map +1 -0
  222. package/dist/server/internal/devtools.js +2 -0
  223. package/dist/server/internal/devtools.js.map +1 -0
  224. package/dist/server/internal/diagnostics.js +2 -0
  225. package/dist/server/internal/diagnostics.js.map +1 -0
  226. package/dist/server/internal/dispose.js +2 -0
  227. package/dist/server/internal/dispose.js.map +1 -0
  228. package/dist/server/internal/flags.js +2 -0
  229. package/dist/server/internal/flags.js.map +1 -0
  230. package/dist/server/internal/graph.js +2 -0
  231. package/dist/server/internal/graph.js.map +1 -0
  232. package/dist/server/internal/hydration-flag.js +2 -0
  233. package/dist/server/internal/hydration-flag.js.map +1 -0
  234. package/dist/server/internal/messages.js +2 -0
  235. package/dist/server/internal/messages.js.map +1 -0
  236. package/dist/server/internal/owner.js +2 -0
  237. package/dist/server/internal/owner.js.map +1 -0
  238. package/dist/server/internal/queue.js +2 -0
  239. package/dist/server/internal/queue.js.map +1 -0
  240. package/dist/server/internal/scheduler.js +2 -0
  241. package/dist/server/internal/scheduler.js.map +1 -0
  242. package/dist/server/internal/state.js +2 -0
  243. package/dist/server/internal/state.js.map +1 -0
  244. package/dist/server/internal/suspension.js +2 -0
  245. package/dist/server/internal/suspension.js.map +1 -0
  246. package/dist/server/list.js +2 -0
  247. package/dist/server/list.js.map +1 -0
  248. package/dist/server/memo.js +2 -0
  249. package/dist/server/memo.js.map +1 -0
  250. package/dist/server/optimistic.js +2 -0
  251. package/dist/server/optimistic.js.map +1 -0
  252. package/dist/server/ownership.js +2 -0
  253. package/dist/server/ownership.js.map +1 -0
  254. package/dist/server/props.js +2 -0
  255. package/dist/server/props.js.map +1 -0
  256. package/dist/server/reaction.js +2 -0
  257. package/dist/server/reaction.js.map +1 -0
  258. package/dist/server/reducer.js +2 -0
  259. package/dist/server/reducer.js.map +1 -0
  260. package/dist/server/refs.js +2 -0
  261. package/dist/server/refs.js.map +1 -0
  262. package/dist/server/resource.js +2 -0
  263. package/dist/server/resource.js.map +1 -0
  264. package/dist/server/selector.js +2 -0
  265. package/dist/server/selector.js.map +1 -0
  266. package/dist/server/signal.js +2 -0
  267. package/dist/server/signal.js.map +1 -0
  268. package/dist/server/store/index.js +1 -0
  269. package/dist/server/store/nodes.js +2 -0
  270. package/dist/server/store/nodes.js.map +1 -0
  271. package/dist/server/store/proxies.js +2 -0
  272. package/dist/server/store/proxies.js.map +1 -0
  273. package/dist/server/store/read.js +2 -0
  274. package/dist/server/store/read.js.map +1 -0
  275. package/dist/server/store/reconcile.js +2 -0
  276. package/dist/server/store/reconcile.js.map +1 -0
  277. package/dist/server/store/use-store.js +2 -0
  278. package/dist/server/store/use-store.js.map +1 -0
  279. package/dist/server/suspense.js +2 -0
  280. package/dist/server/suspense.js.map +1 -0
  281. package/dist/server/transitions.js +2 -0
  282. package/dist/server/transitions.js.map +1 -0
  283. package/dist/server-dev/action.js +90 -0
  284. package/dist/server-dev/action.js.map +1 -0
  285. package/dist/server-dev/cache.js +62 -0
  286. package/dist/server-dev/cache.js.map +1 -0
  287. package/dist/server-dev/context.js +108 -0
  288. package/dist/server-dev/context.js.map +1 -0
  289. package/dist/server-dev/effect.js +56 -0
  290. package/dist/server-dev/effect.js.map +1 -0
  291. package/dist/server-dev/env.js +31 -0
  292. package/dist/server-dev/env.js.map +1 -0
  293. package/dist/server-dev/events.js +33 -0
  294. package/dist/server-dev/events.js.map +1 -0
  295. package/dist/server-dev/extend/index.js +317 -0
  296. package/dist/server-dev/extend/index.js.map +1 -0
  297. package/dist/server-dev/external-store.js +46 -0
  298. package/dist/server-dev/external-store.js.map +1 -0
  299. package/dist/server-dev/index.js +26 -0
  300. package/dist/server-dev/internal/concurrency.js +633 -0
  301. package/dist/server-dev/internal/concurrency.js.map +1 -0
  302. package/dist/server-dev/internal/devtools.js +77 -0
  303. package/dist/server-dev/internal/devtools.js.map +1 -0
  304. package/dist/server-dev/internal/diagnostics.js +102 -0
  305. package/dist/server-dev/internal/diagnostics.js.map +1 -0
  306. package/dist/server-dev/internal/dispose.js +49 -0
  307. package/dist/server-dev/internal/dispose.js.map +1 -0
  308. package/dist/server-dev/internal/flags.js +11 -0
  309. package/dist/server-dev/internal/flags.js.map +1 -0
  310. package/dist/server-dev/internal/graph.js +578 -0
  311. package/dist/server-dev/internal/graph.js.map +1 -0
  312. package/dist/server-dev/internal/hydration-flag.js +46 -0
  313. package/dist/server-dev/internal/hydration-flag.js.map +1 -0
  314. package/dist/server-dev/internal/messages.js +54 -0
  315. package/dist/server-dev/internal/messages.js.map +1 -0
  316. package/dist/server-dev/internal/owner.js +290 -0
  317. package/dist/server-dev/internal/owner.js.map +1 -0
  318. package/dist/server-dev/internal/queue.js +46 -0
  319. package/dist/server-dev/internal/queue.js.map +1 -0
  320. package/dist/server-dev/internal/scheduler.js +287 -0
  321. package/dist/server-dev/internal/scheduler.js.map +1 -0
  322. package/dist/server-dev/internal/state.js +28 -0
  323. package/dist/server-dev/internal/state.js.map +1 -0
  324. package/dist/server-dev/internal/suspension.js +45 -0
  325. package/dist/server-dev/internal/suspension.js.map +1 -0
  326. package/dist/server-dev/list.js +282 -0
  327. package/dist/server-dev/list.js.map +1 -0
  328. package/dist/server-dev/memo.js +41 -0
  329. package/dist/server-dev/memo.js.map +1 -0
  330. package/dist/server-dev/optimistic.js +45 -0
  331. package/dist/server-dev/optimistic.js.map +1 -0
  332. package/dist/server-dev/ownership.js +261 -0
  333. package/dist/server-dev/ownership.js.map +1 -0
  334. package/dist/server-dev/props.js +282 -0
  335. package/dist/server-dev/props.js.map +1 -0
  336. package/dist/server-dev/reaction.js +61 -0
  337. package/dist/server-dev/reaction.js.map +1 -0
  338. package/dist/server-dev/reducer.js +39 -0
  339. package/dist/server-dev/reducer.js.map +1 -0
  340. package/dist/server-dev/refs.js +58 -0
  341. package/dist/server-dev/refs.js.map +1 -0
  342. package/dist/server-dev/resource.js +176 -0
  343. package/dist/server-dev/resource.js.map +1 -0
  344. package/dist/server-dev/selector.js +82 -0
  345. package/dist/server-dev/selector.js.map +1 -0
  346. package/dist/server-dev/signal.js +39 -0
  347. package/dist/server-dev/signal.js.map +1 -0
  348. package/dist/server-dev/store/index.js +4 -0
  349. package/dist/server-dev/store/nodes.js +192 -0
  350. package/dist/server-dev/store/nodes.js.map +1 -0
  351. package/dist/server-dev/store/proxies.js +160 -0
  352. package/dist/server-dev/store/proxies.js.map +1 -0
  353. package/dist/server-dev/store/read.js +72 -0
  354. package/dist/server-dev/store/read.js.map +1 -0
  355. package/dist/server-dev/store/reconcile.js +186 -0
  356. package/dist/server-dev/store/reconcile.js.map +1 -0
  357. package/dist/server-dev/store/use-store.js +168 -0
  358. package/dist/server-dev/store/use-store.js.map +1 -0
  359. package/dist/server-dev/suspense.js +45 -0
  360. package/dist/server-dev/suspense.js.map +1 -0
  361. package/dist/server-dev/transitions.js +86 -0
  362. package/dist/server-dev/transitions.js.map +1 -0
  363. package/package.json +111 -50
  364. package/dist/chunk-6Y3CCWOY.js +0 -887
  365. package/dist/chunk-6Y3CCWOY.js.map +0 -1
  366. package/dist/chunk-B5FTYDUG.js +0 -3
  367. package/dist/chunk-B5FTYDUG.js.map +0 -1
  368. package/dist/index.cjs +0 -2000
  369. package/dist/index.cjs.map +0 -1
  370. package/dist/index.d.cts +0 -609
  371. package/dist/index.d.ts +0 -609
  372. package/dist/index.js +0 -1094
  373. package/dist/index.js.map +0 -1
  374. package/dist/jsx-Bugil6CJ.d.cts +0 -151
  375. package/dist/jsx-Bugil6CJ.d.ts +0 -151
  376. package/dist/jsx-dev-runtime.cjs +0 -742
  377. package/dist/jsx-dev-runtime.cjs.map +0 -1
  378. package/dist/jsx-dev-runtime.d.cts +0 -2
  379. package/dist/jsx-dev-runtime.d.ts +0 -2
  380. package/dist/jsx-dev-runtime.js +0 -4
  381. package/dist/jsx-dev-runtime.js.map +0 -1
  382. package/dist/jsx-runtime.cjs +0 -742
  383. package/dist/jsx-runtime.cjs.map +0 -1
  384. package/dist/jsx-runtime.d.cts +0 -36
  385. package/dist/jsx-runtime.d.ts +0 -36
  386. package/dist/jsx-runtime.js +0 -4
  387. package/dist/jsx-runtime.js.map +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ownership.js","names":["disposeOwner"],"sources":["../../src/ownership.ts"],"sourcesContent":["import {\n addCleanup,\n type Cleanup,\n currentOwner,\n disposeOwner,\n type ErrorHandler,\n handleError,\n Owner,\n runInScope,\n ShadowError,\n warn,\n} from \"./extend\";\n\nexport type { Owner };\n\n/**\n * Runs `fn` without subscribing the running computation to anything `fn` reads. Use it inside an\n * effect or a memo to read a value without re-running when that value changes. The current owner\n * is kept, so effects and cleanups created inside `fn` are still owned.\n *\n * @param fn The function to run untracked.\n * @returns Whatever `fn` returns. An error thrown by `fn` propagates unchanged.\n * @example\n * import { untrack, useEffect, useSignal } from \"@shadow-js/core\";\n *\n * const [count, setCount] = useSignal(0);\n * const [unit] = useSignal(\"clicks\");\n * useEffect(() => {\n * // Re-runs when `count` changes, never when `unit` changes.\n * console.log(`${count()} ${untrack(unit)}`);\n * });\n * setCount(1);\n * @see useEvent\n * @since 1.0.0\n */\nexport function untrack<T>(fn: () => T): T {\n return runInScope({ listener: null }, fn);\n}\n\n/**\n * Options of {@link createRoot}.\n * @since 1.0.0\n */\nexport interface RootOptions {\n /**\n * When true, the root is not attached to the current owner: it outlives that owner and is\n * disposed only through the `dispose` function passed to the body. It still sees the context\n * values provided above the current owner.\n * @default false (the root is a child of the current owner and is disposed with it)\n */\n detached?: boolean;\n}\n\n/**\n * Creates an ownership scope. Everything created inside (effects, memos, cleanups, children) is\n * disposed together when `dispose` is called or, for attached roots, when the parent disposes. Use\n * it for code that runs outside a component, such as an app entry point, a test or a module that\n * owns long-lived effects.\n *\n * @param fn Body; receives the `dispose` function. Runs untracked, with the new root as owner.\n * @param options `detached` keeps the root out of the current owner. Undefined uses the default\n * (attached).\n * @returns Whatever `fn` returns.\n * @throws Rethrows any error thrown by `fn`, after the root and everything created in it are\n * disposed.\n * @example\n * import { createRoot, useEffect, useSignal } from \"@shadow-js/core\";\n *\n * const [count, setCount] = useSignal(0);\n * const dispose = createRoot((dispose) => {\n * useEffect(() => console.log(count()));\n * return dispose;\n * });\n * setCount(1);\n * dispose(); // the effect stops and its cleanups run\n * @see getOwner\n * @since 1.0.0\n */\nexport function createRoot<T>(fn: (dispose: () => void) => T, options?: RootOptions): T {\n const detached = options?.detached === true;\n const current = currentOwner();\n const root = new Owner(detached ? null : current);\n if (detached) root.context = current === null ? null : current.context;\n try {\n return runInScope({ owner: root, listener: null }, () => fn(() => disposeOwner(root)));\n } catch (error) {\n disposeOwner(root);\n throw error;\n }\n}\n\n/**\n * Returns the owner that currently adopts new effects, memos and cleanups. Capture it while a\n * component or root runs, then hand it to {@link runWithOwner} from code that runs later.\n *\n * @returns The current owner, or `null` outside any owner (at module scope, or in a callback that\n * runs after an `await` or a timer).\n * @example\n * import { getOwner, onCleanup, runWithOwner } from \"@shadow-js/core\";\n *\n * function Poller() {\n * const owner = getOwner();\n * setTimeout(() => {\n * runWithOwner(owner, () => onCleanup(() => console.log(\"poller disposed\")));\n * }, 1000);\n * return null;\n * }\n * @see runWithOwner\n * @since 1.0.0\n */\nexport function getOwner(): Owner | null {\n return currentOwner();\n}\n\n/**\n * Runs `fn` with `owner` as the current owner, untracked. Use it to restore ownership after an\n * `await` or inside callbacks that outlive the synchronous run, so that effects, cleanups and\n * context reads inside `fn` attach to that owner. A disposed owner is ignored: `fn` then runs\n * without an owner, and development builds warn `RUN_WITH_DISPOSED_OWNER`.\n *\n * @param owner The owner to make current, usually captured with {@link getOwner}. `null` runs `fn`\n * without an owner.\n * @param fn The function to run.\n * @returns Whatever `fn` returns. An error thrown by `fn` propagates unchanged.\n * @example\n * import { createContext, getOwner, runWithOwner, useContext } from \"@shadow-js/core\";\n *\n * const Locale = createContext(\"en\");\n *\n * function Clock() {\n * const owner = getOwner();\n * queueMicrotask(() => {\n * const locale = runWithOwner(owner, () => useContext(Locale));\n * console.log(new Date().toLocaleTimeString(locale));\n * });\n * return null;\n * }\n * @see getOwner\n * @since 1.0.0\n */\nexport function runWithOwner<T>(owner: Owner | null, fn: () => T): T {\n let target = owner;\n if (target?.disposed) {\n warn(\"RUN_WITH_DISPOSED_OWNER\");\n target = null;\n }\n return runInScope({ owner: target, listener: null }, fn);\n}\n\n/**\n * Registers `fn` to run when the current owner is disposed or, for an effect or memo, before it\n * re-runs. Cleanups run newest first and untracked; one that throws does not stop the others, and\n * its error goes to the nearest error handler ({@link onError}, {@link catchError}). Outside any owner the call does nothing, because\n * nothing would ever run the cleanup; development builds warn `NO_OWNER_CLEANUP`.\n *\n * @param fn The cleanup to register.\n * @example\n * import { onCleanup } from \"@shadow-js/core\";\n *\n * function Ticker() {\n * const timer = setInterval(() => console.log(\"tick\"), 1000);\n * onCleanup(() => clearInterval(timer));\n * return null;\n * }\n * @see onMount\n * @since 1.0.0\n */\nexport function onCleanup(fn: Cleanup): void {\n const owner = currentOwner();\n if (owner === null) {\n warn(\"NO_OWNER_CLEANUP\");\n return;\n }\n addCleanup(owner, fn);\n}\n\n/**\n * Registers an error handler on the current owner. It receives errors thrown in this owner's scope\n * (its effects, memos, cleanups and child owners) that no closer handler took. Handlers on the same\n * owner are tried newest first; a handler that throws passes its own error to the next handler up.\n * Outside any owner the call does nothing; development builds warn `NO_OWNER_ERROR`.\n *\n * @param handler Receives the error, untracked. Throw from it to pass an error on to the next handler.\n * @example\n * import { onError, useEffect } from \"@shadow-js/core\";\n *\n * function Dashboard() {\n * onError((error) => console.error(\"dashboard failed:\", error));\n * useEffect(() => {\n * throw new Error(\"widget crashed\"); // reaches the handler above\n * });\n * return null;\n * }\n * @see catchError\n * @since 1.0.0\n */\nexport function onError(handler: ErrorHandler): void {\n const owner = currentOwner();\n if (owner === null) {\n warn(\"NO_OWNER_ERROR\");\n return;\n }\n if (owner.errorHandlers === null) owner.errorHandlers = [handler];\n else owner.errorHandlers.push(handler);\n}\n\n/**\n * Runs `fn` inside a new child scope whose errors go to `handler`: errors thrown synchronously by\n * `fn`, and later errors of the effects, memos and cleanups it created. The scope is disposed with\n * the current owner. Use it to contain the failures of one part of a component tree.\n *\n * @param fn The function to run; it runs untracked, with the new scope as owner.\n * @param handler Receives each error, untracked. Throw from it to pass the error on to the next handler up.\n * @returns Whatever `fn` returns, or `undefined` when `fn` threw and `handler` took the error.\n * @throws Rethrows the error `handler` throws when no handler above takes it (outside a flush).\n * @example\n * import { catchError, useEffect } from \"@shadow-js/core\";\n *\n * function Widget() {\n * return catchError(\n * () => {\n * useEffect(() => {\n * throw new Error(\"network down\");\n * });\n * return \"ready\";\n * },\n * (error) => console.error(\"widget failed:\", error),\n * );\n * }\n * @see onError\n * @since 1.0.0\n */\nexport function catchError<T>(fn: () => T, handler: ErrorHandler): T | undefined {\n const scope = new Owner(currentOwner());\n scope.errorHandlers = [handler];\n try {\n return runWithOwner(scope, fn);\n } catch (error) {\n return void handleError(error, scope);\n }\n}\n\n/**\n * Returns an id that is identical on server and client for the same position in the owner tree.\n * The id uses only letters, digits, `-` and `_`, so it is valid in `id`, `for`, `aria-*` references\n * and in `querySelector(\"#\" + id)` without escaping. Use it to link a label to its input, or an\n * element to its `aria-describedby` target, in markup that is rendered on the server and hydrated.\n *\n * @returns A new id, unique within the root; each call on the same owner returns the next one.\n * @throws ShadowError `NO_OWNER_ID` when called outside any owner, because no stable id exists\n * there.\n * @example\n * import { useId } from \"@shadow-js/core\";\n *\n * function EmailField() {\n * const id = useId();\n * return (\n * <>\n * <label for={id}>Email</label>\n * <input id={id} type=\"email\" />\n * </>\n * );\n * }\n * @since 1.0.0\n */\nexport function useId(): string {\n const owner = currentOwner();\n if (owner === null) throw new ShadowError(\"NO_OWNER_ID\");\n // An owner with an id prefix (a component the renderer put in a hydration scope) hosts the ids of\n // everything below it: the prefix already encodes where the component is, and the owners between\n // here and there (effects exist in the browser, not on the server) must not leak into the id.\n for (let host: Owner | null = owner; host !== null; host = host.parent) {\n if (host.idPrefix === undefined) continue;\n const hosted = host.idCount;\n host.idCount += 1;\n return `s${host.idPrefix}${hosted}`;\n }\n const path: number[] = [];\n for (let node: Owner | null = owner; node !== null; node = node.parent) path.push(node.index);\n path.reverse();\n const sequence = owner.idCount;\n owner.idCount += 1;\n return `s${path.join(\"-\")}_${sequence}`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAmCA,SAAgB,QAAW,IAAgB;CACzC,OAAO,WAAW,EAAE,UAAU,KAAK,GAAG,EAAE;AAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,WAAc,IAAgC,SAA0B;CACtF,MAAM,WAAW,SAAS,aAAa;CACvC,MAAM,UAAU,aAAa;CAC7B,MAAM,OAAO,IAAI,MAAM,WAAW,OAAO,OAAO;CAChD,IAAI,UAAU,KAAK,UAAU,YAAY,OAAO,OAAO,QAAQ;CAC/D,IAAI;EACF,OAAO,WAAW;GAAE,OAAO;GAAM,UAAU;EAAK,SAAS,SAASA,YAAa,IAAI,CAAC,CAAC;CACvF,SAAS,OAAO;EACd,YAAa,IAAI;EACjB,MAAM;CACR;AACF;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,WAAyB;CACvC,OAAO,aAAa;AACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,aAAgB,OAAqB,IAAgB;CACnE,IAAI,SAAS;CACb,IAAI,QAAQ,UAAU;EACpB,KAAK,yBAAyB;EAC9B,SAAS;CACX;CACA,OAAO,WAAW;EAAE,OAAO;EAAQ,UAAU;CAAK,GAAG,EAAE;AACzD;;;;;;;;;;;;;;;;;;;AAoBA,SAAgB,UAAU,IAAmB;CAC3C,MAAM,QAAQ,aAAa;CAC3B,IAAI,UAAU,MAAM;EAClB,KAAK,kBAAkB;EACvB;CACF;CACA,WAAW,OAAO,EAAE;AACtB;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,QAAQ,SAA6B;CACnD,MAAM,QAAQ,aAAa;CAC3B,IAAI,UAAU,MAAM;EAClB,KAAK,gBAAgB;EACrB;CACF;CACA,IAAI,MAAM,kBAAkB,MAAM,MAAM,gBAAgB,CAAC,OAAO;MAC3D,MAAM,cAAc,KAAK,OAAO;AACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,WAAc,IAAa,SAAsC;CAC/E,MAAM,QAAQ,IAAI,MAAM,aAAa,CAAC;CACtC,MAAM,gBAAgB,CAAC,OAAO;CAC9B,IAAI;EACF,OAAO,aAAa,OAAO,EAAE;CAC/B,SAAS,OAAO;EACP,YAAiB,OAAO,KAAK;EAApC;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAgB,QAAgB;CAC9B,MAAM,QAAQ,aAAa;CAC3B,IAAI,UAAU,MAAM,MAAM,IAAI,YAAY,aAAa;CAIvD,KAAK,IAAI,OAAqB,OAAO,SAAS,MAAM,OAAO,KAAK,QAAQ;EACtE,IAAI,KAAK,aAAa,KAAA,GAAW;EACjC,MAAM,SAAS,KAAK;EACpB,KAAK,WAAW;EAChB,OAAO,IAAI,KAAK,WAAW;CAC7B;CACA,MAAM,OAAiB,CAAC;CACxB,KAAK,IAAI,OAAqB,OAAO,SAAS,MAAM,OAAO,KAAK,QAAQ,KAAK,KAAK,KAAK,KAAK;CAC5F,KAAK,QAAQ;CACb,MAAM,WAAW,MAAM;CACvB,MAAM,WAAW;CACjB,OAAO,IAAI,KAAK,KAAK,GAAG,EAAE,GAAG;AAC/B"}
@@ -0,0 +1,134 @@
1
+ //#region src/props.d.ts
2
+ /**
3
+ * A value accepted by {@link mergeProps}: an object, a function that returns one (called at every
4
+ * read, so it can be reactive), or `null`, `undefined` or `false`, which are skipped. Use it to type
5
+ * a helper that collects sources before merging them.
6
+ * @since 1.0.0
7
+ */
8
+ export type MergeSource = object | null | undefined | false;
9
+ /** The props object a source stands for; functions contribute their return type. */
10
+ type PropsOf<S> = S extends ((...args: never[]) => infer R) ? Exclude<R, null | undefined | false> : S extends null | undefined | false ? object : S;
11
+ /** Later keys replace earlier ones; a later key that may be `undefined` keeps the earlier type too. */
12
+ type Overlay<A, B> = { [K in keyof A | keyof B]: K extends keyof B ? K extends keyof A ? undefined extends B[K] ? Exclude<B[K], undefined> | A[K] : B[K] : B[K] : K extends keyof A ? A[K] : never; };
13
+ /**
14
+ * The type of `mergeProps(...sources)`, folded left to right: a later source's key replaces an
15
+ * earlier one, and a later key that may be `undefined` keeps the earlier type as well.
16
+ * @since 1.0.0
17
+ */
18
+ export type MergeProps<T extends readonly unknown[], Acc = object> = T extends readonly [infer Head, ...infer Rest] ? MergeProps<Rest, Overlay<Acc, PropsOf<Head>>> : Acc;
19
+ /**
20
+ * The type of `splitProps(props, ...keyLists)`: one object per key list, picking those keys, then
21
+ * the rest without any listed key.
22
+ * @since 1.0.0
23
+ */
24
+ export type SplitProps<T extends object, K extends readonly (readonly (keyof T)[])[]> = [...{ [I in keyof K]: Pick<T, Extract<K[I][number], keyof T>>; }, Omit<T, K[number][number]>];
25
+ /**
26
+ * The value returned by {@link children}: calling it yields one leaf, an array of several leaves,
27
+ * or `undefined` for none; `toArray()` always returns an array. The methods mirror React's
28
+ * `Children` helpers.
29
+ * @since 1.0.0
30
+ */
31
+ export interface ResolvedChildren {
32
+ /**
33
+ * The current children: one leaf, an array of several leaves, or `undefined` when there is none.
34
+ * The read is tracked like a memo read.
35
+ */
36
+ (): unknown;
37
+ /** A fresh array of the leaves, without `null`, `undefined` or booleans. */
38
+ toArray(): unknown[];
39
+ /** Number of leaves, zero or more (the React `Children.count`). */
40
+ count(): number;
41
+ /** Maps each leaf with its index; the callback runs untracked (React `Children.map`). */
42
+ map<U>(fn: (leaf: unknown, index: number) => U): U[];
43
+ /** Visits each leaf with its index; the callback runs untracked (React `Children.forEach`). */
44
+ forEach(fn: (leaf: unknown, index: number) => void): void;
45
+ /**
46
+ * The single leaf (React `Children.only`). Throws a TypeError (production message
47
+ * `SHADOW_CHILDREN_ONLY`) when there is not exactly one leaf.
48
+ */
49
+ only(): unknown;
50
+ }
51
+ /**
52
+ * Merges props objects into one getter-preserving object. Reading a key returns the value from the
53
+ * right-most source that has it, unless that value is `undefined`, in which case the next source
54
+ * to the left is tried. Nothing is copied at merge time, so reads stay reactive. Use it to give
55
+ * component props defaults without reading them in the component body.
56
+ *
57
+ * Sources may be objects, `null`, `undefined` or `false` (skipped), or functions that return an
58
+ * object. A function is called on every read, which is how spreads such as `{...props()}` stay
59
+ * reactive. Keys named `__proto__`, `constructor` or `prototype` are ignored.
60
+ *
61
+ * @param sources The props objects, from lowest to highest priority.
62
+ * @returns A read-only object whose keys are the union of the sources' own enumerable keys. With a
63
+ * function source, the key set is recomputed on every access.
64
+ * @throws TypeError (production message `SHADOW_MERGE_SOURCES`) when a source is not an object, a
65
+ * function, `null`, `undefined` or `false`. A read of the result throws TypeError (production
66
+ * message `SHADOW_MERGE_SOURCE`) when a function source returns anything else.
67
+ * @example
68
+ * import { mergeProps } from "@shadow-js/core";
69
+ *
70
+ * function Button(props: { size?: "sm" | "md"; label: string }) {
71
+ * const merged = mergeProps({ size: "md" as const }, props);
72
+ * return <button class={`btn-${merged.size}`}>{merged.label}</button>;
73
+ * }
74
+ * @see splitProps
75
+ * @since 1.0.0
76
+ */
77
+ export declare function mergeProps<T extends readonly MergeSource[]>(...sources: T): MergeProps<T>;
78
+ /**
79
+ * Splits props into one getter-preserving object per key list, followed by an object holding every
80
+ * other key. Each group reads its keys from `props` at access time, so reactivity is preserved. A
81
+ * key listed in two groups appears in both and never in the rest. A listed key that `props` does not
82
+ * have is still present in its group, as `undefined`. Use it to separate the props a component
83
+ * consumes from the ones it forwards to an element.
84
+ *
85
+ * @param props The props to split; plain objects, Proxies and {@link mergeProps} results work.
86
+ * @param keys One or more key lists. Keys named `__proto__`, `constructor` or `prototype` are
87
+ * ignored.
88
+ * @returns `[...groups, rest]`, in the order the key lists were given.
89
+ * @example
90
+ * import { splitProps } from "@shadow-js/core";
91
+ *
92
+ * function Field(props: { label: string; value: string; placeholder?: string }) {
93
+ * const [own, input] = splitProps(props, ["label"]);
94
+ * return (
95
+ * <label>
96
+ * {own.label}
97
+ * <input {...input} />
98
+ * </label>
99
+ * );
100
+ * }
101
+ * @see mergeProps
102
+ * @since 1.0.0
103
+ */
104
+ export declare function splitProps<T extends object, const K extends readonly (readonly (keyof T)[])[]>(props: T, ...keys: K): SplitProps<T, K>;
105
+ /**
106
+ * Memoizes a `props.children` getter so that it is read at most once per change of its
107
+ * dependencies. Arrays are flattened, accessors are called, and `null`, `undefined` and booleans
108
+ * are dropped. The memo is created in the current owner, so nodes created while resolving are
109
+ * disposed with it. Use it when a component inspects or rearranges its children.
110
+ *
111
+ * @param fn The lazy children accessor, usually `() => props.children`.
112
+ * @returns A {@link ResolvedChildren} accessor with `toArray()`, `count()`, `map()`, `forEach()`
113
+ * and `only()`.
114
+ * @throws TypeError from the returned accessor and its methods when the children contain an array
115
+ * that contains itself (production message `SHADOW_CHILDREN_CYCLE`) or more than 1000 nested
116
+ * accessors (`SHADOW_CHILDREN_LAYERS`). `only()` throws TypeError (`SHADOW_CHILDREN_ONLY`) unless
117
+ * there is exactly one leaf.
118
+ * @example
119
+ * import { children } from "@shadow-js/core";
120
+ *
121
+ * function Steps(props: { children?: unknown }) {
122
+ * const steps = children(() => props.children);
123
+ * return (
124
+ * <ol aria-label={`${steps.count()} steps`}>
125
+ * {steps.map((step) => <li>{step as Node | string}</li>)}
126
+ * </ol>
127
+ * );
128
+ * }
129
+ * @since 1.0.0
130
+ */
131
+ export declare function children(fn: () => unknown): ResolvedChildren;
132
+ //#endregion
133
+ export {};
134
+ //# sourceMappingURL=props.d.ts.map
@@ -0,0 +1,282 @@
1
+ import { untrack } from "./ownership.js";
2
+ import { useMemo } from "./memo.js";
3
+ //#region src/props.ts
4
+ /**
5
+ * Keys that never take part in a merge or a split. Reading them through a props object that came
6
+ * from JSON or from user input could reach `Object.prototype`, so they are skipped everywhere.
7
+ */
8
+ const UNSAFE_KEYS = /* @__PURE__ */ new Set([
9
+ "__proto__",
10
+ "constructor",
11
+ "prototype"
12
+ ]);
13
+ /**
14
+ * Results of mergeProps (and splitProps over them) that have at least one function source. Their
15
+ * key set can change between reads, so splitProps builds a live rest object for them. A WeakSet is
16
+ * bounded by the garbage collector.
17
+ */
18
+ const DYNAMIC_PROPS = /* @__PURE__ */ new WeakSet();
19
+ /** Longest chain of nested accessors that children() follows before it gives up. */
20
+ const MAX_FUNCTION_LAYERS = 1e3;
21
+ /** Whether a source stands for nothing and is skipped. */
22
+ function isEmptySource(value) {
23
+ return value === null || value === void 0 || value === false;
24
+ }
25
+ /** Own enumerable string and symbol keys, minus the unsafe ones. Reads no getter. */
26
+ function ownEnumerableKeys(source) {
27
+ return Reflect.ownKeys(source).filter((key) => !UNSAFE_KEYS.has(key) && Object.prototype.propertyIsEnumerable.call(source, key));
28
+ }
29
+ /** Defines an enumerable getter; the target is a fresh object, so this never hits a setter. */
30
+ function defineGetter(target, key, read) {
31
+ Object.defineProperty(target, key, {
32
+ enumerable: true,
33
+ configurable: true,
34
+ get: read
35
+ });
36
+ }
37
+ /** The object a source stands for at this moment, or `undefined` when it is skipped. */
38
+ function resolveSource(source) {
39
+ const value = typeof source === "function" ? source() : source;
40
+ if (isEmptySource(value)) return void 0;
41
+ if (typeof value === "object" && value !== null) return value;
42
+ throw new TypeError("mergeProps: a source function must return an object, null, undefined or false");
43
+ }
44
+ /** The sources that stand for an object right now, in order; skipped ones are dropped. */
45
+ function resolveAll(sources) {
46
+ const resolved = [];
47
+ for (const source of sources) {
48
+ const object = resolveSource(source);
49
+ if (object !== void 0) resolved.push(object);
50
+ }
51
+ return resolved;
52
+ }
53
+ /**
54
+ * Reads one merged key: the right-most object that has the key and a value other than `undefined`
55
+ * wins. Each getter is read at most once.
56
+ */
57
+ function readMerged(objects, key) {
58
+ for (let index = objects.length - 1; index >= 0; index -= 1) {
59
+ const source = objects[index];
60
+ if (source === void 0 || !(key in source)) continue;
61
+ const value = Reflect.get(source, key);
62
+ if (value !== void 0) return value;
63
+ }
64
+ }
65
+ /** Every merged key in first-occurrence order. Reads no getter. */
66
+ function mergedKeys(objects) {
67
+ const seen = /* @__PURE__ */ new Set();
68
+ const keys = [];
69
+ for (const source of objects) for (const key of ownEnumerableKeys(source)) {
70
+ if (seen.has(key)) continue;
71
+ seen.add(key);
72
+ keys.push(key);
73
+ }
74
+ return keys;
75
+ }
76
+ /**
77
+ * A Proxy whose key set and values are recomputed on every access: `load` runs once per trap, so
78
+ * a function source is called once per access. The target is an ordinary object, so prototype
79
+ * lookups keep their usual meaning, and every write is refused because props are read-only.
80
+ */
81
+ /**
82
+ * How deep the live reads are running, and the state each live view computed during the outermost
83
+ * read. A view's traps read the views beneath it, and those read the views beneath them: without a
84
+ * cache every trap recomputes each level below, and a few nested components (a chain of `{...props}`
85
+ * forwards) take exponential time. Within one outermost read a view's state is computed once, so a
86
+ * read costs time linear in the number of views. The cache is dropped when that read returns, so each
87
+ * read still sees the current values.
88
+ */
89
+ let readDepth = 0;
90
+ const readStates = /* @__PURE__ */ new Map();
91
+ function stateOf(view, load) {
92
+ const known = readStates.get(view);
93
+ if (known !== void 0) return known;
94
+ const state = load();
95
+ readStates.set(view, state);
96
+ return state;
97
+ }
98
+ function duringRead(run) {
99
+ readDepth += 1;
100
+ try {
101
+ return run();
102
+ } finally {
103
+ readDepth -= 1;
104
+ if (readDepth === 0) readStates.clear();
105
+ }
106
+ }
107
+ function liveView(load) {
108
+ const target = {};
109
+ return new Proxy(target, {
110
+ get(_target, key) {
111
+ return duringRead(() => {
112
+ const state = stateOf(target, load);
113
+ return state.keys.has(key) ? state.read(key) : Reflect.get(target, key);
114
+ });
115
+ },
116
+ has(_target, key) {
117
+ return duringRead(() => stateOf(target, load).keys.has(key) || Reflect.has(target, key));
118
+ },
119
+ ownKeys() {
120
+ return duringRead(() => [...stateOf(target, load).keys]);
121
+ },
122
+ getOwnPropertyDescriptor(_target, key) {
123
+ return duringRead(() => {
124
+ if (!stateOf(target, load).keys.has(key)) return void 0;
125
+ return {
126
+ enumerable: true,
127
+ configurable: true,
128
+ get: () => duringRead(() => stateOf(target, load).read(key))
129
+ };
130
+ });
131
+ },
132
+ set: () => false,
133
+ defineProperty: () => false,
134
+ deleteProperty: () => false
135
+ });
136
+ }
137
+ function mergeProps(...sources) {
138
+ const inputs = [];
139
+ let dynamic = false;
140
+ for (const source of sources) {
141
+ if (isEmptySource(source)) continue;
142
+ if (typeof source === "function") dynamic = true;
143
+ else if (typeof source !== "object") throw new TypeError("mergeProps: sources must be objects, functions, or null, undefined or false");
144
+ inputs.push(source);
145
+ }
146
+ if (!dynamic) {
147
+ const objects = resolveAll(inputs);
148
+ const merged = {};
149
+ for (const key of mergedKeys(objects)) defineGetter(merged, key, () => readMerged(objects, key));
150
+ return merged;
151
+ }
152
+ const view = liveView(() => {
153
+ const objects = resolveAll(inputs);
154
+ return {
155
+ keys: new Set(mergedKeys(objects)),
156
+ read: (key) => readMerged(objects, key)
157
+ };
158
+ });
159
+ DYNAMIC_PROPS.add(view);
160
+ return view;
161
+ }
162
+ function splitProps(props, ...keys) {
163
+ const listed = /* @__PURE__ */ new Set();
164
+ const groups = [];
165
+ for (const group of keys) {
166
+ const picked = {};
167
+ for (const key of group) {
168
+ if (UNSAFE_KEYS.has(key)) continue;
169
+ listed.add(key);
170
+ defineGetter(picked, key, () => Reflect.get(props, key));
171
+ }
172
+ groups.push(picked);
173
+ }
174
+ const restKeys = () => ownEnumerableKeys(props).filter((key) => !listed.has(key));
175
+ const readRest = (key) => Reflect.get(props, key);
176
+ if (DYNAMIC_PROPS.has(props)) {
177
+ const rest = liveView(() => ({
178
+ keys: new Set(restKeys()),
179
+ read: readRest
180
+ }));
181
+ return [...groups, rest];
182
+ }
183
+ const rest = {};
184
+ for (const key of restKeys()) defineGetter(rest, key, () => readRest(key));
185
+ return [...groups, rest];
186
+ }
187
+ /**
188
+ * Resolves children without recursion: arrays flatten in order, accessors are called until a plain
189
+ * value appears, and `null`, `undefined` and booleans are dropped. A cyclic array or more than
190
+ * {@link MAX_FUNCTION_LAYERS} nested accessors is a TypeError.
191
+ */
192
+ function flattenChildren(fn) {
193
+ const leaves = [];
194
+ const frames = [];
195
+ const open = /* @__PURE__ */ new Set();
196
+ let value = fn;
197
+ let layer = 0;
198
+ for (;;) {
199
+ if (typeof value === "function") {
200
+ if (layer >= MAX_FUNCTION_LAYERS) throw new TypeError(`children(): more than ${MAX_FUNCTION_LAYERS} nested accessors; a function child may return itself`);
201
+ value = value();
202
+ layer += 1;
203
+ continue;
204
+ }
205
+ if (Array.isArray(value)) {
206
+ if (open.has(value)) throw new TypeError("children(): an array contains itself");
207
+ open.add(value);
208
+ frames.push({
209
+ items: value,
210
+ next: 0,
211
+ layer
212
+ });
213
+ } else if (value !== null && value !== void 0 && typeof value !== "boolean") leaves.push(value);
214
+ let advanced = false;
215
+ while (!advanced) {
216
+ const top = frames.at(-1);
217
+ if (top === void 0) return leaves;
218
+ if (top.next < top.items.length) {
219
+ value = top.items[top.next];
220
+ top.next += 1;
221
+ layer = top.layer;
222
+ advanced = true;
223
+ } else {
224
+ frames.pop();
225
+ open.delete(top.items);
226
+ }
227
+ }
228
+ }
229
+ }
230
+ /**
231
+ * Memoizes a `props.children` getter so that it is read at most once per change of its
232
+ * dependencies. Arrays are flattened, accessors are called, and `null`, `undefined` and booleans
233
+ * are dropped. The memo is created in the current owner, so nodes created while resolving are
234
+ * disposed with it. Use it when a component inspects or rearranges its children.
235
+ *
236
+ * @param fn The lazy children accessor, usually `() => props.children`.
237
+ * @returns A {@link ResolvedChildren} accessor with `toArray()`, `count()`, `map()`, `forEach()`
238
+ * and `only()`.
239
+ * @throws TypeError from the returned accessor and its methods when the children contain an array
240
+ * that contains itself (production message `SHADOW_CHILDREN_CYCLE`) or more than 1000 nested
241
+ * accessors (`SHADOW_CHILDREN_LAYERS`). `only()` throws TypeError (`SHADOW_CHILDREN_ONLY`) unless
242
+ * there is exactly one leaf.
243
+ * @example
244
+ * import { children } from "@shadow-js/core";
245
+ *
246
+ * function Steps(props: { children?: unknown }) {
247
+ * const steps = children(() => props.children);
248
+ * return (
249
+ * <ol aria-label={`${steps.count()} steps`}>
250
+ * {steps.map((step) => <li>{step as Node | string}</li>)}
251
+ * </ol>
252
+ * );
253
+ * }
254
+ * @since 1.0.0
255
+ */
256
+ function children(fn) {
257
+ const memo = useMemo(() => flattenChildren(fn), { allowWrites: true });
258
+ const accessor = () => {
259
+ const leaves = memo();
260
+ if (leaves.length === 1) return leaves[0];
261
+ return leaves.length === 0 ? void 0 : leaves;
262
+ };
263
+ return Object.assign(accessor, {
264
+ toArray: () => [...memo()],
265
+ count: () => memo().length,
266
+ map: (fn) => memo().map((leaf, index) => untrack(() => fn(leaf, index))),
267
+ forEach: (fn) => {
268
+ memo().forEach((leaf, index) => {
269
+ untrack(() => fn(leaf, index));
270
+ });
271
+ },
272
+ only: () => {
273
+ const leaves = memo();
274
+ if (leaves.length !== 1) throw new TypeError(`children().only(): expected one child, received ${leaves.length}`);
275
+ return leaves[0];
276
+ }
277
+ });
278
+ }
279
+ //#endregion
280
+ export { children, mergeProps, splitProps };
281
+
282
+ //# sourceMappingURL=props.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"props.js","names":[],"sources":["../../src/props.ts"],"sourcesContent":["import { useMemo } from \"./memo\";\nimport { untrack } from \"./ownership\";\n\n/**\n * Keys that never take part in a merge or a split. Reading them through a props object that came\n * from JSON or from user input could reach `Object.prototype`, so they are skipped everywhere.\n */\nconst UNSAFE_KEYS: ReadonlySet<PropertyKey> = new Set<PropertyKey>([\n \"__proto__\",\n \"constructor\",\n \"prototype\",\n]);\n\n/**\n * Results of mergeProps (and splitProps over them) that have at least one function source. Their\n * key set can change between reads, so splitProps builds a live rest object for them. A WeakSet is\n * bounded by the garbage collector.\n */\nconst DYNAMIC_PROPS = new WeakSet<object>();\n\n/** Longest chain of nested accessors that children() follows before it gives up. */\nconst MAX_FUNCTION_LAYERS = 1000;\n\n/**\n * A value accepted by {@link mergeProps}: an object, a function that returns one (called at every\n * read, so it can be reactive), or `null`, `undefined` or `false`, which are skipped. Use it to type\n * a helper that collects sources before merging them.\n * @since 1.0.0\n */\nexport type MergeSource = object | null | undefined | false;\n\n/** The props object a source stands for; functions contribute their return type. */\ntype PropsOf<S> = S extends (...args: never[]) => infer R\n ? Exclude<R, null | undefined | false>\n : S extends null | undefined | false\n ? object\n : S;\n\n/** Later keys replace earlier ones; a later key that may be `undefined` keeps the earlier type too. */\ntype Overlay<A, B> = {\n [K in keyof A | keyof B]: K extends keyof B\n ? K extends keyof A\n ? undefined extends B[K]\n ? Exclude<B[K], undefined> | A[K]\n : B[K]\n : B[K]\n : K extends keyof A\n ? A[K]\n : never;\n};\n\n/**\n * The type of `mergeProps(...sources)`, folded left to right: a later source's key replaces an\n * earlier one, and a later key that may be `undefined` keeps the earlier type as well.\n * @since 1.0.0\n */\nexport type MergeProps<T extends readonly unknown[], Acc = object> = T extends readonly [\n infer Head,\n ...infer Rest,\n]\n ? MergeProps<Rest, Overlay<Acc, PropsOf<Head>>>\n : Acc;\n\n/**\n * The type of `splitProps(props, ...keyLists)`: one object per key list, picking those keys, then\n * the rest without any listed key.\n * @since 1.0.0\n */\nexport type SplitProps<T extends object, K extends readonly (readonly (keyof T)[])[]> = [\n ...{ [I in keyof K]: Pick<T, Extract<K[I][number], keyof T>> },\n Omit<T, K[number][number]>,\n];\n\n/**\n * The value returned by {@link children}: calling it yields one leaf, an array of several leaves,\n * or `undefined` for none; `toArray()` always returns an array. The methods mirror React's\n * `Children` helpers.\n * @since 1.0.0\n */\nexport interface ResolvedChildren {\n /**\n * The current children: one leaf, an array of several leaves, or `undefined` when there is none.\n * The read is tracked like a memo read.\n */\n (): unknown;\n /** A fresh array of the leaves, without `null`, `undefined` or booleans. */\n toArray(): unknown[];\n /** Number of leaves, zero or more (the React `Children.count`). */\n count(): number;\n /** Maps each leaf with its index; the callback runs untracked (React `Children.map`). */\n map<U>(fn: (leaf: unknown, index: number) => U): U[];\n /** Visits each leaf with its index; the callback runs untracked (React `Children.forEach`). */\n forEach(fn: (leaf: unknown, index: number) => void): void;\n /**\n * The single leaf (React `Children.only`). Throws a TypeError (production message\n * `SHADOW_CHILDREN_ONLY`) when there is not exactly one leaf.\n */\n only(): unknown;\n}\n\n/** Whether a source stands for nothing and is skipped. */\nfunction isEmptySource(value: unknown): value is null | undefined | false {\n return value === null || value === undefined || value === false;\n}\n\n/** Own enumerable string and symbol keys, minus the unsafe ones. Reads no getter. */\nfunction ownEnumerableKeys(source: object): Key[] {\n return Reflect.ownKeys(source).filter(\n (key) => !UNSAFE_KEYS.has(key) && Object.prototype.propertyIsEnumerable.call(source, key),\n );\n}\n\n/** Defines an enumerable getter; the target is a fresh object, so this never hits a setter. */\nfunction defineGetter(target: object, key: PropertyKey, read: () => unknown): void {\n Object.defineProperty(target, key, { enumerable: true, configurable: true, get: read });\n}\n\n/** The object a source stands for at this moment, or `undefined` when it is skipped. */\nfunction resolveSource(source: object): object | undefined {\n const value: unknown = typeof source === \"function\" ? (source as () => unknown)() : source;\n if (isEmptySource(value)) return undefined;\n if (typeof value === \"object\" && value !== null) return value;\n throw new TypeError(\n __DEV__\n ? \"mergeProps: a source function must return an object, null, undefined or false\"\n : \"SHADOW_MERGE_SOURCE\",\n );\n}\n\n/** The sources that stand for an object right now, in order; skipped ones are dropped. */\nfunction resolveAll(sources: readonly object[]): object[] {\n const resolved: object[] = [];\n for (const source of sources) {\n const object = resolveSource(source);\n if (object !== undefined) resolved.push(object);\n }\n return resolved;\n}\n\n/**\n * Reads one merged key: the right-most object that has the key and a value other than `undefined`\n * wins. Each getter is read at most once.\n */\nfunction readMerged(objects: readonly object[], key: Key): unknown {\n for (let index = objects.length - 1; index >= 0; index -= 1) {\n const source = objects[index];\n if (source === undefined || !(key in source)) continue;\n const value: unknown = Reflect.get(source, key);\n if (value !== undefined) return value;\n }\n return undefined;\n}\n\n/** Every merged key in first-occurrence order. Reads no getter. */\nfunction mergedKeys(objects: readonly object[]): Key[] {\n const seen = new Set<Key>();\n const keys: Key[] = [];\n for (const source of objects) {\n for (const key of ownEnumerableKeys(source)) {\n if (seen.has(key)) continue;\n seen.add(key);\n keys.push(key);\n }\n }\n return keys;\n}\n\n/** A property name as a Proxy trap sees it. */\ntype Key = string | symbol;\n\n/** The key set and the reader that a live view uses for one access. */\ninterface LiveState {\n readonly keys: ReadonlySet<Key>;\n read(key: Key): unknown;\n}\n\n/**\n * A Proxy whose key set and values are recomputed on every access: `load` runs once per trap, so\n * a function source is called once per access. The target is an ordinary object, so prototype\n * lookups keep their usual meaning, and every write is refused because props are read-only.\n */\n/**\n * How deep the live reads are running, and the state each live view computed during the outermost\n * read. A view's traps read the views beneath it, and those read the views beneath them: without a\n * cache every trap recomputes each level below, and a few nested components (a chain of `{...props}`\n * forwards) take exponential time. Within one outermost read a view's state is computed once, so a\n * read costs time linear in the number of views. The cache is dropped when that read returns, so each\n * read still sees the current values.\n */\nlet readDepth = 0;\nconst readStates = new Map<object, LiveState>();\n\nfunction stateOf(view: object, load: () => LiveState): LiveState {\n const known = readStates.get(view);\n if (known !== undefined) return known;\n const state = load();\n readStates.set(view, state);\n return state;\n}\n\nfunction duringRead<T>(run: () => T): T {\n readDepth += 1;\n try {\n return run();\n } finally {\n readDepth -= 1;\n if (readDepth === 0) readStates.clear();\n }\n}\n\nfunction liveView(load: () => LiveState): object {\n const target: object = {};\n return new Proxy(target, {\n get(_target, key) {\n return duringRead(() => {\n const state = stateOf(target, load);\n return state.keys.has(key) ? state.read(key) : (Reflect.get(target, key) as unknown);\n });\n },\n has(_target, key) {\n return duringRead(() => stateOf(target, load).keys.has(key) || Reflect.has(target, key));\n },\n ownKeys() {\n return duringRead(() => [...stateOf(target, load).keys]);\n },\n getOwnPropertyDescriptor(_target, key) {\n return duringRead(() => {\n if (!stateOf(target, load).keys.has(key)) return undefined;\n return {\n enumerable: true,\n configurable: true,\n get: () => duringRead(() => stateOf(target, load).read(key)),\n };\n });\n },\n set: () => false,\n defineProperty: () => false,\n deleteProperty: () => false,\n });\n}\n\n/**\n * Merges props objects into one getter-preserving object. Reading a key returns the value from the\n * right-most source that has it, unless that value is `undefined`, in which case the next source\n * to the left is tried. Nothing is copied at merge time, so reads stay reactive. Use it to give\n * component props defaults without reading them in the component body.\n *\n * Sources may be objects, `null`, `undefined` or `false` (skipped), or functions that return an\n * object. A function is called on every read, which is how spreads such as `{...props()}` stay\n * reactive. Keys named `__proto__`, `constructor` or `prototype` are ignored.\n *\n * @param sources The props objects, from lowest to highest priority.\n * @returns A read-only object whose keys are the union of the sources' own enumerable keys. With a\n * function source, the key set is recomputed on every access.\n * @throws TypeError (production message `SHADOW_MERGE_SOURCES`) when a source is not an object, a\n * function, `null`, `undefined` or `false`. A read of the result throws TypeError (production\n * message `SHADOW_MERGE_SOURCE`) when a function source returns anything else.\n * @example\n * import { mergeProps } from \"@shadow-js/core\";\n *\n * function Button(props: { size?: \"sm\" | \"md\"; label: string }) {\n * const merged = mergeProps({ size: \"md\" as const }, props);\n * return <button class={`btn-${merged.size}`}>{merged.label}</button>;\n * }\n * @see splitProps\n * @since 1.0.0\n */\nexport function mergeProps<T extends readonly MergeSource[]>(...sources: T): MergeProps<T>;\nexport function mergeProps(...sources: readonly MergeSource[]): object {\n const inputs: object[] = [];\n let dynamic = false;\n for (const source of sources) {\n if (isEmptySource(source)) continue;\n if (typeof source === \"function\") {\n dynamic = true;\n } else if (typeof source !== \"object\") {\n throw new TypeError(\n __DEV__\n ? \"mergeProps: sources must be objects, functions, or null, undefined or false\"\n : \"SHADOW_MERGE_SOURCES\",\n );\n }\n inputs.push(source);\n }\n if (!dynamic) {\n const objects = resolveAll(inputs);\n const merged: object = {};\n for (const key of mergedKeys(objects)) {\n defineGetter(merged, key, () => readMerged(objects, key));\n }\n return merged;\n }\n const view = liveView(() => {\n const objects = resolveAll(inputs);\n return { keys: new Set(mergedKeys(objects)), read: (key) => readMerged(objects, key) };\n });\n DYNAMIC_PROPS.add(view);\n return view;\n}\n\n/**\n * Splits props into one getter-preserving object per key list, followed by an object holding every\n * other key. Each group reads its keys from `props` at access time, so reactivity is preserved. A\n * key listed in two groups appears in both and never in the rest. A listed key that `props` does not\n * have is still present in its group, as `undefined`. Use it to separate the props a component\n * consumes from the ones it forwards to an element.\n *\n * @param props The props to split; plain objects, Proxies and {@link mergeProps} results work.\n * @param keys One or more key lists. Keys named `__proto__`, `constructor` or `prototype` are\n * ignored.\n * @returns `[...groups, rest]`, in the order the key lists were given.\n * @example\n * import { splitProps } from \"@shadow-js/core\";\n *\n * function Field(props: { label: string; value: string; placeholder?: string }) {\n * const [own, input] = splitProps(props, [\"label\"]);\n * return (\n * <label>\n * {own.label}\n * <input {...input} />\n * </label>\n * );\n * }\n * @see mergeProps\n * @since 1.0.0\n */\nexport function splitProps<T extends object, const K extends readonly (readonly (keyof T)[])[]>(\n props: T,\n ...keys: K\n): SplitProps<T, K>;\nexport function splitProps(props: object, ...keys: readonly (readonly PropertyKey[])[]): object[] {\n const listed = new Set<PropertyKey>();\n const groups: object[] = [];\n for (const group of keys) {\n const picked: object = {};\n for (const key of group) {\n if (UNSAFE_KEYS.has(key)) continue;\n listed.add(key);\n defineGetter(picked, key, () => Reflect.get(props, key) as unknown);\n }\n groups.push(picked);\n }\n const restKeys = (): Key[] => ownEnumerableKeys(props).filter((key) => !listed.has(key));\n const readRest = (key: Key): unknown => Reflect.get(props, key) as unknown;\n if (DYNAMIC_PROPS.has(props)) {\n const rest = liveView(() => ({ keys: new Set(restKeys()), read: readRest }));\n return [...groups, rest];\n }\n const rest: object = {};\n for (const key of restKeys()) defineGetter(rest, key, () => readRest(key));\n return [...groups, rest];\n}\n\n/** One level of a children walk: an array being read and the function-layer depth it sits at. */\ninterface Frame {\n readonly items: readonly unknown[];\n next: number;\n readonly layer: number;\n}\n\n/**\n * Resolves children without recursion: arrays flatten in order, accessors are called until a plain\n * value appears, and `null`, `undefined` and booleans are dropped. A cyclic array or more than\n * {@link MAX_FUNCTION_LAYERS} nested accessors is a TypeError.\n */\nfunction flattenChildren(fn: () => unknown): unknown[] {\n const leaves: unknown[] = [];\n const frames: Frame[] = [];\n const open = new Set<readonly unknown[]>();\n let value: unknown = fn;\n let layer = 0;\n for (;;) {\n if (typeof value === \"function\") {\n if (layer >= MAX_FUNCTION_LAYERS) {\n throw new TypeError(\n __DEV__\n ? `children(): more than ${MAX_FUNCTION_LAYERS} nested accessors; a function child may return itself`\n : \"SHADOW_CHILDREN_LAYERS\",\n );\n }\n value = (value as () => unknown)();\n layer += 1;\n continue;\n }\n if (Array.isArray(value)) {\n if (open.has(value))\n throw new TypeError(\n __DEV__ ? \"children(): an array contains itself\" : \"SHADOW_CHILDREN_CYCLE\",\n );\n open.add(value);\n frames.push({ items: value, next: 0, layer });\n } else if (value !== null && value !== undefined && typeof value !== \"boolean\") {\n leaves.push(value);\n }\n let advanced = false;\n while (!advanced) {\n const top = frames.at(-1);\n if (top === undefined) return leaves;\n if (top.next < top.items.length) {\n value = top.items[top.next];\n top.next += 1;\n layer = top.layer;\n advanced = true;\n } else {\n frames.pop();\n open.delete(top.items);\n }\n }\n }\n}\n\n/**\n * Memoizes a `props.children` getter so that it is read at most once per change of its\n * dependencies. Arrays are flattened, accessors are called, and `null`, `undefined` and booleans\n * are dropped. The memo is created in the current owner, so nodes created while resolving are\n * disposed with it. Use it when a component inspects or rearranges its children.\n *\n * @param fn The lazy children accessor, usually `() => props.children`.\n * @returns A {@link ResolvedChildren} accessor with `toArray()`, `count()`, `map()`, `forEach()`\n * and `only()`.\n * @throws TypeError from the returned accessor and its methods when the children contain an array\n * that contains itself (production message `SHADOW_CHILDREN_CYCLE`) or more than 1000 nested\n * accessors (`SHADOW_CHILDREN_LAYERS`). `only()` throws TypeError (`SHADOW_CHILDREN_ONLY`) unless\n * there is exactly one leaf.\n * @example\n * import { children } from \"@shadow-js/core\";\n *\n * function Steps(props: { children?: unknown }) {\n * const steps = children(() => props.children);\n * return (\n * <ol aria-label={`${steps.count()} steps`}>\n * {steps.map((step) => <li>{step as Node | string}</li>)}\n * </ol>\n * );\n * }\n * @since 1.0.0\n */\nexport function children(fn: () => unknown): ResolvedChildren {\n const memo = useMemo(() => flattenChildren(fn), { allowWrites: true });\n const accessor = (): unknown => {\n const leaves = memo();\n if (leaves.length === 1) return leaves[0];\n return leaves.length === 0 ? undefined : leaves;\n };\n return Object.assign(accessor, {\n toArray: (): unknown[] => [...memo()],\n count: (): number => memo().length,\n map: <U>(fn: (leaf: unknown, index: number) => U): U[] =>\n memo().map((leaf, index) => untrack(() => fn(leaf, index))),\n forEach: (fn: (leaf: unknown, index: number) => void): void => {\n memo().forEach((leaf, index) => {\n untrack(() => fn(leaf, index));\n });\n },\n only: (): unknown => {\n const leaves = memo();\n if (leaves.length !== 1) {\n throw new TypeError(\n __DEV__\n ? `children().only(): expected one child, received ${leaves.length}`\n : \"SHADOW_CHILDREN_ONLY\",\n );\n }\n return leaves[0];\n },\n });\n}\n"],"mappings":";;;;;;;AAOA,MAAM,8BAAwC,IAAI,IAAiB;CACjE;CACA;CACA;AACF,CAAC;;;;;;AAOD,MAAM,gCAAgB,IAAI,QAAgB;;AAG1C,MAAM,sBAAsB;;AAgF5B,SAAS,cAAc,OAAmD;CACxE,OAAO,UAAU,QAAQ,UAAU,KAAA,KAAa,UAAU;AAC5D;;AAGA,SAAS,kBAAkB,QAAuB;CAChD,OAAO,QAAQ,QAAQ,MAAM,CAAC,CAAC,QAC5B,QAAQ,CAAC,YAAY,IAAI,GAAG,KAAK,OAAO,UAAU,qBAAqB,KAAK,QAAQ,GAAG,CAC1F;AACF;;AAGA,SAAS,aAAa,QAAgB,KAAkB,MAA2B;CACjF,OAAO,eAAe,QAAQ,KAAK;EAAE,YAAY;EAAM,cAAc;EAAM,KAAK;CAAK,CAAC;AACxF;;AAGA,SAAS,cAAc,QAAoC;CACzD,MAAM,QAAiB,OAAO,WAAW,aAAc,OAAyB,IAAI;CACpF,IAAI,cAAc,KAAK,GAAG,OAAO,KAAA;CACjC,IAAI,OAAO,UAAU,YAAY,UAAU,MAAM,OAAO;CACxD,MAAM,IAAI,UAEJ,+EAEN;AACF;;AAGA,SAAS,WAAW,SAAsC;CACxD,MAAM,WAAqB,CAAC;CAC5B,KAAK,MAAM,UAAU,SAAS;EAC5B,MAAM,SAAS,cAAc,MAAM;EACnC,IAAI,WAAW,KAAA,GAAW,SAAS,KAAK,MAAM;CAChD;CACA,OAAO;AACT;;;;;AAMA,SAAS,WAAW,SAA4B,KAAmB;CACjE,KAAK,IAAI,QAAQ,QAAQ,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG;EAC3D,MAAM,SAAS,QAAQ;EACvB,IAAI,WAAW,KAAA,KAAa,EAAE,OAAO,SAAS;EAC9C,MAAM,QAAiB,QAAQ,IAAI,QAAQ,GAAG;EAC9C,IAAI,UAAU,KAAA,GAAW,OAAO;CAClC;AAEF;;AAGA,SAAS,WAAW,SAAmC;CACrD,MAAM,uBAAO,IAAI,IAAS;CAC1B,MAAM,OAAc,CAAC;CACrB,KAAK,MAAM,UAAU,SACnB,KAAK,MAAM,OAAO,kBAAkB,MAAM,GAAG;EAC3C,IAAI,KAAK,IAAI,GAAG,GAAG;EACnB,KAAK,IAAI,GAAG;EACZ,KAAK,KAAK,GAAG;CACf;CAEF,OAAO;AACT;;;;;;;;;;;;;;AAwBA,IAAI,YAAY;AAChB,MAAM,6BAAa,IAAI,IAAuB;AAE9C,SAAS,QAAQ,MAAc,MAAkC;CAC/D,MAAM,QAAQ,WAAW,IAAI,IAAI;CACjC,IAAI,UAAU,KAAA,GAAW,OAAO;CAChC,MAAM,QAAQ,KAAK;CACnB,WAAW,IAAI,MAAM,KAAK;CAC1B,OAAO;AACT;AAEA,SAAS,WAAc,KAAiB;CACtC,aAAa;CACb,IAAI;EACF,OAAO,IAAI;CACb,UAAU;EACR,aAAa;EACb,IAAI,cAAc,GAAG,WAAW,MAAM;CACxC;AACF;AAEA,SAAS,SAAS,MAA+B;CAC/C,MAAM,SAAiB,CAAC;CACxB,OAAO,IAAI,MAAM,QAAQ;EACvB,IAAI,SAAS,KAAK;GAChB,OAAO,iBAAiB;IACtB,MAAM,QAAQ,QAAQ,QAAQ,IAAI;IAClC,OAAO,MAAM,KAAK,IAAI,GAAG,IAAI,MAAM,KAAK,GAAG,IAAK,QAAQ,IAAI,QAAQ,GAAG;GACzE,CAAC;EACH;EACA,IAAI,SAAS,KAAK;GAChB,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG,KAAK,QAAQ,IAAI,QAAQ,GAAG,CAAC;EACzF;EACA,UAAU;GACR,OAAO,iBAAiB,CAAC,GAAG,QAAQ,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC;EACzD;EACA,yBAAyB,SAAS,KAAK;GACrC,OAAO,iBAAiB;IACtB,IAAI,CAAC,QAAQ,QAAQ,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG,GAAG,OAAO,KAAA;IACjD,OAAO;KACL,YAAY;KACZ,cAAc;KACd,WAAW,iBAAiB,QAAQ,QAAQ,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC;IAC7D;GACF,CAAC;EACH;EACA,WAAW;EACX,sBAAsB;EACtB,sBAAsB;CACxB,CAAC;AACH;AA6BA,SAAgB,WAAW,GAAG,SAAyC;CACrE,MAAM,SAAmB,CAAC;CAC1B,IAAI,UAAU;CACd,KAAK,MAAM,UAAU,SAAS;EAC5B,IAAI,cAAc,MAAM,GAAG;EAC3B,IAAI,OAAO,WAAW,YACpB,UAAU;OACL,IAAI,OAAO,WAAW,UAC3B,MAAM,IAAI,UAEJ,6EAEN;EAEF,OAAO,KAAK,MAAM;CACpB;CACA,IAAI,CAAC,SAAS;EACZ,MAAM,UAAU,WAAW,MAAM;EACjC,MAAM,SAAiB,CAAC;EACxB,KAAK,MAAM,OAAO,WAAW,OAAO,GAClC,aAAa,QAAQ,WAAW,WAAW,SAAS,GAAG,CAAC;EAE1D,OAAO;CACT;CACA,MAAM,OAAO,eAAe;EAC1B,MAAM,UAAU,WAAW,MAAM;EACjC,OAAO;GAAE,MAAM,IAAI,IAAI,WAAW,OAAO,CAAC;GAAG,OAAO,QAAQ,WAAW,SAAS,GAAG;EAAE;CACvF,CAAC;CACD,cAAc,IAAI,IAAI;CACtB,OAAO;AACT;AAgCA,SAAgB,WAAW,OAAe,GAAG,MAAqD;CAChG,MAAM,yBAAS,IAAI,IAAiB;CACpC,MAAM,SAAmB,CAAC;CAC1B,KAAK,MAAM,SAAS,MAAM;EACxB,MAAM,SAAiB,CAAC;EACxB,KAAK,MAAM,OAAO,OAAO;GACvB,IAAI,YAAY,IAAI,GAAG,GAAG;GAC1B,OAAO,IAAI,GAAG;GACd,aAAa,QAAQ,WAAW,QAAQ,IAAI,OAAO,GAAG,CAAY;EACpE;EACA,OAAO,KAAK,MAAM;CACpB;CACA,MAAM,iBAAwB,kBAAkB,KAAK,CAAC,CAAC,QAAQ,QAAQ,CAAC,OAAO,IAAI,GAAG,CAAC;CACvF,MAAM,YAAY,QAAsB,QAAQ,IAAI,OAAO,GAAG;CAC9D,IAAI,cAAc,IAAI,KAAK,GAAG;EAC5B,MAAM,OAAO,gBAAgB;GAAE,MAAM,IAAI,IAAI,SAAS,CAAC;GAAG,MAAM;EAAS,EAAE;EAC3E,OAAO,CAAC,GAAG,QAAQ,IAAI;CACzB;CACA,MAAM,OAAe,CAAC;CACtB,KAAK,MAAM,OAAO,SAAS,GAAG,aAAa,MAAM,WAAW,SAAS,GAAG,CAAC;CACzE,OAAO,CAAC,GAAG,QAAQ,IAAI;AACzB;;;;;;AAcA,SAAS,gBAAgB,IAA8B;CACrD,MAAM,SAAoB,CAAC;CAC3B,MAAM,SAAkB,CAAC;CACzB,MAAM,uBAAO,IAAI,IAAwB;CACzC,IAAI,QAAiB;CACrB,IAAI,QAAQ;CACZ,SAAS;EACP,IAAI,OAAO,UAAU,YAAY;GAC/B,IAAI,SAAS,qBACX,MAAM,IAAI,UAEJ,yBAAyB,oBAAoB,sDAEnD;GAEF,QAAS,MAAwB;GACjC,SAAS;GACT;EACF;EACA,IAAI,MAAM,QAAQ,KAAK,GAAG;GACxB,IAAI,KAAK,IAAI,KAAK,GAChB,MAAM,IAAI,UACE,sCACZ;GACF,KAAK,IAAI,KAAK;GACd,OAAO,KAAK;IAAE,OAAO;IAAO,MAAM;IAAG;GAAM,CAAC;EAC9C,OAAO,IAAI,UAAU,QAAQ,UAAU,KAAA,KAAa,OAAO,UAAU,WACnE,OAAO,KAAK,KAAK;EAEnB,IAAI,WAAW;EACf,OAAO,CAAC,UAAU;GAChB,MAAM,MAAM,OAAO,GAAG,EAAE;GACxB,IAAI,QAAQ,KAAA,GAAW,OAAO;GAC9B,IAAI,IAAI,OAAO,IAAI,MAAM,QAAQ;IAC/B,QAAQ,IAAI,MAAM,IAAI;IACtB,IAAI,QAAQ;IACZ,QAAQ,IAAI;IACZ,WAAW;GACb,OAAO;IACL,OAAO,IAAI;IACX,KAAK,OAAO,IAAI,KAAK;GACvB;EACF;CACF;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,SAAgB,SAAS,IAAqC;CAC5D,MAAM,OAAO,cAAc,gBAAgB,EAAE,GAAG,EAAE,aAAa,KAAK,CAAC;CACrE,MAAM,iBAA0B;EAC9B,MAAM,SAAS,KAAK;EACpB,IAAI,OAAO,WAAW,GAAG,OAAO,OAAO;EACvC,OAAO,OAAO,WAAW,IAAI,KAAA,IAAY;CAC3C;CACA,OAAO,OAAO,OAAO,UAAU;EAC7B,eAA0B,CAAC,GAAG,KAAK,CAAC;EACpC,aAAqB,KAAK,CAAC,CAAC;EAC5B,MAAS,OACP,KAAK,CAAC,CAAC,KAAK,MAAM,UAAU,cAAc,GAAG,MAAM,KAAK,CAAC,CAAC;EAC5D,UAAU,OAAqD;GAC7D,KAAK,CAAC,CAAC,SAAS,MAAM,UAAU;IAC9B,cAAc,GAAG,MAAM,KAAK,CAAC;GAC/B,CAAC;EACH;EACA,YAAqB;GACnB,MAAM,SAAS,KAAK;GACpB,IAAI,OAAO,WAAW,GACpB,MAAM,IAAI,UAEJ,mDAAmD,OAAO,QAEhE;GAEF,OAAO,OAAO;EAChB;CACF,CAAC;AACH"}
@@ -0,0 +1,29 @@
1
+ //#region src/reaction.d.ts
2
+ /**
3
+ * Creates a tracker that reports the first change of what it reads. `useReaction(onInvalidate)`
4
+ * returns `track(fn)`: `fn` runs at once (synchronously) and the signals it reads are recorded.
5
+ * The first change of any of them calls `onInvalidate` once, untracked, and then nothing is
6
+ * observed until `track` is called again. The ShadowJS form of Solid's `createReaction`.
7
+ *
8
+ * Use it when the work that follows a change is not a pure rerun of `fn` (for example, re-fetching
9
+ * after a change and then deciding what to track next). For ordinary effects use `useEffect`.
10
+ *
11
+ * @param onInvalidate Called once, untracked, after a change of a tracked read.
12
+ * @returns `track(fn)`. Each call replaces the previous tracking. Tracking lives in a child of the
13
+ * owner that called `useReaction`, so it stops when that owner is disposed.
14
+ * @example
15
+ * import { useReaction, useSignal } from "@shadow-js/core";
16
+ *
17
+ * function Results() {
18
+ * const [filters] = useSignal({ query: "" });
19
+ * const [stale, setStale] = useSignal(false);
20
+ * const track = useReaction(() => setStale(true));
21
+ * track(() => filters()); // the first change of filters marks the results stale
22
+ * return <p>{stale() ? "Refresh to update" : "Up to date"}</p>;
23
+ * }
24
+ * @see useEffect
25
+ * @since 1.0.0
26
+ */
27
+ export declare function useReaction(onInvalidate: () => void): (track: () => void) => void;
28
+ //#endregion
29
+ //# sourceMappingURL=reaction.d.ts.map
@@ -0,0 +1,61 @@
1
+ import { untrack } from "./ownership.js";
2
+ import { disposeTree } from "./internal/dispose.js";
3
+ import { createComputation, createOwner, currentOwner, runInScope } from "./extend/index.js";
4
+ //#region src/reaction.ts
5
+ /**
6
+ * Creates a tracker that reports the first change of what it reads. `useReaction(onInvalidate)`
7
+ * returns `track(fn)`: `fn` runs at once (synchronously) and the signals it reads are recorded.
8
+ * The first change of any of them calls `onInvalidate` once, untracked, and then nothing is
9
+ * observed until `track` is called again. The ShadowJS form of Solid's `createReaction`.
10
+ *
11
+ * Use it when the work that follows a change is not a pure rerun of `fn` (for example, re-fetching
12
+ * after a change and then deciding what to track next). For ordinary effects use `useEffect`.
13
+ *
14
+ * @param onInvalidate Called once, untracked, after a change of a tracked read.
15
+ * @returns `track(fn)`. Each call replaces the previous tracking. Tracking lives in a child of the
16
+ * owner that called `useReaction`, so it stops when that owner is disposed.
17
+ * @example
18
+ * import { useReaction, useSignal } from "@shadow-js/core";
19
+ *
20
+ * function Results() {
21
+ * const [filters] = useSignal({ query: "" });
22
+ * const [stale, setStale] = useSignal(false);
23
+ * const track = useReaction(() => setStale(true));
24
+ * track(() => filters()); // the first change of filters marks the results stale
25
+ * return <p>{stale() ? "Refresh to update" : "Up to date"}</p>;
26
+ * }
27
+ * @see useEffect
28
+ * @since 1.0.0
29
+ */
30
+ function useReaction(onInvalidate) {
31
+ const owner = currentOwner();
32
+ let scope = null;
33
+ return (track) => {
34
+ if (scope !== null) disposeTree(scope);
35
+ const next = createOwner(owner);
36
+ scope = next;
37
+ let tracking = true;
38
+ runInScope({
39
+ owner: next,
40
+ listener: null
41
+ }, () => {
42
+ createComputation({
43
+ kind: "effect",
44
+ render: true,
45
+ owner: next,
46
+ fn: () => {
47
+ if (tracking) {
48
+ tracking = false;
49
+ track();
50
+ return;
51
+ }
52
+ untrack(onInvalidate);
53
+ }
54
+ });
55
+ });
56
+ };
57
+ }
58
+ //#endregion
59
+ export { useReaction };
60
+
61
+ //# sourceMappingURL=reaction.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"reaction.js","names":[],"sources":["../../src/reaction.ts"],"sourcesContent":["import {\n createComputation,\n createOwner,\n currentOwner,\n disposeOwner,\n type Owner,\n runInScope,\n} from \"./extend\";\nimport { untrack } from \"./ownership\";\n\n/**\n * Creates a tracker that reports the first change of what it reads. `useReaction(onInvalidate)`\n * returns `track(fn)`: `fn` runs at once (synchronously) and the signals it reads are recorded.\n * The first change of any of them calls `onInvalidate` once, untracked, and then nothing is\n * observed until `track` is called again. The ShadowJS form of Solid's `createReaction`.\n *\n * Use it when the work that follows a change is not a pure rerun of `fn` (for example, re-fetching\n * after a change and then deciding what to track next). For ordinary effects use `useEffect`.\n *\n * @param onInvalidate Called once, untracked, after a change of a tracked read.\n * @returns `track(fn)`. Each call replaces the previous tracking. Tracking lives in a child of the\n * owner that called `useReaction`, so it stops when that owner is disposed.\n * @example\n * import { useReaction, useSignal } from \"@shadow-js/core\";\n *\n * function Results() {\n * const [filters] = useSignal({ query: \"\" });\n * const [stale, setStale] = useSignal(false);\n * const track = useReaction(() => setStale(true));\n * track(() => filters()); // the first change of filters marks the results stale\n * return <p>{stale() ? \"Refresh to update\" : \"Up to date\"}</p>;\n * }\n * @see useEffect\n * @since 1.0.0\n */\nexport function useReaction(onInvalidate: () => void): (track: () => void) => void {\n const owner = currentOwner();\n let scope: Owner | null = null;\n return (track: () => void): void => {\n if (scope !== null) disposeOwner(scope);\n const next = createOwner(owner);\n scope = next;\n let tracking = true;\n runInScope({ owner: next, listener: null }, () => {\n createComputation({\n kind: \"effect\",\n render: true,\n owner: next,\n fn: () => {\n if (tracking) {\n tracking = false;\n track();\n return undefined;\n }\n untrack(onInvalidate);\n return undefined;\n },\n });\n });\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCA,SAAgB,YAAY,cAAuD;CACjF,MAAM,QAAQ,aAAa;CAC3B,IAAI,QAAsB;CAC1B,QAAQ,UAA4B;EAClC,IAAI,UAAU,MAAM,YAAa,KAAK;EACtC,MAAM,OAAO,YAAY,KAAK;EAC9B,QAAQ;EACR,IAAI,WAAW;EACf,WAAW;GAAE,OAAO;GAAM,UAAU;EAAK,SAAS;GAChD,kBAAkB;IAChB,MAAM;IACN,QAAQ;IACR,OAAO;IACP,UAAU;KACR,IAAI,UAAU;MACZ,WAAW;MACX,MAAM;MACN;KACF;KACA,QAAQ,YAAY;IAEtB;GACF,CAAC;EACH,CAAC;CACH;AACF"}
@@ -0,0 +1,41 @@
1
+ import { Accessor, Equals } from "./internal/types.js";
2
+ //#region src/reducer.d.ts
3
+ /** Options of {@link useReducer}. @since 1.0.0 */
4
+ export interface ReducerOptions {
5
+ /**
6
+ * Decides whether a new state is a change: readers are notified only when it returns `false`.
7
+ * @default Object.is
8
+ */
9
+ equals?: Equals<unknown>;
10
+ /**
11
+ * Label shown by devtools and diagnostics.
12
+ * @default undefined (the state is unnamed)
13
+ */
14
+ name?: string;
15
+ }
16
+ /**
17
+ * A state cell whose writes go through a reducer: `dispatch(action)` stores
18
+ * `reducer(state, action)`. Equivalent to `useSignal` with the transition written in one place,
19
+ * which keeps every state change of a complex value (a form, a queue) in one function. Reads are
20
+ * fresh immediately after `dispatch`, like every write.
21
+ *
22
+ * @param reducer Pure function `(state, action) => next`.
23
+ * @param initialState Starting state, stored as is.
24
+ * @param options Equality override and a devtools name. Undefined uses the defaults.
25
+ * @returns `[state, dispatch]`; `state()` tracks, `dispatch(action)` returns nothing. The reducer
26
+ * runs untracked, once per dispatch.
27
+ * @throws ShadowError `WRITE_IN_MEMO` from `dispatch`, in development builds only, when it is called
28
+ * while a {@link useMemo} computation runs. `dispatch` also rethrows what the reducer throws.
29
+ * @example
30
+ * import { useReducer } from "@shadow-js/core";
31
+ *
32
+ * type Action = "inc" | "dec";
33
+ * const [count, dispatch] = useReducer((n: number, a: Action) => (a === "inc" ? n + 1 : n - 1), 0);
34
+ * dispatch("inc");
35
+ * console.log(count()); // 1
36
+ * @see useSignal
37
+ * @since 1.0.0
38
+ */
39
+ export declare function useReducer<S, A>(reducer: (state: S, action: A) => S, initialState: S, options?: ReducerOptions): [Accessor<S>, (action: A) => void];
40
+ //#endregion
41
+ //# sourceMappingURL=reducer.d.ts.map