spacefn-docs 0.0.0-stage → 0.11.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 (366) hide show
  1. package/LICENSE +200 -0
  2. package/README.md +15 -2
  3. package/assets/reader.css +1131 -0
  4. package/assets/reader.js +324 -0
  5. package/content/1-getting-started.md +107 -0
  6. package/content/2-conventions.md +138 -0
  7. package/content/3-best-practices.md +68 -0
  8. package/content/4-folders/1-app/1-entry.md +48 -0
  9. package/content/4-folders/1-app/2-routes.md +92 -0
  10. package/content/4-folders/1-app/3-db.md +81 -0
  11. package/content/4-folders/1-app/4-queues.md +46 -0
  12. package/content/4-folders/1-app/5-crons.md +30 -0
  13. package/content/4-folders/1-app/6-assets.md +53 -0
  14. package/content/4-folders/1-app/7-durable-objects.md +60 -0
  15. package/content/4-folders/1-app/8-workflows.md +46 -0
  16. package/content/4-folders/1-app/index.md +43 -0
  17. package/content/4-folders/2-modules.md +71 -0
  18. package/content/4-folders/3-lib.md +60 -0
  19. package/content/4-folders/4-public.md +24 -0
  20. package/content/4-folders/5-docs.md +23 -0
  21. package/content/4-folders/6-configs.md +57 -0
  22. package/content/4-folders/7-space.md +34 -0
  23. package/content/4-folders/8-env.md +34 -0
  24. package/content/4-folders/9-package-json.md +37 -0
  25. package/content/4-folders/index.md +50 -0
  26. package/content/5-deployment/1-cloudflare.md +56 -0
  27. package/content/5-deployment/2-bun.md +68 -0
  28. package/content/5-deployment/3-infrastructure.md +67 -0
  29. package/content/5-deployment/4-ci-cd.md +131 -0
  30. package/content/5-deployment/index.md +48 -0
  31. package/content/6-guides/1-entry.md +113 -0
  32. package/content/6-guides/2-routes.md +162 -0
  33. package/content/6-guides/3-pages.md +148 -0
  34. package/content/6-guides/4-frontend.md +232 -0
  35. package/content/6-guides/5-database.md +178 -0
  36. package/content/6-guides/6-services.md +125 -0
  37. package/content/6-guides/7-jobs.md +61 -0
  38. package/content/6-guides/8-auth.md +111 -0
  39. package/content/6-guides/9-testing.md +70 -0
  40. package/content/6-guides/index.md +21 -0
  41. package/content/7-reference/1-config.md +67 -0
  42. package/content/7-reference/2-cli.md +27 -0
  43. package/content/7-reference/3-writing-docs.md +206 -0
  44. package/content/7-reference/index.md +15 -0
  45. package/content/index.md +49 -0
  46. package/content/logo.svg +12 -0
  47. package/dist/index.d.mts +72 -0
  48. package/dist/index.mjs +713 -0
  49. package/examples/README.md +18 -0
  50. package/examples/datastar/.env.example +2 -0
  51. package/examples/datastar/README.md +17 -0
  52. package/examples/datastar/app/assets/main.ts +4 -0
  53. package/examples/datastar/app/assets/site.css +3 -0
  54. package/examples/datastar/app/db/main/config.json +5 -0
  55. package/examples/datastar/app/db/main/migrations/0001_votes.sql +8 -0
  56. package/examples/datastar/app/db/main/queries/add-vote.sql +3 -0
  57. package/examples/datastar/app/db/main/queries/tally.sql +1 -0
  58. package/examples/datastar/app/entry.ts +28 -0
  59. package/examples/datastar/app/routes/_middleware.ts +4 -0
  60. package/examples/datastar/app/routes/health.ts +7 -0
  61. package/examples/datastar/app/routes/index.ts +43 -0
  62. package/examples/datastar/configs/env.ts +6 -0
  63. package/examples/datastar/configs/infra.ts +85 -0
  64. package/examples/datastar/configs/tsconfig.json +15 -0
  65. package/examples/datastar/configs/vite.ts +4 -0
  66. package/examples/datastar/configs/vitest.ts +9 -0
  67. package/examples/datastar/lib/types/rocket.d.ts +30 -0
  68. package/examples/datastar/lib/ui/base.css +17 -0
  69. package/examples/datastar/lib/ui/layout.ts +27 -0
  70. package/examples/datastar/modules/poll/client/poll-meter.ts +39 -0
  71. package/examples/datastar/modules/poll/poll.css +13 -0
  72. package/examples/datastar/modules/poll/poll.test.ts +48 -0
  73. package/examples/datastar/modules/poll/poll.ts +62 -0
  74. package/examples/datastar/modules/poll/views.ts +52 -0
  75. package/examples/datastar/package.json +33 -0
  76. package/examples/datastar/tsconfig.json +4 -0
  77. package/examples/lightningcss/.env.example +1 -0
  78. package/examples/lightningcss/README.md +15 -0
  79. package/examples/lightningcss/app/assets/site.css +3 -0
  80. package/examples/lightningcss/app/entry.ts +28 -0
  81. package/examples/lightningcss/app/routes/_middleware.ts +4 -0
  82. package/examples/lightningcss/app/routes/health.ts +7 -0
  83. package/examples/lightningcss/app/routes/index.ts +12 -0
  84. package/examples/lightningcss/configs/Dockerfile +26 -0
  85. package/examples/lightningcss/configs/Dockerfile.dockerignore +9 -0
  86. package/examples/lightningcss/configs/env.ts +4 -0
  87. package/examples/lightningcss/configs/infra.ts +55 -0
  88. package/examples/lightningcss/configs/tsconfig.json +15 -0
  89. package/examples/lightningcss/configs/vite.ts +19 -0
  90. package/examples/lightningcss/configs/vitest.ts +9 -0
  91. package/examples/lightningcss/lib/ui/layout.ts +17 -0
  92. package/examples/lightningcss/lib/ui/tokens.css +23 -0
  93. package/examples/lightningcss/modules/releases/releases.css +20 -0
  94. package/examples/lightningcss/modules/releases/releases.test.ts +18 -0
  95. package/examples/lightningcss/modules/releases/releases.ts +21 -0
  96. package/examples/lightningcss/modules/releases/views.ts +25 -0
  97. package/examples/lightningcss/package.json +33 -0
  98. package/examples/lightningcss/tsconfig.json +4 -0
  99. package/examples/mini-shopify/.env.example +6 -0
  100. package/examples/mini-shopify/README.md +19 -0
  101. package/examples/mini-shopify/app/assets/site.css +2 -0
  102. package/examples/mini-shopify/app/db/platform/config.json +5 -0
  103. package/examples/mini-shopify/app/db/platform/migrations/0001_shops.sql +10 -0
  104. package/examples/mini-shopify/app/db/platform/queries/add-shop.sql +4 -0
  105. package/examples/mini-shopify/app/db/platform/queries/find-shop.sql +3 -0
  106. package/examples/mini-shopify/app/db/platform/queries/list-shops.sql +1 -0
  107. package/examples/mini-shopify/app/db/shop/config.json +6 -0
  108. package/examples/mini-shopify/app/db/shop/migrations/0001_products.sql +11 -0
  109. package/examples/mini-shopify/app/db/shop/queries/add-product.sql +4 -0
  110. package/examples/mini-shopify/app/db/shop/queries/list-products.sql +1 -0
  111. package/examples/mini-shopify/app/db/shop/queries/sell-product.sql +2 -0
  112. package/examples/mini-shopify/app/entry.ts +25 -0
  113. package/examples/mini-shopify/app/routes/_middleware.ts +4 -0
  114. package/examples/mini-shopify/app/routes/health.ts +7 -0
  115. package/examples/mini-shopify/app/routes/index.ts +26 -0
  116. package/examples/mini-shopify/app/routes/s/[shop]/_middleware.ts +6 -0
  117. package/examples/mini-shopify/app/routes/s/[shop]/index.ts +32 -0
  118. package/examples/mini-shopify/configs/Dockerfile +26 -0
  119. package/examples/mini-shopify/configs/Dockerfile.dockerignore +9 -0
  120. package/examples/mini-shopify/configs/env.ts +14 -0
  121. package/examples/mini-shopify/configs/infra.ts +55 -0
  122. package/examples/mini-shopify/configs/tsconfig.json +15 -0
  123. package/examples/mini-shopify/configs/vite.ts +4 -0
  124. package/examples/mini-shopify/configs/vitest.ts +9 -0
  125. package/examples/mini-shopify/lib/ui/base.css +19 -0
  126. package/examples/mini-shopify/lib/ui/layout.ts +17 -0
  127. package/examples/mini-shopify/modules/catalog/catalog.ts +31 -0
  128. package/examples/mini-shopify/modules/catalog/views.ts +39 -0
  129. package/examples/mini-shopify/modules/shops/host.test.ts +38 -0
  130. package/examples/mini-shopify/modules/shops/host.ts +73 -0
  131. package/examples/mini-shopify/modules/shops/shops.test.ts +63 -0
  132. package/examples/mini-shopify/modules/shops/shops.ts +64 -0
  133. package/examples/mini-shopify/modules/shops/views.ts +28 -0
  134. package/examples/mini-shopify/package.json +35 -0
  135. package/examples/mini-shopify/tsconfig.json +4 -0
  136. package/examples/react/.env.example +2 -0
  137. package/examples/react/README.md +18 -0
  138. package/examples/react/app/assets/site.css +3 -0
  139. package/examples/react/app/entry.ts +28 -0
  140. package/examples/react/app/routes/_middleware.ts +4 -0
  141. package/examples/react/app/routes/about.ts +10 -0
  142. package/examples/react/app/routes/health.ts +7 -0
  143. package/examples/react/app/routes/index.ts +12 -0
  144. package/examples/react/configs/Dockerfile +26 -0
  145. package/examples/react/configs/Dockerfile.dockerignore +9 -0
  146. package/examples/react/configs/env.ts +6 -0
  147. package/examples/react/configs/infra.ts +55 -0
  148. package/examples/react/configs/tsconfig.json +16 -0
  149. package/examples/react/configs/vite.ts +7 -0
  150. package/examples/react/configs/vitest.ts +9 -0
  151. package/examples/react/lib/ui/base.css +12 -0
  152. package/examples/react/lib/ui/layout.ts +18 -0
  153. package/examples/react/modules/about/views.ts +8 -0
  154. package/examples/react/modules/shop/products.ts +18 -0
  155. package/examples/react/modules/shop/shop.css +13 -0
  156. package/examples/react/modules/shop/shop.test.ts +28 -0
  157. package/examples/react/modules/shop/shop.ts +13 -0
  158. package/examples/react/modules/shop/ui/Cart.island.tsx +31 -0
  159. package/examples/react/modules/shop/views.ts +16 -0
  160. package/examples/react/package.json +38 -0
  161. package/examples/react/tsconfig.json +4 -0
  162. package/examples/services-bun/README.md +10 -0
  163. package/examples/services-bun/app/assets/main.ts +4 -0
  164. package/examples/services-bun/app/assets/style.css +1 -0
  165. package/examples/services-bun/app/crons/nightly.ts +5 -0
  166. package/examples/services-bun/app/entry.ts +9 -0
  167. package/examples/services-bun/app/queues/jobs.ts +5 -0
  168. package/examples/services-bun/app/routes/index.ts +10 -0
  169. package/examples/services-bun/app/routes/runtime.ts +5 -0
  170. package/examples/services-bun/app/routes/send.ts +8 -0
  171. package/examples/services-bun/app/routes/version.ts +5 -0
  172. package/examples/services-bun/configs/Dockerfile +10 -0
  173. package/examples/services-bun/configs/Dockerfile.dockerignore +4 -0
  174. package/examples/services-bun/configs/infra.ts +28 -0
  175. package/examples/services-bun/configs/tsconfig.json +15 -0
  176. package/examples/services-bun/configs/vite.ts +4 -0
  177. package/examples/services-bun/lib/ui/base.css +3 -0
  178. package/examples/services-bun/lib/ui/layout.ts +13 -0
  179. package/examples/services-bun/modules/status/client/ready.ts +4 -0
  180. package/examples/services-bun/modules/status/status.ts +20 -0
  181. package/examples/services-bun/modules/status/views.ts +4 -0
  182. package/examples/services-bun/package.json +30 -0
  183. package/examples/services-bun/public/robots.txt +1 -0
  184. package/examples/services-bun/tsconfig.json +4 -0
  185. package/examples/services-cloudflare/README.md +9 -0
  186. package/examples/services-cloudflare/app/assets/main.ts +4 -0
  187. package/examples/services-cloudflare/app/crons/nightly.ts +5 -0
  188. package/examples/services-cloudflare/app/db/main/config.json +4 -0
  189. package/examples/services-cloudflare/app/db/main/migrations/0001_notes.sql +2 -0
  190. package/examples/services-cloudflare/app/db/main/queries/add-note.sql +1 -0
  191. package/examples/services-cloudflare/app/db/main/queries/count-notes.sql +3 -0
  192. package/examples/services-cloudflare/app/entry.ts +10 -0
  193. package/examples/services-cloudflare/app/queues/jobs.ts +5 -0
  194. package/examples/services-cloudflare/app/routes/files.ts +5 -0
  195. package/examples/services-cloudflare/app/routes/index.ts +10 -0
  196. package/examples/services-cloudflare/app/routes/limited.ts +7 -0
  197. package/examples/services-cloudflare/app/routes/send.ts +8 -0
  198. package/examples/services-cloudflare/configs/env.ts +3 -0
  199. package/examples/services-cloudflare/configs/infra.ts +85 -0
  200. package/examples/services-cloudflare/configs/tsconfig.json +15 -0
  201. package/examples/services-cloudflare/configs/vite.ts +4 -0
  202. package/examples/services-cloudflare/lib/ui/layout.ts +12 -0
  203. package/examples/services-cloudflare/modules/files/files.ts +9 -0
  204. package/examples/services-cloudflare/modules/status/client/ready.ts +4 -0
  205. package/examples/services-cloudflare/modules/status/status.ts +27 -0
  206. package/examples/services-cloudflare/modules/status/views.ts +8 -0
  207. package/examples/services-cloudflare/package.json +30 -0
  208. package/examples/services-cloudflare/public/robots.txt +1 -0
  209. package/examples/services-cloudflare/tsconfig.json +4 -0
  210. package/examples/solid/.env.example +2 -0
  211. package/examples/solid/README.md +18 -0
  212. package/examples/solid/app/assets/site.css +3 -0
  213. package/examples/solid/app/entry.ts +28 -0
  214. package/examples/solid/app/routes/_middleware.ts +4 -0
  215. package/examples/solid/app/routes/about.ts +10 -0
  216. package/examples/solid/app/routes/health.ts +7 -0
  217. package/examples/solid/app/routes/index.ts +12 -0
  218. package/examples/solid/configs/Dockerfile +26 -0
  219. package/examples/solid/configs/Dockerfile.dockerignore +9 -0
  220. package/examples/solid/configs/env.ts +6 -0
  221. package/examples/solid/configs/infra.ts +55 -0
  222. package/examples/solid/configs/tsconfig.json +17 -0
  223. package/examples/solid/configs/vite.ts +7 -0
  224. package/examples/solid/configs/vitest.ts +12 -0
  225. package/examples/solid/lib/ui/base.css +12 -0
  226. package/examples/solid/lib/ui/layout.ts +18 -0
  227. package/examples/solid/modules/about/views.ts +8 -0
  228. package/examples/solid/modules/shop/products.ts +18 -0
  229. package/examples/solid/modules/shop/shop.css +13 -0
  230. package/examples/solid/modules/shop/shop.test.ts +28 -0
  231. package/examples/solid/modules/shop/shop.ts +13 -0
  232. package/examples/solid/modules/shop/ui/Cart.island.tsx +31 -0
  233. package/examples/solid/modules/shop/views.ts +16 -0
  234. package/examples/solid/package.json +35 -0
  235. package/examples/solid/tsconfig.json +4 -0
  236. package/examples/starter-bun/.env.example +2 -0
  237. package/examples/starter-bun/AGENTS.md +9 -0
  238. package/examples/starter-bun/README.md +47 -0
  239. package/examples/starter-bun/app/assets/site.css +3 -0
  240. package/examples/starter-bun/app/db/main/config.json +5 -0
  241. package/examples/starter-bun/app/db/main/migrations/0001_todos.sql +9 -0
  242. package/examples/starter-bun/app/db/main/queries/add-todo.sql +2 -0
  243. package/examples/starter-bun/app/db/main/queries/list-todos.sql +2 -0
  244. package/examples/starter-bun/app/db/main/queries/toggle-todo.sql +2 -0
  245. package/examples/starter-bun/app/entry.ts +28 -0
  246. package/examples/starter-bun/app/routes/_middleware.ts +4 -0
  247. package/examples/starter-bun/app/routes/health.ts +7 -0
  248. package/examples/starter-bun/app/routes/index.ts +44 -0
  249. package/examples/starter-bun/configs/Dockerfile +26 -0
  250. package/examples/starter-bun/configs/Dockerfile.dockerignore +9 -0
  251. package/examples/starter-bun/configs/env.ts +6 -0
  252. package/examples/starter-bun/configs/infra.ts +55 -0
  253. package/examples/starter-bun/configs/tsconfig.json +15 -0
  254. package/examples/starter-bun/configs/vite.ts +4 -0
  255. package/examples/starter-bun/configs/vitest.ts +9 -0
  256. package/examples/starter-bun/docs/index.md +5 -0
  257. package/examples/starter-bun/lib/ui/base.css +17 -0
  258. package/examples/starter-bun/lib/ui/layout.ts +22 -0
  259. package/examples/starter-bun/modules/todos/todos.css +16 -0
  260. package/examples/starter-bun/modules/todos/todos.test.ts +33 -0
  261. package/examples/starter-bun/modules/todos/todos.ts +31 -0
  262. package/examples/starter-bun/modules/todos/views.ts +38 -0
  263. package/examples/starter-bun/package.json +32 -0
  264. package/examples/starter-bun/public/favicon.svg +1 -0
  265. package/examples/starter-bun/tsconfig.json +4 -0
  266. package/examples/starter-cloudflare/.env.example +2 -0
  267. package/examples/starter-cloudflare/AGENTS.md +9 -0
  268. package/examples/starter-cloudflare/README.md +47 -0
  269. package/examples/starter-cloudflare/app/assets/site.css +3 -0
  270. package/examples/starter-cloudflare/app/db/main/config.json +5 -0
  271. package/examples/starter-cloudflare/app/db/main/migrations/0001_todos.sql +9 -0
  272. package/examples/starter-cloudflare/app/db/main/queries/add-todo.sql +2 -0
  273. package/examples/starter-cloudflare/app/db/main/queries/list-todos.sql +2 -0
  274. package/examples/starter-cloudflare/app/db/main/queries/toggle-todo.sql +2 -0
  275. package/examples/starter-cloudflare/app/entry.ts +28 -0
  276. package/examples/starter-cloudflare/app/routes/_middleware.ts +4 -0
  277. package/examples/starter-cloudflare/app/routes/health.ts +7 -0
  278. package/examples/starter-cloudflare/app/routes/index.ts +44 -0
  279. package/examples/starter-cloudflare/configs/env.ts +6 -0
  280. package/examples/starter-cloudflare/configs/infra.ts +85 -0
  281. package/examples/starter-cloudflare/configs/tsconfig.json +15 -0
  282. package/examples/starter-cloudflare/configs/vite.ts +4 -0
  283. package/examples/starter-cloudflare/configs/vitest.ts +9 -0
  284. package/examples/starter-cloudflare/docs/index.md +5 -0
  285. package/examples/starter-cloudflare/lib/ui/base.css +17 -0
  286. package/examples/starter-cloudflare/lib/ui/layout.ts +22 -0
  287. package/examples/starter-cloudflare/modules/todos/todos.css +16 -0
  288. package/examples/starter-cloudflare/modules/todos/todos.test.ts +33 -0
  289. package/examples/starter-cloudflare/modules/todos/todos.ts +31 -0
  290. package/examples/starter-cloudflare/modules/todos/views.ts +38 -0
  291. package/examples/starter-cloudflare/package.json +32 -0
  292. package/examples/starter-cloudflare/public/favicon.svg +1 -0
  293. package/examples/starter-cloudflare/tsconfig.json +4 -0
  294. package/examples/svelte/.env.example +2 -0
  295. package/examples/svelte/README.md +18 -0
  296. package/examples/svelte/app/assets/site.css +3 -0
  297. package/examples/svelte/app/entry.ts +28 -0
  298. package/examples/svelte/app/routes/_middleware.ts +4 -0
  299. package/examples/svelte/app/routes/about.ts +10 -0
  300. package/examples/svelte/app/routes/health.ts +7 -0
  301. package/examples/svelte/app/routes/index.ts +12 -0
  302. package/examples/svelte/configs/env.ts +6 -0
  303. package/examples/svelte/configs/infra.ts +85 -0
  304. package/examples/svelte/configs/tsconfig.json +15 -0
  305. package/examples/svelte/configs/vite.ts +9 -0
  306. package/examples/svelte/configs/vitest.ts +9 -0
  307. package/examples/svelte/lib/types/svelte.d.ts +8 -0
  308. package/examples/svelte/lib/ui/base.css +12 -0
  309. package/examples/svelte/lib/ui/layout.ts +18 -0
  310. package/examples/svelte/modules/about/views.ts +8 -0
  311. package/examples/svelte/modules/shop/products.ts +18 -0
  312. package/examples/svelte/modules/shop/shop.css +13 -0
  313. package/examples/svelte/modules/shop/shop.test.ts +28 -0
  314. package/examples/svelte/modules/shop/shop.ts +13 -0
  315. package/examples/svelte/modules/shop/ui/Cart.island.svelte +23 -0
  316. package/examples/svelte/modules/shop/views.ts +16 -0
  317. package/examples/svelte/package.json +35 -0
  318. package/examples/svelte/tsconfig.json +4 -0
  319. package/examples/tailwind/.env.example +2 -0
  320. package/examples/tailwind/README.md +16 -0
  321. package/examples/tailwind/app/assets/site.css +2 -0
  322. package/examples/tailwind/app/entry.ts +28 -0
  323. package/examples/tailwind/app/routes/_middleware.ts +4 -0
  324. package/examples/tailwind/app/routes/health.ts +7 -0
  325. package/examples/tailwind/app/routes/index.ts +30 -0
  326. package/examples/tailwind/configs/Dockerfile +26 -0
  327. package/examples/tailwind/configs/Dockerfile.dockerignore +9 -0
  328. package/examples/tailwind/configs/env.ts +6 -0
  329. package/examples/tailwind/configs/infra.ts +55 -0
  330. package/examples/tailwind/configs/tsconfig.json +15 -0
  331. package/examples/tailwind/configs/vite.ts +7 -0
  332. package/examples/tailwind/configs/vitest.ts +9 -0
  333. package/examples/tailwind/lib/ui/components.ts +21 -0
  334. package/examples/tailwind/lib/ui/layout.ts +21 -0
  335. package/examples/tailwind/lib/ui/theme.css +10 -0
  336. package/examples/tailwind/modules/team/team.test.ts +30 -0
  337. package/examples/tailwind/modules/team/team.ts +34 -0
  338. package/examples/tailwind/modules/team/views.ts +45 -0
  339. package/examples/tailwind/package.json +35 -0
  340. package/examples/tailwind/tsconfig.json +4 -0
  341. package/examples/vue/.env.example +2 -0
  342. package/examples/vue/README.md +18 -0
  343. package/examples/vue/app/assets/site.css +3 -0
  344. package/examples/vue/app/entry.ts +28 -0
  345. package/examples/vue/app/routes/_middleware.ts +4 -0
  346. package/examples/vue/app/routes/about.ts +10 -0
  347. package/examples/vue/app/routes/health.ts +7 -0
  348. package/examples/vue/app/routes/index.ts +12 -0
  349. package/examples/vue/configs/env.ts +6 -0
  350. package/examples/vue/configs/infra.ts +85 -0
  351. package/examples/vue/configs/tsconfig.json +15 -0
  352. package/examples/vue/configs/vite.ts +7 -0
  353. package/examples/vue/configs/vitest.ts +9 -0
  354. package/examples/vue/lib/types/vue.d.ts +8 -0
  355. package/examples/vue/lib/ui/base.css +12 -0
  356. package/examples/vue/lib/ui/layout.ts +18 -0
  357. package/examples/vue/modules/about/views.ts +8 -0
  358. package/examples/vue/modules/shop/products.ts +18 -0
  359. package/examples/vue/modules/shop/shop.css +13 -0
  360. package/examples/vue/modules/shop/shop.test.ts +28 -0
  361. package/examples/vue/modules/shop/shop.ts +13 -0
  362. package/examples/vue/modules/shop/ui/Cart.island.vue +27 -0
  363. package/examples/vue/modules/shop/views.ts +16 -0
  364. package/examples/vue/package.json +35 -0
  365. package/examples/vue/tsconfig.json +4 -0
  366. package/package.json +44 -3
@@ -0,0 +1,55 @@
1
+ // The app's infrastructure: a plain Alchemy stack. `space deploy` runs `alchemy deploy configs/infra.ts`.
2
+ import * as Docker from "@alchemy.run/docker";
3
+ import * as Alchemy from "alchemy";
4
+ import { Effect } from "effect";
5
+ import { variables } from "spacefn/infra";
6
+
7
+ import env from "#configs/env.ts";
8
+ // What the file conventions ask for (databases, ...), as plain data from app/.
9
+ import { app } from "#space/infra.ts";
10
+
11
+ export default Alchemy.Stack(
12
+ app.name,
13
+ {
14
+ providers: Docker.providers(),
15
+ // Deploy state on this machine, in .alchemy/. To deploy from CI or several machines, keep it in
16
+ // a shared store instead, such as Cloudflare.state() from @alchemy.run/cloudflare.
17
+ state: Alchemy.localState(),
18
+ },
19
+ Effect.gen(function* () {
20
+ const environment: Record<string, any> = {
21
+ // configs/env.ts's variables, from .env.<stage> or the environment.
22
+ ...variables(env),
23
+ ...variables({ OTEL_EXPORTER_OTLP_ENDPOINT: "plain", OTEL_EXPORTER_OTLP_HEADERS: "secret" }),
24
+ };
25
+ // app/db/<name>/: a libSQL server reads DB_<NAME>_URL and DB_<NAME>_AUTH_TOKEN; without them, a file in /data.
26
+ for (const db of app.databases)
27
+ Object.assign(
28
+ environment,
29
+ variables({ [`${db.binding}_URL`]: "plain", [`${db.binding}_AUTH_TOKEN`]: "secret" }),
30
+ );
31
+
32
+ // To run it all on another machine, add `context` to each resource below:
33
+ // const context = yield* Docker.Context("Host", { docker: "host=ssh://deploy@example.com" });
34
+ const image = yield* Docker.Image("Image", {
35
+ name: app.name,
36
+ skipPush: true,
37
+ // Built from the source by configs/Dockerfile, which runs vite build.
38
+ build: { context: ".", dockerfile: "configs/Dockerfile" },
39
+ });
40
+ // File databases, the state database and blobs.
41
+ const data = yield* Docker.Volume("Data");
42
+ const port = 3000;
43
+ yield* Docker.Container("App", {
44
+ image,
45
+ start: true,
46
+ restart: "unless-stopped",
47
+ ports: [{ external: port, internal: 3000 }],
48
+ volumes: [{ hostPath: data.name, containerPath: "/data" }],
49
+ environment,
50
+ // SIGTERM lets requests finish and hands queue messages back.
51
+ stopTimeout: "30 seconds",
52
+ });
53
+ return { url: `http://localhost:${port}` };
54
+ }),
55
+ );
@@ -0,0 +1,16 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "lib": ["ES2022", "ESNext.Disposable", "DOM", "DOM.Iterable"],
5
+ "module": "preserve",
6
+ "moduleResolution": "bundler",
7
+ "allowImportingTsExtensions": true,
8
+ "verbatimModuleSyntax": true,
9
+ "strict": true,
10
+ "noEmit": true,
11
+ "skipLibCheck": true,
12
+ "types": [],
13
+ "jsx": "react-jsx"
14
+ },
15
+ "include": ["../app", "../lib", "../modules", "../configs"]
16
+ }
@@ -0,0 +1,7 @@
1
+ import react from "@vitejs/plugin-react";
2
+ import { space } from "spacefn/vite";
3
+ import { defineConfig } from "vite";
4
+
5
+ // React's own Vite plugin, beside spacefn's: it compiles the components that
6
+ // islands are. Pages stay server-rendered html.
7
+ export default defineConfig({ plugins: [react(), space({ target: "bun" })] });
@@ -0,0 +1,9 @@
1
+ import { defineConfig, mergeConfig } from "vitest/config";
2
+
3
+ import vite from "./vite.ts";
4
+
5
+ // The app's Vite config, so tests get the spacefn plugin (and spacefn/assets) too.
6
+ export default mergeConfig(
7
+ vite,
8
+ defineConfig({ test: { include: ["{app,lib,modules}/**/*.test.ts"] } }),
9
+ );
@@ -0,0 +1,12 @@
1
+ /* The base styles every page shares. */
2
+ :root {
3
+ --space: 0.5rem;
4
+ color-scheme: light dark;
5
+ font-family: system-ui, sans-serif;
6
+ }
7
+ body {
8
+ max-width: 32rem;
9
+ margin: calc(var(--space) * 6) auto;
10
+ padding: 0 calc(var(--space) * 2);
11
+ line-height: 1.5;
12
+ }
@@ -0,0 +1,18 @@
1
+ import { html, type HtmlValue } from "spacefn";
2
+ import { assets } from "spacefn/assets";
3
+
4
+ /** The HTML around every page: its title, the site's styles and the links between pages. */
5
+ export const layout = (title: string, body: HtmlValue) =>
6
+ html`<!doctype html>
7
+ <html lang="en">
8
+ <head>
9
+ <meta charset="utf-8" />
10
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
11
+ <title>${title}</title>
12
+ ${assets("site")}
13
+ </head>
14
+ <body>
15
+ <nav><a href="/">Shop</a> · <a href="/about">About</a></nav>
16
+ ${body}
17
+ </body>
18
+ </html>`;
@@ -0,0 +1,8 @@
1
+ import { html } from "spacefn";
2
+
3
+ /** The about page's body: plain server-rendered HTML, with no island. */
4
+ export const aboutPage = () =>
5
+ html`<main>
6
+ <h1>About</h1>
7
+ <p>This page is plain server-rendered HTML: it loads the site's styles, and not the cart.</p>
8
+ </main>`;
@@ -0,0 +1,18 @@
1
+ // Shared by the server, which renders the page, and the browser, which runs the cart:
2
+ // so this file imports nothing server-only.
3
+
4
+ export interface Product {
5
+ readonly id: string;
6
+ readonly name: string;
7
+ /** In cents. */
8
+ readonly price: number;
9
+ }
10
+
11
+ /** What the shop sells. */
12
+ export const PRODUCTS: readonly Product[] = [
13
+ { id: "mug", name: "Mug", price: 1200 },
14
+ { id: "shirt", name: "T-shirt", price: 2500 },
15
+ { id: "sticker", name: "Sticker", price: 300 },
16
+ ];
17
+
18
+ export const formatPrice = (cents: number) => `$${(cents / 100).toFixed(2)}`;
@@ -0,0 +1,13 @@
1
+ /* The shop: the cart, as its island renders it. */
2
+ .cart ul {
3
+ padding: 0;
4
+ list-style: none;
5
+ }
6
+ .cart li {
7
+ display: flex;
8
+ gap: var(--space);
9
+ align-items: center;
10
+ }
11
+ .cart li span {
12
+ flex: 1;
13
+ }
@@ -0,0 +1,28 @@
1
+ import { Layer } from "effect";
2
+ import { memoryServices, testApp, testEnv } from "spacefn/testing";
3
+ import { describe, expect, it } from "vitest";
4
+
5
+ import Env from "#configs/env.ts";
6
+ import { manifest } from "#space/manifest.ts";
7
+
8
+ const app = () =>
9
+ testApp(manifest, Layer.mergeAll(memoryServices, Env.layer.pipe(Layer.provide(testEnv({})))));
10
+
11
+ describe("the shop", () => {
12
+ it("renders the cart's island with its props, and loads its script once", async () => {
13
+ await using shop = app();
14
+ const page = await (await shop.fetch("/")).text();
15
+ expect(page).toMatch(
16
+ /<spacefn-island name="Cart"[^>]*><script type="application\/json">\{"products":\[\{"id":"mug"/,
17
+ );
18
+ const script = '<script type="module" src="/.space/islands/Cart.ts"></script>';
19
+ expect(page.split(script).length).toBe(2);
20
+ });
21
+
22
+ it("doesn't load the cart on a page without it", async () => {
23
+ await using shop = app();
24
+ const page = await (await shop.fetch("/about")).text();
25
+ expect(page).toContain('<link rel="stylesheet" href="/app/assets/site.css">');
26
+ expect(page).not.toContain("islands/Cart");
27
+ });
28
+ });
@@ -0,0 +1,13 @@
1
+ import { Effect } from "effect";
2
+
3
+ import Env from "#configs/env.ts";
4
+
5
+ import { PRODUCTS } from "./products.ts";
6
+
7
+ /** The shop's name, from configs/env.ts. */
8
+ export const title = Effect.gen(function* () {
9
+ return (yield* Env).SHOP_NAME;
10
+ });
11
+
12
+ /** What the shop sells. An app would read it from a database; the example keeps it in code. */
13
+ export const products = Effect.succeed(PRODUCTS);
@@ -0,0 +1,31 @@
1
+ import { useState } from "react";
2
+
3
+ import { formatPrice, type Product } from "../products.ts";
4
+
5
+ /** The cart: add products, see the total. Its state lives in the browser. */
6
+ export default function Cart({ products }: { readonly products: readonly Product[] }) {
7
+ const [counts, setCounts] = useState<Readonly<Record<string, number>>>({});
8
+ const total = products.reduce(
9
+ (sum, product) => sum + product.price * (counts[product.id] ?? 0),
10
+ 0,
11
+ );
12
+ return (
13
+ <div className="cart">
14
+ <ul>
15
+ {products.map((product) => (
16
+ <li key={product.id}>
17
+ <span>{product.name}</span>{" "}
18
+ <button
19
+ type="button"
20
+ onClick={() => setCounts((c) => ({ ...c, [product.id]: (c[product.id] ?? 0) + 1 }))}
21
+ >
22
+ Add
23
+ </button>{" "}
24
+ <output>{counts[product.id] ?? 0}</output>
25
+ </li>
26
+ ))}
27
+ </ul>
28
+ <p>Total: {formatPrice(total)}</p>
29
+ </div>
30
+ );
31
+ }
@@ -0,0 +1,16 @@
1
+ import { html } from "spacefn";
2
+
3
+ import { island } from "#space/islands.ts";
4
+
5
+ import type { Product } from "./products.ts";
6
+
7
+ /** The shop's page: server-rendered, with the React cart as an island. */
8
+ export const shopPage = (props: {
9
+ readonly title: string;
10
+ readonly products: readonly Product[];
11
+ }) =>
12
+ html`<main>
13
+ <h1>${props.title}</h1>
14
+ ${island("Cart", { products: props.products })}
15
+ <noscript>The cart needs JavaScript.</noscript>
16
+ </main>`;
@@ -0,0 +1,38 @@
1
+ {
2
+ "name": "react",
3
+ "private": true,
4
+ "description": "A React island on a server-rendered spacefn page: a client-only cart, loaded only on the page that uses it.",
5
+ "type": "module",
6
+ "imports": {
7
+ "#configs/*": "./configs/*",
8
+ "#lib/*": "./lib/*",
9
+ "#modules/*": "./modules/*",
10
+ "#space/*": "./.space/*"
11
+ },
12
+ "scripts": {
13
+ "postinstall": "space gen",
14
+ "dev": "space dev",
15
+ "build": "space build",
16
+ "deploy": "space deploy",
17
+ "docs": "space docs",
18
+ "test": "vitest run --config configs/vitest.ts",
19
+ "typecheck": "tsc --noEmit"
20
+ },
21
+ "dependencies": {
22
+ "effect": "4.1.4",
23
+ "react": "19.3.1",
24
+ "react-dom": "19.3.1",
25
+ "spacefn": "^0.11.0"
26
+ },
27
+ "devDependencies": {
28
+ "@alchemy.run/docker": "2.0.0-beta.87",
29
+ "@types/react": "19.3.0",
30
+ "@types/react-dom": "19.3.0",
31
+ "@vitejs/plugin-react": "6.2.1",
32
+ "alchemy": "2.0.0-beta.87",
33
+ "spacefn-docs": "^0.11.0",
34
+ "typescript": "^7.0.2",
35
+ "vite": "8.3.8",
36
+ "vitest": "5.1.1"
37
+ }
38
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "//": "Editors and tsc look for this file here; the settings are in configs/tsconfig.json.",
3
+ "extends": "./configs/tsconfig.json"
4
+ }
@@ -0,0 +1,10 @@
1
+ # services-bun
2
+
3
+ spacefn's services on Bun: KV, a queue with its consumer, a cron, `public/` and the client build, deployed to a Docker container. spacefn's tests run it with `space dev`, build it, and deploy it to local Docker on port 4890.
4
+
5
+ ```sh
6
+ pnpm dev # Vite, with the queue and cron in-process
7
+ pnpm build && pnpm deploy # the image takes dist/; see configs/Dockerfile
8
+ ```
9
+
10
+ `app/` only wires: the routes, the queue and the cron call `modules/status/`, and `lib/ui/` has the layout and base styles.
@@ -0,0 +1,4 @@
1
+ // The browser entry, loaded by assets("main").
2
+ import { markReady } from "#modules/status/client/ready.ts";
3
+
4
+ markReady();
@@ -0,0 +1 @@
1
+ @import "#lib/ui/base.css";
@@ -0,0 +1,5 @@
1
+ import { cron } from "spacefn";
2
+
3
+ import * as Status from "#modules/status/status.ts";
4
+
5
+ export default cron("0 3 * * *", Status.nightly);
@@ -0,0 +1,9 @@
1
+ import { app, databases, staticFiles, telemetry } from "spacefn";
2
+ import { platform } from "spacefn/platform";
3
+
4
+ import { manifest } from "#space/manifest.ts";
5
+
6
+ export default app(manifest, {
7
+ services: [platform(manifest), databases(manifest), telemetry(manifest.name)],
8
+ before: [staticFiles()],
9
+ });
@@ -0,0 +1,5 @@
1
+ import { queue } from "spacefn";
2
+
3
+ import * as Status from "#modules/status/status.ts";
4
+
5
+ export default queue({ body: Status.Job, handler: Status.runJob });
@@ -0,0 +1,10 @@
1
+ import { Effect } from "effect";
2
+ import { route } from "spacefn";
3
+
4
+ import { layout } from "#lib/ui/layout.ts";
5
+ import * as Status from "#modules/status/status.ts";
6
+ import { statusView } from "#modules/status/views.ts";
7
+
8
+ export default route({
9
+ GET: Effect.map(Status.overview, (status) => layout(statusView(status))),
10
+ });
@@ -0,0 +1,5 @@
1
+ import { route } from "spacefn";
2
+
3
+ import * as Status from "#modules/status/status.ts";
4
+
5
+ export default route({ GET: Status.runtime });
@@ -0,0 +1,8 @@
1
+ import { Effect } from "effect";
2
+ import { route } from "spacefn";
3
+
4
+ import * as Status from "#modules/status/status.ts";
5
+
6
+ export default route({
7
+ POST: Effect.as(Status.sendJob("dev"), { queued: true }),
8
+ });
@@ -0,0 +1,5 @@
1
+ import { Effect } from "effect";
2
+ import { route } from "spacefn";
3
+
4
+ // The dev test edits this text, to see the edit served on the next request.
5
+ export default route({ GET: Effect.succeed("v1") });
@@ -0,0 +1,10 @@
1
+ # In the spacefn repo, spacefn is a workspace link, which an image can't install, so this
2
+ # Dockerfile takes the dist/ that `space build` wrote. A new app's builds from source.
3
+ FROM oven/bun:1.4.4-slim
4
+ WORKDIR /app
5
+ COPY dist .
6
+ RUN cd server && bun install --production --no-save \
7
+ && mkdir -p /data && chown bun:bun /data
8
+ ENV NODE_ENV=production PORT=3000 SPACE_DATA_DIR=/data
9
+ USER bun
10
+ CMD ["bun", "server/index.js"]
@@ -0,0 +1,4 @@
1
+ node_modules
2
+ .space
3
+ .alchemy
4
+ dist/server/node_modules
@@ -0,0 +1,28 @@
1
+ // A new Bun app's stack, on port 4890 (the Docker deploy test's), without configs/env.ts.
2
+ import * as Docker from "@alchemy.run/docker";
3
+ import * as Alchemy from "alchemy";
4
+ import { Effect } from "effect";
5
+
6
+ import { app } from "#space/infra.ts";
7
+
8
+ export default Alchemy.Stack(
9
+ app.name,
10
+ { providers: Docker.providers(), state: Alchemy.localState() },
11
+ Effect.gen(function* () {
12
+ const image = yield* Docker.Image("Image", {
13
+ name: app.name,
14
+ skipPush: true,
15
+ build: { context: ".", dockerfile: "configs/Dockerfile" },
16
+ });
17
+ const data = yield* Docker.Volume("Data");
18
+ yield* Docker.Container("App", {
19
+ image,
20
+ start: true,
21
+ restart: "unless-stopped",
22
+ ports: [{ external: 4890, internal: 3000 }],
23
+ volumes: [{ hostPath: data.name, containerPath: "/data" }],
24
+ stopTimeout: "30 seconds",
25
+ });
26
+ return { url: "http://localhost:4890" };
27
+ }),
28
+ );
@@ -0,0 +1,15 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "lib": ["ES2022", "ESNext.Disposable", "DOM", "DOM.Iterable"],
5
+ "module": "preserve",
6
+ "moduleResolution": "bundler",
7
+ "allowImportingTsExtensions": true,
8
+ "verbatimModuleSyntax": true,
9
+ "strict": true,
10
+ "noEmit": true,
11
+ "skipLibCheck": true,
12
+ "types": []
13
+ },
14
+ "include": ["../app", "../lib", "../modules", "../configs"]
15
+ }
@@ -0,0 +1,4 @@
1
+ import { space } from "spacefn/vite";
2
+ import { defineConfig } from "vite";
3
+
4
+ export default defineConfig({ plugins: [space({ target: "bun" })] });
@@ -0,0 +1,3 @@
1
+ body {
2
+ color: rebeccapurple;
3
+ }
@@ -0,0 +1,13 @@
1
+ import { html, type HtmlValue } from "spacefn";
2
+ import { assets } from "spacefn/assets";
3
+
4
+ export const layout = (body: HtmlValue) =>
5
+ html`<!doctype html>
6
+ <html>
7
+ <head>
8
+ ${assets("style", "main")}
9
+ </head>
10
+ <body>
11
+ ${body}
12
+ </body>
13
+ </html>`;
@@ -0,0 +1,4 @@
1
+ /** Marks the page once the client build ran. */
2
+ export const markReady = () => {
3
+ document.body.dataset.client = "ready";
4
+ };
@@ -0,0 +1,20 @@
1
+ import { Effect, Option, Schema } from "effect";
2
+ import { Kv, Queue } from "spacefn";
3
+
4
+ /** What the `jobs` queue carries: where the job was sent from. */
5
+ export const Job = Schema.Struct({ at: Schema.String });
6
+
7
+ /** What the last job left in KV, or `none`. */
8
+ export const overview = Effect.map(Kv.get("job"), (job) => ({
9
+ job: Option.getOrElse(job, () => "none"),
10
+ }));
11
+
12
+ export const sendJob = (at: string) => Queue.send("jobs", { at });
13
+
14
+ /** The queue consumer: records that the job ran. */
15
+ export const runJob = ({ at }: typeof Job.Type) => Kv.set("job", `done in ${at}`);
16
+
17
+ /** Which runtime serves the app: `bun`, or `node` under Vite in dev. */
18
+ export const runtime = Effect.sync(() => ("Bun" in globalThis ? "bun" : "node"));
19
+
20
+ export const nightly = Effect.log("nightly run");
@@ -0,0 +1,4 @@
1
+ import { html } from "spacefn";
2
+
3
+ /** What the last job left, for the dev and deploy tests to read. */
4
+ export const statusView = (status: { readonly job: string }) => html`<p>${status.job}</p>`;
@@ -0,0 +1,30 @@
1
+ {
2
+ "name": "services-bun",
3
+ "private": true,
4
+ "description": "The services on Bun, deployed to Docker: KV, a queue, a cron, public/ and the client build. spacefn's dev, build and Docker tests run it.",
5
+ "type": "module",
6
+ "imports": {
7
+ "#configs/*": "./configs/*",
8
+ "#lib/*": "./lib/*",
9
+ "#modules/*": "./modules/*",
10
+ "#space/*": "./.space/*"
11
+ },
12
+ "scripts": {
13
+ "postinstall": "space gen",
14
+ "dev": "space dev",
15
+ "build": "space build",
16
+ "deploy": "space deploy",
17
+ "typecheck": "tsc --noEmit"
18
+ },
19
+ "dependencies": {
20
+ "effect": "4.1.4",
21
+ "spacefn": "^0.11.0"
22
+ },
23
+ "devDependencies": {
24
+ "@alchemy.run/docker": "2.0.0-beta.87",
25
+ "alchemy": "2.0.0-beta.87",
26
+ "spacefn-docs": "^0.11.0",
27
+ "typescript": "^7.0.2",
28
+ "vite": "8.3.8"
29
+ }
30
+ }
@@ -0,0 +1 @@
1
+ User-agent: *
@@ -0,0 +1,4 @@
1
+ {
2
+ "//": "Editors and tsc look for this file here; the settings are in configs/tsconfig.json.",
3
+ "extends": "./configs/tsconfig.json"
4
+ }
@@ -0,0 +1,9 @@
1
+ # services-cloudflare
2
+
3
+ Every binding a Cloudflare deploy creates, in use: D1 (`app/db/main/`), KV, R2, a queue with its consumer, a cron and the rate limiter. spacefn's tests run it with `alchemy dev` and read what each binding holds from `/`.
4
+
5
+ ```sh
6
+ pnpm dev # alchemy dev: every binding, locally
7
+ ```
8
+
9
+ `app/` only wires: the routes, the queue and the cron call `modules/status/` and `modules/files/`, and `lib/ui/layout.ts` is the HTML around the page.
@@ -0,0 +1,4 @@
1
+ // The browser entry, loaded by assets("main").
2
+ import { markReady } from "#modules/status/client/ready.ts";
3
+
4
+ markReady();
@@ -0,0 +1,5 @@
1
+ import { cron } from "spacefn";
2
+
3
+ import * as Status from "#modules/status/status.ts";
4
+
5
+ export default cron("0 3 * * *", Status.nightly);
@@ -0,0 +1,4 @@
1
+ {
2
+ "driver": "d1",
3
+ "migrateOn": "startup"
4
+ }
@@ -0,0 +1,2 @@
1
+ -- up
2
+ CREATE TABLE notes (id INTEGER PRIMARY KEY, text TEXT NOT NULL);
@@ -0,0 +1 @@
1
+ INSERT INTO notes (text) VALUES (:text);
@@ -0,0 +1,3 @@
1
+ -- :one
2
+ -- @column n number
3
+ SELECT count(*) AS n FROM notes;
@@ -0,0 +1,10 @@
1
+ import { app, databases, staticFiles, telemetry } from "spacefn";
2
+ import { platform } from "spacefn/platform";
3
+
4
+ import Env from "#configs/env.ts";
5
+ import { manifest } from "#space/manifest.ts";
6
+
7
+ export default app(manifest, {
8
+ services: [platform(manifest), Env.layer, databases(manifest), telemetry(manifest.name)],
9
+ before: [staticFiles()],
10
+ });
@@ -0,0 +1,5 @@
1
+ import { queue } from "spacefn";
2
+
3
+ import * as Status from "#modules/status/status.ts";
4
+
5
+ export default queue({ body: Status.Job, handler: Status.runJob });
@@ -0,0 +1,5 @@
1
+ import { route } from "spacefn";
2
+
3
+ import * as Files from "#modules/files/files.ts";
4
+
5
+ export default route({ GET: Files.roundTrip });
@@ -0,0 +1,10 @@
1
+ import { Effect } from "effect";
2
+ import { route } from "spacefn";
3
+
4
+ import { layout } from "#lib/ui/layout.ts";
5
+ import * as Status from "#modules/status/status.ts";
6
+ import { statusView } from "#modules/status/views.ts";
7
+
8
+ export default route({
9
+ GET: Effect.map(Status.overview, (status) => layout(statusView(status))),
10
+ });
@@ -0,0 +1,7 @@
1
+ import { Effect } from "effect";
2
+ import { rateLimit, route } from "spacefn";
3
+
4
+ // Two requests a minute, then 429.
5
+ export default route({
6
+ GET: Effect.as(rateLimit("limited", { limit: 2, window: "1 minute" }), "ok"),
7
+ });