create-cloudflare 0.0.0-a55314cb → 0.0.0-a602de088

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 (154) hide show
  1. package/dist/cli.js +51541 -51906
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +25 -25
  4. package/templates/analog/c3.ts +5 -4
  5. package/templates/analog/templates/wrangler.toml +7 -0
  6. package/templates/angular/c3.ts +4 -2
  7. package/templates/astro/c3.ts +4 -3
  8. package/templates/astro/templates/wrangler.toml +7 -0
  9. package/templates/common/c3.ts +3 -0
  10. package/templates/common/js/package.json +1 -1
  11. package/templates/common/js/wrangler.toml +7 -0
  12. package/templates/common/ts/package.json +2 -2
  13. package/templates/common/ts/src/ab-test.ts +2 -2
  14. package/templates/common/ts/src/index.ts +2 -2
  15. package/templates/common/ts/src/proxy.ts +2 -2
  16. package/templates/common/ts/src/redirect.ts +2 -2
  17. package/templates/common/ts/tsconfig.json +1 -1
  18. package/templates/common/ts/wrangler.toml +7 -0
  19. package/templates/docusaurus/c3.ts +1 -0
  20. package/templates/gatsby/c3.ts +1 -0
  21. package/templates/hello-world/c3.ts +5 -1
  22. package/templates/hello-world/js/package.json +3 -3
  23. package/templates/hello-world/js/vitest.config.js +8 -8
  24. package/templates/hello-world/js/wrangler.toml +7 -0
  25. package/templates/hello-world/py/__dot__gitignore +68 -0
  26. package/templates/hello-world/py/package.json +13 -0
  27. package/templates/hello-world/py/src/entry.py +4 -0
  28. package/templates/{hello-world-python → hello-world}/py/wrangler.toml +7 -0
  29. package/templates/hello-world/ts/package.json +4 -4
  30. package/templates/hello-world/ts/src/index.ts +2 -2
  31. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  32. package/templates/hello-world/ts/tsconfig.json +3 -2
  33. package/templates/hello-world/ts/vitest.config.mts +11 -0
  34. package/templates/hello-world/ts/wrangler.toml +7 -0
  35. package/templates/hello-world-durable-object/c3.ts +3 -1
  36. package/templates/hello-world-durable-object/js/package.json +1 -1
  37. package/templates/hello-world-durable-object/js/src/index.js +1 -1
  38. package/templates/hello-world-durable-object/js/wrangler.toml +8 -1
  39. package/templates/hello-world-durable-object/ts/package.json +2 -2
  40. package/templates/hello-world-durable-object/ts/src/index.ts +3 -3
  41. package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
  42. package/templates/hello-world-durable-object/ts/wrangler.toml +9 -2
  43. package/templates/hono/c3.ts +44 -0
  44. package/templates/hono/snippets/appDeclaration.ts +1 -0
  45. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  46. package/templates/hono/templates/wrangler.toml +107 -0
  47. package/templates/next/README.md +1 -1
  48. package/templates/next/c3.ts +10 -7
  49. package/templates/next/wrangler.toml +7 -0
  50. package/templates/nuxt/c3.ts +9 -9
  51. package/templates/nuxt/templates/wrangler.toml +7 -0
  52. package/templates/openapi/c3.ts +1 -0
  53. package/templates/openapi/ts/README.md +3 -3
  54. package/templates/openapi/ts/package.json +5 -3
  55. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  56. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  57. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  58. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  59. package/templates/openapi/ts/src/index.ts +14 -20
  60. package/templates/openapi/ts/src/types.ts +9 -8
  61. package/templates/openapi/ts/wrangler.toml +7 -0
  62. package/templates/pre-existing/c3.ts +5 -5
  63. package/templates/pre-existing/js/package.json +1 -1
  64. package/templates/queues/c3.ts +2 -0
  65. package/templates/queues/js/package.json +1 -1
  66. package/templates/queues/js/wrangler.toml +7 -0
  67. package/templates/queues/ts/package.json +2 -2
  68. package/templates/queues/ts/src/index.ts +3 -3
  69. package/templates/queues/ts/tsconfig.json +1 -1
  70. package/templates/queues/ts/wrangler.toml +7 -0
  71. package/templates/qwik/c3.ts +5 -4
  72. package/templates/qwik/templates/wrangler.toml +8 -0
  73. package/templates/react/c3.ts +33 -3
  74. package/templates/remix/c3.ts +1 -0
  75. package/templates/remix/templates/wrangler.toml +7 -0
  76. package/templates/scheduled/c3.ts +2 -0
  77. package/templates/scheduled/js/package.json +3 -3
  78. package/templates/scheduled/js/src/index.js +8 -1
  79. package/templates/scheduled/js/wrangler.toml +7 -0
  80. package/templates/scheduled/ts/package.json +4 -4
  81. package/templates/scheduled/ts/src/index.ts +3 -3
  82. package/templates/scheduled/ts/tsconfig.json +1 -1
  83. package/templates/scheduled/ts/wrangler.toml +7 -0
  84. package/templates/solid/c3.ts +12 -9
  85. package/templates/solid/templates/wrangler.toml +7 -0
  86. package/templates/svelte/c3.ts +7 -6
  87. package/templates/svelte/js/wrangler.toml +7 -0
  88. package/templates/svelte/ts/wrangler.toml +7 -0
  89. package/templates/vue/c3.ts +1 -0
  90. package/templates-experimental/angular/c3.ts +102 -0
  91. package/templates-experimental/angular/templates/server.ts +34 -0
  92. package/templates-experimental/angular/templates/src/.assetsignore +4 -0
  93. package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +27 -0
  94. package/templates-experimental/angular/templates/tools/copy-files.mjs +9 -0
  95. package/templates-experimental/angular/templates/tools/paths.mjs +9 -0
  96. package/templates-experimental/angular/templates/wrangler.toml +5 -0
  97. package/templates-experimental/astro/c3.ts +114 -0
  98. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  99. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  100. package/templates-experimental/astro/templates/wrangler.toml +6 -0
  101. package/templates-experimental/docusaurus/c3.ts +32 -0
  102. package/templates-experimental/docusaurus/templates/wrangler.toml +4 -0
  103. package/templates-experimental/gatsby/c3.ts +53 -0
  104. package/templates-experimental/gatsby/templates/wrangler.toml +4 -0
  105. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  106. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  107. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  108. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  109. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  110. package/templates-experimental/hello-world-with-assets/js/public/index.html +19 -0
  111. package/templates-experimental/hello-world-with-assets/js/src/index.js +15 -0
  112. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +20 -0
  113. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  114. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +6 -0
  115. package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/package.json +1 -1
  116. package/templates-experimental/hello-world-with-assets/py/public/index.html +19 -0
  117. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +6 -0
  118. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  119. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  120. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  121. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  122. package/templates-experimental/hello-world-with-assets/ts/public/index.html +19 -0
  123. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +18 -0
  124. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +25 -0
  125. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  126. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +103 -0
  127. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  128. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  129. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +6 -0
  130. package/templates-experimental/nuxt/c3.ts +135 -0
  131. package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
  132. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  133. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  134. package/templates-experimental/nuxt/templates/wrangler.toml +5 -0
  135. package/templates-experimental/qwik/c3.ts +153 -0
  136. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  137. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  138. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  139. package/templates-experimental/qwik/templates/wrangler.toml +6 -0
  140. package/templates-experimental/remix/c3.ts +77 -0
  141. package/templates-experimental/remix/templates/public/.assetsignore +4 -0
  142. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  143. package/templates-experimental/remix/templates/wrangler.toml +5 -0
  144. package/templates-experimental/solid/c3.ts +137 -0
  145. package/templates-experimental/solid/templates/wrangler.toml +6 -0
  146. package/templates-experimental/svelte/c3.ts +132 -0
  147. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  148. package/templates-experimental/svelte/js/wrangler.toml +5 -0
  149. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  150. package/templates-experimental/svelte/ts/wrangler.toml +5 -0
  151. package/templates/hello-world/ts/vitest.config.ts +0 -11
  152. package/templates/hello-world-python/c3.ts +0 -9
  153. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/__dot__gitignore +0 -0
  154. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/src/entry.py +0 -0
@@ -35,7 +35,7 @@ const generate = async (ctx: C3Context) => {
35
35
  // (instead of making it a special case which needs extra care)
36
36
  const newTomlContent = wranglerToml.replace(
37
37
  /#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
38
- ($1) => `# KV Example:\n${$1}`
38
+ ($1) => `# KV Example:\n${$1}`,
39
39
  );
40
40
 
41
41
  if (!/# KV Example/.test(newTomlContent)) {
@@ -63,7 +63,7 @@ const updateNextConfig = () => {
63
63
 
64
64
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
65
65
  // (when running the application with \`next dev\`), for more information see:
66
- // https://github.com/cloudflare/next-on-pages/blob/5712c57ea7/internal-packages/next-dev/README.md
66
+ // https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
67
67
  if (process.env.NODE_ENV === 'development') {
68
68
  await setupDevPlatform();
69
69
  }
@@ -97,7 +97,7 @@ const configure = async (ctx: C3Context) => {
97
97
  if (usesTs) {
98
98
  copyFile(
99
99
  join(getTemplatePath(ctx), "env.d.ts"),
100
- join(projectPath, "env.d.ts")
100
+ join(projectPath, "env.d.ts"),
101
101
  );
102
102
  updateStatus("Created an env.d.ts file");
103
103
  }
@@ -112,7 +112,7 @@ const configure = async (ctx: C3Context) => {
112
112
 
113
113
  copyFile(
114
114
  join(getTemplatePath(ctx), "README.md"),
115
- join(projectPath, "README.md")
115
+ join(projectPath, "README.md"),
116
116
  );
117
117
  updateStatus("Updated the README file");
118
118
 
@@ -120,15 +120,17 @@ const configure = async (ctx: C3Context) => {
120
120
  };
121
121
 
122
122
  export const shouldInstallNextOnPagesEslintPlugin = async (
123
- ctx: C3Context
123
+ ctx: C3Context,
124
124
  ): Promise<boolean> => {
125
125
  const eslintUsage = usesEslint(ctx);
126
126
 
127
- if (!eslintUsage.used) return false;
127
+ if (!eslintUsage.used) {
128
+ return false;
129
+ }
128
130
 
129
131
  if (eslintUsage.configType !== ".eslintrc.json") {
130
132
  warn(
131
- `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`
133
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
132
134
  );
133
135
  return false;
134
136
  }
@@ -173,6 +175,7 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
173
175
  export default {
174
176
  configVersion: 1,
175
177
  id: "next",
178
+ frameworkCli: "create-next-app",
176
179
  platform: "pages",
177
180
  displayName: "Next",
178
181
  generate,
@@ -4,6 +4,13 @@ compatibility_date = "<TBD>"
4
4
  compatibility_flags = ["nodejs_compat"]
5
5
  pages_build_output_dir = ".vercel/output/static"
6
6
 
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
9
+ # rather than the end user may result in better performance.
10
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
13
+
7
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
8
15
  # Docs:
9
16
  # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
@@ -2,7 +2,7 @@ import { logRaw } from "@cloudflare/cli";
2
2
  import { brandColor, dim } from "@cloudflare/cli/colors";
3
3
  import { spinner } from "@cloudflare/cli/interactive";
4
4
  import { runFrameworkGenerator } from "frameworks/index";
5
- import { transformFile } from "helpers/codemod";
5
+ import { mergeObjectProperties, transformFile } from "helpers/codemod";
6
6
  import { getLatestTypesEntrypoint } from "helpers/compatDate";
7
7
  import { readFile, writeFile } from "helpers/files";
8
8
  import { detectPackageManager } from "helpers/packageManagers";
@@ -82,25 +82,24 @@ const updateNuxtConfig = () => {
82
82
  b.objectExpression([
83
83
  b.objectProperty(
84
84
  b.identifier("preset"),
85
- b.stringLiteral("cloudflare-pages")
85
+ b.stringLiteral("cloudflare-pages"),
86
86
  ),
87
- ])
87
+ ]),
88
88
  );
89
89
 
90
90
  const moduleDef = b.objectProperty(
91
91
  b.identifier("modules"),
92
- b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
92
+ b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
93
93
  );
94
94
 
95
95
  transformFile(configFile, {
96
96
  visitCallExpression: function (n) {
97
97
  const callee = n.node.callee as recast.types.namedTypes.Identifier;
98
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);
99
+ mergeObjectProperties(
100
+ n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
101
+ [presetDef, moduleDef],
102
+ );
104
103
  }
105
104
 
106
105
  return this.traverse(n);
@@ -113,6 +112,7 @@ const updateNuxtConfig = () => {
113
112
  const config: TemplateConfig = {
114
113
  configVersion: 1,
115
114
  id: "nuxt",
115
+ frameworkCli: "nuxi",
116
116
  platform: "pages",
117
117
  displayName: "Nuxt",
118
118
  copyFiles: {
@@ -3,6 +3,13 @@ name = "<TBD>"
3
3
  compatibility_date = "<TBD>"
4
4
  pages_build_output_dir = "./dist"
5
5
 
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
6
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
14
  # Docs:
8
15
  # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
@@ -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.
@@ -9,11 +9,13 @@
9
9
  "cf-typegen": "wrangler types"
10
10
  },
11
11
  "dependencies": {
12
- "@cloudflare/itty-router-openapi": "^1.0.1"
12
+ "chanfana": "^2.0.2",
13
+ "zod": "^3.23.8",
14
+ "hono": "^4.4.7"
13
15
  },
14
16
  "devDependencies": {
15
- "@types/node": "^20.5.7",
17
+ "@types/node": "20.8.3",
16
18
  "@types/service-worker-mock": "^2.0.1",
17
- "wrangler": "^3.0.0"
19
+ "wrangler": "^3.60.3"
18
20
  }
19
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
+ });
@@ -3,6 +3,13 @@ name = "<TBD>"
3
3
  main = "src/index.ts"
4
4
  compatibility_date = "<TBD>"
5
5
 
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
6
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
14
  # Docs:
8
15
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -23,7 +23,7 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
23
23
  "Please specify the name of the existing worker in this account?",
24
24
  label: "worker",
25
25
  defaultValue: ctx.project.name,
26
- }
26
+ },
27
27
  );
28
28
  }
29
29
 
@@ -46,22 +46,22 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
46
46
  env: { CLOUDFLARE_ACCOUNT_ID: ctx.account?.id },
47
47
  startText: "Downloading existing worker files",
48
48
  doneText: `${brandColor("downloaded")} ${dim(
49
- `existing "${ctx.args.existingScript}" worker files`
49
+ `existing "${ctx.args.existingScript}" worker files`,
50
50
  )}`,
51
- }
51
+ },
52
52
  );
53
53
 
54
54
  // copy src/* files from the downloaded worker
55
55
  await cp(
56
56
  join(tempdir, ctx.args.existingScript, "src"),
57
57
  join(ctx.project.path, "src"),
58
- { recursive: true }
58
+ { recursive: true },
59
59
  );
60
60
 
61
61
  // copy wrangler.toml from the downloaded worker
62
62
  await cp(
63
63
  join(tempdir, ctx.args.existingScript, "wrangler.toml"),
64
- join(ctx.project.path, "wrangler.toml")
64
+ join(ctx.project.path, "wrangler.toml"),
65
65
  );
66
66
  }
67
67
 
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -2,6 +2,8 @@ export default {
2
2
  configVersion: 1,
3
3
  id: "queues",
4
4
  displayName: "Queue consumer & producer Worker",
5
+ description:
6
+ "Get started with a Worker that processes background tasks and message batches with Cloudflare Queues",
5
7
  platform: "workers",
6
8
  copyFiles: {
7
9
  variants: {
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -3,6 +3,13 @@ name = "<TBD>"
3
3
  main = "src/index.js"
4
4
  compatibility_date = "<TBD>"
5
5
 
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
6
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
14
  # Docs:
8
15
  # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
@@ -9,7 +9,7 @@
9
9
  "cf-typegen": "wrangler types"
10
10
  },
11
11
  "devDependencies": {
12
- "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0"
12
+ "typescript": "^5.5.2",
13
+ "wrangler": "^3.60.3"
14
14
  }
15
15
  }
@@ -18,7 +18,7 @@ export default {
18
18
  // Our fetch handler is invoked on a HTTP request: we can send a message to a queue
19
19
  // during (or after) a request.
20
20
  // https://developers.cloudflare.com/queues/platform/javascript-apis/#producer
21
- async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
21
+ async fetch(req, env, ctx): Promise<Response> {
22
22
  // To send a message on a queue, we need to create the queue first
23
23
  // https://developers.cloudflare.com/queues/get-started/#3-create-a-queue
24
24
  await env.MY_QUEUE.send({
@@ -30,7 +30,7 @@ export default {
30
30
  },
31
31
  // The queue handler is invoked when a batch of messages is ready to be delivered
32
32
  // https://developers.cloudflare.com/queues/platform/javascript-apis/#messagebatch
33
- async queue(batch: MessageBatch<Error>, env: Env): Promise<void> {
33
+ async queue(batch, env): Promise<void> {
34
34
  // A queue consumer can make requests to other endpoints on the Internet,
35
35
  // write to R2 object storage, query a D1 Database, and much more.
36
36
  for (let message of batch.messages) {
@@ -38,4 +38,4 @@ export default {
38
38
  console.log(`message ${message.id} processed: ${JSON.stringify(message.body)}`);
39
39
  }
40
40
  },
41
- };
41
+ } satisfies ExportedHandler<Env, Error>;