create-cloudflare 0.0.0-e2972cf2 → 0.0.0-e3136f935

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 (109) hide show
  1. package/dist/cli.js +49866 -49427
  2. package/dist/tsconfig.tsbuildinfo +1 -1
  3. package/package.json +13 -13
  4. package/templates/analog/c3.ts +1 -0
  5. package/templates/angular/c3.ts +2 -0
  6. package/templates/astro/c3.ts +1 -0
  7. package/templates/common/c3.ts +3 -0
  8. package/templates/common/ts/package.json +1 -1
  9. package/templates/docusaurus/c3.ts +1 -0
  10. package/templates/gatsby/c3.ts +1 -0
  11. package/templates/hello-world/c3.ts +5 -1
  12. package/templates/hello-world/js/package.json +2 -2
  13. package/templates/hello-world/py/__dot__gitignore +68 -0
  14. package/templates/hello-world/py/package.json +13 -0
  15. package/templates/hello-world/py/src/entry.py +4 -0
  16. package/templates/hello-world/ts/package.json +3 -3
  17. package/templates/hello-world/ts/tsconfig.json +2 -1
  18. package/templates/hello-world-durable-object/c3.ts +3 -1
  19. package/templates/hello-world-durable-object/ts/package.json +1 -1
  20. package/templates/hono/c3.ts +1 -10
  21. package/templates/hono/snippets/appDeclaration.ts +1 -1
  22. package/templates/next/README.md +1 -1
  23. package/templates/next/c3.ts +2 -1
  24. package/templates/nuxt/c3.ts +1 -0
  25. package/templates/openapi/c3.ts +1 -0
  26. package/templates/openapi/ts/README.md +3 -3
  27. package/templates/openapi/ts/package.json +3 -1
  28. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  29. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  30. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  31. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  32. package/templates/openapi/ts/src/index.ts +14 -20
  33. package/templates/openapi/ts/src/types.ts +9 -8
  34. package/templates/queues/c3.ts +2 -0
  35. package/templates/queues/ts/package.json +1 -1
  36. package/templates/qwik/c3.ts +1 -0
  37. package/templates/react/c3.ts +33 -3
  38. package/templates/remix/c3.ts +1 -0
  39. package/templates/scheduled/c3.ts +2 -0
  40. package/templates/scheduled/ts/package.json +1 -1
  41. package/templates/solid/c3.ts +1 -0
  42. package/templates/svelte/c3.ts +1 -0
  43. package/templates/vue/c3.ts +1 -0
  44. package/templates-experimental/angular/c3.ts +102 -0
  45. package/templates-experimental/angular/templates/server.ts +34 -0
  46. package/templates-experimental/angular/templates/src/.assetsignore +4 -0
  47. package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +27 -0
  48. package/templates-experimental/angular/templates/tools/copy-files.mjs +9 -0
  49. package/templates-experimental/angular/templates/tools/paths.mjs +9 -0
  50. package/templates-experimental/angular/templates/wrangler.toml +5 -0
  51. package/templates-experimental/astro/c3.ts +114 -0
  52. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  53. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  54. package/templates-experimental/astro/templates/wrangler.toml +6 -0
  55. package/templates-experimental/docusaurus/c3.ts +32 -0
  56. package/templates-experimental/docusaurus/templates/wrangler.toml +4 -0
  57. package/templates-experimental/gatsby/c3.ts +53 -0
  58. package/templates-experimental/gatsby/templates/wrangler.toml +4 -0
  59. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  60. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  61. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  62. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  63. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  64. package/templates-experimental/hello-world-with-assets/js/public/index.html +19 -0
  65. package/templates-experimental/hello-world-with-assets/js/src/index.js +15 -0
  66. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +20 -0
  67. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  68. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +6 -0
  69. package/templates-experimental/hello-world-with-assets/py/public/index.html +19 -0
  70. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +6 -0
  71. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  72. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  73. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  74. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  75. package/templates-experimental/hello-world-with-assets/ts/public/index.html +19 -0
  76. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +18 -0
  77. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +25 -0
  78. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  79. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +103 -0
  80. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  81. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  82. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +6 -0
  83. package/templates-experimental/nuxt/c3.ts +135 -0
  84. package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
  85. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  86. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  87. package/templates-experimental/nuxt/templates/wrangler.toml +5 -0
  88. package/templates-experimental/qwik/c3.ts +153 -0
  89. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  90. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  91. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  92. package/templates-experimental/qwik/templates/wrangler.toml +6 -0
  93. package/templates-experimental/remix/c3.ts +77 -0
  94. package/templates-experimental/remix/templates/public/.assetsignore +4 -0
  95. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  96. package/templates-experimental/remix/templates/wrangler.toml +5 -0
  97. package/templates-experimental/solid/c3.ts +137 -0
  98. package/templates-experimental/solid/templates/wrangler.toml +6 -0
  99. package/templates-experimental/svelte/c3.ts +132 -0
  100. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  101. package/templates-experimental/svelte/js/wrangler.toml +5 -0
  102. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  103. package/templates-experimental/svelte/ts/wrangler.toml +5 -0
  104. package/templates/hello-world-python/c3.ts +0 -9
  105. package/templates/hono/snippets/bindingsType.ts +0 -3
  106. /package/templates/{hello-world-python → hello-world}/py/wrangler.toml +0 -0
  107. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/__dot__gitignore +0 -0
  108. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/package.json +0 -0
  109. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/src/entry.py +0 -0
@@ -12,6 +12,7 @@ const generate = async (ctx: C3Context) => {
12
12
  const config: TemplateConfig = {
13
13
  configVersion: 1,
14
14
  id: "docusaurus",
15
+ frameworkCli: "create-docusaurus",
15
16
  platform: "pages",
16
17
  displayName: "Docusaurus",
17
18
  generate,
@@ -32,6 +32,7 @@ const generate = async (ctx: C3Context) => {
32
32
  const config: TemplateConfig = {
33
33
  configVersion: 1,
34
34
  id: "gatsby",
35
+ frameworkCli: "gatsby",
35
36
  platform: "pages",
36
37
  displayName: "Gatsby",
37
38
  generate,
@@ -1,7 +1,8 @@
1
1
  export default {
2
2
  configVersion: 1,
3
3
  id: "hello-world",
4
- displayName: '"Hello World" Worker',
4
+ displayName: "Hello World Worker",
5
+ description: "Get started with a basic Worker in the language of your choice",
5
6
  platform: "workers",
6
7
  copyFiles: {
7
8
  variants: {
@@ -11,6 +12,9 @@ export default {
11
12
  ts: {
12
13
  path: "./ts",
13
14
  },
15
+ python: {
16
+ path: "./py",
17
+ },
14
18
  },
15
19
  },
16
20
  };
@@ -9,8 +9,8 @@
9
9
  "test": "vitest"
10
10
  },
11
11
  "devDependencies": {
12
- "@cloudflare/vitest-pool-workers": "^0.4.5",
12
+ "@cloudflare/vitest-pool-workers": "^0.5.2",
13
13
  "wrangler": "^3.60.3",
14
- "vitest": "1.5.0"
14
+ "vitest": "2.0.5"
15
15
  }
16
16
  }
@@ -0,0 +1,68 @@
1
+ # Logs
2
+
3
+ logs
4
+ _.log
5
+ npm-debug.log_
6
+ yarn-debug.log*
7
+ yarn-error.log*
8
+ lerna-debug.log*
9
+ .pnpm-debug.log*
10
+
11
+ # Diagnostic reports (https://nodejs.org/api/report.html)
12
+
13
+ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
14
+
15
+ # Runtime data
16
+
17
+ pids
18
+ _.pid
19
+ _.seed
20
+ \*.pid.lock
21
+
22
+ # Dependency directories
23
+
24
+ node_modules/
25
+ jspm_packages/
26
+
27
+ # TypeScript cache
28
+
29
+ \*.tsbuildinfo
30
+
31
+ # Optional npm cache directory
32
+
33
+ .npm
34
+
35
+ # Optional eslint cache
36
+
37
+ .eslintcache
38
+
39
+ # Optional stylelint cache
40
+
41
+ .stylelintcache
42
+
43
+ # Optional REPL history
44
+
45
+ .node_repl_history
46
+
47
+ # Output of 'npm pack'
48
+
49
+ \*.tgz
50
+
51
+ # dotenv environment variable files
52
+
53
+ .env
54
+ .env.development.local
55
+ .env.test.local
56
+ .env.production.local
57
+ .env.local
58
+
59
+ # public
60
+
61
+ # Stores VSCode versions used for testing VSCode extensions
62
+
63
+ .vscode-test
64
+
65
+ # wrangler project
66
+
67
+ .dev.vars
68
+ .wrangler/
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "<TBD>",
3
+ "version": "0.0.0",
4
+ "private": true,
5
+ "scripts": {
6
+ "deploy": "wrangler deploy",
7
+ "dev": "wrangler dev",
8
+ "start": "wrangler dev"
9
+ },
10
+ "devDependencies": {
11
+ "wrangler": "^3.60.3"
12
+ }
13
+ }
@@ -0,0 +1,4 @@
1
+ from js import Response
2
+
3
+ async def on_fetch(request, env):
4
+ return Response.new("Hello World!")
@@ -10,9 +10,9 @@
10
10
  "cf-typegen": "wrangler types"
11
11
  },
12
12
  "devDependencies": {
13
- "@cloudflare/vitest-pool-workers": "^0.4.5",
14
- "typescript": "^5.4.5",
15
- "vitest": "1.5.0",
13
+ "@cloudflare/vitest-pool-workers": "^0.5.2",
14
+ "typescript": "^5.5.2",
15
+ "vitest": "2.0.5",
16
16
  "wrangler": "^3.60.3"
17
17
  }
18
18
  }
@@ -98,5 +98,6 @@
98
98
  // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99
99
  "skipLibCheck": true /* Skip type checking all .d.ts files. */
100
100
  },
101
- "exclude": ["test"]
101
+ "exclude": ["test"],
102
+ "include": ["worker-configuration.d.ts", "src/**/*.ts"]
102
103
  }
@@ -1,7 +1,9 @@
1
1
  export default {
2
2
  configVersion: 1,
3
3
  id: "hello-world-durable-object",
4
- displayName: "Co-ordination / multiplayer API (using Durable Objects)",
4
+ displayName: "Hello World Worker Using Durable Objects",
5
+ description:
6
+ "Get started with a basic stateful app to build projects like real-time chats, collaborative apps, and multiplayer games",
5
7
  platform: "workers",
6
8
  copyFiles: {
7
9
  variants: {
@@ -9,7 +9,7 @@
9
9
  "cf-typegen": "wrangler types"
10
10
  },
11
11
  "devDependencies": {
12
- "typescript": "^5.4.5",
12
+ "typescript": "^5.5.2",
13
13
  "wrangler": "^3.60.3"
14
14
  }
15
15
  }
@@ -32,16 +32,6 @@ const configure = async (ctx: C3Context) => {
32
32
  const snippets = loadTemplateSnippets(ctx);
33
33
 
34
34
  transformFile(indexFile, {
35
- // Insert the env declaration after the last import (but before the rest of the body)
36
- visitProgram: function (n) {
37
- const lastImportIndex = n.node.body.findLastIndex(
38
- (t) => t.type === "ImportDeclaration",
39
- );
40
- const lastImport = n.get("body", lastImportIndex);
41
- lastImport.insertAfter(...snippets.bindingsTypeTs);
42
-
43
- return this.traverse(n);
44
- },
45
35
  visitVariableDeclarator(n) {
46
36
  if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
47
37
  n.node.init = snippets
@@ -58,6 +48,7 @@ const configure = async (ctx: C3Context) => {
58
48
  const config: TemplateConfig = {
59
49
  configVersion: 1,
60
50
  id: "hono",
51
+ frameworkCli: "create-hono",
61
52
  displayName: "Hono",
62
53
  copyFiles: {
63
54
  path: "./templates",
@@ -1 +1 @@
1
- new Hono<{ Bindings: Bindings }>()
1
+ new Hono<{ Bindings: CloudflareBindings }>()
@@ -23,7 +23,7 @@ Besides the `dev` script mentioned above `c3` has added a few extra scripts that
23
23
  - `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
24
24
  - `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
25
25
 
26
- > __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md#recommended-workflow))
26
+ > __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md#recommended-development-workflow))
27
27
 
28
28
  ### Bindings
29
29
 
@@ -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
  }
@@ -175,6 +175,7 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
175
175
  export default {
176
176
  configVersion: 1,
177
177
  id: "next",
178
+ frameworkCli: "create-next-app",
178
179
  platform: "pages",
179
180
  displayName: "Next",
180
181
  generate,
@@ -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: {
@@ -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,7 +9,9 @@
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
17
  "@types/node": "20.8.3",
@@ -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
- } satisfies ExportedHandler;
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
+ });
@@ -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: {
@@ -9,7 +9,7 @@
9
9
  "cf-typegen": "wrangler types"
10
10
  },
11
11
  "devDependencies": {
12
- "typescript": "^5.4.5",
12
+ "typescript": "^5.5.2",
13
13
  "wrangler": "^3.60.3"
14
14
  }
15
15
  }
@@ -125,6 +125,7 @@ const populateCloudflareEnv = () => {
125
125
  const config: TemplateConfig = {
126
126
  configVersion: 1,
127
127
  id: "qwik",
128
+ frameworkCli: "create-qwik",
128
129
  displayName: "Qwik",
129
130
  platform: "pages",
130
131
  copyFiles: {