create-cloudflare 0.0.0-e739b7fe → 0.0.0-e7c06d78

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 (104) hide show
  1. package/dist/cli.js +21157 -21251
  2. package/dist/tsconfig.tsbuildinfo +1 -0
  3. package/package.json +24 -23
  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 +7 -7
  56. package/templates/next/app/js/app/api/hello/route.js +1 -1
  57. package/templates/next/app/ts/app/api/hello/route.ts +1 -1
  58. package/templates/next/c3.ts +30 -12
  59. package/templates/next/pages/js/pages/api/hello.js +1 -1
  60. package/templates/next/pages/ts/pages/api/hello.ts +1 -1
  61. package/templates/next/wrangler.toml +33 -5
  62. package/templates/nuxt/c3.ts +12 -13
  63. package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
  64. package/templates/nuxt/templates/wrangler.toml +35 -2
  65. package/templates/openapi/ts/README.md +3 -3
  66. package/templates/openapi/ts/package.json +7 -4
  67. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  68. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  69. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  70. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  71. package/templates/openapi/ts/src/index.ts +14 -20
  72. package/templates/openapi/ts/src/types.ts +9 -8
  73. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  74. package/templates/openapi/ts/wrangler.toml +104 -0
  75. package/templates/pre-existing/c3.ts +5 -5
  76. package/templates/pre-existing/js/package.json +1 -1
  77. package/templates/pre-existing/js/wrangler.toml +1 -0
  78. package/templates/queues/js/package.json +1 -1
  79. package/templates/queues/js/wrangler.toml +11 -1
  80. package/templates/queues/ts/package.json +4 -3
  81. package/templates/queues/ts/src/index.ts +6 -8
  82. package/templates/queues/ts/tsconfig.json +1 -1
  83. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  84. package/templates/queues/ts/wrangler.toml +11 -1
  85. package/templates/qwik/c3.ts +6 -6
  86. package/templates/qwik/templates/worker-configuration.d.ts +1 -1
  87. package/templates/qwik/templates/wrangler.toml +35 -2
  88. package/templates/remix/c3.ts +4 -4
  89. package/templates/remix/templates/worker-configuration.d.ts +1 -1
  90. package/templates/remix/templates/wrangler.toml +35 -2
  91. package/templates/scheduled/js/package.json +3 -3
  92. package/templates/scheduled/js/src/index.js +8 -1
  93. package/templates/scheduled/js/wrangler.toml +12 -2
  94. package/templates/scheduled/ts/package.json +5 -4
  95. package/templates/scheduled/ts/src/index.ts +6 -23
  96. package/templates/scheduled/ts/tsconfig.json +1 -1
  97. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  98. package/templates/scheduled/ts/wrangler.toml +12 -2
  99. package/templates/solid/c3.ts +16 -12
  100. package/templates/solid/templates/wrangler.toml +84 -0
  101. package/templates/svelte/c3.ts +9 -9
  102. package/templates/svelte/js/wrangler.toml +35 -2
  103. package/templates/svelte/ts/wrangler.toml +35 -2
  104. package/templates/hello-world/ts/vitest.config.ts +0 -11
@@ -22,7 +22,7 @@ const configure = async (ctx: C3Context) => {
22
22
  silent: true,
23
23
  startText: "Installing adapter",
24
24
  doneText: `${brandColor("installed")} ${dim(
25
- `via \`${npx} astro add cloudflare\``
25
+ `via \`${npx} astro add cloudflare\``,
26
26
  )}`,
27
27
  });
28
28
 
@@ -46,10 +46,10 @@ const updateAstroConfig = () => {
46
46
  n.node.arguments = [
47
47
  b.objectExpression([
48
48
  b.objectProperty(
49
- b.identifier("runtime"),
49
+ b.identifier("platformProxy"),
50
50
  b.objectExpression([
51
- b.objectProperty(b.identifier("mode"), b.stringLiteral("local")),
52
- ])
51
+ b.objectProperty(b.identifier("enabled"), b.booleanLiteral(true)),
52
+ ]),
53
53
  ),
54
54
  ]),
55
55
  ];
@@ -77,7 +77,7 @@ const updateEnvDeclaration = (ctx: C3Context) => {
77
77
  // Preserve comments with the new body
78
78
  const comments = n.get("comments").value;
79
79
  n.node.comments = comments.map((c: recast.types.namedTypes.CommentLine) =>
80
- b.commentLine(c.value)
80
+ b.commentLine(c.value),
81
81
  );
82
82
 
83
83
  // Add the patch
@@ -103,9 +103,9 @@ const config: TemplateConfig = {
103
103
  configure,
104
104
  transformPackageJson: async (pkgJson: PackageJson, ctx: C3Context) => ({
105
105
  scripts: {
106
- deploy: `astro build && wrangler pages deploy ./dist`,
107
- preview: `astro build && wrangler pages dev ./dist`,
108
- ...(usesTypescript(ctx) && { "build-cf-types": `wrangler types` }),
106
+ deploy: `astro build && wrangler pages deploy`,
107
+ preview: `astro build && wrangler pages dev`,
108
+ ...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
109
109
  },
110
110
  }),
111
111
  };
@@ -1,4 +1,5 @@
1
- type Runtime = import("@astrojs/cloudflare").DirectoryRuntime<Env>;
1
+ type Runtime = import("@astrojs/cloudflare").Runtime<Env>;
2
+
2
3
  declare namespace App {
3
4
  interface Locals extends Runtime {}
4
5
  }
@@ -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>"
@@ -9,6 +9,6 @@
9
9
  },
10
10
  "devDependencies": {
11
11
  "itty-router": "^3.0.12",
12
- "wrangler": "^3.0.0"
12
+ "wrangler": "^3.60.3"
13
13
  }
14
14
  }
@@ -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,11 +5,12 @@
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",
12
- "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0"
13
+ "typescript": "^5.5.2",
14
+ "wrangler": "^3.60.3"
14
15
  }
15
16
  }
@@ -6,7 +6,7 @@ const EXPERIMENTS = [
6
6
  ];
7
7
 
8
8
  export default {
9
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
9
+ async fetch(request, env, ctx): Promise<Response> {
10
10
  const fingerprint = [request.headers.get('cf-connecting-ip'), request.cf?.postalCode]; // add any values you want considered as a fingerprint
11
11
  const activeExperiments = await getActiveExperiments(fingerprint, EXPERIMENTS);
12
12
 
@@ -22,7 +22,7 @@ export default {
22
22
 
23
23
  return rewriter.transform(res);
24
24
  },
25
- };
25
+ } satisfies ExportedHandler<Env>;
26
26
 
27
27
  // Get active experiments by hashing a fingerprint
28
28
  async function getActiveExperiments(fingerprint: unknown, experiments: Array<{ name: string; threshold: number }>) {
@@ -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
 
@@ -16,7 +19,7 @@ import apiRouter from './router';
16
19
  export default {
17
20
  // The fetch handler is invoked when this worker receives a HTTP(S) request
18
21
  // and should return a Response (optionally wrapped in a Promise)
19
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
22
+ async fetch(request, env, ctx): Promise<Response> {
20
23
  // You'll find it helpful to parse the request.url string into a URL object. Learn more at https://developer.mozilla.org/en-US/docs/Web/API/URL
21
24
  const url = new URL(request.url);
22
25
 
@@ -43,4 +46,4 @@ export default {
43
46
  { headers: { 'Content-Type': 'text/html' } }
44
47
  );
45
48
  },
46
- };
49
+ } satisfies ExportedHandler<Env>;
@@ -1,5 +1,5 @@
1
1
  export default {
2
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
2
+ async fetch(request, env, ctx): Promise<Response> {
3
3
  const url = new URL(request.url);
4
4
 
5
5
  const proxyUrl = url.searchParams.get('proxyUrl'); // get a query param value (?proxyUrl=...)
@@ -20,4 +20,4 @@ export default {
20
20
 
21
21
  return res;
22
22
  },
23
- };
23
+ } satisfies ExportedHandler<Env>;
@@ -1,5 +1,5 @@
1
1
  export default {
2
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
2
+ async fetch(request, env, ctx): Promise<Response> {
3
3
  const url = new URL(request.url);
4
4
  const redirectUrl = url.searchParams.get('redirectUrl'); // get a query param value (?redirectUrl=...)
5
5
 
@@ -10,4 +10,4 @@ export default {
10
10
  // The Response class has static methods to create common Response objects as a convenience
11
11
  return Response.redirect(redirectUrl);
12
12
  },
13
- };
13
+ } 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' */
@@ -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,11 +5,12 @@
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
- "wrangler": "^3.0.0",
12
- "vitest": "1.3.0",
13
- "@cloudflare/vitest-pool-workers": "^0.1.0"
12
+ "@cloudflare/vitest-pool-workers": "^0.4.5",
13
+ "wrangler": "^3.60.3",
14
+ "vitest": "1.5.0"
14
15
  }
15
16
  }
@@ -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,12 +6,13 @@
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
- "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0",
14
- "vitest": "1.3.0",
15
- "@cloudflare/vitest-pool-workers": "^0.1.0"
13
+ "@cloudflare/vitest-pool-workers": "^0.4.5",
14
+ "typescript": "^5.5.2",
15
+ "vitest": "1.5.0",
16
+ "wrangler": "^3.60.3"
16
17
  }
17
18
  }
@@ -5,28 +5,14 @@
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
- async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
15
+ async fetch(request, env, ctx): Promise<Response> {
30
16
  return new Response('Hello World!');
31
17
  },
32
- };
18
+ } satisfies ExportedHandler<Env>;
@@ -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
  }
@@ -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,11 @@
1
+ import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2
+
3
+ export default defineWorkersConfig({
4
+ test: {
5
+ poolOptions: {
6
+ workers: {
7
+ wrangler: { configPath: './wrangler.toml' },
8
+ },
9
+ },
10
+ },
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: {
@@ -8,6 +8,6 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.60.3"
12
12
  }
13
13
  }
@@ -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
  };