create-cloudflare 0.0.0-4e63ec08 → 0.0.0-4e69fb6f0

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 (284) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +59532 -58708
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +35 -27
  5. package/templates/analog/c3.ts +135 -0
  6. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  7. package/templates/analog/templates/env.d.ts +13 -0
  8. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  9. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  10. package/templates/analog/templates/wrangler.jsonc +5 -0
  11. package/templates/angular/c3.ts +5 -96
  12. package/templates/angular/pages/c3.ts +135 -0
  13. package/templates/angular/pages/templates/src/server.ts +15 -0
  14. package/templates/angular/pages/templates/tools/copy-files.mjs +15 -0
  15. package/templates/angular/workers/c3.ts +130 -0
  16. package/templates/angular/workers/templates/src/server.ts +15 -0
  17. package/templates/angular/workers/templates/wrangler.jsonc +12 -0
  18. package/templates/astro/c3.ts +5 -108
  19. package/templates/astro/pages/c3.ts +99 -0
  20. package/templates/astro/pages/templates/js/wrangler.jsonc +8 -0
  21. package/templates/astro/pages/templates/ts/worker-configuration.d.ts +4 -0
  22. package/templates/astro/pages/templates/ts/wrangler.jsonc +8 -0
  23. package/templates/astro/workers/c3.ts +98 -0
  24. package/templates/astro/workers/templates/js/public/.assetsignore +2 -0
  25. package/templates/astro/workers/templates/js/wrangler.jsonc +15 -0
  26. package/templates/astro/workers/templates/ts/public/.assetsignore +2 -0
  27. package/templates/astro/workers/templates/ts/src/env.d.ts +5 -0
  28. package/templates/astro/workers/templates/ts/worker-configuration.d.ts +4 -0
  29. package/templates/astro/workers/templates/ts/wrangler.jsonc +15 -0
  30. package/templates/common/c3.ts +8 -1
  31. package/templates/common/js/package.json +1 -1
  32. package/templates/common/js/wrangler.jsonc +8 -0
  33. package/templates/common/ts/package.json +4 -3
  34. package/templates/common/ts/src/ab-test.ts +2 -2
  35. package/templates/common/ts/src/index.ts +5 -2
  36. package/templates/common/ts/src/proxy.ts +2 -2
  37. package/templates/common/ts/src/redirect.ts +2 -2
  38. package/templates/common/ts/tsconfig.json +37 -95
  39. package/templates/common/ts/worker-configuration.d.ts +2 -14
  40. package/templates/common/ts/wrangler.jsonc +8 -0
  41. package/templates/docusaurus/c3.ts +5 -22
  42. package/templates/docusaurus/pages/c3.ts +31 -0
  43. package/templates/docusaurus/workers/c3.ts +33 -0
  44. package/templates/docusaurus/workers/templates/wrangler.jsonc +10 -0
  45. package/templates/gatsby/c3.ts +5 -44
  46. package/templates/gatsby/pages/c3.ts +51 -0
  47. package/templates/gatsby/workers/c3.ts +53 -0
  48. package/templates/gatsby/workers/templates/wrangler.jsonc +10 -0
  49. package/templates/hello-world/c3.ts +23 -2
  50. package/templates/hello-world/js/package.json +3 -3
  51. package/templates/hello-world/js/test/index.spec.js +17 -17
  52. package/templates/hello-world/js/vitest.config.js +8 -8
  53. package/templates/hello-world/js/wrangler.jsonc +8 -0
  54. package/templates/hello-world/py/.python-version +1 -0
  55. package/templates/hello-world/py/README.md +23 -0
  56. package/templates/hello-world/py/__dot__gitignore +68 -0
  57. package/templates/hello-world/py/package.json +13 -0
  58. package/templates/hello-world/py/pyproject.toml +9 -0
  59. package/templates/hello-world/py/uv.lock +22 -0
  60. package/templates/hello-world/py/wrangler.jsonc +9 -0
  61. package/templates/hello-world/ts/package.json +6 -5
  62. package/templates/hello-world/ts/src/index.ts +5 -19
  63. package/templates/hello-world/ts/test/env.d.ts +3 -0
  64. package/templates/hello-world/ts/test/index.spec.ts +17 -17
  65. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  66. package/templates/hello-world/ts/tsconfig.json +38 -96
  67. package/templates/hello-world/ts/vitest.config.mts +11 -0
  68. package/templates/hello-world/ts/worker-configuration.d.ts +8 -0
  69. package/templates/hello-world/ts/wrangler.jsonc +8 -0
  70. package/templates/hello-world-assets-only/c3.ts +16 -0
  71. package/templates/{hello-world-python/py → hello-world-assets-only/templates}/package.json +1 -1
  72. package/templates/hello-world-assets-only/templates/public/index.html +11 -0
  73. package/templates/hello-world-assets-only/templates/wrangler.jsonc +10 -0
  74. package/templates/hello-world-durable-object/c3.ts +7 -2
  75. package/templates/hello-world-durable-object/js/package.json +1 -1
  76. package/templates/hello-world-durable-object/js/src/index.js +28 -23
  77. package/templates/hello-world-durable-object/js/wrangler.jsonc +24 -0
  78. package/templates/hello-world-durable-object/ts/package.json +4 -4
  79. package/templates/hello-world-durable-object/ts/src/index.ts +32 -44
  80. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  81. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +7 -0
  82. package/templates/hello-world-durable-object/ts/wrangler.jsonc +24 -0
  83. package/templates/hello-world-durable-object-with-assets/c3.ts +23 -0
  84. package/templates/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  85. package/templates/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  86. package/templates/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  87. package/templates/hello-world-durable-object-with-assets/js/package.json +13 -0
  88. package/templates/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  89. package/templates/hello-world-durable-object-with-assets/js/src/index.js +70 -0
  90. package/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc +28 -0
  91. package/templates/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  92. package/templates/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  93. package/templates/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  94. package/templates/hello-world-durable-object-with-assets/ts/package.json +15 -0
  95. package/templates/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  96. package/templates/hello-world-durable-object-with-assets/ts/src/index.ts +67 -0
  97. package/templates/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  98. package/templates/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +8 -0
  99. package/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc +28 -0
  100. package/templates/hello-world-with-assets/c3.ts +24 -0
  101. package/templates/hello-world-with-assets/js/.editorconfig +12 -0
  102. package/templates/hello-world-with-assets/js/.prettierrc +6 -0
  103. package/templates/hello-world-with-assets/js/__dot__gitignore +172 -0
  104. package/templates/hello-world-with-assets/js/package.json +16 -0
  105. package/templates/hello-world-with-assets/js/public/index.html +31 -0
  106. package/templates/hello-world-with-assets/js/src/index.js +23 -0
  107. package/templates/hello-world-with-assets/js/test/index.spec.js +41 -0
  108. package/templates/hello-world-with-assets/js/vitest.config.js +11 -0
  109. package/templates/hello-world-with-assets/js/wrangler.jsonc +15 -0
  110. package/templates/hello-world-with-assets/py/package.json +13 -0
  111. package/templates/hello-world-with-assets/py/public/index.html +31 -0
  112. package/templates/hello-world-with-assets/py/src/entry.py +9 -0
  113. package/templates/hello-world-with-assets/py/wrangler.jsonc +15 -0
  114. package/templates/hello-world-with-assets/ts/.editorconfig +12 -0
  115. package/templates/hello-world-with-assets/ts/.prettierrc +6 -0
  116. package/templates/hello-world-with-assets/ts/__dot__gitignore +172 -0
  117. package/templates/hello-world-with-assets/ts/package.json +18 -0
  118. package/templates/hello-world-with-assets/ts/public/index.html +31 -0
  119. package/templates/hello-world-with-assets/ts/src/index.ts +26 -0
  120. package/templates/hello-world-with-assets/ts/test/env.d.ts +3 -0
  121. package/templates/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  122. package/templates/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  123. package/templates/hello-world-with-assets/ts/tsconfig.json +44 -0
  124. package/templates/hello-world-with-assets/ts/vitest.config.mts +11 -0
  125. package/templates/hello-world-with-assets/ts/worker-configuration.d.ts +7 -0
  126. package/templates/hello-world-with-assets/ts/wrangler.jsonc +15 -0
  127. package/templates/hono/c3.ts +5 -21
  128. package/templates/hono/pages/c3.ts +44 -0
  129. package/templates/hono/pages/templates/src/index.tsx +12 -0
  130. package/templates/hono/pages/templates/worker-configuration.d.ts +4 -0
  131. package/templates/hono/pages/templates/wrangler.jsonc +8 -0
  132. package/templates/hono/workers/c3.ts +42 -0
  133. package/templates/hono/workers/templates/public/index.html +19 -0
  134. package/templates/hono/workers/templates/src/index.ts +9 -0
  135. package/templates/hono/workers/templates/worker-configuration.d.ts +4 -0
  136. package/templates/hono/workers/templates/wrangler.jsonc +9 -0
  137. package/templates/next/c3.ts +7 -234
  138. package/templates/next/{README.md → pages/README.md} +9 -10
  139. package/templates/next/{app → pages/app}/js/app/api/hello/route.js +4 -4
  140. package/templates/next/{app → pages/app}/ts/app/api/hello/route.ts +4 -5
  141. package/templates/next/pages/c3.ts +225 -0
  142. package/templates/next/pages/wrangler.jsonc +8 -0
  143. package/templates/next/workers/c3.ts +74 -0
  144. package/templates/next/workers/templates/.dev.vars +2 -0
  145. package/templates/next/workers/templates/__dot__gitignore +39 -0
  146. package/templates/next/workers/templates/cloudflare-env.d.ts +5 -0
  147. package/templates/next/workers/templates/open-next.config.ts +6 -0
  148. package/templates/next/workers/templates/wrangler.jsonc +12 -0
  149. package/templates/nuxt/c3.ts +5 -130
  150. package/templates/nuxt/pages/c3.ts +147 -0
  151. package/templates/nuxt/pages/templates/worker-configuration.d.ts +4 -0
  152. package/templates/nuxt/pages/templates/wrangler.jsonc +5 -0
  153. package/templates/nuxt/workers/c3.ts +146 -0
  154. package/templates/nuxt/workers/templates/env.d.ts +14 -0
  155. package/templates/nuxt/workers/templates/worker-configuration.d.ts +4 -0
  156. package/templates/nuxt/workers/templates/wrangler.jsonc +12 -0
  157. package/templates/openapi/c3.ts +6 -1
  158. package/templates/openapi/ts/README.md +3 -3
  159. package/templates/openapi/ts/package.json +7 -4
  160. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  161. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  162. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  163. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  164. package/templates/openapi/ts/src/index.ts +14 -20
  165. package/templates/openapi/ts/src/types.ts +9 -8
  166. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  167. package/templates/openapi/ts/wrangler.jsonc +8 -0
  168. package/templates/pre-existing/c3.ts +41 -18
  169. package/templates/pre-existing/js/package.json +1 -1
  170. package/templates/queues/c3.ts +7 -1
  171. package/templates/queues/js/package.json +1 -1
  172. package/templates/queues/js/wrangler.jsonc +21 -0
  173. package/templates/queues/ts/package.json +4 -3
  174. package/templates/queues/ts/src/index.ts +6 -8
  175. package/templates/queues/ts/tsconfig.json +36 -95
  176. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  177. package/templates/queues/ts/wrangler.jsonc +21 -0
  178. package/templates/qwik/c3.ts +5 -142
  179. package/templates/qwik/pages/c3.ts +150 -0
  180. package/templates/qwik/pages/templates/worker-configuration.d.ts +4 -0
  181. package/templates/qwik/pages/templates/wrangler.jsonc +8 -0
  182. package/templates/qwik/workers/c3.ts +154 -0
  183. package/templates/qwik/workers/snippets/getPlatformProxy.ts +6 -0
  184. package/templates/qwik/workers/templates/public/.assetsignore +4 -0
  185. package/templates/qwik/workers/templates/worker-configuration.d.ts +4 -0
  186. package/templates/qwik/workers/templates/wrangler.jsonc +15 -0
  187. package/templates/react/c3.ts +5 -27
  188. package/templates/react/pages/c3.ts +63 -0
  189. package/templates/react/workers/c3.ts +183 -0
  190. package/templates/react/workers/js/src/App.css +45 -0
  191. package/templates/react/workers/js/src/App.jsx +58 -0
  192. package/templates/react/workers/js/src/assets/Cloudflare_Logo.svg +53 -0
  193. package/templates/react/workers/js/worker/index.js +13 -0
  194. package/templates/react/workers/js/wrangler.jsonc +9 -0
  195. package/templates/react/workers/ts/src/App.css +45 -0
  196. package/templates/react/workers/ts/src/App.tsx +58 -0
  197. package/templates/react/workers/ts/src/assets/Cloudflare_Logo.svg +51 -0
  198. package/templates/react/workers/ts/tsconfig.worker.json +8 -0
  199. package/templates/react/workers/ts/worker/index.ts +12 -0
  200. package/templates/react/workers/ts/worker-configuration.d.ts +5 -0
  201. package/templates/react/workers/ts/wrangler.jsonc +9 -0
  202. package/templates/react-router/c3.ts +53 -0
  203. package/templates/react-router/templates/worker-configuration.d.ts +8 -0
  204. package/templates/remix/c3.ts +6 -62
  205. package/templates/remix/pages/c3.ts +69 -0
  206. package/templates/remix/pages/templates/worker-configuration.d.ts +4 -0
  207. package/templates/remix/pages/templates/wrangler.jsonc +5 -0
  208. package/templates/remix/workers/c3.ts +52 -0
  209. package/templates/remix/workers/templates/public/.assetsignore +0 -0
  210. package/templates/remix/{templates → workers/templates}/worker-configuration.d.ts +1 -1
  211. package/templates/remix/workers/templates/wrangler.toml +11 -0
  212. package/templates/scheduled/c3.ts +7 -1
  213. package/templates/scheduled/js/package.json +3 -3
  214. package/templates/scheduled/js/src/index.js +9 -2
  215. package/templates/scheduled/js/wrangler.jsonc +13 -0
  216. package/templates/scheduled/ts/package.json +5 -4
  217. package/templates/scheduled/ts/src/index.ts +15 -25
  218. package/templates/scheduled/ts/tsconfig.json +36 -95
  219. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  220. package/templates/scheduled/ts/wrangler.jsonc +13 -0
  221. package/templates/solid/c3.ts +18 -13
  222. package/templates/solid/templates/wrangler.jsonc +8 -0
  223. package/templates/svelte/c3.ts +6 -127
  224. package/templates/svelte/pages/c3.ts +160 -0
  225. package/templates/svelte/pages/templates/wrangler.jsonc +5 -0
  226. package/templates/svelte/workers/c3.ts +129 -0
  227. package/templates/svelte/workers/templates/static/.assetsignore +2 -0
  228. package/templates/svelte/workers/templates/wrangler.jsonc +12 -0
  229. package/templates/vue/c3.ts +5 -24
  230. package/templates/vue/pages/c3.ts +31 -0
  231. package/templates/vue/workers/c3.ts +98 -0
  232. package/templates/vue/workers/js/server/index.js +13 -0
  233. package/templates/vue/workers/js/src/App.vue +107 -0
  234. package/templates/vue/workers/js/src/components/HelloWorld.vue +47 -0
  235. package/templates/vue/workers/js/vite.config.js +21 -0
  236. package/templates/vue/workers/js/wrangler.jsonc +11 -0
  237. package/templates/vue/workers/ts/server/index.ts +12 -0
  238. package/templates/vue/workers/ts/src/App.vue +107 -0
  239. package/templates/vue/workers/ts/src/components/HelloWorld.vue +44 -0
  240. package/templates/vue/workers/ts/tsconfig.worker.json +8 -0
  241. package/templates/vue/workers/ts/vite.config.ts +21 -0
  242. package/templates/vue/workers/ts/worker-configuration.d.ts +6 -0
  243. package/templates/vue/workers/ts/wrangler.jsonc +11 -0
  244. package/templates-experimental/solid/c3.ts +94 -0
  245. package/templates-experimental/solid/templates/wrangler.jsonc +15 -0
  246. package/templates/angular/templates/server.ts +0 -34
  247. package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
  248. package/templates/angular/templates/tools/copy-files.mjs +0 -9
  249. package/templates/angular/templates/tools/paths.mjs +0 -9
  250. package/templates/astro/templates/wrangler.toml +0 -53
  251. package/templates/common/js/wrangler.toml +0 -98
  252. package/templates/common/ts/wrangler.toml +0 -98
  253. package/templates/hello-world/js/wrangler.toml +0 -99
  254. package/templates/hello-world/ts/vitest.config.ts +0 -11
  255. package/templates/hello-world/ts/wrangler.toml +0 -99
  256. package/templates/hello-world-durable-object/js/wrangler.toml +0 -98
  257. package/templates/hello-world-durable-object/ts/wrangler.toml +0 -99
  258. package/templates/hello-world-python/c3.ts +0 -9
  259. package/templates/hello-world-python/py/wrangler.toml +0 -5
  260. package/templates/next/wrangler.toml +0 -55
  261. package/templates/nuxt/templates/worker-configuration.d.ts +0 -4
  262. package/templates/nuxt/templates/wrangler.toml +0 -53
  263. package/templates/openapi/ts/wrangler.toml +0 -4
  264. package/templates/pre-existing/js/wrangler.toml +0 -4
  265. package/templates/queues/js/wrangler.toml +0 -103
  266. package/templates/queues/ts/wrangler.toml +0 -103
  267. package/templates/qwik/templates/worker-configuration.d.ts +0 -4
  268. package/templates/qwik/templates/wrangler.toml +0 -53
  269. package/templates/remix/templates/wrangler.toml +0 -53
  270. package/templates/scheduled/js/wrangler.toml +0 -104
  271. package/templates/scheduled/ts/wrangler.toml +0 -104
  272. package/templates/svelte/js/wrangler.toml +0 -53
  273. package/templates/svelte/ts/wrangler.toml +0 -53
  274. /package/templates/angular/{templates → pages/templates}/src/_routes.json +0 -0
  275. /package/templates/astro/{snippets/runtimeDeclaration.ts → pages/templates/ts/src/env.d.ts} +0 -0
  276. /package/templates/{hello-world-python → hello-world}/py/src/entry.py +0 -0
  277. /package/templates/{hello-world-python → hello-world-with-assets}/py/__dot__gitignore +0 -0
  278. /package/templates/next/{app → pages/app}/js/app/not-found.js +0 -0
  279. /package/templates/next/{app → pages/app}/ts/app/not-found.tsx +0 -0
  280. /package/templates/next/{env.d.ts → pages/env.d.ts} +0 -0
  281. /package/templates/next/pages/{js → pages/js}/pages/api/hello.js +0 -0
  282. /package/templates/next/pages/{ts → pages/ts}/pages/api/hello.ts +0 -0
  283. /package/templates/nuxt/{templates → pages/templates}/env.d.ts +0 -0
  284. /package/templates/qwik/{snippets → pages/snippets}/getPlatformProxy.ts +0 -0
@@ -0,0 +1,39 @@
1
+ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2
+
3
+ # dependencies
4
+ /node_modules
5
+ /.pnp
6
+ .pnp.js
7
+ .yarn/install-state.gz
8
+
9
+ # testing
10
+ /coverage
11
+
12
+ # next.js
13
+ /.next/
14
+ /out/
15
+
16
+ # production
17
+ /build
18
+
19
+ # misc
20
+ .DS_Store
21
+ *.pem
22
+
23
+ # debug
24
+ npm-debug.log*
25
+ yarn-debug.log*
26
+ yarn-error.log*
27
+
28
+ # local env files
29
+ .env*.local
30
+
31
+ # vercel
32
+ .vercel
33
+
34
+ # typescript
35
+ *.tsbuildinfo
36
+ next-env.d.ts
37
+
38
+ # OpenNext
39
+ /.open-next
@@ -0,0 +1,5 @@
1
+ // Generated by Wrangler
2
+ // by running `wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts`
3
+
4
+ interface CloudflareEnv {
5
+ }
@@ -0,0 +1,6 @@
1
+ import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2
+ import r2IncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache";
3
+
4
+ export default defineCloudflareConfig({
5
+ incrementalCache: r2IncrementalCache,
6
+ });
@@ -0,0 +1,12 @@
1
+ {
2
+ "name": "<app-name>",
3
+ "main": ".open-next/worker.js",
4
+ "compatibility_date": "2025-03-01",
5
+ "compatibility_flags": [
6
+ "nodejs_compat"
7
+ ],
8
+ "assets": {
9
+ "binding": "ASSETS",
10
+ "directory": ".open-next/assets"
11
+ }
12
+ }
@@ -1,134 +1,9 @@
1
- import { logRaw } from "@cloudflare/cli";
2
- import { brandColor, dim } from "@cloudflare/cli/colors";
3
- import { spinner } from "@cloudflare/cli/interactive";
4
- import { runFrameworkGenerator } from "frameworks/index";
5
- import { transformFile } from "helpers/codemod";
6
- import { getLatestTypesEntrypoint } from "helpers/compatDate";
7
- import { readFile, writeFile } from "helpers/files";
8
- import { detectPackageManager } from "helpers/packageManagers";
9
- import { installPackages } from "helpers/packages";
10
- import * as recast from "recast";
11
- import type { TemplateConfig } from "../../src/templates";
12
- import type { C3Context } from "types";
1
+ import pages from "./pages/c3";
2
+ import workers from "./workers/c3";
3
+ import type { MultiPlatformTemplateConfig } from "../../src/templates";
13
4
 
14
- const { npm, name: pm } = detectPackageManager();
15
-
16
- const generate = async (ctx: C3Context) => {
17
- const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
18
-
19
- await runFrameworkGenerator(ctx, [
20
- "init",
21
- ctx.project.name,
22
- "--packageManager",
23
- npm,
24
- gitFlag,
25
- ]);
26
-
27
- writeFile("./.node-version", "17");
28
-
29
- logRaw(""); // newline
30
- };
31
-
32
- const configure = async (ctx: C3Context) => {
33
- const packages = ["nitro-cloudflare-dev"];
34
-
35
- // When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
36
- // Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
37
- if (pm === "pnpm") {
38
- packages.push("h3");
39
- }
40
-
41
- await installPackages(packages, {
42
- dev: true,
43
- startText: "Installing nitro module `nitro-cloudflare-dev`",
44
- doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
45
- });
46
- updateNuxtConfig();
47
-
48
- updateEnvTypes(ctx);
49
- };
50
-
51
- const updateEnvTypes = (ctx: C3Context) => {
52
- const filepath = "env.d.ts";
53
-
54
- const s = spinner();
55
- s.start(`Updating ${filepath}`);
56
-
57
- let file = readFile(filepath);
58
-
59
- let typesEntrypoint = `@cloudflare/workers-types/`;
60
- const latestEntrypoint = getLatestTypesEntrypoint(ctx);
61
- if (latestEntrypoint) {
62
- typesEntrypoint += `/${latestEntrypoint}`;
63
- }
64
-
65
- // Replace placeholder with actual types entrypoint
66
- file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
67
- writeFile("env.d.ts", file);
68
-
69
- s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
70
- };
71
-
72
- const updateNuxtConfig = () => {
73
- const s = spinner();
74
-
75
- const configFile = "nuxt.config.ts";
76
- s.start(`Updating \`${configFile}\``);
77
-
78
- const b = recast.types.builders;
79
-
80
- const presetDef = b.objectProperty(
81
- b.identifier("nitro"),
82
- b.objectExpression([
83
- b.objectProperty(
84
- b.identifier("preset"),
85
- b.stringLiteral("cloudflare-pages")
86
- ),
87
- ])
88
- );
89
-
90
- const moduleDef = b.objectProperty(
91
- b.identifier("modules"),
92
- b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
93
- );
94
-
95
- transformFile(configFile, {
96
- visitCallExpression: function (n) {
97
- const callee = n.node.callee as recast.types.namedTypes.Identifier;
98
- if (callee.name === "defineNuxtConfig") {
99
- const obj = n.node
100
- .arguments[0] as recast.types.namedTypes.ObjectExpression;
101
-
102
- obj.properties.push(presetDef);
103
- obj.properties.push(moduleDef);
104
- }
105
-
106
- return this.traverse(n);
107
- },
108
- });
109
-
110
- s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
111
- };
112
-
113
- const config: TemplateConfig = {
114
- configVersion: 1,
115
- id: "nuxt",
116
- platform: "pages",
5
+ const config: MultiPlatformTemplateConfig = {
117
6
  displayName: "Nuxt",
118
- copyFiles: {
119
- path: "./templates",
120
- },
121
- generate,
122
- configure,
123
- transformPackageJson: async () => ({
124
- scripts: {
125
- deploy: `${npm} run build && wrangler pages deploy ./dist`,
126
- preview: `${npm} run build && wrangler pages dev ./dist`,
127
- "build-cf-types": `wrangler types`,
128
- },
129
- }),
130
- devScript: "dev",
131
- deployScript: "deploy",
132
- previewScript: "preview",
7
+ platformVariants: { pages, workers },
133
8
  };
134
9
  export default config;
@@ -0,0 +1,147 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { mergeObjectProperties, transformFile } from "helpers/codemod";
6
+ import { getLatestTypesEntrypoint } from "helpers/compatDate";
7
+ import { readFile, writeFile } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
10
+ import * as recast from "recast";
11
+ import type { TemplateConfig } from "../../../src/templates";
12
+ import type { C3Context } from "types";
13
+
14
+ const { npm, name: pm } = detectPackageManager();
15
+
16
+ const generate = async (ctx: C3Context) => {
17
+ const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
18
+
19
+ await runFrameworkGenerator(ctx, [
20
+ "init",
21
+ ctx.project.name,
22
+ "--packageManager",
23
+ npm,
24
+ "--no-install",
25
+ gitFlag,
26
+ ]);
27
+
28
+ writeFile("./.node-version", "18");
29
+
30
+ logRaw(""); // newline
31
+ };
32
+
33
+ const configure = async (ctx: C3Context) => {
34
+ const packages = ["nitro-cloudflare-dev"];
35
+
36
+ // When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
37
+ // Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
38
+ if (pm === "pnpm") {
39
+ packages.push("h3");
40
+ }
41
+
42
+ await installPackages(packages, {
43
+ dev: true,
44
+ startText: "Installing nitro module `nitro-cloudflare-dev`",
45
+ doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
46
+ });
47
+ updateNuxtConfig();
48
+
49
+ updateEnvTypes(ctx);
50
+ };
51
+
52
+ const updateEnvTypes = (ctx: C3Context) => {
53
+ const filepath = "env.d.ts";
54
+
55
+ const s = spinner();
56
+ s.start(`Updating ${filepath}`);
57
+
58
+ let file = readFile(filepath);
59
+
60
+ let typesEntrypoint = `@cloudflare/workers-types`;
61
+ const latestEntrypoint = getLatestTypesEntrypoint(ctx);
62
+ if (latestEntrypoint) {
63
+ typesEntrypoint += `/${latestEntrypoint}`;
64
+ }
65
+
66
+ // Replace placeholder with actual types entrypoint
67
+ file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
68
+ writeFile("env.d.ts", file);
69
+
70
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
71
+ };
72
+
73
+ const updateNuxtConfig = () => {
74
+ const s = spinner();
75
+
76
+ const configFile = "nuxt.config.ts";
77
+ s.start(`Updating \`${configFile}\``);
78
+
79
+ const b = recast.types.builders;
80
+
81
+ const presetDef = b.objectProperty(
82
+ b.identifier("nitro"),
83
+ b.objectExpression([
84
+ b.objectProperty(
85
+ b.identifier("preset"),
86
+ b.stringLiteral("cloudflare-pages"),
87
+ ),
88
+ b.objectProperty(
89
+ b.identifier("cloudflare"),
90
+ b.objectExpression([
91
+ b.objectProperty(
92
+ b.identifier("deployConfig"),
93
+ b.booleanLiteral(true),
94
+ ),
95
+ b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
96
+ ]),
97
+ ),
98
+ ]),
99
+ );
100
+
101
+ const moduleDef = b.objectProperty(
102
+ b.identifier("modules"),
103
+ b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
104
+ );
105
+
106
+ transformFile(configFile, {
107
+ visitCallExpression: function (n) {
108
+ const callee = n.node.callee as recast.types.namedTypes.Identifier;
109
+ if (callee.name === "defineNuxtConfig") {
110
+ mergeObjectProperties(
111
+ n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
112
+ [presetDef, moduleDef],
113
+ );
114
+ }
115
+
116
+ return this.traverse(n);
117
+ },
118
+ });
119
+
120
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
121
+ };
122
+
123
+ const config: TemplateConfig = {
124
+ configVersion: 1,
125
+ id: "nuxt",
126
+ frameworkCli: "nuxi",
127
+ platform: "pages",
128
+ hidden: true,
129
+ displayName: "Nuxt",
130
+ copyFiles: {
131
+ path: "./templates",
132
+ },
133
+ path: "templates/nuxt/pages",
134
+ generate,
135
+ configure,
136
+ transformPackageJson: async () => ({
137
+ scripts: {
138
+ deploy: `${npm} run build && wrangler pages deploy`,
139
+ preview: `${npm} run build && wrangler pages dev`,
140
+ "cf-typegen": `wrangler types`,
141
+ },
142
+ }),
143
+ devScript: "dev",
144
+ deployScript: "deploy",
145
+ previewScript: "preview",
146
+ };
147
+ export default config;
@@ -0,0 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
3
+ interface Env {
4
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "compatibility_date": "<TBD>",
4
+ "pages_build_output_dir": "./dist"
5
+ }
@@ -0,0 +1,146 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { mergeObjectProperties, transformFile } from "helpers/codemod";
6
+ import { getLatestTypesEntrypoint } from "helpers/compatDate";
7
+ import { readFile, writeFile } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
10
+ import * as recast from "recast";
11
+ import type { TemplateConfig } from "../../../src/templates";
12
+ import type { C3Context } from "types";
13
+
14
+ const { npm, name: pm } = detectPackageManager();
15
+
16
+ const generate = async (ctx: C3Context) => {
17
+ const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
18
+
19
+ await runFrameworkGenerator(ctx, [
20
+ "init",
21
+ ctx.project.name,
22
+ "--packageManager",
23
+ npm,
24
+ "--no-install",
25
+ gitFlag,
26
+ ]);
27
+
28
+ writeFile("./.node-version", "18");
29
+
30
+ logRaw(""); // newline
31
+ };
32
+
33
+ const configure = async (ctx: C3Context) => {
34
+ const packages = ["nitro-cloudflare-dev", "nitropack"];
35
+
36
+ // When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
37
+ // Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
38
+ if (pm === "pnpm") {
39
+ packages.push("h3");
40
+ }
41
+
42
+ await installPackages(packages, {
43
+ dev: true,
44
+ startText: "Installing nitro module `nitro-cloudflare-dev`",
45
+ doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
46
+ });
47
+ updateNuxtConfig();
48
+
49
+ updateEnvTypes(ctx);
50
+ };
51
+
52
+ const updateEnvTypes = (ctx: C3Context) => {
53
+ const filepath = "env.d.ts";
54
+
55
+ const s = spinner();
56
+ s.start(`Updating ${filepath}`);
57
+
58
+ let file = readFile(filepath);
59
+
60
+ let typesEntrypoint = `@cloudflare/workers-types`;
61
+ const latestEntrypoint = getLatestTypesEntrypoint(ctx);
62
+ if (latestEntrypoint) {
63
+ typesEntrypoint += `/${latestEntrypoint}`;
64
+ }
65
+
66
+ // Replace placeholder with actual types entrypoint
67
+ file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
68
+ writeFile("env.d.ts", file);
69
+
70
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
71
+ };
72
+
73
+ const updateNuxtConfig = () => {
74
+ const s = spinner();
75
+
76
+ const configFile = "nuxt.config.ts";
77
+ s.start(`Updating \`${configFile}\``);
78
+
79
+ const b = recast.types.builders;
80
+
81
+ const presetDef = b.objectProperty(
82
+ b.identifier("nitro"),
83
+ b.objectExpression([
84
+ b.objectProperty(
85
+ b.identifier("preset"),
86
+ b.stringLiteral("cloudflare_module"),
87
+ ),
88
+ b.objectProperty(
89
+ b.identifier("cloudflare"),
90
+ b.objectExpression([
91
+ b.objectProperty(
92
+ b.identifier("deployConfig"),
93
+ b.booleanLiteral(true),
94
+ ),
95
+ b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
96
+ ]),
97
+ ),
98
+ ]),
99
+ );
100
+
101
+ const moduleDef = b.objectProperty(
102
+ b.identifier("modules"),
103
+ b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
104
+ );
105
+
106
+ transformFile(configFile, {
107
+ visitCallExpression: function (n) {
108
+ const callee = n.node.callee as recast.types.namedTypes.Identifier;
109
+ if (callee.name === "defineNuxtConfig") {
110
+ mergeObjectProperties(
111
+ n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
112
+ [presetDef, moduleDef],
113
+ );
114
+ }
115
+
116
+ return this.traverse(n);
117
+ },
118
+ });
119
+
120
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
121
+ };
122
+
123
+ const config: TemplateConfig = {
124
+ configVersion: 1,
125
+ id: "nuxt",
126
+ frameworkCli: "nuxi",
127
+ platform: "workers",
128
+ displayName: "Nuxt",
129
+ copyFiles: {
130
+ path: "./templates",
131
+ },
132
+ path: "templates/nuxt/workers",
133
+ generate,
134
+ configure,
135
+ transformPackageJson: async () => ({
136
+ scripts: {
137
+ deploy: `${npm} run build && wrangler deploy`,
138
+ preview: `${npm} run build && wrangler dev`,
139
+ "cf-typegen": `wrangler types`,
140
+ },
141
+ }),
142
+ devScript: "dev",
143
+ deployScript: "deploy",
144
+ previewScript: "preview",
145
+ };
146
+ export default config;
@@ -0,0 +1,14 @@
1
+ /// <reference types="WORKERS_TYPES_ENTRYPOINT" />
2
+
3
+ declare module "h3" {
4
+ interface H3EventContext {
5
+ cf: CfProperties;
6
+ cloudflare: {
7
+ request: Request;
8
+ env: Env;
9
+ context: ExecutionContext;
10
+ };
11
+ }
12
+ }
13
+
14
+ export {};
@@ -0,0 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
3
+ interface Env {
4
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "./.output/server/index.mjs",
4
+ "compatibility_date": "<TBD>",
5
+ "assets": {
6
+ "binding": "ASSETS",
7
+ "directory": "./.output/public/"
8
+ },
9
+ "observability": {
10
+ "enabled": true
11
+ }
12
+ }
@@ -1,9 +1,14 @@
1
- export default {
1
+ import type { TemplateConfig } from "../../src/templates";
2
+
3
+ const config: TemplateConfig = {
2
4
  configVersion: 1,
3
5
  id: "openapi",
4
6
  displayName: "API starter (OpenAPI compliant)",
7
+ description: "Get started building a basic API on Workers",
5
8
  platform: "workers",
6
9
  copyFiles: {
7
10
  path: "./ts",
8
11
  },
9
12
  };
13
+
14
+ export default config;
@@ -1,6 +1,6 @@
1
1
  # Cloudflare Workers OpenAPI 3.1
2
2
 
3
- This is a Cloudflare Worker with OpenAPI 3.1 using [itty-router-openapi](https://github.com/cloudflare/itty-router-openapi).
3
+ This is a Cloudflare Worker with OpenAPI 3.1 using [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
4
4
 
5
5
  This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
6
6
  `openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
@@ -16,10 +16,10 @@ This is an example project made to be used as a quick start into building OpenAP
16
16
 
17
17
  1. Your main router is defined in `src/index.ts`.
18
18
  2. Each endpoint has its own file in `src/endpoints/`.
19
- 3. For more information read the [itty-router-openapi official documentation](https://cloudflare.github.io/itty-router-openapi/).
19
+ 3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
20
20
 
21
21
  ## Development
22
22
 
23
23
  1. Run `wrangler dev` to start a local instance of the API.
24
- 2. Open `http://localhost:9000/` in your browser to see the Swagger interface where you can try the endpoints.
24
+ 2. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
25
25
  3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
@@ -5,14 +5,17 @@
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
- "start": "wrangler dev"
8
+ "start": "wrangler dev",
9
+ "cf-typegen": "wrangler types"
9
10
  },
10
11
  "dependencies": {
11
- "@cloudflare/itty-router-openapi": "^1.0.1"
12
+ "chanfana": "^2.0.2",
13
+ "zod": "^3.23.8",
14
+ "hono": "^4.4.7"
12
15
  },
13
16
  "devDependencies": {
14
- "@types/node": "^20.5.7",
17
+ "@types/node": "20.8.3",
15
18
  "@types/service-worker-mock": "^2.0.1",
16
- "wrangler": "^3.0.0"
19
+ "wrangler": "^3.101.0"
17
20
  }
18
21
  }
@@ -1,33 +1,43 @@
1
- import {
2
- OpenAPIRoute,
3
- OpenAPIRouteSchema,
4
- } from "@cloudflare/itty-router-openapi";
1
+ import { Bool, OpenAPIRoute } from "chanfana";
2
+ import { z } from "zod";
5
3
  import { Task } from "../types";
6
4
 
7
5
  export class TaskCreate extends OpenAPIRoute {
8
- static schema: OpenAPIRouteSchema = {
6
+ schema = {
9
7
  tags: ["Tasks"],
10
8
  summary: "Create a new Task",
11
- requestBody: Task,
9
+ request: {
10
+ body: {
11
+ content: {
12
+ "application/json": {
13
+ schema: Task,
14
+ },
15
+ },
16
+ },
17
+ },
12
18
  responses: {
13
19
  "200": {
14
20
  description: "Returns the created task",
15
- schema: {
16
- success: Boolean,
17
- result: {
18
- task: Task,
21
+ content: {
22
+ "application/json": {
23
+ schema: z.object({
24
+ series: z.object({
25
+ success: Bool(),
26
+ result: z.object({
27
+ task: Task,
28
+ }),
29
+ }),
30
+ }),
19
31
  },
20
32
  },
21
33
  },
22
34
  },
23
35
  };
24
36
 
25
- async handle(
26
- request: Request,
27
- env: any,
28
- context: any,
29
- data: Record<string, any>
30
- ) {
37
+ async handle(c) {
38
+ // Get validated data
39
+ const data = await this.getValidatedData<typeof this.schema>();
40
+
31
41
  // Retrieve the validated request body
32
42
  const taskToCreate = data.body;
33
43