create-cloudflare 0.0.0-e6ddf8a7 → 0.0.0-e739b7fe

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 (102) hide show
  1. package/dist/cli.js +73271 -55347
  2. package/package.json +16 -7
  3. package/templates/angular/c3.ts +100 -0
  4. package/{dist → templates}/angular/templates/tools/alter-polyfills.mjs +2 -2
  5. package/{dist → templates}/angular/templates/tools/copy-files.mjs +1 -1
  6. package/templates/astro/c3.ts +112 -0
  7. package/templates/astro/snippets/runtimeDeclaration.ts +4 -0
  8. package/templates/astro/templates/wrangler.toml +52 -0
  9. package/templates/common/c3.ts +16 -0
  10. package/templates/common/js/.editorconfig +0 -1
  11. package/templates/common/js/wrangler.toml +68 -22
  12. package/templates/common/ts/.editorconfig +0 -1
  13. package/templates/common/ts/package.json +0 -1
  14. package/templates/common/ts/wrangler.toml +68 -22
  15. package/templates/docusaurus/c3.ts +26 -0
  16. package/templates/gatsby/c3.ts +48 -0
  17. package/templates/hello-world/c3.ts +16 -0
  18. package/templates/hello-world/js/.editorconfig +0 -1
  19. package/templates/hello-world/js/package.json +3 -1
  20. package/templates/hello-world/js/test/index.spec.js +20 -0
  21. package/templates/hello-world/js/vitest.config.js +11 -0
  22. package/templates/hello-world/js/wrangler.toml +69 -22
  23. package/templates/hello-world/ts/.editorconfig +0 -1
  24. package/templates/hello-world/ts/package.json +5 -3
  25. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  26. package/templates/hello-world/ts/test/tsconfig.json +11 -0
  27. package/templates/hello-world/ts/tsconfig.json +3 -2
  28. package/templates/hello-world/ts/vitest.config.ts +11 -0
  29. package/templates/hello-world/ts/wrangler.toml +69 -22
  30. package/templates/hello-world-durable-object/c3.ts +16 -0
  31. package/templates/hello-world-durable-object/js/.editorconfig +12 -0
  32. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  33. package/templates/{chatgptPlugin/ts → hello-world-durable-object/js}/__dot__gitignore +1 -0
  34. package/templates/hello-world-durable-object/js/package.json +13 -0
  35. package/templates/hello-world-durable-object/js/src/index.js +65 -0
  36. package/templates/hello-world-durable-object/js/wrangler.toml +97 -0
  37. package/templates/hello-world-durable-object/ts/.editorconfig +12 -0
  38. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  39. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  40. package/templates/hello-world-durable-object/ts/package.json +15 -0
  41. package/templates/hello-world-durable-object/ts/src/index.ts +78 -0
  42. package/templates/hello-world-durable-object/ts/tsconfig.json +101 -0
  43. package/templates/hello-world-durable-object/ts/wrangler.toml +98 -0
  44. package/templates/hono/c3.ts +25 -0
  45. package/templates/next/README.md +68 -0
  46. package/templates/next/app/js/app/api/hello/route.js +21 -0
  47. package/templates/next/app/js/app/not-found.js +58 -0
  48. package/templates/next/app/ts/app/api/hello/route.ts +22 -0
  49. package/templates/next/app/ts/app/not-found.tsx +58 -0
  50. package/templates/next/c3.ts +220 -0
  51. package/templates/next/env.d.ts +5 -0
  52. package/templates/next/pages/js/pages/api/hello.js +23 -0
  53. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  54. package/templates/next/wrangler.toml +58 -0
  55. package/templates/nuxt/c3.ts +134 -0
  56. package/templates/nuxt/templates/env.d.ts +14 -0
  57. package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
  58. package/templates/nuxt/templates/wrangler.toml +52 -0
  59. package/templates/openapi/c3.ts +9 -0
  60. package/templates/openapi/ts/package.json +0 -1
  61. package/templates/openapi/ts/src/endpoints/taskList.ts +1 -1
  62. package/templates/openapi/ts/src/index.ts +2 -2
  63. package/templates/pre-existing/c3.ts +83 -0
  64. package/templates/pre-existing/js/.editorconfig +12 -0
  65. package/templates/pre-existing/js/.prettierrc +6 -0
  66. package/templates/pre-existing/js/__dot__gitignore +172 -0
  67. package/templates/pre-existing/js/package.json +13 -0
  68. package/templates/pre-existing/js/wrangler.toml +3 -0
  69. package/templates/queues/c3.ts +26 -0
  70. package/templates/queues/js/.editorconfig +0 -1
  71. package/templates/queues/js/wrangler.toml +85 -2
  72. package/templates/queues/ts/.editorconfig +0 -1
  73. package/templates/queues/ts/package.json +0 -1
  74. package/templates/queues/ts/wrangler.toml +85 -2
  75. package/templates/qwik/c3.ts +146 -0
  76. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  77. package/templates/qwik/templates/worker-configuration.d.ts +4 -0
  78. package/templates/qwik/templates/wrangler.toml +52 -0
  79. package/templates/react/c3.ts +31 -0
  80. package/templates/remix/c3.ts +66 -0
  81. package/templates/remix/templates/worker-configuration.d.ts +4 -0
  82. package/templates/remix/templates/wrangler.toml +52 -0
  83. package/templates/scheduled/c3.ts +16 -0
  84. package/templates/scheduled/js/.editorconfig +0 -1
  85. package/templates/scheduled/js/wrangler.toml +94 -0
  86. package/templates/scheduled/ts/.editorconfig +0 -1
  87. package/templates/scheduled/ts/package.json +0 -1
  88. package/templates/scheduled/ts/wrangler.toml +94 -0
  89. package/templates/solid/c3.ts +82 -0
  90. package/templates/svelte/c3.ts +130 -0
  91. package/templates/svelte/js/wrangler.toml +52 -0
  92. package/templates/svelte/ts/wrangler.toml +52 -0
  93. package/templates/vue/c3.ts +28 -0
  94. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  95. package/templates/chatgptPlugin/ts/README.md +0 -25
  96. package/templates/chatgptPlugin/ts/package.json +0 -17
  97. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  98. package/templates/chatgptPlugin/ts/src/search.ts +0 -59
  99. package/templates/chatgptPlugin/ts/wrangler.toml +0 -3
  100. /package/{dist → templates}/angular/templates/server.ts +0 -0
  101. /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
  102. /package/{dist → templates}/angular/templates/tools/paths.mjs +0 -0
@@ -0,0 +1,26 @@
1
+ import { runFrameworkGenerator } from "frameworks/index";
2
+ import { detectPackageManager } from "helpers/packageManagers";
3
+ import type { TemplateConfig } from "../../src/templates";
4
+ import type { C3Context } from "types";
5
+
6
+ const { npm } = detectPackageManager();
7
+
8
+ const generate = async (ctx: C3Context) => {
9
+ await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
10
+ };
11
+
12
+ const config: TemplateConfig = {
13
+ configVersion: 1,
14
+ id: "docusaurus",
15
+ platform: "pages",
16
+ displayName: "Docusaurus",
17
+ generate,
18
+ transformPackageJson: async () => ({
19
+ scripts: {
20
+ deploy: `${npm} run build && wrangler pages deploy ./build`,
21
+ },
22
+ }),
23
+ devScript: "start",
24
+ deployScript: "deploy",
25
+ };
26
+ export default config;
@@ -0,0 +1,48 @@
1
+ import { inputPrompt } from "@cloudflare/cli/interactive";
2
+ import { runFrameworkGenerator } from "frameworks/index";
3
+ import { detectPackageManager } from "helpers/packageManagers";
4
+ import type { TemplateConfig } from "../../src/templates";
5
+ import type { C3Context } from "types";
6
+
7
+ const { npm } = detectPackageManager();
8
+
9
+ const generate = async (ctx: C3Context) => {
10
+ const defaultTemplate = "https://github.com/gatsbyjs/gatsby-starter-blog";
11
+
12
+ const useTemplate = await inputPrompt({
13
+ type: "confirm",
14
+ question: "Would you like to use a template?",
15
+ label: "template",
16
+ defaultValue: true,
17
+ });
18
+
19
+ let templateUrl = "";
20
+ if (useTemplate) {
21
+ templateUrl = await inputPrompt({
22
+ type: "text",
23
+ question: `Please specify the url of the template you'd like to use`,
24
+ label: "template",
25
+ defaultValue: defaultTemplate,
26
+ });
27
+ }
28
+
29
+ await runFrameworkGenerator(ctx, ["new", ctx.project.name, templateUrl]);
30
+ };
31
+
32
+ const config: TemplateConfig = {
33
+ configVersion: 1,
34
+ id: "gatsby",
35
+ platform: "pages",
36
+ displayName: "Gatsby",
37
+ generate,
38
+ transformPackageJson: async () => ({
39
+ scripts: {
40
+ deploy: `${npm} run build && wrangler pages deploy ./public`,
41
+ preview: `${npm} run build && wrangler pages dev ./public`,
42
+ },
43
+ }),
44
+ devScript: "develop",
45
+ deployScript: "deploy",
46
+ previewScript: "preview",
47
+ };
48
+ export default config;
@@ -0,0 +1,16 @@
1
+ export default {
2
+ configVersion: 1,
3
+ id: "hello-world",
4
+ displayName: '"Hello World" Worker',
5
+ platform: "workers",
6
+ copyFiles: {
7
+ variants: {
8
+ js: {
9
+ path: "./js",
10
+ },
11
+ ts: {
12
+ path: "./ts",
13
+ },
14
+ },
15
+ },
16
+ };
@@ -3,7 +3,6 @@ root = true
3
3
 
4
4
  [*]
5
5
  indent_style = tab
6
- tab_width = 2
7
6
  end_of_line = lf
8
7
  charset = utf-8
9
8
  trim_trailing_whitespace = true
@@ -8,6 +8,8 @@
8
8
  "start": "wrangler dev"
9
9
  },
10
10
  "devDependencies": {
11
- "wrangler": "^3.0.0"
11
+ "wrangler": "^3.0.0",
12
+ "vitest": "1.3.0",
13
+ "@cloudflare/vitest-pool-workers": "^0.1.0"
12
14
  }
13
15
  }
@@ -0,0 +1,20 @@
1
+ import { env, createExecutionContext, waitOnExecutionContext, SELF } from "cloudflare:test";
2
+ import { describe, it, expect } from "vitest";
3
+ import worker from "../src";
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
+ });
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
+ });
20
+ });
@@ -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
+ });
@@ -1,51 +1,98 @@
1
1
  name = "<TBD>"
2
2
  main = "src/index.js"
3
3
  compatibility_date = "<TBD>"
4
+ compatibility_flags = ["nodejs_compat"]
4
5
 
5
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
6
7
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
8
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
8
9
  # [vars]
9
10
  # MY_VARIABLE = "production_value"
10
11
 
12
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
13
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
14
+ # [ai]
15
+ # binding = "AI"
16
+
17
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
18
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
19
+ # [[analytics_engine_datasets]]
20
+ # binding = "MY_DATASET"
21
+
22
+ # Bind a headless browser instance running on Cloudflare's global network.
23
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
24
+ # [browser]
25
+ # binding = "MY_BROWSER"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
35
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
36
+ # [[dispatch_namespaces]]
37
+ # binding = "MY_DISPATCHER"
38
+ # namespace = "my-namespace"
39
+
40
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
43
+ # [[durable_objects.bindings]]
44
+ # name = "MY_DURABLE_OBJECT"
45
+ # class_name = "MyDurableObject"
46
+
47
+ # Durable Object migrations.
48
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
49
+ # [[migrations]]
50
+ # tag = "v1"
51
+ # new_classes = ["MyDurableObject"]
52
+
53
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
54
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
55
+ # [[hyperdrive]]
56
+ # binding = "MY_HYPERDRIVE"
57
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
58
+
11
59
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
60
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
13
61
  # [[kv_namespaces]]
14
62
  # binding = "MY_KV_NAMESPACE"
15
63
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
64
 
17
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
18
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
19
- # [[r2_buckets]]
20
- # binding = "MY_BUCKET"
21
- # bucket_name = "my-bucket"
65
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
66
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
67
+ # [[mtls_certificates]]
68
+ # binding = "MY_CERTIFICATE"
69
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
22
70
 
23
71
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
24
- # Docs: https://developers.cloudflare.com/queues/get-started
72
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
25
73
  # [[queues.producers]]
26
74
  # binding = "MY_QUEUE"
27
75
  # queue = "my-queue"
28
76
 
29
77
  # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
30
- # Docs: https://developers.cloudflare.com/queues/get-started
78
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
31
79
  # [[queues.consumers]]
32
80
  # queue = "my-queue"
33
81
 
82
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
83
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
84
+ # [[r2_buckets]]
85
+ # binding = "MY_BUCKET"
86
+ # bucket_name = "my-bucket"
87
+
34
88
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
- # Docs: https://developers.cloudflare.com/workers/platform/services
89
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
36
90
  # [[services]]
37
91
  # binding = "MY_SERVICE"
38
92
  # service = "my-service"
39
93
 
40
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
- # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
43
- # [[durable_objects.bindings]]
44
- # name = "MY_DURABLE_OBJECT"
45
- # class_name = "MyDurableObject"
46
-
47
- # Durable Object migrations.
48
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
49
- # [[migrations]]
50
- # tag = "v1"
51
- # new_classes = ["MyDurableObject"]
94
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
95
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
96
+ # [[vectorize]]
97
+ # binding = "MY_INDEX"
98
+ # index_name = "my-index"
@@ -3,7 +3,6 @@ root = true
3
3
 
4
4
  [*]
5
5
  indent_style = tab
6
- tab_width = 2
7
6
  end_of_line = lf
8
7
  charset = utf-8
9
8
  trim_trailing_whitespace = true
@@ -5,11 +5,13 @@
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
- "@cloudflare/workers-types": "^4.20230419.0",
12
12
  "typescript": "^5.0.4",
13
- "wrangler": "^3.0.0"
13
+ "wrangler": "^3.0.0",
14
+ "vitest": "1.3.0",
15
+ "@cloudflare/vitest-pool-workers": "^0.1.0"
14
16
  }
15
17
  }
@@ -0,0 +1,25 @@
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";
5
+
6
+ // For now, you'll need to do something like this to get a correctly-typed
7
+ // `Request` to pass to `worker.fetch()`.
8
+ const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
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
+ });
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
+ });
25
+ });
@@ -0,0 +1,11 @@
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": []
11
+ }
@@ -26,7 +26,7 @@
26
26
  /* Modules */
27
27
  "module": "es2022" /* Specify what module code is generated. */,
28
28
  // "rootDir": "./", /* Specify the root folder within your source files. */
29
- "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
29
+ "moduleResolution": "Bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
30
30
  // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31
31
  // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32
32
  // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
@@ -97,5 +97,6 @@
97
97
  /* Completeness */
98
98
  // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99
99
  "skipLibCheck": true /* Skip type checking all .d.ts files. */
100
- }
100
+ },
101
+ "exclude": ["test"]
101
102
  }
@@ -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
+ });
@@ -1,51 +1,98 @@
1
1
  name = "<TBD>"
2
2
  main = "src/index.ts"
3
3
  compatibility_date = "<TBD>"
4
+ compatibility_flags = ["nodejs_compat"]
4
5
 
5
6
  # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
6
7
  # Note: Use secrets to store sensitive data.
7
- # Docs: https://developers.cloudflare.com/workers/platform/environment-variables
8
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
8
9
  # [vars]
9
10
  # MY_VARIABLE = "production_value"
10
11
 
12
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
13
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
14
+ # [ai]
15
+ # binding = "AI"
16
+
17
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
18
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
19
+ # [[analytics_engine_datasets]]
20
+ # binding = "MY_DATASET"
21
+
22
+ # Bind a headless browser instance running on Cloudflare's global network.
23
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
24
+ # [browser]
25
+ # binding = "MY_BROWSER"
26
+
27
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
28
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
29
+ # [[d1_databases]]
30
+ # binding = "MY_DB"
31
+ # database_name = "my-database"
32
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
33
+
34
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
35
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
36
+ # [[dispatch_namespaces]]
37
+ # binding = "MY_DISPATCHER"
38
+ # namespace = "my-namespace"
39
+
40
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
43
+ # [[durable_objects.bindings]]
44
+ # name = "MY_DURABLE_OBJECT"
45
+ # class_name = "MyDurableObject"
46
+
47
+ # Durable Object migrations.
48
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
49
+ # [[migrations]]
50
+ # tag = "v1"
51
+ # new_classes = ["MyDurableObject"]
52
+
53
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
54
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
55
+ # [[hyperdrive]]
56
+ # binding = "MY_HYPERDRIVE"
57
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
58
+
11
59
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
60
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
13
61
  # [[kv_namespaces]]
14
62
  # binding = "MY_KV_NAMESPACE"
15
63
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
64
 
17
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
18
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
19
- # [[r2_buckets]]
20
- # binding = "MY_BUCKET"
21
- # bucket_name = "my-bucket"
65
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
66
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
67
+ # [[mtls_certificates]]
68
+ # binding = "MY_CERTIFICATE"
69
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
22
70
 
23
71
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
24
- # Docs: https://developers.cloudflare.com/queues/get-started
72
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
25
73
  # [[queues.producers]]
26
74
  # binding = "MY_QUEUE"
27
75
  # queue = "my-queue"
28
76
 
29
77
  # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
30
- # Docs: https://developers.cloudflare.com/queues/get-started
78
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
31
79
  # [[queues.consumers]]
32
80
  # queue = "my-queue"
33
81
 
82
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
83
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
84
+ # [[r2_buckets]]
85
+ # binding = "MY_BUCKET"
86
+ # bucket_name = "my-bucket"
87
+
34
88
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
- # Docs: https://developers.cloudflare.com/workers/platform/services
89
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
36
90
  # [[services]]
37
91
  # binding = "MY_SERVICE"
38
92
  # service = "my-service"
39
93
 
40
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
41
- # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
42
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
43
- # [[durable_objects.bindings]]
44
- # name = "MY_DURABLE_OBJECT"
45
- # class_name = "MyDurableObject"
46
-
47
- # Durable Object migrations.
48
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
49
- # [[migrations]]
50
- # tag = "v1"
51
- # new_classes = ["MyDurableObject"]
94
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
95
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
96
+ # [[vectorize]]
97
+ # binding = "MY_INDEX"
98
+ # index_name = "my-index"
@@ -0,0 +1,16 @@
1
+ export default {
2
+ configVersion: 1,
3
+ id: "hello-world-durable-object",
4
+ displayName: '"Hello World" Durable Object',
5
+ platform: "workers",
6
+ copyFiles: {
7
+ variants: {
8
+ js: {
9
+ path: "./js",
10
+ },
11
+ ts: {
12
+ path: "./ts",
13
+ },
14
+ },
15
+ },
16
+ };
@@ -0,0 +1,12 @@
1
+ # http://editorconfig.org
2
+ root = true
3
+
4
+ [*]
5
+ indent_style = tab
6
+ end_of_line = lf
7
+ charset = utf-8
8
+ trim_trailing_whitespace = true
9
+ insert_final_newline = true
10
+
11
+ [*.yml]
12
+ indent_style = space
@@ -0,0 +1,6 @@
1
+ {
2
+ "printWidth": 140,
3
+ "singleQuote": true,
4
+ "semi": true,
5
+ "useTabs": true
6
+ }
@@ -169,3 +169,4 @@ dist
169
169
  # wrangler project
170
170
 
171
171
  .dev.vars
172
+ .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.0.0"
12
+ }
13
+ }
@@ -0,0 +1,65 @@
1
+ /**
2
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
3
+ *
4
+ * - Run `npm run dev` in your terminal to start a development server
5
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
6
+ * - Run `npm run deploy` to publish your application
7
+ *
8
+ * Learn more at https://developers.cloudflare.com/durable-objects
9
+ */
10
+
11
+ /**
12
+ * Env provides a mechanism to reference bindings declared in wrangler.toml within JavaScript
13
+ *
14
+ * @typedef {Object} Env
15
+ * @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
16
+ */
17
+
18
+ /** A Durable Object's behavior is defined in an exported Javascript class */
19
+ export class MyDurableObject {
20
+ /**
21
+ * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
22
+ * `DurableObjectStub::get` for a given identifier
23
+ *
24
+ * @param {DurableObjectState} state - The interface for interacting with Durable Object state
25
+ * @param {Env} env - The interface to reference bindings declared in wrangler.toml
26
+ */
27
+ constructor(state, env) {}
28
+
29
+ /**
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
32
+ *
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
35
+ */
36
+ async fetch(request) {
37
+ return new Response('Hello World');
38
+ }
39
+ }
40
+
41
+ export default {
42
+ /**
43
+ * This is the standard fetch handler for a Cloudflare Worker
44
+ *
45
+ * @param {Request} request - The request submitted to the Worker from the client
46
+ * @param {Env} env - The interface to reference bindings declared in wrangler.toml
47
+ * @param {ExecutionContext} ctx - The execution context of the Worker
48
+ * @returns {Promise<Response>} The response to be sent back to the client
49
+ */
50
+ async fetch(request, env, ctx) {
51
+ // We will create a `DurableObjectId` using the pathname from the Worker request
52
+ // This id refers to a unique instance of our 'MyDurableObject' class above
53
+ let id = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
54
+
55
+ // This stub creates a communication channel with the Durable Object instance
56
+ // The Durable Object constructor will be invoked upon the first call for a given id
57
+ let stub = env.MY_DURABLE_OBJECT.get(id);
58
+
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);
62
+
63
+ return response;
64
+ },
65
+ };