create-cloudflare 0.0.0-e11e1691 → 0.0.0-e144f63f

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 (80) hide show
  1. package/dist/cli.js +20238 -19347
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +11 -9
  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/wrangler.toml +11 -1
  15. package/templates/common/ts/package.json +2 -1
  16. package/templates/common/ts/src/index.ts +3 -0
  17. package/templates/common/ts/worker-configuration.d.ts +2 -14
  18. package/templates/common/ts/wrangler.toml +11 -1
  19. package/templates/hello-world/js/package.json +2 -1
  20. package/templates/hello-world/js/test/index.spec.js +17 -17
  21. package/templates/hello-world/js/vitest.config.js +8 -8
  22. package/templates/hello-world/js/wrangler.toml +11 -1
  23. package/templates/hello-world/ts/package.json +2 -1
  24. package/templates/hello-world/ts/src/index.ts +3 -17
  25. package/templates/hello-world/ts/test/index.spec.ts +17 -17
  26. package/templates/hello-world/ts/test/tsconfig.json +6 -9
  27. package/templates/hello-world/ts/vitest.config.ts +8 -8
  28. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  29. package/templates/hello-world/ts/wrangler.toml +11 -1
  30. package/templates/hello-world-durable-object/c3.ts +1 -1
  31. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  32. package/templates/hello-world-durable-object/js/wrangler.toml +12 -2
  33. package/templates/hello-world-durable-object/ts/package.json +2 -2
  34. package/templates/hello-world-durable-object/ts/src/index.ts +24 -16
  35. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  36. package/templates/hello-world-durable-object/ts/wrangler.toml +13 -4
  37. package/templates/hello-world-python/c3.ts +9 -0
  38. package/templates/hello-world-python/py/__dot__gitignore +68 -0
  39. package/templates/hello-world-python/py/package.json +13 -0
  40. package/templates/hello-world-python/py/src/entry.py +4 -0
  41. package/templates/hello-world-python/py/wrangler.toml +108 -0
  42. package/templates/hono/c3.ts +53 -0
  43. package/templates/hono/snippets/appDeclaration.ts +1 -0
  44. package/templates/hono/snippets/bindingsType.ts +3 -0
  45. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  46. package/templates/hono/templates/wrangler.toml +107 -0
  47. package/templates/next/README.md +5 -5
  48. package/templates/next/c3.ts +11 -9
  49. package/templates/next/wrangler.toml +33 -1
  50. package/templates/nuxt/c3.ts +7 -7
  51. package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
  52. package/templates/nuxt/templates/wrangler.toml +35 -2
  53. package/templates/openapi/ts/package.json +2 -1
  54. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  55. package/templates/openapi/ts/wrangler.toml +104 -0
  56. package/templates/pre-existing/c3.ts +5 -5
  57. package/templates/pre-existing/js/wrangler.toml +1 -0
  58. package/templates/queues/js/wrangler.toml +11 -1
  59. package/templates/queues/ts/package.json +2 -1
  60. package/templates/queues/ts/src/index.ts +3 -5
  61. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  62. package/templates/queues/ts/wrangler.toml +11 -1
  63. package/templates/qwik/c3.ts +6 -6
  64. package/templates/qwik/templates/worker-configuration.d.ts +1 -1
  65. package/templates/qwik/templates/wrangler.toml +35 -2
  66. package/templates/remix/c3.ts +3 -3
  67. package/templates/remix/templates/worker-configuration.d.ts +1 -1
  68. package/templates/remix/templates/wrangler.toml +35 -2
  69. package/templates/scheduled/js/package.json +2 -2
  70. package/templates/scheduled/js/src/index.js +8 -1
  71. package/templates/scheduled/js/wrangler.toml +12 -2
  72. package/templates/scheduled/ts/package.json +3 -2
  73. package/templates/scheduled/ts/src/index.ts +4 -21
  74. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  75. package/templates/scheduled/ts/wrangler.toml +12 -2
  76. package/templates/solid/c3.ts +9 -7
  77. package/templates/solid/templates/wrangler.toml +84 -0
  78. package/templates/svelte/c3.ts +9 -9
  79. package/templates/svelte/js/wrangler.toml +35 -2
  80. package/templates/svelte/ts/wrangler.toml +35 -2
@@ -1,9 +1,20 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./dist"
5
+
6
+ # Automatically place your workloads in an optimal location to minimize latency.
7
+ # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
8
+ # rather than the end user may result in better performance.
9
+ # Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
10
+ # [placement]
11
+ # mode = "smart"
3
12
 
4
13
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Docs:
15
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
5
16
  # Note: Use secrets to store sensitive data.
6
- # Docs: https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
7
18
  # [vars]
8
19
  # MY_VARIABLE = "production_value"
9
20
 
@@ -49,4 +60,26 @@ compatibility_date = "<TBD>"
49
60
  # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
50
61
  # [[services]]
51
62
  # binding = "MY_SERVICE"
52
- # service = "my-service"
63
+ # service = "my-service"
64
+
65
+ # To use different bindings for preview and production environments, follow the examples below.
66
+ # When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
67
+ # Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
68
+
69
+ ######## PREVIEW environment config ########
70
+
71
+ # [env.preview.vars]
72
+ # API_KEY = "xyz789"
73
+
74
+ # [[env.preview.kv_namespaces]]
75
+ # binding = "MY_KV_NAMESPACE"
76
+ # id = "<PREVIEW_NAMESPACE_ID>"
77
+
78
+ ######## PRODUCTION environment config ########
79
+
80
+ # [env.production.vars]
81
+ # API_KEY = "abc123"
82
+
83
+ # [[env.production.kv_namespaces]]
84
+ # binding = "MY_KV_NAMESPACE"
85
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -1,10 +1,20 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
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,7 +5,8 @@
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
12
  "itty-router": "^3.0.12",
@@ -5,6 +5,9 @@
5
5
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
6
6
  * - Run `npm run deploy` to publish your worker
7
7
  *
8
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9
+ * `Env` object can be regenerated with `npm run cf-typegen`.
10
+ *
8
11
  * Learn more at https://developers.cloudflare.com/workers/
9
12
  */
10
13
 
@@ -1,16 +1,4 @@
1
+ // Generated by Wrangler
2
+ // After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
1
3
  interface Env {
2
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
3
- // MY_KV_NAMESPACE: KVNamespace;
4
- //
5
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
6
- // MY_DURABLE_OBJECT: DurableObjectNamespace;
7
- //
8
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
9
- // MY_BUCKET: R2Bucket;
10
- //
11
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
12
- // MY_SERVICE: Fetcher;
13
- //
14
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
15
- // MY_QUEUE: Queue;
16
4
  }
@@ -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
 
@@ -5,7 +5,8 @@
5
5
  "scripts": {
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
- "start": "wrangler dev"
8
+ "start": "wrangler dev",
9
+ "test": "vitest"
9
10
  },
10
11
  "devDependencies": {
11
12
  "wrangler": "^3.0.0",
@@ -1,20 +1,20 @@
1
- import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test";
2
- import { describe, it, expect } from "vitest";
3
- import worker from "../src";
1
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
2
+ import { describe, it, expect } from 'vitest';
3
+ import worker from '../src';
4
4
 
5
- describe("Hello World worker", () => {
6
- it("responds with Hello World! (unit style)", async () => {
7
- const request = new Request("http://example.com");
8
- // Create an empty context to pass to `worker.fetch()`.
9
- const ctx = createExecutionContext();
10
- const response = await worker.fetch(request, env, ctx);
11
- // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
12
- await waitOnExecutionContext(ctx);
13
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
14
- });
5
+ describe('Hello World worker', () => {
6
+ it('responds with Hello World! (unit style)', async () => {
7
+ const request = new Request('http://example.com');
8
+ // Create an empty context to pass to `worker.fetch()`.
9
+ const ctx = createExecutionContext();
10
+ const response = await worker.fetch(request, env, ctx);
11
+ // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
12
+ await waitOnExecutionContext(ctx);
13
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
14
+ });
15
15
 
16
- it("responds with Hello World! (integration style)", async () => {
17
- const response = await SELF.fetch(request, env, ctx);
18
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
- });
16
+ it('responds with Hello World! (integration style)', async () => {
17
+ const response = await SELF.fetch(request, env, ctx);
18
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
+ });
20
20
  });
@@ -1,11 +1,11 @@
1
- import { defineWorkersConfig } from "@cloudflare/vitest-pool-workers/config";
1
+ import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2
2
 
3
3
  export default defineWorkersConfig({
4
- test: {
5
- poolOptions: {
6
- workers: {
7
- wrangler: { configPath: "./wrangler.toml" },
8
- },
9
- },
10
- },
4
+ test: {
5
+ poolOptions: {
6
+ workers: {
7
+ wrangler: { configPath: './wrangler.toml' },
8
+ },
9
+ },
10
+ },
11
11
  });
@@ -1,11 +1,21 @@
1
+ #:schema node_modules/wrangler/config-schema.json
1
2
  name = "<TBD>"
2
3
  main = "src/index.js"
3
4
  compatibility_date = "<TBD>"
4
5
  compatibility_flags = ["nodejs_compat"]
5
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
+
6
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
7
17
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
18
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
9
19
  # [vars]
10
20
  # MY_VARIABLE = "production_value"
11
21
 
@@ -6,7 +6,8 @@
6
6
  "deploy": "wrangler deploy",
7
7
  "dev": "wrangler dev",
8
8
  "start": "wrangler dev",
9
- "test": "vitest"
9
+ "test": "vitest",
10
+ "cf-typegen": "wrangler types"
10
11
  },
11
12
  "devDependencies": {
12
13
  "typescript": "^5.0.4",
@@ -5,26 +5,12 @@
5
5
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
6
6
  * - Run `npm run deploy` to publish your worker
7
7
  *
8
+ * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9
+ * `Env` object can be regenerated with `npm run cf-typegen`.
10
+ *
8
11
  * Learn more at https://developers.cloudflare.com/workers/
9
12
  */
10
13
 
11
- export interface Env {
12
- // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
13
- // MY_KV_NAMESPACE: KVNamespace;
14
- //
15
- // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
16
- // MY_DURABLE_OBJECT: DurableObjectNamespace;
17
- //
18
- // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
19
- // MY_BUCKET: R2Bucket;
20
- //
21
- // Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
22
- // MY_SERVICE: Fetcher;
23
- //
24
- // Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
25
- // MY_QUEUE: Queue;
26
- }
27
-
28
14
  export default {
29
15
  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
30
16
  return new Response('Hello World!');
@@ -1,25 +1,25 @@
1
1
  // test/index.spec.ts
2
- import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test";
3
- import { describe, it, expect } from "vitest";
4
- import worker from "../src/index";
2
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
3
+ import { describe, it, expect } from 'vitest';
4
+ import worker from '../src/index';
5
5
 
6
6
  // For now, you'll need to do something like this to get a correctly-typed
7
7
  // `Request` to pass to `worker.fetch()`.
8
8
  const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
9
9
 
10
- describe("Hello World worker", () => {
11
- it("responds with Hello World! (unit style)", async () => {
12
- const request = new IncomingRequest("http://example.com");
13
- // Create an empty context to pass to `worker.fetch()`.
14
- const ctx = createExecutionContext();
15
- const response = await worker.fetch(request, env, ctx);
16
- // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
17
- await waitOnExecutionContext(ctx);
18
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
- });
10
+ describe('Hello World worker', () => {
11
+ it('responds with Hello World! (unit style)', async () => {
12
+ const request = new IncomingRequest('http://example.com');
13
+ // Create an empty context to pass to `worker.fetch()`.
14
+ const ctx = createExecutionContext();
15
+ const response = await worker.fetch(request, env, ctx);
16
+ // Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
17
+ await waitOnExecutionContext(ctx);
18
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19
+ });
20
20
 
21
- it("responds with Hello World! (integration style)", async () => {
22
- const response = await SELF.fetch("https://example.com");
23
- expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
24
- });
21
+ it('responds with Hello World! (integration style)', async () => {
22
+ const response = await SELF.fetch('https://example.com');
23
+ expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
24
+ });
25
25
  });
@@ -1,11 +1,8 @@
1
1
  {
2
- "extends": "../tsconfig.json",
3
- "compilerOptions": {
4
- "types": [
5
- "@cloudflare/workers-types/experimental",
6
- "@cloudflare/vitest-pool-workers"
7
- ]
8
- },
9
- "include": ["./**/*.ts", "../src/env.d.ts"],
10
- "exclude": []
2
+ "extends": "../tsconfig.json",
3
+ "compilerOptions": {
4
+ "types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
5
+ },
6
+ "include": ["./**/*.ts", "../src/env.d.ts"],
7
+ "exclude": []
11
8
  }
@@ -1,11 +1,11 @@
1
- import { defineWorkersConfig } from "@cloudflare/vitest-pool-workers/config";
1
+ import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2
2
 
3
3
  export default defineWorkersConfig({
4
- test: {
5
- poolOptions: {
6
- workers: {
7
- wrangler: { configPath: "./wrangler.toml" },
8
- },
9
- },
10
- },
4
+ test: {
5
+ poolOptions: {
6
+ workers: {
7
+ wrangler: { configPath: './wrangler.toml' },
8
+ },
9
+ },
10
+ },
11
11
  });
@@ -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 Env {
4
+ }
@@ -1,11 +1,21 @@
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
  compatibility_flags = ["nodejs_compat"]
5
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
+
6
14
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
7
17
  # Note: Use secrets to store sensitive data.
8
- # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
18
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
9
19
  # [vars]
10
20
  # MY_VARIABLE = "production_value"
11
21
 
@@ -1,7 +1,7 @@
1
1
  export default {
2
2
  configVersion: 1,
3
3
  id: "hello-world-durable-object",
4
- displayName: '"Hello World" Durable Object',
4
+ displayName: "Co-ordination / multiplayer API (using Durable Objects)",
5
5
  platform: "workers",
6
6
  copyFiles: {
7
7
  variants: {
@@ -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
  *
@@ -16,25 +18,27 @@
16
18
  */
17
19
 
18
20
  /** A Durable Object's behavior is defined in an exported Javascript class */
19
- export class MyDurableObject {
21
+ export class MyDurableObject extends DurableObject {
20
22
  /**
21
23
  * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
22
- * `DurableObjectStub::get` for a given identifier
24
+ * `DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
23
25
  *
24
- * @param {DurableObjectState} state - The interface for interacting with Durable Object state
26
+ * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
25
27
  * @param {Env} env - The interface to reference bindings declared in wrangler.toml
26
28
  */
27
- constructor(state, env) {}
29
+ constructor(ctx, env) {
30
+ super(ctx, env);
31
+ }
28
32
 
29
33
  /**
30
- * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
31
- * request from a Worker via an associated stub
34
+ * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
35
+ * Object instance receives a request from a Worker via the same method invocation on the stub
32
36
  *
33
- * @param {Request} request - The request submitted to a Durable Object instance from a Worker
34
- * @returns {Promise<Response>} The response to be sent back to the Worker
37
+ * @param {string} name - The name provided to a Durable Object instance from a Worker
38
+ * @returns {Promise<string>} The greeting to be sent back to the Worker
35
39
  */
36
- async fetch(request) {
37
- return new Response('Hello World');
40
+ async sayHello(name) {
41
+ return `Hello, ${name}!`;
38
42
  }
39
43
  }
40
44
 
@@ -56,10 +60,10 @@ export default {
56
60
  // The Durable Object constructor will be invoked upon the first call for a given id
57
61
  let stub = env.MY_DURABLE_OBJECT.get(id);
58
62
 
59
- // We call `fetch()` on the stub to send a request to the Durable Object instance
60
- // The Durable Object instance will invoke its fetch handler to handle the request
61
- let response = await stub.fetch(request);
63
+ // We call the `sayHello()` RPC method on the stub to invoke the method on the remote
64
+ // Durable Object instance
65
+ let greeting = await stub.sayHello("world");
62
66
 
63
- return response;
67
+ return new Response(greeting);
64
68
  },
65
69
  };
@@ -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,10 +5,10 @@
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
12
  "typescript": "^5.0.4",
13
13
  "wrangler": "^3.0.0"
14
14
  }
@@ -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
 
@@ -67,12 +75,12 @@ export default {
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
  };
@@ -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
+ };