create-cloudflare 0.0.0-e0abf917 → 0.0.0-e0b98fdb6

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 (188) hide show
  1. package/README.md +1 -1
  2. package/dist/cli.js +35303 -34897
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +26 -25
  5. package/templates/analog/c3.ts +5 -4
  6. package/templates/analog/templates/wrangler.toml +7 -0
  7. package/templates/angular/c3.ts +28 -14
  8. package/templates/angular/templates/src/server.ts +15 -0
  9. package/templates/angular/templates/tools/copy-files.mjs +8 -2
  10. package/templates/astro/c3.ts +4 -3
  11. package/templates/astro/templates/wrangler.toml +8 -0
  12. package/templates/common/c3.ts +3 -0
  13. package/templates/common/js/package.json +1 -1
  14. package/templates/common/js/wrangler.toml +13 -0
  15. package/templates/common/ts/package.json +2 -2
  16. package/templates/common/ts/src/ab-test.ts +2 -2
  17. package/templates/common/ts/src/index.ts +2 -2
  18. package/templates/common/ts/src/proxy.ts +2 -2
  19. package/templates/common/ts/src/redirect.ts +2 -2
  20. package/templates/common/ts/tsconfig.json +37 -95
  21. package/templates/common/ts/wrangler.toml +13 -0
  22. package/templates/docusaurus/c3.ts +3 -1
  23. package/templates/gatsby/c3.ts +1 -0
  24. package/templates/hello-world/c3.ts +5 -1
  25. package/templates/hello-world/js/package.json +3 -3
  26. package/templates/hello-world/js/vitest.config.js +8 -8
  27. package/templates/hello-world/js/wrangler.toml +13 -0
  28. package/templates/hello-world/py/__dot__gitignore +68 -0
  29. package/templates/hello-world/py/package.json +13 -0
  30. package/templates/{hello-world-python → hello-world}/py/wrangler.toml +13 -0
  31. package/templates/hello-world/ts/package.json +4 -4
  32. package/templates/hello-world/ts/src/index.ts +2 -2
  33. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  34. package/templates/hello-world/ts/tsconfig.json +38 -96
  35. package/templates/hello-world/ts/vitest.config.mts +11 -0
  36. package/templates/hello-world/ts/wrangler.toml +13 -0
  37. package/templates/hello-world-durable-object/c3.ts +3 -1
  38. package/templates/hello-world-durable-object/js/package.json +1 -1
  39. package/templates/hello-world-durable-object/js/src/index.js +1 -1
  40. package/templates/hello-world-durable-object/js/wrangler.toml +14 -1
  41. package/templates/hello-world-durable-object/ts/package.json +2 -2
  42. package/templates/hello-world-durable-object/ts/src/index.ts +3 -24
  43. package/templates/hello-world-durable-object/ts/tsconfig.json +36 -95
  44. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +3 -4
  45. package/templates/hello-world-durable-object/ts/wrangler.toml +15 -2
  46. package/templates/hono/c3.ts +44 -0
  47. package/templates/hono/snippets/appDeclaration.ts +1 -0
  48. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  49. package/templates/hono/templates/wrangler.toml +113 -0
  50. package/templates/next/README.md +1 -1
  51. package/templates/next/c3.ts +16 -14
  52. package/templates/next/wrangler.toml +7 -0
  53. package/templates/nuxt/c3.ts +9 -9
  54. package/templates/nuxt/templates/wrangler.toml +8 -0
  55. package/templates/openapi/c3.ts +1 -0
  56. package/templates/openapi/ts/README.md +3 -3
  57. package/templates/openapi/ts/package.json +5 -3
  58. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  59. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  60. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  61. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  62. package/templates/openapi/ts/src/index.ts +14 -20
  63. package/templates/openapi/ts/src/types.ts +9 -8
  64. package/templates/openapi/ts/wrangler.toml +13 -0
  65. package/templates/pre-existing/c3.ts +33 -14
  66. package/templates/pre-existing/js/package.json +1 -1
  67. package/templates/queues/c3.ts +2 -0
  68. package/templates/queues/js/package.json +1 -1
  69. package/templates/queues/js/wrangler.toml +13 -0
  70. package/templates/queues/ts/package.json +2 -2
  71. package/templates/queues/ts/src/index.ts +3 -3
  72. package/templates/queues/ts/tsconfig.json +36 -95
  73. package/templates/queues/ts/wrangler.toml +13 -0
  74. package/templates/qwik/c3.ts +7 -6
  75. package/templates/qwik/templates/wrangler.toml +8 -0
  76. package/templates/react/c3.ts +33 -3
  77. package/templates/remix/c3.ts +1 -0
  78. package/templates/remix/templates/wrangler.toml +7 -0
  79. package/templates/scheduled/c3.ts +2 -0
  80. package/templates/scheduled/js/package.json +3 -3
  81. package/templates/scheduled/js/src/index.js +8 -1
  82. package/templates/scheduled/js/wrangler.toml +13 -0
  83. package/templates/scheduled/ts/package.json +4 -4
  84. package/templates/scheduled/ts/src/index.ts +3 -3
  85. package/templates/scheduled/ts/tsconfig.json +36 -95
  86. package/templates/scheduled/ts/wrangler.toml +13 -0
  87. package/templates/solid/c3.ts +12 -9
  88. package/templates/solid/templates/wrangler.toml +7 -0
  89. package/templates/svelte/c3.ts +39 -8
  90. package/templates/svelte/js/wrangler.toml +7 -0
  91. package/templates/svelte/ts/wrangler.toml +7 -0
  92. package/templates/vue/c3.ts +1 -0
  93. package/templates-experimental/angular/c3.ts +112 -0
  94. package/templates-experimental/angular/templates/src/server.ts +15 -0
  95. package/templates-experimental/angular/templates/wrangler.toml +11 -0
  96. package/templates-experimental/astro/c3.ts +114 -0
  97. package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
  98. package/templates-experimental/astro/templates/public/.assetsignore +4 -0
  99. package/templates-experimental/astro/templates/wrangler.toml +12 -0
  100. package/templates-experimental/docusaurus/c3.ts +32 -0
  101. package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
  102. package/templates-experimental/gatsby/c3.ts +53 -0
  103. package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
  104. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  105. package/{templates/hello-world-python/py → templates-experimental/hello-world-assets-only/templates}/package.json +1 -1
  106. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  107. package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
  108. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  109. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  110. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  111. package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
  112. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  113. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  114. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  115. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
  116. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  117. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  118. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  119. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  120. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  121. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  122. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  123. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  124. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
  125. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  126. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  127. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  128. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  129. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  130. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  131. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  132. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  133. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  134. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
  135. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  136. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  137. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  138. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
  139. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  140. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  141. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  142. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  143. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  144. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  145. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  146. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  147. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
  148. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  149. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  150. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
  151. package/templates-experimental/hono/c3.ts +43 -0
  152. package/templates-experimental/hono/templates/public/index.html +19 -0
  153. package/templates-experimental/hono/templates/src/index.ts +9 -0
  154. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  155. package/templates-experimental/hono/templates/wrangler.toml +5 -0
  156. package/templates-experimental/next/c3.ts +52 -0
  157. package/templates-experimental/next/templates/__dot__gitignore +42 -0
  158. package/templates-experimental/next/templates/env.d.ts +5 -0
  159. package/templates-experimental/next/templates/wrangler.toml +12 -0
  160. package/templates-experimental/nuxt/c3.ts +135 -0
  161. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  162. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  163. package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
  164. package/templates-experimental/qwik/c3.ts +153 -0
  165. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  166. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  167. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  168. package/templates-experimental/qwik/templates/wrangler.toml +12 -0
  169. package/templates-experimental/remix/c3.ts +52 -0
  170. package/templates-experimental/remix/templates/public/.assetsignore +0 -0
  171. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  172. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  173. package/templates-experimental/solid/c3.ts +94 -0
  174. package/templates-experimental/solid/templates/wrangler.toml +12 -0
  175. package/templates-experimental/svelte/c3.ts +132 -0
  176. package/templates-experimental/svelte/js/static/.assetsignore +4 -0
  177. package/templates-experimental/svelte/js/wrangler.toml +11 -0
  178. package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
  179. package/templates-experimental/svelte/ts/wrangler.toml +11 -0
  180. package/templates-experimental/vue/c3.ts +33 -0
  181. package/templates-experimental/vue/templates/wrangler.toml +10 -0
  182. package/templates/angular/templates/server.ts +0 -34
  183. package/templates/angular/templates/tools/alter-polyfills.mjs +0 -27
  184. package/templates/angular/templates/tools/paths.mjs +0 -9
  185. package/templates/hello-world/ts/vitest.config.ts +0 -11
  186. package/templates/hello-world-python/c3.ts +0 -9
  187. /package/templates/{hello-world-python → hello-world}/py/src/entry.py +0 -0
  188. /package/{templates/hello-world-python → templates-experimental/hello-world-with-assets}/py/__dot__gitignore +0 -0
@@ -0,0 +1,113 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ main = "src/index.ts"
4
+ compatibility_date = "<TBD>"
5
+
6
+ # Workers Logs
7
+ # Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
8
+ # Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
9
+ [observability]
10
+ enabled = true
11
+
12
+ # Automatically place your workloads in an optimal location to minimize latency.
13
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
14
+ # rather than the end user may result in better performance.
15
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
16
+ # [placement]
17
+ # mode = "smart"
18
+
19
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
20
+ # Docs:
21
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
22
+ # Note: Use secrets to store sensitive data.
23
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
24
+ # [vars]
25
+ # MY_VARIABLE = "production_value"
26
+
27
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
28
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
29
+ # [ai]
30
+ # binding = "AI"
31
+
32
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
33
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
34
+ # [[analytics_engine_datasets]]
35
+ # binding = "MY_DATASET"
36
+
37
+ # Bind a headless browser instance running on Cloudflare's global network.
38
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
39
+ # [browser]
40
+ # binding = "MY_BROWSER"
41
+
42
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
43
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
44
+ # [[d1_databases]]
45
+ # binding = "MY_DB"
46
+ # database_name = "my-database"
47
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
48
+
49
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
50
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
51
+ # [[dispatch_namespaces]]
52
+ # binding = "MY_DISPATCHER"
53
+ # namespace = "my-namespace"
54
+
55
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
56
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
58
+ # [[durable_objects.bindings]]
59
+ # name = "MY_DURABLE_OBJECT"
60
+ # class_name = "MyDurableObject"
61
+
62
+ # Durable Object migrations.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
64
+ # [[migrations]]
65
+ # tag = "v1"
66
+ # new_classes = ["MyDurableObject"]
67
+
68
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
70
+ # [[hyperdrive]]
71
+ # binding = "MY_HYPERDRIVE"
72
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
73
+
74
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
76
+ # [[kv_namespaces]]
77
+ # binding = "MY_KV_NAMESPACE"
78
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
79
+
80
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
82
+ # [[mtls_certificates]]
83
+ # binding = "MY_CERTIFICATE"
84
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
85
+
86
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
88
+ # [[queues.producers]]
89
+ # binding = "MY_QUEUE"
90
+ # queue = "my-queue"
91
+
92
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
93
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
94
+ # [[queues.consumers]]
95
+ # queue = "my-queue"
96
+
97
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
98
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
99
+ # [[r2_buckets]]
100
+ # binding = "MY_BUCKET"
101
+ # bucket_name = "my-bucket"
102
+
103
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
105
+ # [[services]]
106
+ # binding = "MY_SERVICE"
107
+ # service = "my-service"
108
+
109
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
110
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
111
+ # [[vectorize]]
112
+ # binding = "MY_INDEX"
113
+ # index_name = "my-index"
@@ -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
 
@@ -1,8 +1,7 @@
1
1
  import { join } from "path";
2
- import { crash, updateStatus, warn } from "@cloudflare/cli";
3
- import { processArgument } from "@cloudflare/cli/args";
2
+ import { updateStatus, warn } from "@cloudflare/cli";
4
3
  import { brandColor, dim } from "@cloudflare/cli/colors";
5
- import { spinner } from "@cloudflare/cli/interactive";
4
+ import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
6
5
  import { runFrameworkGenerator } from "frameworks/index";
7
6
  import {
8
7
  copyFile,
@@ -18,7 +17,7 @@ import { detectPackageManager } from "helpers/packageManagers";
18
17
  import { installPackages } from "helpers/packages";
19
18
  import { getTemplatePath } from "../../src/templates";
20
19
  import type { TemplateConfig } from "../../src/templates";
21
- import type { C3Args, C3Context } from "types";
20
+ import type { C3Context } from "types";
22
21
 
23
22
  const { npm, npx } = detectPackageManager();
24
23
 
@@ -35,14 +34,14 @@ const generate = async (ctx: C3Context) => {
35
34
  // (instead of making it a special case which needs extra care)
36
35
  const newTomlContent = wranglerToml.replace(
37
36
  /#\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}`
37
+ ($1) => `# KV Example:\n${$1}`,
39
38
  );
40
39
 
41
40
  if (!/# KV Example/.test(newTomlContent)) {
42
41
  // This should never happen to users, it is a check mostly so that
43
42
  // if the toml file is changed in a way that breaks the "KV Example" addition
44
43
  // the C3 Next.js e2e runs will fail with this
45
- crash("Failed to properly generate the wrangler.toml file");
44
+ throw new Error("Failed to properly generate the wrangler.toml file");
46
45
  }
47
46
 
48
47
  writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
@@ -63,7 +62,7 @@ const updateNextConfig = () => {
63
62
 
64
63
  // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
65
64
  // (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
65
+ // https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
67
66
  if (process.env.NODE_ENV === 'development') {
68
67
  await setupDevPlatform();
69
68
  }
@@ -89,7 +88,7 @@ const configure = async (ctx: C3Context) => {
89
88
  ]);
90
89
 
91
90
  if (!path) {
92
- crash("Could not find the `/api` or `/app` directory");
91
+ throw new Error("Could not find the `/api` or `/app` directory");
93
92
  }
94
93
 
95
94
  const usesTs = usesTypescript(ctx);
@@ -97,7 +96,7 @@ const configure = async (ctx: C3Context) => {
97
96
  if (usesTs) {
98
97
  copyFile(
99
98
  join(getTemplatePath(ctx), "env.d.ts"),
100
- join(projectPath, "env.d.ts")
99
+ join(projectPath, "env.d.ts"),
101
100
  );
102
101
  updateStatus("Created an env.d.ts file");
103
102
  }
@@ -112,7 +111,7 @@ const configure = async (ctx: C3Context) => {
112
111
 
113
112
  copyFile(
114
113
  join(getTemplatePath(ctx), "README.md"),
115
- join(projectPath, "README.md")
114
+ join(projectPath, "README.md"),
116
115
  );
117
116
  updateStatus("Updated the README file");
118
117
 
@@ -120,20 +119,22 @@ const configure = async (ctx: C3Context) => {
120
119
  };
121
120
 
122
121
  export const shouldInstallNextOnPagesEslintPlugin = async (
123
- ctx: C3Context
122
+ ctx: C3Context,
124
123
  ): Promise<boolean> => {
125
124
  const eslintUsage = usesEslint(ctx);
126
125
 
127
- if (!eslintUsage.used) return false;
126
+ if (!eslintUsage.used) {
127
+ return false;
128
+ }
128
129
 
129
130
  if (eslintUsage.configType !== ".eslintrc.json") {
130
131
  warn(
131
- `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`
132
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
132
133
  );
133
134
  return false;
134
135
  }
135
136
 
136
- return await processArgument(ctx.args, "eslint-plugin" as keyof C3Args, {
137
+ return await inputPrompt({
137
138
  type: "confirm",
138
139
  question: "Do you want to use the next-on-pages eslint-plugin?",
139
140
  label: "eslint-plugin",
@@ -173,6 +174,7 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
173
174
  export default {
174
175
  configVersion: 1,
175
176
  id: "next",
177
+ frameworkCli: "create-next-app",
176
178
  platform: "pages",
177
179
  displayName: "Next",
178
180
  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: {
@@ -1,8 +1,16 @@
1
1
  #:schema node_modules/wrangler/config-schema.json
2
2
  name = "<TBD>"
3
3
  compatibility_date = "<TBD>"
4
+ compatibility_flags = ["nodejs_compat"]
4
5
  pages_build_output_dir = "./dist"
5
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
+
6
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
7
15
  # Docs:
8
16
  # - 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