@shadow-js/core 0.1.0 → 1.0.1

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 +17 -0
  2. package/LICENSE +2 -2
  3. package/README.md +134 -331
  4. package/dist/dev/action.d.ts +34 -0
  5. package/dist/dev/action.js +89 -0
  6. package/dist/dev/action.js.map +1 -0
  7. package/dist/dev/cache.d.ts +33 -0
  8. package/dist/dev/cache.js +61 -0
  9. package/dist/dev/cache.js.map +1 -0
  10. package/dist/dev/context.d.ts +104 -0
  11. package/dist/dev/context.js +110 -0
  12. package/dist/dev/context.js.map +1 -0
  13. package/dist/dev/effect.d.ts +120 -0
  14. package/dist/dev/effect.js +110 -0
  15. package/dist/dev/effect.js.map +1 -0
  16. package/dist/dev/env.d.ts +27 -0
  17. package/dist/dev/env.js +30 -0
  18. package/dist/dev/env.js.map +1 -0
  19. package/dist/dev/events.d.ts +26 -0
  20. package/dist/dev/events.js +32 -0
  21. package/dist/dev/events.js.map +1 -0
  22. package/dist/dev/extend/index.d.ts +329 -0
  23. package/dist/dev/extend/index.js +316 -0
  24. package/dist/dev/extend/index.js.map +1 -0
  25. package/dist/dev/external-store.d.ts +58 -0
  26. package/dist/dev/external-store.js +59 -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 +211 -0
  31. package/dist/dev/internal/concurrency.js +631 -0
  32. package/dist/dev/internal/concurrency.js.map +1 -0
  33. package/dist/dev/internal/devtools.d.ts +69 -0
  34. package/dist/dev/internal/devtools.js +76 -0
  35. package/dist/dev/internal/devtools.js.map +1 -0
  36. package/dist/dev/internal/diagnostics.d.ts +88 -0
  37. package/dist/dev/internal/diagnostics.js +101 -0
  38. package/dist/dev/internal/diagnostics.js.map +1 -0
  39. package/dist/dev/internal/dispose.d.ts +26 -0
  40. package/dist/dev/internal/dispose.js +48 -0
  41. package/dist/dev/internal/dispose.js.map +1 -0
  42. package/dist/dev/internal/flags.js +10 -0
  43. package/dist/dev/internal/flags.js.map +1 -0
  44. package/dist/dev/internal/graph.d.ts +231 -0
  45. package/dist/dev/internal/graph.js +577 -0
  46. package/dist/dev/internal/graph.js.map +1 -0
  47. package/dist/dev/internal/hydration-flag.d.ts +31 -0
  48. package/dist/dev/internal/hydration-flag.js +45 -0
  49. package/dist/dev/internal/hydration-flag.js.map +1 -0
  50. package/dist/dev/internal/messages.d.ts +54 -0
  51. package/dist/dev/internal/messages.js +53 -0
  52. package/dist/dev/internal/messages.js.map +1 -0
  53. package/dist/dev/internal/owner.d.ts +140 -0
  54. package/dist/dev/internal/owner.js +289 -0
  55. package/dist/dev/internal/owner.js.map +1 -0
  56. package/dist/dev/internal/queue.js +45 -0
  57. package/dist/dev/internal/queue.js.map +1 -0
  58. package/dist/dev/internal/scheduler.d.ts +111 -0
  59. package/dist/dev/internal/scheduler.js +286 -0
  60. package/dist/dev/internal/scheduler.js.map +1 -0
  61. package/dist/dev/internal/state.d.ts +139 -0
  62. package/dist/dev/internal/state.js +27 -0
  63. package/dist/dev/internal/state.js.map +1 -0
  64. package/dist/dev/internal/suspension.d.ts +41 -0
  65. package/dist/dev/internal/suspension.js +44 -0
  66. package/dist/dev/internal/suspension.js.map +1 -0
  67. package/dist/dev/internal/types.d.ts +44 -0
  68. package/dist/dev/list.d.ts +91 -0
  69. package/dist/dev/list.js +281 -0
  70. package/dist/dev/list.js.map +1 -0
  71. package/dist/dev/memo.d.ts +58 -0
  72. package/dist/dev/memo.js +40 -0
  73. package/dist/dev/memo.js.map +1 -0
  74. package/dist/dev/optimistic.d.ts +24 -0
  75. package/dist/dev/optimistic.js +44 -0
  76. package/dist/dev/optimistic.js.map +1 -0
  77. package/dist/dev/ownership.d.ts +202 -0
  78. package/dist/dev/ownership.js +260 -0
  79. package/dist/dev/ownership.js.map +1 -0
  80. package/dist/dev/props.d.ts +132 -0
  81. package/dist/dev/props.js +281 -0
  82. package/dist/dev/props.js.map +1 -0
  83. package/dist/dev/reaction.d.ts +27 -0
  84. package/dist/dev/reaction.js +60 -0
  85. package/dist/dev/reaction.js.map +1 -0
  86. package/dist/dev/reducer.d.ts +39 -0
  87. package/dist/dev/reducer.js +38 -0
  88. package/dist/dev/reducer.js.map +1 -0
  89. package/dist/dev/refs.d.ts +50 -0
  90. package/dist/dev/refs.js +57 -0
  91. package/dist/dev/refs.js.map +1 -0
  92. package/dist/dev/resource.d.ts +133 -0
  93. package/dist/dev/resource.js +176 -0
  94. package/dist/dev/resource.js.map +1 -0
  95. package/dist/dev/selector.d.ts +32 -0
  96. package/dist/dev/selector.js +117 -0
  97. package/dist/dev/selector.js.map +1 -0
  98. package/dist/dev/signal.d.ts +40 -0
  99. package/dist/dev/signal.js +38 -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 +191 -0
  104. package/dist/dev/store/nodes.js.map +1 -0
  105. package/dist/dev/store/proxies.js +159 -0
  106. package/dist/dev/store/proxies.js.map +1 -0
  107. package/dist/dev/store/read.d.ts +37 -0
  108. package/dist/dev/store/read.js +71 -0
  109. package/dist/dev/store/read.js.map +1 -0
  110. package/dist/dev/store/reconcile.d.ts +71 -0
  111. package/dist/dev/store/reconcile.js +185 -0
  112. package/dist/dev/store/reconcile.js.map +1 -0
  113. package/dist/dev/store/types.d.ts +104 -0
  114. package/dist/dev/store/use-store.d.ts +58 -0
  115. package/dist/dev/store/use-store.js +167 -0
  116. package/dist/dev/store/use-store.js.map +1 -0
  117. package/dist/dev/suspense.d.ts +99 -0
  118. package/dist/dev/suspense.js +44 -0
  119. package/dist/dev/suspense.js.map +1 -0
  120. package/dist/dev/transitions.d.ts +75 -0
  121. package/dist/dev/transitions.js +100 -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 +89 -0
  284. package/dist/server-dev/action.js.map +1 -0
  285. package/dist/server-dev/cache.js +61 -0
  286. package/dist/server-dev/cache.js.map +1 -0
  287. package/dist/server-dev/context.js +107 -0
  288. package/dist/server-dev/context.js.map +1 -0
  289. package/dist/server-dev/effect.js +55 -0
  290. package/dist/server-dev/effect.js.map +1 -0
  291. package/dist/server-dev/env.js +30 -0
  292. package/dist/server-dev/env.js.map +1 -0
  293. package/dist/server-dev/events.js +32 -0
  294. package/dist/server-dev/events.js.map +1 -0
  295. package/dist/server-dev/extend/index.js +316 -0
  296. package/dist/server-dev/extend/index.js.map +1 -0
  297. package/dist/server-dev/external-store.js +45 -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 +632 -0
  301. package/dist/server-dev/internal/concurrency.js.map +1 -0
  302. package/dist/server-dev/internal/devtools.js +76 -0
  303. package/dist/server-dev/internal/devtools.js.map +1 -0
  304. package/dist/server-dev/internal/diagnostics.js +101 -0
  305. package/dist/server-dev/internal/diagnostics.js.map +1 -0
  306. package/dist/server-dev/internal/dispose.js +48 -0
  307. package/dist/server-dev/internal/dispose.js.map +1 -0
  308. package/dist/server-dev/internal/flags.js +10 -0
  309. package/dist/server-dev/internal/flags.js.map +1 -0
  310. package/dist/server-dev/internal/graph.js +577 -0
  311. package/dist/server-dev/internal/graph.js.map +1 -0
  312. package/dist/server-dev/internal/hydration-flag.js +45 -0
  313. package/dist/server-dev/internal/hydration-flag.js.map +1 -0
  314. package/dist/server-dev/internal/messages.js +53 -0
  315. package/dist/server-dev/internal/messages.js.map +1 -0
  316. package/dist/server-dev/internal/owner.js +289 -0
  317. package/dist/server-dev/internal/owner.js.map +1 -0
  318. package/dist/server-dev/internal/queue.js +45 -0
  319. package/dist/server-dev/internal/queue.js.map +1 -0
  320. package/dist/server-dev/internal/scheduler.js +286 -0
  321. package/dist/server-dev/internal/scheduler.js.map +1 -0
  322. package/dist/server-dev/internal/state.js +27 -0
  323. package/dist/server-dev/internal/state.js.map +1 -0
  324. package/dist/server-dev/internal/suspension.js +44 -0
  325. package/dist/server-dev/internal/suspension.js.map +1 -0
  326. package/dist/server-dev/list.js +281 -0
  327. package/dist/server-dev/list.js.map +1 -0
  328. package/dist/server-dev/memo.js +40 -0
  329. package/dist/server-dev/memo.js.map +1 -0
  330. package/dist/server-dev/optimistic.js +44 -0
  331. package/dist/server-dev/optimistic.js.map +1 -0
  332. package/dist/server-dev/ownership.js +260 -0
  333. package/dist/server-dev/ownership.js.map +1 -0
  334. package/dist/server-dev/props.js +281 -0
  335. package/dist/server-dev/props.js.map +1 -0
  336. package/dist/server-dev/reaction.js +60 -0
  337. package/dist/server-dev/reaction.js.map +1 -0
  338. package/dist/server-dev/reducer.js +38 -0
  339. package/dist/server-dev/reducer.js.map +1 -0
  340. package/dist/server-dev/refs.js +57 -0
  341. package/dist/server-dev/refs.js.map +1 -0
  342. package/dist/server-dev/resource.js +175 -0
  343. package/dist/server-dev/resource.js.map +1 -0
  344. package/dist/server-dev/selector.js +81 -0
  345. package/dist/server-dev/selector.js.map +1 -0
  346. package/dist/server-dev/signal.js +38 -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 +191 -0
  350. package/dist/server-dev/store/nodes.js.map +1 -0
  351. package/dist/server-dev/store/proxies.js +159 -0
  352. package/dist/server-dev/store/proxies.js.map +1 -0
  353. package/dist/server-dev/store/read.js +71 -0
  354. package/dist/server-dev/store/read.js.map +1 -0
  355. package/dist/server-dev/store/reconcile.js +185 -0
  356. package/dist/server-dev/store/reconcile.js.map +1 -0
  357. package/dist/server-dev/store/use-store.js +167 -0
  358. package/dist/server-dev/store/use-store.js.map +1 -0
  359. package/dist/server-dev/suspense.js +44 -0
  360. package/dist/server-dev/suspense.js.map +1 -0
  361. package/dist/server-dev/transitions.js +85 -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,211 @@
1
+ import { Owner } from "./owner.js";
2
+ import { Hooks, TransitionHold } from "./state.js";
3
+ /**
4
+ * Installs the transition machinery (the transition lane, Activity pauses and Suspense holds) now
5
+ * instead of at the first `startTransition`. The machinery is created on first use so that an
6
+ * application that never uses transitions does not carry its code; call this from a primitive whose
7
+ * later work needs the lane to exist, as `useDeferredValue` does. Calling it again does nothing.
8
+ *
9
+ * @example
10
+ * import { registerTransitionLane } from "@shadow-js/core/extend";
11
+ *
12
+ * export function useBackgroundValue(): void {
13
+ * registerTransitionLane(); // later lane-only effects of this hook find the lane
14
+ * }
15
+ * @see startTransition
16
+ * @since 1.0.0
17
+ */
18
+ export declare function registerTransitionLane(): void;
19
+ /**
20
+ * Runs `fn` as a transition: the effects its writes wake wait in the transition lane, which runs
21
+ * after urgent work (in a macrotask, one chunk at a time). Reads see the writes at once; the DOM
22
+ * catches up when the lane runs. Use it for an update that may be slow to render or load, so input
23
+ * stays responsive and a Suspense boundary keeps its content instead of showing its fallback. `fn`
24
+ * runs untracked. The returned promise resolves when the lane is idle and no Suspense boundary holds
25
+ * the transition.
26
+ *
27
+ * On the server there are no effects, so `fn` simply runs and the promise is already resolved.
28
+ *
29
+ * @param fn Callback whose writes form the transition.
30
+ * @returns A promise that resolves when the transition has been applied.
31
+ * @throws What `fn` throws, synchronously; no transition is started then.
32
+ * @example
33
+ * import { startTransition, useSignal } from "@shadow-js/core";
34
+ *
35
+ * const [page, setPage] = useSignal("home");
36
+ * async function openReports(): Promise<void> {
37
+ * await startTransition(() => setPage("reports"));
38
+ * console.log(`${page()} is on screen`);
39
+ * }
40
+ * @see inTransition
41
+ * @since 1.0.0
42
+ */
43
+ export declare function startTransition(fn: () => void): Promise<void>;
44
+ /**
45
+ * Starts a Suspense hold: the boundary keeps showing its current content while a transition waits
46
+ * for data. Holds are counted, and the running transitions stay pending (`isPending` of
47
+ * `useTransition`, the promise of `startTransition`) until every hold has ended. For renderers that
48
+ * implement Suspense; each call needs one {@link endHold}. Does nothing before the transition
49
+ * machinery exists (no transition has run).
50
+ *
51
+ * @example
52
+ * import { beginHold, endHold, wakeSuspended } from "@shadow-js/core/extend";
53
+ *
54
+ * export function holdUntil(data: Promise<unknown>): void {
55
+ * beginHold(); // the boundary keeps its content
56
+ * void data.finally(() => {
57
+ * wakeSuspended();
58
+ * endHold();
59
+ * });
60
+ * }
61
+ * @see endHold
62
+ * @since 1.0.0
63
+ */
64
+ export declare function beginHold(): void;
65
+ /**
66
+ * Ends a Suspense hold started with {@link beginHold}. Call {@link wakeSuspended} first, so the
67
+ * memos and effects that waited are queued; this then schedules the lane for them and, once the lane
68
+ * is idle and no hold remains, resolves the transitions that were waiting. Extra calls never take the
69
+ * count below zero. Does nothing before the transition machinery exists.
70
+ *
71
+ * @example
72
+ * import { endHold, wakeSuspended } from "@shadow-js/core/extend";
73
+ *
74
+ * export function release(): void {
75
+ * wakeSuspended(); // the held readers run again with the data that arrived
76
+ * endHold();
77
+ * }
78
+ * @see beginHold
79
+ * @since 1.0.0
80
+ */
81
+ export declare function endHold(): void;
82
+ /**
83
+ * Wakes every memo and effect that kept its value for a transition (it caught {@link SUSPENSION}):
84
+ * each runs again in the transition lane, so it reads the data that arrived. A Suspense boundary
85
+ * calls it when it releases its hold, before {@link endHold}. Does nothing before the transition
86
+ * machinery exists.
87
+ *
88
+ * @example
89
+ * import { endHold, wakeSuspended } from "@shadow-js/core/extend";
90
+ *
91
+ * export function onDataArrived(): void {
92
+ * wakeSuspended();
93
+ * endHold();
94
+ * }
95
+ * @see endHold
96
+ * @since 1.0.0
97
+ */
98
+ export declare function wakeSuspended(): void;
99
+ /**
100
+ * Lets a pending read inside a transition keep the boundary's content: when the tracker's `hold()`
101
+ * returns true (the boundary holds its content for the transition), the reader throws
102
+ * {@link SUSPENSION} and keeps its previous value until the boundary wakes it. Call it from a data
103
+ * primitive's reader when its data is pending, the reader is tracked and {@link inTransition} is
104
+ * true, as `useResource` does. Does nothing before the transition machinery exists, or when the
105
+ * tracker has no `hold`.
106
+ *
107
+ * @param tracker The Suspense tracker of the nearest boundary (`SuspenseContext`).
108
+ * @throws {@link SUSPENSION} (not an error) when the boundary holds its content.
109
+ * @example
110
+ * import { useContext, SuspenseContext } from "@shadow-js/core";
111
+ * import { currentListener, holdReader, inTransition } from "@shadow-js/core/extend";
112
+ *
113
+ * export function readPending(): void {
114
+ * const tracker = useContext(SuspenseContext);
115
+ * if (tracker !== null && currentListener() !== null && inTransition()) holdReader(tracker);
116
+ * }
117
+ * @see isSuspension
118
+ * @since 1.0.0
119
+ */
120
+ export declare function holdReader(tracker: {
121
+ hold?(): boolean;
122
+ }): void;
123
+ /**
124
+ * Tells whether a transition callback or a transition-lane run is active, so the writes made now
125
+ * belong to the lane. Use it in a primitive that treats transition reads differently, such as a data
126
+ * reader that holds the boundary only in a transition.
127
+ *
128
+ * @returns True inside `startTransition`'s callback and while the lane runs.
129
+ * @example
130
+ * import { startTransition } from "@shadow-js/core";
131
+ * import { inTransition } from "@shadow-js/core/extend";
132
+ *
133
+ * void startTransition(() => {
134
+ * console.log(inTransition()); // true in the browser
135
+ * });
136
+ * console.log(inTransition()); // false
137
+ * @see startTransition
138
+ * @since 1.0.0
139
+ */
140
+ export declare function inTransition(): boolean;
141
+ /**
142
+ * Creates the hold of a value a transition builds (see {@link TransitionHold}): the reads that wait
143
+ * for data inside `hold.run(...)` count against this hold instead of the Suspense boundary around the
144
+ * value, so the value on screen stays until the new one is ready. For renderers that build values
145
+ * during a transition.
146
+ *
147
+ * @param onSettled Called each time the number of waiting reads drops back to zero.
148
+ * @returns The hold, or null when the transition machinery does not exist yet (no transition has run,
149
+ * so nothing can be held).
150
+ * @example
151
+ * import { createTransitionHold } from "@shadow-js/core/extend";
152
+ *
153
+ * const hold = createTransitionHold(() => console.log("ready to commit"));
154
+ * const built = hold === null ? "now" : hold.run(() => "pending");
155
+ * @see transitionHooks
156
+ * @since 1.0.0
157
+ */
158
+ export declare function createTransitionHold(onSettled: () => void): TransitionHold | null;
159
+ /**
160
+ * Returns the transition machinery while a transition is running, otherwise null. Renderers reach
161
+ * the slot and boundary layers (`slotSwap`, `boundaryHold`) only through it: a transition can only be
162
+ * running once the machinery exists, so this never creates it (a static call that did would keep the
163
+ * whole machinery in every bundle that renders a Show).
164
+ *
165
+ * @returns The hooks during a transition callback or lane run, null otherwise.
166
+ * @example
167
+ * import { transitionHooks } from "@shadow-js/core/extend";
168
+ *
169
+ * export function boundaryHoldIfTransition() {
170
+ * return transitionHooks()?.boundaryHold() ?? null;
171
+ * }
172
+ * @see inTransition
173
+ * @since 1.0.0
174
+ */
175
+ export declare function transitionHooks(): Hooks | null;
176
+ /**
177
+ * Pauses `owner` and everything below it (Activity hidden). User effects run their cleanups and wait.
178
+ * DOM bindings (render effects) wait without a cleanup, so their nodes stay as they are. Memos keep their
179
+ * last value, and effects created below are parked until the owner resumes. Pauses nest: each
180
+ * `pauseOwner` needs one `resumeOwner`. Use it to hide a subtree while keeping its state.
181
+ *
182
+ * @param owner The owner to pause, with its whole subtree.
183
+ * @example
184
+ * import { createOwner, pauseOwner, resumeOwner } from "@shadow-js/core/extend";
185
+ *
186
+ * const hidden = createOwner(null);
187
+ * pauseOwner(hidden); // its effects stop; its memos keep their values
188
+ * resumeOwner(hidden); // its user effects run again with the latest values
189
+ * @see resumeOwner
190
+ * @since 1.0.0
191
+ */
192
+ export declare function pauseOwner(owner: Owner): void;
193
+ /**
194
+ * Resumes an owner paused with {@link pauseOwner}; the subtree runs again once its last pause ends.
195
+ * User effects below it run once more with the current values (their cleanups ran on pause). DOM
196
+ * bindings run only if something they read changed while paused, so a hidden subtree is not rebuilt
197
+ * on show. Memos that changed while paused wake their readers outside the owner. Call it once per
198
+ * `pauseOwner`, not on an owner that is not paused.
199
+ *
200
+ * @param owner The paused owner.
201
+ * @example
202
+ * import { createOwner, pauseOwner, resumeOwner } from "@shadow-js/core/extend";
203
+ *
204
+ * const panel = createOwner(null);
205
+ * pauseOwner(panel);
206
+ * resumeOwner(panel); // every user effect below runs once with the latest values
207
+ * @see pauseOwner
208
+ * @since 1.0.0
209
+ */
210
+ export declare function resumeOwner(owner: Owner): void;
211
+ //# sourceMappingURL=concurrency.d.ts.map