create-cloudflare 0.0.0-dd7a0aef → 0.0.0-ddaef2b9c

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 (233) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +58388 -58693
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +34 -26
  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 +33 -17
  12. package/templates/angular/templates/src/server.ts +15 -0
  13. package/templates/angular/templates/tools/copy-files.mjs +8 -2
  14. package/templates/astro/c3.ts +28 -42
  15. package/templates/astro/templates/js/wrangler.jsonc +8 -0
  16. package/templates/astro/templates/ts/src/env.d.ts +5 -0
  17. package/templates/astro/templates/ts/worker-configuration.d.ts +4 -0
  18. package/templates/astro/templates/ts/wrangler.jsonc +8 -0
  19. package/templates/common/c3.ts +3 -0
  20. package/templates/common/js/package.json +1 -1
  21. package/templates/common/js/wrangler.jsonc +8 -0
  22. package/templates/common/ts/package.json +4 -3
  23. package/templates/common/ts/src/ab-test.ts +2 -2
  24. package/templates/common/ts/src/index.ts +5 -2
  25. package/templates/common/ts/src/proxy.ts +2 -2
  26. package/templates/common/ts/src/redirect.ts +2 -2
  27. package/templates/common/ts/tsconfig.json +37 -95
  28. package/templates/common/ts/worker-configuration.d.ts +2 -14
  29. package/templates/common/ts/wrangler.jsonc +8 -0
  30. package/templates/docusaurus/c3.ts +5 -3
  31. package/templates/gatsby/c3.ts +3 -2
  32. package/templates/hello-world/c3.ts +5 -1
  33. package/templates/hello-world/js/package.json +5 -2
  34. package/templates/hello-world/js/test/index.spec.js +20 -0
  35. package/templates/hello-world/js/vitest.config.js +11 -0
  36. package/templates/hello-world/js/wrangler.jsonc +8 -0
  37. package/templates/hello-world/py/__dot__gitignore +68 -0
  38. package/templates/hello-world/py/package.json +13 -0
  39. package/templates/hello-world/py/src/entry.py +4 -0
  40. package/templates/hello-world/py/wrangler.jsonc +9 -0
  41. package/templates/hello-world/ts/package.json +7 -3
  42. package/templates/hello-world/ts/src/index.ts +5 -19
  43. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  44. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  45. package/templates/hello-world/ts/tsconfig.json +39 -96
  46. package/templates/hello-world/ts/vitest.config.mts +11 -0
  47. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  48. package/templates/hello-world/ts/wrangler.jsonc +8 -0
  49. package/templates/hello-world-durable-object/c3.ts +3 -1
  50. package/templates/hello-world-durable-object/js/package.json +1 -1
  51. package/templates/hello-world-durable-object/js/src/index.js +21 -17
  52. package/templates/hello-world-durable-object/js/wrangler.jsonc +24 -0
  53. package/templates/hello-world-durable-object/ts/package.json +4 -4
  54. package/templates/hello-world-durable-object/ts/src/index.ts +26 -39
  55. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  56. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  57. package/templates/hello-world-durable-object/ts/wrangler.jsonc +24 -0
  58. package/templates/hono/c3.ts +45 -1
  59. package/templates/hono/snippets/appDeclaration.ts +1 -0
  60. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  61. package/templates/hono/templates/wrangler.jsonc +8 -0
  62. package/templates/next/README.md +15 -6
  63. package/templates/next/app/js/app/api/hello/route.js +5 -5
  64. package/templates/next/app/ts/app/api/hello/route.ts +5 -6
  65. package/templates/next/c3.ts +35 -31
  66. package/templates/next/env.d.ts +3 -5
  67. package/templates/next/pages/js/pages/api/hello.js +1 -1
  68. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  69. package/templates/next/wrangler.jsonc +8 -0
  70. package/templates/nuxt/c3.ts +18 -17
  71. package/templates/nuxt/templates/worker-configuration.d.ts +4 -3
  72. package/templates/nuxt/templates/wrangler.jsonc +8 -0
  73. package/templates/openapi/c3.ts +1 -0
  74. package/templates/openapi/ts/README.md +3 -3
  75. package/templates/openapi/ts/package.json +7 -4
  76. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  77. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  78. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  79. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  80. package/templates/openapi/ts/src/index.ts +14 -20
  81. package/templates/openapi/ts/src/types.ts +9 -8
  82. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  83. package/templates/openapi/ts/wrangler.jsonc +8 -0
  84. package/templates/pre-existing/c3.ts +37 -18
  85. package/templates/pre-existing/js/package.json +1 -1
  86. package/templates/pre-existing/js/wrangler.jsonc +5 -0
  87. package/templates/queues/c3.ts +2 -0
  88. package/templates/queues/js/package.json +1 -1
  89. package/templates/queues/js/wrangler.jsonc +21 -0
  90. package/templates/queues/ts/package.json +4 -3
  91. package/templates/queues/ts/src/index.ts +6 -8
  92. package/templates/queues/ts/tsconfig.json +36 -95
  93. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  94. package/templates/queues/ts/wrangler.jsonc +21 -0
  95. package/templates/qwik/c3.ts +13 -12
  96. package/templates/qwik/templates/worker-configuration.d.ts +4 -3
  97. package/templates/qwik/templates/wrangler.jsonc +8 -0
  98. package/templates/react/c3.ts +35 -5
  99. package/templates/remix/c3.ts +7 -6
  100. package/templates/remix/templates/worker-configuration.d.ts +4 -3
  101. package/templates/remix/templates/wrangler.jsonc +5 -0
  102. package/templates/scheduled/c3.ts +2 -0
  103. package/templates/scheduled/js/package.json +3 -3
  104. package/templates/scheduled/js/src/index.js +9 -2
  105. package/templates/scheduled/js/wrangler.jsonc +13 -0
  106. package/templates/scheduled/ts/package.json +5 -4
  107. package/templates/scheduled/ts/src/index.ts +8 -25
  108. package/templates/scheduled/ts/tsconfig.json +36 -95
  109. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  110. package/templates/scheduled/ts/wrangler.jsonc +13 -0
  111. package/templates/solid/c3.ts +21 -15
  112. package/templates/solid/templates/wrangler.jsonc +8 -0
  113. package/templates/svelte/c3.ts +46 -17
  114. package/templates/svelte/templates/wrangler.jsonc +5 -0
  115. package/templates/vue/c3.ts +3 -2
  116. package/templates-experimental/angular/c3.ts +112 -0
  117. package/templates-experimental/angular/templates/src/server.ts +15 -0
  118. package/templates-experimental/angular/templates/wrangler.jsonc +12 -0
  119. package/templates-experimental/astro/c3.ts +98 -0
  120. package/templates-experimental/astro/templates/js/public/.assetsignore +4 -0
  121. package/templates-experimental/astro/templates/js/wrangler.jsonc +15 -0
  122. package/templates-experimental/astro/templates/ts/public/.assetsignore +4 -0
  123. package/templates-experimental/astro/templates/ts/src/env.d.ts +5 -0
  124. package/templates-experimental/astro/templates/ts/worker-configuration.d.ts +4 -0
  125. package/templates-experimental/astro/templates/ts/wrangler.jsonc +15 -0
  126. package/templates-experimental/docusaurus/c3.ts +32 -0
  127. package/templates-experimental/docusaurus/templates/wrangler.jsonc +10 -0
  128. package/templates-experimental/gatsby/c3.ts +53 -0
  129. package/templates-experimental/gatsby/templates/wrangler.jsonc +10 -0
  130. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  131. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  132. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  133. package/templates-experimental/hello-world-assets-only/templates/wrangler.jsonc +10 -0
  134. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  135. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  136. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  137. package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  138. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  139. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  140. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  141. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.jsonc +28 -0
  142. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  143. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  144. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  145. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  146. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  147. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  148. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  149. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  150. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.jsonc +28 -0
  151. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  152. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  153. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  154. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  155. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  156. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  157. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  158. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  159. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  160. package/templates-experimental/hello-world-with-assets/js/wrangler.jsonc +15 -0
  161. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  162. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  163. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  164. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  165. package/templates-experimental/hello-world-with-assets/py/wrangler.jsonc +15 -0
  166. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  167. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  168. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  169. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  170. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  171. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  172. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  173. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  174. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
  175. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  176. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  177. package/templates-experimental/hello-world-with-assets/ts/wrangler.jsonc +15 -0
  178. package/templates-experimental/hono/c3.ts +43 -0
  179. package/templates-experimental/hono/templates/public/index.html +19 -0
  180. package/templates-experimental/hono/templates/src/index.ts +9 -0
  181. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  182. package/templates-experimental/hono/templates/wrangler.jsonc +9 -0
  183. package/templates-experimental/next/c3.ts +84 -0
  184. package/templates-experimental/next/templates/.dev.vars +2 -0
  185. package/templates-experimental/next/templates/__dot__gitignore +39 -0
  186. package/templates-experimental/next/templates/cloudflare-env.d.ts +5 -0
  187. package/templates-experimental/next/templates/open-next.config.ts +28 -0
  188. package/templates-experimental/next/templates/wrangler.jsonc +13 -0
  189. package/templates-experimental/nuxt/c3.ts +135 -0
  190. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  191. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  192. package/templates-experimental/nuxt/templates/wrangler.jsonc +12 -0
  193. package/templates-experimental/qwik/c3.ts +153 -0
  194. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  195. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  196. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  197. package/templates-experimental/qwik/templates/wrangler.jsonc +15 -0
  198. package/templates-experimental/remix/c3.ts +52 -0
  199. package/templates-experimental/remix/templates/public/.assetsignore +0 -0
  200. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  201. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  202. package/templates-experimental/solid/c3.ts +94 -0
  203. package/templates-experimental/solid/templates/wrangler.jsonc +15 -0
  204. package/templates-experimental/svelte/c3.ts +129 -0
  205. package/templates-experimental/svelte/templates/static/.assetsignore +4 -0
  206. package/templates-experimental/svelte/templates/wrangler.jsonc +12 -0
  207. package/templates-experimental/vue/c3.ts +33 -0
  208. package/templates-experimental/vue/templates/wrangler.jsonc +10 -0
  209. package/templates/angular/templates/server.ts +0 -34
  210. package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
  211. package/templates/angular/templates/tools/paths.mjs +0 -9
  212. package/templates/astro/snippets/runtimeDeclaration.ts +0 -4
  213. package/templates/astro/templates/wrangler.toml +0 -50
  214. package/templates/common/js/wrangler.toml +0 -51
  215. package/templates/common/ts/wrangler.toml +0 -51
  216. package/templates/hello-world/js/wrangler.toml +0 -51
  217. package/templates/hello-world/ts/wrangler.toml +0 -51
  218. package/templates/hello-world-durable-object/js/wrangler.toml +0 -51
  219. package/templates/hello-world-durable-object/ts/wrangler.toml +0 -51
  220. package/templates/next/wrangler.toml +0 -57
  221. package/templates/nuxt/templates/wrangler.toml +0 -50
  222. package/templates/openapi/ts/wrangler.toml +0 -3
  223. package/templates/pre-existing/js/wrangler.toml +0 -3
  224. package/templates/queues/js/wrangler.toml +0 -19
  225. package/templates/queues/ts/wrangler.toml +0 -19
  226. package/templates/qwik/templates/wrangler.toml +0 -50
  227. package/templates/remix/templates/wrangler.toml +0 -50
  228. package/templates/scheduled/js/wrangler.toml +0 -9
  229. package/templates/scheduled/ts/wrangler.toml +0 -9
  230. package/templates/svelte/js/src/hooks.server.js +0 -25
  231. package/templates/svelte/js/wrangler.toml +0 -50
  232. package/templates/svelte/ts/src/hooks.server.ts +0 -24
  233. package/templates/svelte/ts/wrangler.toml +0 -50
@@ -14,7 +14,7 @@ export default async function handler(req) {
14
14
  // )
15
15
  //
16
16
  // KV Example:
17
- // const myKv = getRequestContext().env.MY_KV
17
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
18
18
  // await myKv.put('suffix', ' from a KV store!')
19
19
  // const suffix = await myKv.get('suffix')
20
20
  // responseText += suffix
@@ -15,7 +15,7 @@ export default async function handler(req: NextRequest) {
15
15
  // )
16
16
  //
17
17
  // KV Example:
18
- // const myKv = getRequestContext().env.MY_KV;
18
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
19
19
  // await myKv.put('suffix', ' from a KV store!')
20
20
  // const suffix = await myKv.get('suffix')
21
21
  // responseText += suffix
@@ -0,0 +1,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "compatibility_date": "<TBD>",
4
+ "compatibility_flags": [
5
+ "nodejs_compat"
6
+ ],
7
+ "pages_build_output_dir": ".vercel/output/static"
8
+ }
@@ -1,12 +1,13 @@
1
1
  import { logRaw } from "@cloudflare/cli";
2
2
  import { brandColor, dim } from "@cloudflare/cli/colors";
3
3
  import { spinner } from "@cloudflare/cli/interactive";
4
- import { transformFile } from "helpers/codemod";
5
- import { installPackages, runFrameworkGenerator } from "helpers/command";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { mergeObjectProperties, transformFile } from "helpers/codemod";
6
+ import { getLatestTypesEntrypoint } from "helpers/compatDate";
6
7
  import { readFile, writeFile } from "helpers/files";
7
- import { detectPackageManager } from "helpers/packages";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
8
10
  import * as recast from "recast";
9
- import { getLatestTypesEntrypoint } from "../../src/workers";
10
11
  import type { TemplateConfig } from "../../src/templates";
11
12
  import type { C3Context } from "types";
12
13
 
@@ -23,7 +24,7 @@ const generate = async (ctx: C3Context) => {
23
24
  gitFlag,
24
25
  ]);
25
26
 
26
- writeFile("./.node-version", "17");
27
+ writeFile("./.node-version", "18");
27
28
 
28
29
  logRaw(""); // newline
29
30
  };
@@ -55,7 +56,7 @@ const updateEnvTypes = (ctx: C3Context) => {
55
56
 
56
57
  let file = readFile(filepath);
57
58
 
58
- let typesEntrypoint = `@cloudflare/workers-types/`;
59
+ let typesEntrypoint = `@cloudflare/workers-types`;
59
60
  const latestEntrypoint = getLatestTypesEntrypoint(ctx);
60
61
  if (latestEntrypoint) {
61
62
  typesEntrypoint += `/${latestEntrypoint}`;
@@ -81,25 +82,24 @@ const updateNuxtConfig = () => {
81
82
  b.objectExpression([
82
83
  b.objectProperty(
83
84
  b.identifier("preset"),
84
- b.stringLiteral("cloudflare-pages")
85
+ b.stringLiteral("cloudflare-pages"),
85
86
  ),
86
- ])
87
+ ]),
87
88
  );
88
89
 
89
90
  const moduleDef = b.objectProperty(
90
91
  b.identifier("modules"),
91
- b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
92
+ b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
92
93
  );
93
94
 
94
95
  transformFile(configFile, {
95
96
  visitCallExpression: function (n) {
96
97
  const callee = n.node.callee as recast.types.namedTypes.Identifier;
97
98
  if (callee.name === "defineNuxtConfig") {
98
- const obj = n.node
99
- .arguments[0] as recast.types.namedTypes.ObjectExpression;
100
-
101
- obj.properties.push(presetDef);
102
- obj.properties.push(moduleDef);
99
+ mergeObjectProperties(
100
+ n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
101
+ [presetDef, moduleDef],
102
+ );
103
103
  }
104
104
 
105
105
  return this.traverse(n);
@@ -112,6 +112,7 @@ const updateNuxtConfig = () => {
112
112
  const config: TemplateConfig = {
113
113
  configVersion: 1,
114
114
  id: "nuxt",
115
+ frameworkCli: "nuxi",
115
116
  platform: "pages",
116
117
  displayName: "Nuxt",
117
118
  copyFiles: {
@@ -121,9 +122,9 @@ const config: TemplateConfig = {
121
122
  configure,
122
123
  transformPackageJson: async () => ({
123
124
  scripts: {
124
- deploy: `${npm} run build && wrangler pages deploy ./dist`,
125
- preview: `${npm} run build && wrangler pages dev ./dist`,
126
- "build-cf-types": `wrangler types`,
125
+ deploy: `${npm} run build && wrangler pages deploy`,
126
+ preview: `${npm} run build && wrangler pages dev`,
127
+ "cf-typegen": `wrangler types`,
127
128
  },
128
129
  }),
129
130
  devScript: "dev",
@@ -1,3 +1,4 @@
1
- // Generated by Wrangler on Fri Feb 16 2024 15:52:18 GMT-0600 (Central Standard Time)
2
- // After adding bindings to `wrangler.toml`, regenerate this interface via `npm build-cf-types`
3
- interface Env {}
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,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "compatibility_date": "<TBD>",
4
+ "compatibility_flags": [
5
+ "nodejs_compat"
6
+ ],
7
+ "pages_build_output_dir": "./dist"
8
+ }
@@ -2,6 +2,7 @@ export default {
2
2
  configVersion: 1,
3
3
  id: "openapi",
4
4
  displayName: "API starter (OpenAPI compliant)",
5
+ description: "Get started building a basic API on Workers",
5
6
  platform: "workers",
6
7
  copyFiles: {
7
8
  path: "./ts",
@@ -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
 
@@ -1,38 +1,39 @@
1
- import {
2
- OpenAPIRoute,
3
- OpenAPIRouteSchema,
4
- Path,
5
- } from "@cloudflare/itty-router-openapi";
1
+ import { Bool, OpenAPIRoute, Str } from "chanfana";
2
+ import { z } from "zod";
6
3
  import { Task } from "../types";
7
4
 
8
5
  export class TaskDelete extends OpenAPIRoute {
9
- static schema: OpenAPIRouteSchema = {
6
+ schema = {
10
7
  tags: ["Tasks"],
11
8
  summary: "Delete a Task",
12
- parameters: {
13
- taskSlug: Path(String, {
14
- description: "Task slug",
9
+ request: {
10
+ params: z.object({
11
+ taskSlug: Str({ description: "Task slug" }),
15
12
  }),
16
13
  },
17
14
  responses: {
18
15
  "200": {
19
16
  description: "Returns if the task was deleted successfully",
20
- schema: {
21
- success: Boolean,
22
- result: {
23
- task: Task,
17
+ content: {
18
+ "application/json": {
19
+ schema: z.object({
20
+ series: z.object({
21
+ success: Bool(),
22
+ result: z.object({
23
+ task: Task,
24
+ }),
25
+ }),
26
+ }),
24
27
  },
25
28
  },
26
29
  },
27
30
  },
28
31
  };
29
32
 
30
- async handle(
31
- request: Request,
32
- env: any,
33
- context: any,
34
- data: Record<string, any>
35
- ) {
33
+ async handle(c) {
34
+ // Get validated data
35
+ const data = await this.getValidatedData<typeof this.schema>();
36
+
36
37
  // Retrieve the validated slug
37
38
  const { taskSlug } = data.params;
38
39
 
@@ -1,45 +1,52 @@
1
- import {
2
- OpenAPIRoute,
3
- OpenAPIRouteSchema,
4
- Path,
5
- } from "@cloudflare/itty-router-openapi";
1
+ import { Bool, OpenAPIRoute, Str } from "chanfana";
2
+ import { z } from "zod";
6
3
  import { Task } from "../types";
7
4
 
8
5
  export class TaskFetch extends OpenAPIRoute {
9
- static schema: OpenAPIRouteSchema = {
6
+ schema = {
10
7
  tags: ["Tasks"],
11
8
  summary: "Get a single Task by slug",
12
- parameters: {
13
- taskSlug: Path(String, {
14
- description: "Task slug",
9
+ request: {
10
+ params: z.object({
11
+ taskSlug: Str({ description: "Task slug" }),
15
12
  }),
16
13
  },
17
14
  responses: {
18
15
  "200": {
19
16
  description: "Returns a single task if found",
20
- schema: {
21
- success: Boolean,
22
- result: {
23
- task: Task,
17
+ content: {
18
+ "application/json": {
19
+ schema: z.object({
20
+ series: z.object({
21
+ success: Bool(),
22
+ result: z.object({
23
+ task: Task,
24
+ }),
25
+ }),
26
+ }),
24
27
  },
25
28
  },
26
29
  },
27
30
  "404": {
28
31
  description: "Task not found",
29
- schema: {
30
- success: Boolean,
31
- error: String,
32
+ content: {
33
+ "application/json": {
34
+ schema: z.object({
35
+ series: z.object({
36
+ success: Bool(),
37
+ error: Str(),
38
+ }),
39
+ }),
40
+ },
32
41
  },
33
42
  },
34
43
  },
35
44
  };
36
45
 
37
- async handle(
38
- request: Request,
39
- env: any,
40
- context: any,
41
- data: Record<string, any>
42
- ) {
46
+ async handle(c) {
47
+ // Get validated data
48
+ const data = await this.getValidatedData<typeof this.schema>();
49
+
43
50
  // Retrieve the validated slug
44
51
  const { taskSlug } = data.params;
45
52
 
@@ -56,7 +63,7 @@ export class TaskFetch extends OpenAPIRoute {
56
63
  },
57
64
  {
58
65
  status: 404,
59
- }
66
+ },
60
67
  );
61
68
  }
62
69
 
@@ -1,43 +1,46 @@
1
- import {
2
- OpenAPIRoute,
3
- OpenAPIRouteSchema,
4
- Query,
5
- } from "@cloudflare/itty-router-openapi";
1
+ import { Bool, Num, OpenAPIRoute } from "chanfana";
2
+ import { z } from "zod";
6
3
  import { Task } from "../types";
7
4
 
8
5
  export class TaskList extends OpenAPIRoute {
9
- static schema: OpenAPIRouteSchema = {
6
+ schema = {
10
7
  tags: ["Tasks"],
11
8
  summary: "List Tasks",
12
- parameters: {
13
- page: Query(Number, {
14
- description: "Page number",
15
- default: 0,
16
- }),
17
- isCompleted: Query(Boolean, {
18
- description: "Filter by completed flag",
19
- required: false,
9
+ request: {
10
+ query: z.object({
11
+ page: Num({
12
+ description: "Page number",
13
+ default: 0,
14
+ }),
15
+ isCompleted: Bool({
16
+ description: "Filter by completed flag",
17
+ required: false,
18
+ }),
20
19
  }),
21
20
  },
22
21
  responses: {
23
22
  "200": {
24
23
  description: "Returns a list of tasks",
25
- schema: {
26
- success: Boolean,
27
- result: {
28
- tasks: [Task],
24
+ content: {
25
+ "application/json": {
26
+ schema: z.object({
27
+ series: z.object({
28
+ success: Bool(),
29
+ result: z.object({
30
+ tasks: Task.array(),
31
+ }),
32
+ }),
33
+ }),
29
34
  },
30
35
  },
31
36
  },
32
37
  },
33
38
  };
34
39
 
35
- async handle(
36
- request: Request,
37
- env: any,
38
- context: any,
39
- data: Record<string, any>
40
- ) {
40
+ async handle(c) {
41
+ // Get validated data
42
+ const data = await this.getValidatedData<typeof this.schema>();
43
+
41
44
  // Retrieve the validated parameters
42
45
  const { page, isCompleted } = data.query;
43
46
 
@@ -1,29 +1,23 @@
1
- import { OpenAPIRouter } from "@cloudflare/itty-router-openapi";
1
+ import { fromHono } from "chanfana";
2
+ import { Hono } from "hono";
2
3
  import { TaskCreate } from "./endpoints/taskCreate";
3
4
  import { TaskDelete } from "./endpoints/taskDelete";
4
5
  import { TaskFetch } from "./endpoints/taskFetch";
5
6
  import { TaskList } from "./endpoints/taskList";
6
7
 
7
- export const router = OpenAPIRouter({
8
+ // Start a Hono app
9
+ const app = new Hono();
10
+
11
+ // Setup OpenAPI registry
12
+ const openapi = fromHono(app, {
8
13
  docs_url: "/",
9
14
  });
10
15
 
11
- router.get("/api/tasks/", TaskList);
12
- router.post("/api/tasks/", TaskCreate);
13
- router.get("/api/tasks/:taskSlug/", TaskFetch);
14
- router.delete("/api/tasks/:taskSlug/", TaskDelete);
15
-
16
- // 404 for everything else
17
- router.all("*", () =>
18
- Response.json(
19
- {
20
- success: false,
21
- error: "Route not found",
22
- },
23
- { status: 404 }
24
- )
25
- );
16
+ // Register OpenAPI endpoints
17
+ openapi.get("/api/tasks", TaskList);
18
+ openapi.post("/api/tasks", TaskCreate);
19
+ openapi.get("/api/tasks/:taskSlug", TaskFetch);
20
+ openapi.delete("/api/tasks/:taskSlug", TaskDelete);
26
21
 
27
- export default {
28
- fetch: router.handle,
29
- };
22
+ // Export the Hono app
23
+ export default app;
@@ -1,9 +1,10 @@
1
- import { DateTime, Str } from "@cloudflare/itty-router-openapi";
1
+ import { DateTime, Str } from "chanfana";
2
+ import { z } from "zod";
2
3
 
3
- export const Task = {
4
- name: new Str({ example: "lorem" }),
5
- slug: String,
6
- description: new Str({ required: false }),
7
- completed: Boolean,
8
- due_date: new DateTime(),
9
- };
4
+ export const Task = z.object({
5
+ name: Str({ example: "lorem" }),
6
+ slug: Str(),
7
+ description: Str({ required: false }),
8
+ completed: z.boolean().default(false),
9
+ due_date: DateTime(),
10
+ });
@@ -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,8 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/index.ts",
4
+ "compatibility_date": "<TBD>",
5
+ "observability": {
6
+ "enabled": true
7
+ }
8
+ }
@@ -1,20 +1,18 @@
1
1
  import { cp, mkdtemp } from "fs/promises";
2
2
  import { tmpdir } from "os";
3
3
  import { join } from "path";
4
- import { processArgument } from "@cloudflare/cli/args";
5
4
  import { brandColor, dim } from "@cloudflare/cli/colors";
5
+ import { processArgument } from "helpers/args";
6
6
  import { runCommand } from "helpers/command";
7
- import { detectPackageManager } from "helpers/packages";
8
- import { chooseAccount } from "../../src/common";
7
+ import { detectPackageManager } from "helpers/packageManagers";
8
+ import { chooseAccount, wranglerLogin } from "../../src/wrangler/accounts";
9
9
  import type { C3Context } from "types";
10
10
 
11
11
  export async function copyExistingWorkerFiles(ctx: C3Context) {
12
12
  const { dlx } = detectPackageManager();
13
13
 
14
- await chooseAccount(ctx);
15
-
16
14
  if (ctx.args.existingScript === undefined) {
17
- ctx.args.existingScript = await processArgument<string>(
15
+ ctx.args.existingScript = await processArgument(
18
16
  ctx.args,
19
17
  "existingScript",
20
18
  {
@@ -23,7 +21,7 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
23
21
  "Please specify the name of the existing worker in this account?",
24
22
  label: "worker",
25
23
  defaultValue: ctx.project.name,
26
- }
24
+ },
27
25
  );
28
26
  }
29
27
 
@@ -46,22 +44,22 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
46
44
  env: { CLOUDFLARE_ACCOUNT_ID: ctx.account?.id },
47
45
  startText: "Downloading existing worker files",
48
46
  doneText: `${brandColor("downloaded")} ${dim(
49
- `existing "${ctx.args.existingScript}" worker files`
47
+ `existing "${ctx.args.existingScript}" worker files`,
50
48
  )}`,
51
- }
49
+ },
52
50
  );
53
51
 
54
- // copy src/* files from the downloaded worker
52
+ // copy src/* files from the downloaded Worker
55
53
  await cp(
56
54
  join(tempdir, ctx.args.existingScript, "src"),
57
55
  join(ctx.project.path, "src"),
58
- { recursive: true }
56
+ { recursive: true },
59
57
  );
60
58
 
61
- // copy wrangler.toml from the downloaded worker
59
+ // copy wrangler.toml from the downloaded Worker
62
60
  await cp(
63
61
  join(tempdir, ctx.args.existingScript, "wrangler.toml"),
64
- join(ctx.project.path, "wrangler.toml")
62
+ join(ctx.project.path, "wrangler.toml"),
65
63
  );
66
64
  }
67
65
 
@@ -74,10 +72,31 @@ export default {
74
72
  copyFiles: {
75
73
  path: "./js",
76
74
  },
77
- configure: async (ctx: C3Context) => {
78
- await copyExistingWorkerFiles(ctx);
75
+ configure: buildConfigure({
76
+ login: wranglerLogin,
77
+ chooseAccount,
78
+ copyFiles: copyExistingWorkerFiles,
79
+ }),
80
+ };
81
+
82
+ export interface ConfigureParams {
83
+ login: (ctx: C3Context) => Promise<boolean>;
84
+ chooseAccount: (ctx: C3Context) => Promise<void>;
85
+ copyFiles: (ctx: C3Context) => Promise<void>;
86
+ }
87
+
88
+ export function buildConfigure(params: ConfigureParams) {
89
+ return async function configure(ctx: C3Context) {
90
+ const loginSuccess = await params.login(ctx);
79
91
 
80
- // Force no-deploy since the worker is already deployed
92
+ if (!loginSuccess) {
93
+ throw new Error("Failed to login to Cloudflare");
94
+ }
95
+
96
+ await params.chooseAccount(ctx);
97
+ await params.copyFiles(ctx);
98
+
99
+ // Force no-deploy since the Worker is already deployed
81
100
  ctx.args.deploy = false;
82
- },
83
- };
101
+ };
102
+ }
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.101.0"
12
12
  }
13
13
  }
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "main": "src/index.js",
4
+ "compatibility_date": "<TBD>"
5
+ }