create-cloudflare 0.0.0-d4dae6f6 → 0.0.0-d4e1e9fc

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 (94) hide show
  1. package/dist/cli.js +21144 -21246
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +20 -19
  4. package/templates/analog/c3.ts +134 -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 +2 -2
  11. package/templates/astro/c3.ts +8 -8
  12. package/templates/astro/snippets/runtimeDeclaration.ts +2 -1
  13. package/templates/astro/templates/wrangler.toml +35 -2
  14. package/templates/common/js/package.json +1 -1
  15. package/templates/common/js/wrangler.toml +11 -1
  16. package/templates/common/ts/package.json +4 -3
  17. package/templates/common/ts/src/ab-test.ts +2 -2
  18. package/templates/common/ts/src/index.ts +5 -2
  19. package/templates/common/ts/src/proxy.ts +2 -2
  20. package/templates/common/ts/src/redirect.ts +2 -2
  21. package/templates/common/ts/tsconfig.json +1 -1
  22. package/templates/common/ts/worker-configuration.d.ts +2 -14
  23. package/templates/common/ts/wrangler.toml +11 -1
  24. package/templates/hello-world/js/package.json +5 -4
  25. package/templates/hello-world/js/test/index.spec.js +17 -17
  26. package/templates/hello-world/js/vitest.config.js +8 -8
  27. package/templates/hello-world/js/wrangler.toml +11 -1
  28. package/templates/hello-world/ts/package.json +6 -5
  29. package/templates/hello-world/ts/src/index.ts +5 -19
  30. package/templates/hello-world/ts/test/index.spec.ts +17 -17
  31. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  32. package/templates/hello-world/ts/tsconfig.json +1 -1
  33. package/templates/hello-world/ts/vitest.config.mts +11 -0
  34. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  35. package/templates/hello-world/ts/wrangler.toml +11 -1
  36. package/templates/hello-world-durable-object/c3.ts +1 -1
  37. package/templates/hello-world-durable-object/js/package.json +1 -1
  38. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  39. package/templates/hello-world-durable-object/js/wrangler.toml +12 -2
  40. package/templates/hello-world-durable-object/ts/package.json +4 -4
  41. package/templates/hello-world-durable-object/ts/src/index.ts +26 -18
  42. package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
  43. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  44. package/templates/hello-world-durable-object/ts/wrangler.toml +13 -4
  45. package/templates/hello-world-python/c3.ts +9 -0
  46. package/templates/hello-world-python/py/__dot__gitignore +68 -0
  47. package/templates/hello-world-python/py/package.json +13 -0
  48. package/templates/hello-world-python/py/src/entry.py +4 -0
  49. package/templates/hello-world-python/py/wrangler.toml +108 -0
  50. package/templates/hono/c3.ts +53 -0
  51. package/templates/hono/snippets/appDeclaration.ts +1 -0
  52. package/templates/hono/snippets/bindingsType.ts +3 -0
  53. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  54. package/templates/hono/templates/wrangler.toml +107 -0
  55. package/templates/next/README.md +5 -5
  56. package/templates/next/c3.ts +11 -9
  57. package/templates/next/wrangler.toml +33 -1
  58. package/templates/nuxt/c3.ts +12 -13
  59. package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
  60. package/templates/nuxt/templates/wrangler.toml +35 -2
  61. package/templates/openapi/ts/package.json +4 -3
  62. package/templates/openapi/ts/src/index.ts +1 -1
  63. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  64. package/templates/openapi/ts/wrangler.toml +104 -0
  65. package/templates/pre-existing/c3.ts +5 -5
  66. package/templates/pre-existing/js/package.json +1 -1
  67. package/templates/pre-existing/js/wrangler.toml +1 -0
  68. package/templates/queues/js/package.json +1 -1
  69. package/templates/queues/js/wrangler.toml +11 -1
  70. package/templates/queues/ts/package.json +4 -3
  71. package/templates/queues/ts/src/index.ts +6 -8
  72. package/templates/queues/ts/tsconfig.json +1 -1
  73. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  74. package/templates/queues/ts/wrangler.toml +11 -1
  75. package/templates/qwik/c3.ts +6 -6
  76. package/templates/qwik/templates/worker-configuration.d.ts +1 -1
  77. package/templates/qwik/templates/wrangler.toml +35 -2
  78. package/templates/remix/c3.ts +3 -3
  79. package/templates/remix/templates/worker-configuration.d.ts +1 -1
  80. package/templates/remix/templates/wrangler.toml +35 -2
  81. package/templates/scheduled/js/package.json +3 -3
  82. package/templates/scheduled/js/src/index.js +8 -1
  83. package/templates/scheduled/js/wrangler.toml +12 -2
  84. package/templates/scheduled/ts/package.json +5 -4
  85. package/templates/scheduled/ts/src/index.ts +6 -23
  86. package/templates/scheduled/ts/tsconfig.json +1 -1
  87. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  88. package/templates/scheduled/ts/wrangler.toml +12 -2
  89. package/templates/solid/c3.ts +16 -12
  90. package/templates/solid/templates/wrangler.toml +84 -0
  91. package/templates/svelte/c3.ts +9 -9
  92. package/templates/svelte/js/wrangler.toml +35 -2
  93. package/templates/svelte/ts/wrangler.toml +35 -2
  94. package/templates/hello-world/ts/vitest.config.ts +0 -11
@@ -1,10 +1,20 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
- main = "src/index.ts"
3
+ main = "src/index.js"
3
4
  compatibility_date = "<TBD>"
4
5
 
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
5
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
6
16
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
17
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
18
  # [vars]
9
19
  # MY_VARIABLE = "production_value"
10
20
 
@@ -5,11 +5,11 @@
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
  "devDependencies": {
11
- "@cloudflare/workers-types": "^4.20231218.0",
12
- "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0"
12
+ "typescript": "^5.4.5",
13
+ "wrangler": "^3.60.3"
14
14
  }
15
15
  }
@@ -1,3 +1,5 @@
1
+ import { DurableObject } from "cloudflare:workers";
2
+
1
3
  /**
2
4
  * Welcome to Cloudflare Workers! This is your first Durable Objects application.
3
5
  *
@@ -5,9 +7,13 @@
5
7
  * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
8
  * - Run `npm run deploy` to publish your application
7
9
  *
10
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
11
+ * `Env` object can be regenerated with `npm run cf-typegen`.
12
+ *
8
13
  * Learn more at https://developers.cloudflare.com/durable-objects
9
14
  */
10
15
 
16
+
11
17
  /**
12
18
  * Associate bindings declared in wrangler.toml with the TypeScript type system
13
19
  */
@@ -16,7 +22,7 @@ export interface Env {
16
22
  // MY_KV_NAMESPACE: KVNamespace;
17
23
  //
18
24
  // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
19
- MY_DURABLE_OBJECT: DurableObjectNamespace;
25
+ MY_DURABLE_OBJECT: DurableObjectNamespace<MyDurableObject>;
20
26
  //
21
27
  // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
22
28
  // MY_BUCKET: R2Bucket;
@@ -29,25 +35,27 @@ export interface Env {
29
35
  }
30
36
 
31
37
  /** A Durable Object's behavior is defined in an exported Javascript class */
32
- export class MyDurableObject {
38
+ export class MyDurableObject extends DurableObject {
33
39
  /**
34
40
  * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
35
- * `DurableObjectStub::get` for a given identifier
41
+ * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
36
42
  *
37
- * @param state - The interface for interacting with Durable Object state
43
+ * @param ctx - The interface for interacting with Durable Object state
38
44
  * @param env - The interface to reference bindings declared in wrangler.toml
39
45
  */
40
- constructor(state: DurableObjectState, env: Env) {}
46
+ constructor(ctx: DurableObjectState, env: Env) {
47
+ super(ctx, env);
48
+ }
41
49
 
42
50
  /**
43
- * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
44
- * request from a Worker via an associated stub
51
+ * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
52
+ * Object instance receives a request from a Worker via the same method invocation on the stub
45
53
  *
46
- * @param request - The request submitted to a Durable Object instance from a Worker
47
- * @returns The response to be sent back to the Worker
54
+ * @param name - The name provided to a Durable Object instance from a Worker
55
+ * @returns The greeting to be sent back to the Worker
48
56
  */
49
- async fetch(request: Request): Promise<Response> {
50
- return new Response('Hello World');
57
+ async sayHello(name: string): Promise<string> {
58
+ return `Hello, ${name}!`;
51
59
  }
52
60
  }
53
61
 
@@ -60,19 +68,19 @@ export default {
60
68
  * @param ctx - The execution context of the Worker
61
69
  * @returns The response to be sent back to the client
62
70
  */
63
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
71
+ async fetch(request, env, ctx): Promise<Response> {
64
72
  // We will create a `DurableObjectId` using the pathname from the Worker request
65
73
  // This id refers to a unique instance of our 'MyDurableObject' class above
66
74
  let id: DurableObjectId = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
67
75
 
68
76
  // This stub creates a communication channel with the Durable Object instance
69
77
  // The Durable Object constructor will be invoked upon the first call for a given id
70
- let stub: DurableObjectStub = env.MY_DURABLE_OBJECT.get(id);
78
+ let stub = env.MY_DURABLE_OBJECT.get(id);
71
79
 
72
- // We call `fetch()` on the stub to send a request to the Durable Object instance
73
- // The Durable Object instance will invoke its fetch handler to handle the request
74
- let response = await stub.fetch(request);
80
+ // We call the `sayHello()` RPC method on the stub to invoke the method on the remote
81
+ // Durable Object instance
82
+ let greeting = await stub.sayHello("world");
75
83
 
76
- return response;
84
+ return new Response(greeting);
77
85
  },
78
- };
86
+ } satisfies ExportedHandler<Env>;
@@ -13,7 +13,7 @@
13
13
  /* Language and Environment */
14
14
  "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15
15
  "lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
16
- "jsx": "react" /* Specify what JSX code is generated. */,
16
+ "jsx": "react-jsx" /* Specify what JSX code is generated. */,
17
17
  // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18
18
  // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19
19
  // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
@@ -0,0 +1,6 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
3
+ interface Env {
4
+ MY_DURABLE_OBJECT: DurableObjectNamespace;
5
+ }
6
+
@@ -1,10 +1,20 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  main = "src/index.ts"
3
4
  compatibility_date = "<TBD>"
4
5
 
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
5
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
6
16
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
17
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
18
  # [vars]
9
19
  # MY_VARIABLE = "production_value"
10
20
 
@@ -38,13 +48,13 @@ compatibility_date = "<TBD>"
38
48
 
39
49
  # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
40
50
  # 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
51
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
42
52
  [[durable_objects.bindings]]
43
53
  name = "MY_DURABLE_OBJECT"
44
54
  class_name = "MyDurableObject"
45
55
 
46
56
  # Durable Object migrations.
47
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
48
58
  [[migrations]]
49
59
  tag = "v1"
50
60
  new_classes = ["MyDurableObject"]
@@ -95,4 +105,3 @@ new_classes = ["MyDurableObject"]
95
105
  # [[vectorize]]
96
106
  # binding = "MY_INDEX"
97
107
  # index_name = "my-index"
98
-
@@ -0,0 +1,9 @@
1
+ export default {
2
+ configVersion: 1,
3
+ id: "hello-world-python",
4
+ displayName: '"Hello World" Worker (Python)',
5
+ platform: "workers",
6
+ copyFiles: {
7
+ path: "./py",
8
+ },
9
+ };
@@ -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!")
@@ -0,0 +1,108 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ main = "src/entry.py"
4
+ compatibility_flags = ["python_workers"]
5
+ compatibility_date = "<TBD>"
6
+
7
+ # Automatically place your workloads in an optimal location to minimize latency.
8
+ # If you are running back-end logic in a Worker, 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/workers/configuration/smart-placement/#smart-placement
11
+ # [placement]
12
+ # mode = "smart"
13
+
14
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
17
+ # Note: Use secrets to store sensitive data.
18
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
19
+ # [vars]
20
+ # MY_VARIABLE = "production_value"
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/workers/wrangler/configuration/#workers-ai
24
+ # [ai]
25
+ # binding = "AI"
26
+
27
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
28
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
29
+ # [[analytics_engine_datasets]]
30
+ # binding = "MY_DATASET"
31
+
32
+ # Bind a headless browser instance running on Cloudflare's global network.
33
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
34
+ # [browser]
35
+ # binding = "MY_BROWSER"
36
+
37
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
38
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
39
+ # [[d1_databases]]
40
+ # binding = "MY_DB"
41
+ # database_name = "my-database"
42
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
43
+
44
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
45
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
46
+ # [[dispatch_namespaces]]
47
+ # binding = "MY_DISPATCHER"
48
+ # namespace = "my-namespace"
49
+
50
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
51
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
52
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
53
+ # [[durable_objects.bindings]]
54
+ # name = "MY_DURABLE_OBJECT"
55
+ # class_name = "MyDurableObject"
56
+
57
+ # Durable Object migrations.
58
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
59
+ # [[migrations]]
60
+ # tag = "v1"
61
+ # new_classes = ["MyDurableObject"]
62
+
63
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
64
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
65
+ # [[hyperdrive]]
66
+ # binding = "MY_HYPERDRIVE"
67
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
68
+
69
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
70
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
71
+ # [[kv_namespaces]]
72
+ # binding = "MY_KV_NAMESPACE"
73
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
74
+
75
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
76
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
77
+ # [[mtls_certificates]]
78
+ # binding = "MY_CERTIFICATE"
79
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
80
+
81
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
82
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
83
+ # [[queues.producers]]
84
+ # binding = "MY_QUEUE"
85
+ # queue = "my-queue"
86
+
87
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
88
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
89
+ # [[queues.consumers]]
90
+ # queue = "my-queue"
91
+
92
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
93
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
94
+ # [[r2_buckets]]
95
+ # binding = "MY_BUCKET"
96
+ # bucket_name = "my-bucket"
97
+
98
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
99
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
100
+ # [[services]]
101
+ # binding = "MY_SERVICE"
102
+ # service = "my-service"
103
+
104
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
105
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
106
+ # [[vectorize]]
107
+ # binding = "MY_INDEX"
108
+ # index_name = "my-index"
@@ -1,24 +1,77 @@
1
1
  import { logRaw } from "@cloudflare/cli";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
2
4
  import { runFrameworkGenerator } from "frameworks/index";
5
+ import { loadTemplateSnippets, transformFile } from "helpers/codemod";
6
+ import { detectPackageManager } from "helpers/packageManagers";
3
7
  import type { TemplateConfig } from "../../src/templates";
8
+ import type * as recast from "recast";
4
9
  import type { C3Context } from "types";
5
10
 
6
11
  const generate = async (ctx: C3Context) => {
12
+ const { name: pm } = detectPackageManager();
13
+
7
14
  await runFrameworkGenerator(ctx, [
8
15
  ctx.project.name,
9
16
  "--template",
10
17
  "cloudflare-workers",
18
+ "--install",
19
+ "--pm",
20
+ pm,
11
21
  ]);
12
22
 
13
23
  logRaw(""); // newline
14
24
  };
15
25
 
26
+ const configure = async (ctx: C3Context) => {
27
+ const indexFile = "src/index.ts";
28
+
29
+ const s = spinner();
30
+ s.start(`Updating \`${indexFile}\``);
31
+
32
+ const snippets = loadTemplateSnippets(ctx);
33
+
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
+ visitVariableDeclarator(n) {
46
+ if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
47
+ n.node.init = snippets
48
+ .appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
49
+
50
+ return false;
51
+ }
52
+ },
53
+ });
54
+
55
+ s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
56
+ };
57
+
16
58
  const config: TemplateConfig = {
17
59
  configVersion: 1,
18
60
  id: "hono",
19
61
  displayName: "Hono",
62
+ copyFiles: {
63
+ path: "./templates",
64
+ },
20
65
  platform: "workers",
21
66
  generate,
67
+ configure,
68
+ transformPackageJson: async () => ({
69
+ scripts: {
70
+ dev: "wrangler dev",
71
+ deploy: "wrangler deploy --minify",
72
+ "cf-typegen": "wrangler types --env-interface CloudflareBindings",
73
+ },
74
+ }),
22
75
  devScript: "dev",
23
76
  deployScript: "deploy",
24
77
  };
@@ -0,0 +1 @@
1
+ new Hono<{ Bindings: Bindings }>()
@@ -0,0 +1,3 @@
1
+ type Bindings = {
2
+ [key in keyof CloudflareBindings]: CloudflareBindings[key]
3
+ }
@@ -0,0 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
3
+ interface CloudflareBindings {
4
+ }
@@ -0,0 +1,107 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ main = "src/index.ts"
4
+ compatibility_date = "<TBD>"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
12
+
13
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
16
+ # Note: Use secrets to store sensitive data.
17
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
18
+ # [vars]
19
+ # MY_VARIABLE = "production_value"
20
+
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
27
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
28
+ # [[analytics_engine_datasets]]
29
+ # binding = "MY_DATASET"
30
+
31
+ # Bind a headless browser instance running on Cloudflare's global network.
32
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
33
+ # [browser]
34
+ # binding = "MY_BROWSER"
35
+
36
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
37
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
38
+ # [[d1_databases]]
39
+ # binding = "MY_DB"
40
+ # database_name = "my-database"
41
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
42
+
43
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
44
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
45
+ # [[dispatch_namespaces]]
46
+ # binding = "MY_DISPATCHER"
47
+ # namespace = "my-namespace"
48
+
49
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
50
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
51
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
52
+ # [[durable_objects.bindings]]
53
+ # name = "MY_DURABLE_OBJECT"
54
+ # class_name = "MyDurableObject"
55
+
56
+ # Durable Object migrations.
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
58
+ # [[migrations]]
59
+ # tag = "v1"
60
+ # new_classes = ["MyDurableObject"]
61
+
62
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
64
+ # [[hyperdrive]]
65
+ # binding = "MY_HYPERDRIVE"
66
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
67
+
68
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
70
+ # [[kv_namespaces]]
71
+ # binding = "MY_KV_NAMESPACE"
72
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
73
+
74
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
76
+ # [[mtls_certificates]]
77
+ # binding = "MY_CERTIFICATE"
78
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
79
+
80
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
82
+ # [[queues.producers]]
83
+ # binding = "MY_QUEUE"
84
+ # queue = "my-queue"
85
+
86
+ # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
88
+ # [[queues.consumers]]
89
+ # queue = "my-queue"
90
+
91
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
92
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
93
+ # [[r2_buckets]]
94
+ # binding = "MY_BUCKET"
95
+ # bucket_name = "my-bucket"
96
+
97
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
98
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
99
+ # [[services]]
100
+ # binding = "MY_SERVICE"
101
+ # service = "my-service"
102
+
103
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
105
+ # [[vectorize]]
106
+ # binding = "MY_INDEX"
107
+ # index_name = "my-index"
@@ -52,15 +52,15 @@ In order to enable the example:
52
52
  ```
53
53
  # KV Example:
54
54
  ```
55
- - If you're using TypeScript run the `build-cf-types` script to update the `env.d.ts` file:
55
+ - If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
56
56
  ```bash
57
- npm run build-cf-types
57
+ npm run cf-typegen
58
58
  # or
59
- yarn build-cf-types
59
+ yarn cf-typegen
60
60
  # or
61
- pnpm build-cf-types
61
+ pnpm cf-typegen
62
62
  # or
63
- bun build-cf-types
63
+ bun cf-typegen
64
64
  ```
65
65
 
66
66
  After doing this you can run the `dev` or `preview` script and visit the `/api/hello` route to see the example in action.