create-cloudflare 0.0.0-b27c95f4 → 0.0.0-b2d094e52

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 (214) hide show
  1. package/dist/cli.js +43848 -42466
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +28 -25
  4. package/templates/analog/c3.ts +135 -0
  5. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  6. package/templates/analog/templates/env.d.ts +13 -0
  7. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  8. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  9. package/templates/analog/templates/wrangler.toml +85 -0
  10. package/templates/angular/c3.ts +14 -11
  11. package/templates/astro/c3.ts +12 -19
  12. package/templates/astro/snippets/runtimeDeclaration.ts +2 -1
  13. package/templates/astro/templates/wrangler.toml +60 -25
  14. package/templates/common/c3.ts +3 -0
  15. package/templates/common/js/.editorconfig +0 -1
  16. package/templates/common/js/package.json +1 -1
  17. package/templates/common/js/wrangler.toml +84 -22
  18. package/templates/common/ts/.editorconfig +0 -1
  19. package/templates/common/ts/package.json +4 -3
  20. package/templates/common/ts/src/ab-test.ts +2 -2
  21. package/templates/common/ts/src/index.ts +5 -2
  22. package/templates/common/ts/src/proxy.ts +2 -2
  23. package/templates/common/ts/src/redirect.ts +2 -2
  24. package/templates/common/ts/tsconfig.json +1 -1
  25. package/templates/common/ts/worker-configuration.d.ts +2 -14
  26. package/templates/common/ts/wrangler.toml +84 -22
  27. package/templates/docusaurus/c3.ts +7 -6
  28. package/templates/gatsby/c3.ts +8 -5
  29. package/templates/hello-world/c3.ts +5 -1
  30. package/templates/hello-world/js/.editorconfig +0 -1
  31. package/templates/hello-world/js/package.json +5 -2
  32. package/templates/hello-world/js/test/index.spec.js +20 -0
  33. package/templates/hello-world/js/vitest.config.js +11 -0
  34. package/templates/hello-world/js/wrangler.toml +85 -22
  35. package/templates/hello-world/py/__dot__gitignore +68 -0
  36. package/templates/hello-world/py/package.json +13 -0
  37. package/templates/hello-world/py/src/entry.py +4 -0
  38. package/templates/hello-world/py/wrangler.toml +114 -0
  39. package/templates/hello-world/ts/.editorconfig +0 -1
  40. package/templates/hello-world/ts/package.json +7 -3
  41. package/templates/hello-world/ts/src/index.ts +5 -19
  42. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  43. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  44. package/templates/hello-world/ts/tsconfig.json +5 -3
  45. package/templates/hello-world/ts/vitest.config.mts +11 -0
  46. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  47. package/templates/hello-world/ts/wrangler.toml +85 -22
  48. package/templates/hello-world-durable-object/c3.ts +3 -1
  49. package/templates/hello-world-durable-object/js/.editorconfig +0 -1
  50. package/templates/hello-world-durable-object/js/package.json +1 -1
  51. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  52. package/templates/hello-world-durable-object/js/wrangler.toml +84 -22
  53. package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
  54. package/templates/hello-world-durable-object/ts/package.json +4 -4
  55. package/templates/hello-world-durable-object/ts/src/index.ts +24 -37
  56. package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
  57. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  58. package/templates/hello-world-durable-object/ts/wrangler.toml +84 -22
  59. package/templates/hono/c3.ts +45 -1
  60. package/templates/hono/snippets/appDeclaration.ts +1 -0
  61. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  62. package/templates/hono/templates/wrangler.toml +113 -0
  63. package/templates/next/README.md +12 -2
  64. package/templates/next/app/js/app/api/hello/route.js +1 -1
  65. package/templates/next/app/ts/app/api/hello/route.ts +1 -1
  66. package/templates/next/c3.ts +45 -33
  67. package/templates/next/env.d.ts +3 -5
  68. package/templates/next/pages/js/pages/api/hello.js +1 -1
  69. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  70. package/templates/next/wrangler.toml +59 -30
  71. package/templates/nuxt/c3.ts +20 -18
  72. package/templates/nuxt/templates/worker-configuration.d.ts +4 -3
  73. package/templates/nuxt/templates/wrangler.toml +61 -25
  74. package/templates/openapi/c3.ts +1 -0
  75. package/templates/openapi/ts/README.md +3 -3
  76. package/templates/openapi/ts/package.json +7 -4
  77. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  78. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  79. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  80. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  81. package/templates/openapi/ts/src/index.ts +14 -20
  82. package/templates/openapi/ts/src/types.ts +9 -8
  83. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  84. package/templates/openapi/ts/wrangler.toml +110 -0
  85. package/templates/pre-existing/c3.ts +9 -9
  86. package/templates/pre-existing/js/.editorconfig +0 -1
  87. package/templates/pre-existing/js/package.json +1 -1
  88. package/templates/pre-existing/js/wrangler.toml +1 -0
  89. package/templates/queues/c3.ts +2 -0
  90. package/templates/queues/js/.editorconfig +0 -1
  91. package/templates/queues/js/package.json +1 -1
  92. package/templates/queues/js/wrangler.toml +101 -2
  93. package/templates/queues/ts/.editorconfig +0 -1
  94. package/templates/queues/ts/package.json +4 -3
  95. package/templates/queues/ts/src/index.ts +6 -8
  96. package/templates/queues/ts/tsconfig.json +1 -1
  97. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  98. package/templates/queues/ts/wrangler.toml +101 -2
  99. package/templates/qwik/c3.ts +16 -14
  100. package/templates/qwik/templates/worker-configuration.d.ts +4 -3
  101. package/templates/qwik/templates/wrangler.toml +61 -25
  102. package/templates/react/c3.ts +38 -6
  103. package/templates/remix/c3.ts +7 -7
  104. package/templates/remix/templates/worker-configuration.d.ts +4 -3
  105. package/templates/remix/templates/wrangler.toml +60 -25
  106. package/templates/scheduled/c3.ts +2 -0
  107. package/templates/scheduled/js/.editorconfig +0 -1
  108. package/templates/scheduled/js/package.json +3 -3
  109. package/templates/scheduled/js/src/index.js +8 -1
  110. package/templates/scheduled/js/wrangler.toml +110 -0
  111. package/templates/scheduled/ts/.editorconfig +0 -1
  112. package/templates/scheduled/ts/package.json +5 -4
  113. package/templates/scheduled/ts/src/index.ts +6 -23
  114. package/templates/scheduled/ts/tsconfig.json +1 -1
  115. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  116. package/templates/scheduled/ts/wrangler.toml +110 -0
  117. package/templates/solid/c3.ts +23 -16
  118. package/templates/solid/templates/wrangler.toml +84 -0
  119. package/templates/svelte/c3.ts +13 -11
  120. package/templates/svelte/js/wrangler.toml +60 -25
  121. package/templates/svelte/ts/wrangler.toml +60 -25
  122. package/templates/vue/c3.ts +8 -6
  123. package/templates-experimental/angular/c3.ts +98 -0
  124. package/templates-experimental/angular/templates/server.ts +34 -0
  125. package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +32 -0
  126. package/templates-experimental/angular/templates/wrangler.toml +11 -0
  127. package/templates-experimental/astro/c3.ts +114 -0
  128. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  129. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  130. package/templates-experimental/astro/templates/wrangler.toml +12 -0
  131. package/templates-experimental/docusaurus/c3.ts +32 -0
  132. package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
  133. package/templates-experimental/gatsby/c3.ts +53 -0
  134. package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
  135. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  136. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  137. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  138. package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
  139. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  140. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  141. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  142. package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  143. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  144. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  145. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  146. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
  147. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  148. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  149. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  150. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  151. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  152. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  153. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +101 -0
  154. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  155. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
  156. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  157. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  158. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  159. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  160. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  161. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  162. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  163. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  164. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  165. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
  166. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  167. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  168. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  169. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  170. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
  171. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  172. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  173. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  174. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  175. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  176. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  177. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  178. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  179. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +103 -0
  180. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  181. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  182. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
  183. package/templates-experimental/hono/c3.ts +43 -0
  184. package/templates-experimental/hono/templates/public/index.html +19 -0
  185. package/templates-experimental/hono/templates/src/index.ts +9 -0
  186. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  187. package/templates-experimental/hono/templates/wrangler.toml +5 -0
  188. package/templates-experimental/next/c3.ts +52 -0
  189. package/templates-experimental/next/templates/__dot__gitignore +42 -0
  190. package/templates-experimental/next/templates/env.d.ts +5 -0
  191. package/templates-experimental/next/templates/wrangler.toml +12 -0
  192. package/templates-experimental/nuxt/c3.ts +135 -0
  193. package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
  194. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  195. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  196. package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
  197. package/templates-experimental/qwik/c3.ts +153 -0
  198. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  199. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  200. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  201. package/templates-experimental/qwik/templates/wrangler.toml +12 -0
  202. package/templates-experimental/remix/c3.ts +77 -0
  203. package/templates-experimental/remix/templates/public/.assetsignore +4 -0
  204. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  205. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  206. package/templates-experimental/solid/c3.ts +137 -0
  207. package/templates-experimental/solid/templates/wrangler.toml +12 -0
  208. package/templates-experimental/svelte/c3.ts +132 -0
  209. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  210. package/templates-experimental/svelte/js/wrangler.toml +11 -0
  211. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  212. package/templates-experimental/svelte/ts/wrangler.toml +11 -0
  213. package/templates/svelte/js/src/hooks.server.js +0 -25
  214. package/templates/svelte/ts/src/hooks.server.ts +0 -24
@@ -1,57 +1,86 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  compatibility_date = "<TBD>"
3
-
4
4
  compatibility_flags = ["nodejs_compat"]
5
+ pages_build_output_dir = ".vercel/output/static"
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"
5
13
 
6
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
7
17
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
18
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
9
19
  # [vars]
10
20
  # MY_VARIABLE = "production_value"
11
21
 
22
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
23
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
24
+ # [ai]
25
+ # binding = "AI"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
35
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
36
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
37
+ # [[durable_objects.bindings]]
38
+ # name = "MY_DURABLE_OBJECT"
39
+ # class_name = "MyDurableObject"
40
+ # script_name = 'my-durable-object'
41
+
12
42
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
13
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
43
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
14
44
  # [[kv_namespaces]]
15
45
  # binding = "MY_KV_NAMESPACE"
16
46
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
17
47
 
18
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
19
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
20
- # [[r2_buckets]]
21
- # binding = "MY_BUCKET"
22
- # bucket_name = "my-bucket"
23
-
24
48
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
25
- # Docs: https://developers.cloudflare.com/queues/get-started
49
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
26
50
  # [[queues.producers]]
27
51
  # binding = "MY_QUEUE"
28
52
  # queue = "my-queue"
29
53
 
30
- # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
31
- # Docs: https://developers.cloudflare.com/queues/get-started
32
- # [[queues.consumers]]
33
- # queue = "my-queue"
54
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
55
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
56
+ # [[r2_buckets]]
57
+ # binding = "MY_BUCKET"
58
+ # bucket_name = "my-bucket"
34
59
 
35
60
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
36
- # Docs: https://developers.cloudflare.com/workers/platform/services
61
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
37
62
  # [[services]]
38
63
  # binding = "MY_SERVICE"
39
64
  # service = "my-service"
40
65
 
41
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
42
- # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
43
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
44
- # [[durable_objects.bindings]]
45
- # name = "MY_DURABLE_OBJECT"
46
- # class_name = "MyDurableObject"
66
+ # To use different bindings for preview and production environments, follow the examples below.
67
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
68
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
47
69
 
48
- # Durable Object migrations.
49
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
50
- # [[migrations]]
51
- # tag = "v1"
52
- # new_classes = ["MyDurableObject"]
70
+ ######## PREVIEW environment config ########
53
71
 
54
- # KV Example:
55
- # [[kv_namespaces]]
56
- # binding = "MY_KV"
57
- # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
72
+ # [env.preview.vars]
73
+ # API_KEY = "xyz789"
74
+
75
+ # [[env.preview.kv_namespaces]]
76
+ # binding = "MY_KV_NAMESPACE"
77
+ # id = "<PREVIEW_NAMESPACE_ID>"
78
+
79
+ ######## PRODUCTION environment config ########
80
+
81
+ # [env.production.vars]
82
+ # API_KEY = "abc123"
83
+
84
+ # [[env.production.kv_namespaces]]
85
+ # binding = "MY_KV_NAMESPACE"
86
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -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
 
@@ -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,21 +112,23 @@ 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: {
118
119
  path: "./templates",
119
120
  },
120
- devScript: "dev",
121
- deployScript: "deploy",
122
121
  generate,
123
122
  configure,
124
123
  transformPackageJson: async () => ({
125
124
  scripts: {
126
- deploy: `${npm} run build && wrangler pages deploy ./dist`,
127
- preview: `${npm} run build && wrangler pages dev ./dist`,
128
- "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`,
129
128
  },
130
129
  }),
130
+ devScript: "dev",
131
+ deployScript: "deploy",
132
+ previewScript: "preview",
131
133
  };
132
134
  export default config;
@@ -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.toml`, regenerate this interface via `npm run cf-typegen`
3
+ interface Env {
4
+ }
@@ -1,50 +1,86 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  compatibility_date = "<TBD>"
4
+ compatibility_flags = ["nodejs_compat"]
5
+ pages_build_output_dir = "./dist"
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"
3
13
 
4
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
5
17
  # Note: Use secrets to store sensitive data.
6
- # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
18
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
7
19
  # [vars]
8
20
  # MY_VARIABLE = "production_value"
9
21
 
22
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
23
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
24
+ # [ai]
25
+ # binding = "AI"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
35
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
36
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
37
+ # [[durable_objects.bindings]]
38
+ # name = "MY_DURABLE_OBJECT"
39
+ # class_name = "MyDurableObject"
40
+ # script_name = 'my-durable-object'
41
+
10
42
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
11
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
43
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
12
44
  # [[kv_namespaces]]
13
45
  # binding = "MY_KV_NAMESPACE"
14
46
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
15
47
 
16
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
17
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
18
- # [[r2_buckets]]
19
- # binding = "MY_BUCKET"
20
- # bucket_name = "my-bucket"
21
-
22
48
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
23
- # Docs: https://developers.cloudflare.com/queues/get-started
49
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
24
50
  # [[queues.producers]]
25
51
  # binding = "MY_QUEUE"
26
52
  # queue = "my-queue"
27
53
 
28
- # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
29
- # Docs: https://developers.cloudflare.com/queues/get-started
30
- # [[queues.consumers]]
31
- # queue = "my-queue"
54
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
55
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
56
+ # [[r2_buckets]]
57
+ # binding = "MY_BUCKET"
58
+ # bucket_name = "my-bucket"
32
59
 
33
60
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
34
- # Docs: https://developers.cloudflare.com/workers/platform/services
61
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
35
62
  # [[services]]
36
63
  # binding = "MY_SERVICE"
37
64
  # service = "my-service"
38
65
 
39
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
40
- # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
41
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
42
- # [[durable_objects.bindings]]
43
- # name = "MY_DURABLE_OBJECT"
44
- # class_name = "MyDurableObject"
66
+ # To use different bindings for preview and production environments, follow the examples below.
67
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
68
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
69
+
70
+ ######## PREVIEW environment config ########
71
+
72
+ # [env.preview.vars]
73
+ # API_KEY = "xyz789"
74
+
75
+ # [[env.preview.kv_namespaces]]
76
+ # binding = "MY_KV_NAMESPACE"
77
+ # id = "<PREVIEW_NAMESPACE_ID>"
78
+
79
+ ######## PRODUCTION environment config ########
45
80
 
46
- # Durable Object migrations.
47
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
48
- # [[migrations]]
49
- # tag = "v1"
50
- # new_classes = ["MyDurableObject"]
81
+ # [env.production.vars]
82
+ # API_KEY = "abc123"
83
+
84
+ # [[env.production.kv_namespaces]]
85
+ # binding = "MY_KV_NAMESPACE"
86
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -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.60.3"
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