create-cloudflare 0.0.0-9a8d36f1 → 0.0.0-9aa155d4

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 (99) hide show
  1. package/dist/cli.js +39922 -39144
  2. package/package.json +5 -3
  3. package/templates/analog/c3.ts +134 -0
  4. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  5. package/templates/analog/templates/env.d.ts +13 -0
  6. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  7. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  8. package/templates/analog/templates/wrangler.toml +85 -0
  9. package/templates/angular/c3.ts +5 -3
  10. package/templates/astro/c3.ts +8 -7
  11. package/templates/astro/snippets/runtimeDeclaration.ts +2 -1
  12. package/templates/astro/templates/wrangler.toml +60 -25
  13. package/templates/common/js/.editorconfig +0 -1
  14. package/templates/common/js/wrangler.toml +78 -22
  15. package/templates/common/ts/.editorconfig +0 -1
  16. package/templates/common/ts/package.json +2 -1
  17. package/templates/common/ts/src/index.ts +3 -0
  18. package/templates/common/ts/worker-configuration.d.ts +2 -14
  19. package/templates/common/ts/wrangler.toml +78 -22
  20. package/templates/docusaurus/c3.ts +2 -2
  21. package/templates/gatsby/c3.ts +2 -2
  22. package/templates/hello-world/js/.editorconfig +0 -1
  23. package/templates/hello-world/js/package.json +5 -2
  24. package/templates/hello-world/js/test/index.spec.js +20 -0
  25. package/templates/hello-world/js/vitest.config.js +11 -0
  26. package/templates/hello-world/js/wrangler.toml +79 -22
  27. package/templates/hello-world/ts/.editorconfig +0 -1
  28. package/templates/hello-world/ts/package.json +6 -2
  29. package/templates/hello-world/ts/src/index.ts +3 -17
  30. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  31. package/templates/hello-world/ts/test/tsconfig.json +11 -0
  32. package/templates/hello-world/ts/tsconfig.json +3 -2
  33. package/templates/hello-world/ts/vitest.config.ts +11 -0
  34. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  35. package/templates/hello-world/ts/wrangler.toml +79 -22
  36. package/templates/hello-world-durable-object/js/.editorconfig +0 -1
  37. package/templates/hello-world-durable-object/js/src/index.js +18 -14
  38. package/templates/hello-world-durable-object/js/wrangler.toml +79 -23
  39. package/templates/hello-world-durable-object/ts/.editorconfig +0 -1
  40. package/templates/hello-world-durable-object/ts/package.json +2 -2
  41. package/templates/hello-world-durable-object/ts/src/index.ts +24 -16
  42. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +6 -0
  43. package/templates/hello-world-durable-object/ts/wrangler.toml +78 -22
  44. package/templates/hello-world-python/c3.ts +9 -0
  45. package/templates/hello-world-python/py/__dot__gitignore +68 -0
  46. package/templates/hello-world-python/py/package.json +13 -0
  47. package/templates/hello-world-python/py/src/entry.py +4 -0
  48. package/templates/hello-world-python/py/wrangler.toml +108 -0
  49. package/templates/hono/c3.ts +54 -1
  50. package/templates/hono/snippets/appDeclaration.ts +1 -0
  51. package/templates/hono/snippets/bindingsType.ts +1 -0
  52. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  53. package/templates/hono/templates/wrangler.toml +107 -0
  54. package/templates/next/README.md +11 -1
  55. package/templates/next/app/js/app/api/hello/route.js +1 -1
  56. package/templates/next/app/ts/app/api/hello/route.ts +1 -1
  57. package/templates/next/c3.ts +28 -8
  58. package/templates/next/env.d.ts +3 -5
  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 +59 -30
  62. package/templates/nuxt/c3.ts +8 -7
  63. package/templates/nuxt/templates/worker-configuration.d.ts +4 -3
  64. package/templates/nuxt/templates/wrangler.toml +60 -25
  65. package/templates/openapi/ts/package.json +2 -1
  66. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  67. package/templates/openapi/ts/wrangler.toml +104 -0
  68. package/templates/pre-existing/c3.ts +2 -2
  69. package/templates/pre-existing/js/.editorconfig +0 -1
  70. package/templates/pre-existing/js/wrangler.toml +1 -0
  71. package/templates/queues/js/.editorconfig +0 -1
  72. package/templates/queues/js/wrangler.toml +95 -2
  73. package/templates/queues/ts/.editorconfig +0 -1
  74. package/templates/queues/ts/package.json +2 -1
  75. package/templates/queues/ts/src/index.ts +3 -5
  76. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  77. package/templates/queues/ts/wrangler.toml +95 -2
  78. package/templates/qwik/c3.ts +6 -6
  79. package/templates/qwik/templates/worker-configuration.d.ts +4 -3
  80. package/templates/qwik/templates/wrangler.toml +60 -25
  81. package/templates/react/c3.ts +2 -2
  82. package/templates/remix/c3.ts +6 -6
  83. package/templates/remix/templates/worker-configuration.d.ts +4 -3
  84. package/templates/remix/templates/wrangler.toml +60 -25
  85. package/templates/scheduled/js/.editorconfig +0 -1
  86. package/templates/scheduled/js/wrangler.toml +104 -0
  87. package/templates/scheduled/ts/.editorconfig +0 -1
  88. package/templates/scheduled/ts/package.json +2 -1
  89. package/templates/scheduled/ts/src/index.ts +3 -20
  90. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  91. package/templates/scheduled/ts/wrangler.toml +104 -0
  92. package/templates/solid/c3.ts +8 -5
  93. package/templates/solid/templates/wrangler.toml +84 -0
  94. package/templates/svelte/c3.ts +6 -5
  95. package/templates/svelte/js/wrangler.toml +60 -25
  96. package/templates/svelte/ts/wrangler.toml +60 -25
  97. package/templates/vue/c3.ts +2 -2
  98. package/templates/svelte/js/src/hooks.server.js +0 -25
  99. package/templates/svelte/ts/src/hooks.server.ts +0 -24
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-cloudflare",
3
- "version": "0.0.0-9a8d36f1",
3
+ "version": "0.0.0-9aa155d4",
4
4
  "description": "A CLI for creating and deploying new applications to Cloudflare.",
5
5
  "keywords": [
6
6
  "cloudflare",
@@ -30,7 +30,7 @@
30
30
  "@babel/types": "^7.21.4",
31
31
  "@clack/prompts": "^0.6.3",
32
32
  "@cloudflare/eslint-config-worker": "*",
33
- "@cloudflare/workers-types": "^4.20230419.0",
33
+ "@cloudflare/workers-types": "^4.20240419.0",
34
34
  "@iarna/toml": "^3.0.0",
35
35
  "@types/command-exists": "^1.2.0",
36
36
  "@types/cross-spawn": "^6.0.2",
@@ -55,6 +55,7 @@
55
55
  "execa": "^7.1.1",
56
56
  "glob": "^10.3.3",
57
57
  "haikunator": "^2.1.2",
58
+ "indent-string": "^5.0.0",
58
59
  "magic-string": "^0.30.5",
59
60
  "open": "^8.4.0",
60
61
  "pnpm": "^8.10.0",
@@ -64,10 +65,11 @@
64
65
  "undici": "5.28.3",
65
66
  "vite-tsconfig-paths": "^4.0.8",
66
67
  "which-pm-runs": "^1.1.0",
68
+ "wrap-ansi": "^9.0.0",
67
69
  "yargs": "^17.7.1",
68
70
  "yarn": "^1.22.19",
69
71
  "@cloudflare/cli": "1.1.1",
70
- "wrangler": "3.32.0",
72
+ "wrangler": "3.51.2",
71
73
  "@cloudflare/workers-tsconfig": "0.0.0"
72
74
  },
73
75
  "engines": {
@@ -0,0 +1,134 @@
1
+ import { logRaw } from "@cloudflare/cli";
2
+ import { brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { spinner } from "@cloudflare/cli/interactive";
4
+ import { runFrameworkGenerator } from "frameworks/index";
5
+ import { loadTemplateSnippets, transformFile } from "helpers/codemod";
6
+ import { getLatestTypesEntrypoint } from "helpers/compatDate";
7
+ import { readFile, writeFile } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
10
+ import * as recast from "recast";
11
+ import type { TemplateConfig } from "../../src/templates";
12
+ import type { C3Context } from "types";
13
+
14
+ const { npm, name: pm } = detectPackageManager();
15
+
16
+ const generate = async (ctx: C3Context) => {
17
+ await runFrameworkGenerator(ctx, [
18
+ ctx.project.name,
19
+ "--template",
20
+ "angular-v17",
21
+ ]);
22
+
23
+ logRaw(""); // newline
24
+ };
25
+
26
+ const configure = async (ctx: C3Context) => {
27
+ // Fix hoisting issues with pnpm, yarn and bun
28
+ if (pm === "pnpm" || pm === "yarn" || pm === "bun") {
29
+ const packages = [];
30
+ packages.push("nitropack");
31
+ packages.push("h3");
32
+ packages.push("@ngtools/webpack");
33
+ packages.push("@angular-devkit/build-angular");
34
+
35
+ await installPackages(packages, {
36
+ dev: true,
37
+ startText: `Installing ${packages.join(", ")}`,
38
+ doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
39
+ });
40
+ }
41
+
42
+ updateViteConfig(ctx);
43
+ updateEnvTypes(ctx);
44
+ };
45
+
46
+ const updateEnvTypes = (ctx: C3Context) => {
47
+ const filepath = "env.d.ts";
48
+
49
+ const s = spinner();
50
+ s.start(`Updating ${filepath}`);
51
+
52
+ let file = readFile(filepath);
53
+
54
+ let typesEntrypoint = `@cloudflare/workers-types`;
55
+ const latestEntrypoint = getLatestTypesEntrypoint(ctx);
56
+ if (latestEntrypoint) {
57
+ typesEntrypoint += `/${latestEntrypoint}`;
58
+ }
59
+
60
+ // Replace placeholder with actual types entrypoint
61
+ file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
62
+ writeFile("env.d.ts", file);
63
+
64
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
65
+ };
66
+
67
+ const updateViteConfig = (ctx: C3Context) => {
68
+ const b = recast.types.builders;
69
+ const s = spinner();
70
+
71
+ const configFile = "vite.config.ts";
72
+ s.start(`Updating \`${configFile}\``);
73
+
74
+ const snippets = loadTemplateSnippets(ctx);
75
+
76
+ transformFile(configFile, {
77
+ visitProgram(n) {
78
+ const lastImportIndex = n.node.body.findLastIndex(
79
+ (t) => t.type === "ImportDeclaration"
80
+ );
81
+ const lastImport = n.get("body", lastImportIndex);
82
+ lastImport.insertAfter(...snippets.devBindingsModuleTs);
83
+
84
+ return this.traverse(n);
85
+ },
86
+ visitCallExpression(n) {
87
+ const callee = n.node.callee as recast.types.namedTypes.Identifier;
88
+ if (callee.name === "analog") {
89
+ const pluginArguments = b.objectProperty(
90
+ b.identifier("nitro"),
91
+ b.objectExpression([
92
+ b.objectProperty(
93
+ b.identifier("preset"),
94
+ b.stringLiteral("cloudflare-pages")
95
+ ),
96
+ b.objectProperty(
97
+ b.identifier("modules"),
98
+ b.arrayExpression([b.identifier("devBindingsModule")])
99
+ ),
100
+ ])
101
+ );
102
+
103
+ n.node.arguments = [b.objectExpression([pluginArguments])];
104
+ }
105
+
106
+ return this.traverse(n);
107
+ },
108
+ });
109
+
110
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
111
+ };
112
+
113
+ const config: TemplateConfig = {
114
+ configVersion: 1,
115
+ id: "analog",
116
+ platform: "pages",
117
+ displayName: "Analog",
118
+ copyFiles: {
119
+ path: "./templates",
120
+ },
121
+ generate,
122
+ configure,
123
+ transformPackageJson: async () => ({
124
+ scripts: {
125
+ preview: `${npm} run build && wrangler pages dev`,
126
+ deploy: `${npm} run build && wrangler pages deploy`,
127
+ "cf-typegen": `wrangler types`,
128
+ },
129
+ }),
130
+ devScript: "dev",
131
+ deployScript: "deploy",
132
+ previewScript: "preview",
133
+ };
134
+ export default config;
@@ -0,0 +1,7 @@
1
+ import { Nitro } from 'nitropack';
2
+
3
+ const devBindingsModule = async (nitro: Nitro) => {
4
+ if (nitro.options.dev) {
5
+ nitro.options.plugins.push('./src/dev-bindings.ts');
6
+ }
7
+ };
@@ -0,0 +1,13 @@
1
+ /// <reference types="WORKERS_TYPES_ENTRYPOINT" />
2
+
3
+ declare module "h3" {
4
+ interface H3EventContext {
5
+ cf: CfProperties;
6
+ cloudflare: {
7
+ env: Env;
8
+ context: ExecutionContext;
9
+ };
10
+ }
11
+ }
12
+
13
+ export {};
@@ -0,0 +1,18 @@
1
+ import { NitroApp } from 'nitropack';
2
+ import { defineNitroPlugin } from 'nitropack/dist/runtime/plugin';
3
+
4
+ export default defineNitroPlugin((nitroApp: NitroApp) => {
5
+ nitroApp.hooks.hook('request', async (event) => {
6
+ const _pkg = 'wrangler'; // Bypass bundling!
7
+ const { getPlatformProxy } = (await import(
8
+ _pkg
9
+ )) as typeof import('wrangler');
10
+ const platform = await getPlatformProxy();
11
+
12
+ event.context.cf = platform['cf'];
13
+ event.context.cloudflare = {
14
+ env: platform['env'] as unknown as Env,
15
+ context: platform['ctx'],
16
+ };
17
+ });
18
+ });
@@ -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
+ }
@@ -0,0 +1,85 @@
1
+ #:schema node_modules/wrangler/config-schema.json
2
+ name = "<TBD>"
3
+ compatibility_date = "<TBD>"
4
+ pages_build_output_dir = "./dist/analog/public"
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"
12
+
13
+ # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
14
+ # Note: Use secrets to store sensitive data.
15
+ # Docs:
16
+ # - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
18
+ # [vars]
19
+ # MY_VARIABLE = "production_value"
20
+
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
27
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
28
+ # [[d1_databases]]
29
+ # binding = "MY_DB"
30
+ # database_name = "my-database"
31
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
32
+
33
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
34
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
35
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
36
+ # [[durable_objects.bindings]]
37
+ # name = "MY_DURABLE_OBJECT"
38
+ # class_name = "MyDurableObject"
39
+ # script_name = 'my-durable-object'
40
+
41
+ # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
42
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
43
+ # [[kv_namespaces]]
44
+ # binding = "MY_KV_NAMESPACE"
45
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
46
+
47
+ # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
48
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
49
+ # [[queues.producers]]
50
+ # binding = "MY_QUEUE"
51
+ # queue = "my-queue"
52
+
53
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
54
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
55
+ # [[r2_buckets]]
56
+ # binding = "MY_BUCKET"
57
+ # bucket_name = "my-bucket"
58
+
59
+ # Bind another Worker service. Use this binding to call another Worker without network overhead.
60
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
61
+ # [[services]]
62
+ # binding = "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>"
@@ -2,9 +2,11 @@ import { resolve } from "node:path";
2
2
  import { logRaw } from "@cloudflare/cli";
3
3
  import { brandColor, dim } from "@cloudflare/cli/colors";
4
4
  import { spinner } from "@cloudflare/cli/interactive";
5
- import { installPackages, runFrameworkGenerator } from "helpers/command";
6
- import { compatDateFlag, readFile, readJSON, writeFile } from "helpers/files";
7
- import { detectPackageManager } from "helpers/packages";
5
+ import { runFrameworkGenerator } from "frameworks/index";
6
+ import { compatDateFlag } from "helpers/compatDate";
7
+ import { readFile, readJSON, writeFile } from "helpers/files";
8
+ import { detectPackageManager } from "helpers/packageManagers";
9
+ import { installPackages } from "helpers/packages";
8
10
  import type { TemplateConfig } from "../../src/templates";
9
11
  import type { C3Context } from "types";
10
12
 
@@ -1,9 +1,10 @@
1
1
  import { logRaw, updateStatus } from "@cloudflare/cli";
2
2
  import { blue, brandColor, dim } from "@cloudflare/cli/colors";
3
+ import { runFrameworkGenerator } from "frameworks/index";
3
4
  import { loadTemplateSnippets, transformFile } from "helpers/codemod";
4
- import { runCommand, runFrameworkGenerator } from "helpers/command";
5
+ import { runCommand } from "helpers/command";
5
6
  import { usesTypescript } from "helpers/files";
6
- import { detectPackageManager } from "helpers/packages";
7
+ import { detectPackageManager } from "helpers/packageManagers";
7
8
  import * as recast from "recast";
8
9
  import type { TemplateConfig } from "../../src/templates";
9
10
  import type { C3Context, PackageJson } from "types";
@@ -45,9 +46,9 @@ const updateAstroConfig = () => {
45
46
  n.node.arguments = [
46
47
  b.objectExpression([
47
48
  b.objectProperty(
48
- b.identifier("runtime"),
49
+ b.identifier("platformProxy"),
49
50
  b.objectExpression([
50
- b.objectProperty(b.identifier("mode"), b.stringLiteral("local")),
51
+ b.objectProperty(b.identifier("enabled"), b.booleanLiteral(true)),
51
52
  ])
52
53
  ),
53
54
  ]),
@@ -102,9 +103,9 @@ const config: TemplateConfig = {
102
103
  configure,
103
104
  transformPackageJson: async (pkgJson: PackageJson, ctx: C3Context) => ({
104
105
  scripts: {
105
- deploy: `astro build && wrangler pages deploy ./dist`,
106
- preview: `astro build && wrangler pages dev ./dist`,
107
- ...(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` }),
108
109
  },
109
110
  }),
110
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,50 +1,85 @@
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/workers/platform/environment-variables
17
+ # - https://developers.cloudflare.com/pages/functions/bindings/#secrets
7
18
  # [vars]
8
19
  # MY_VARIABLE = "production_value"
9
20
 
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
27
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#d1-databases
28
+ # [[d1_databases]]
29
+ # binding = "MY_DB"
30
+ # database_name = "my-database"
31
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
32
+
33
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
34
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
35
+ # Docs: https://developers.cloudflare.com/workers/runtime-apis/durable-objects
36
+ # [[durable_objects.bindings]]
37
+ # name = "MY_DURABLE_OBJECT"
38
+ # class_name = "MyDurableObject"
39
+ # script_name = 'my-durable-object'
40
+
10
41
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
11
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
42
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
12
43
  # [[kv_namespaces]]
13
44
  # binding = "MY_KV_NAMESPACE"
14
45
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
15
46
 
16
- # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
17
- # Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
18
- # [[r2_buckets]]
19
- # binding = "MY_BUCKET"
20
- # bucket_name = "my-bucket"
21
-
22
47
  # Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
23
- # Docs: https://developers.cloudflare.com/queues/get-started
48
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#queue-producers
24
49
  # [[queues.producers]]
25
50
  # binding = "MY_QUEUE"
26
51
  # queue = "my-queue"
27
52
 
28
- # Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
29
- # Docs: https://developers.cloudflare.com/queues/get-started
30
- # [[queues.consumers]]
31
- # queue = "my-queue"
53
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
54
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#r2-buckets
55
+ # [[r2_buckets]]
56
+ # binding = "MY_BUCKET"
57
+ # bucket_name = "my-bucket"
32
58
 
33
59
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
34
- # Docs: https://developers.cloudflare.com/workers/platform/services
60
+ # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
35
61
  # [[services]]
36
62
  # binding = "MY_SERVICE"
37
63
  # service = "my-service"
38
64
 
39
- # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
40
- # 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
42
- # [[durable_objects.bindings]]
43
- # name = "MY_DURABLE_OBJECT"
44
- # class_name = "MyDurableObject"
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 ########
45
79
 
46
- # Durable Object migrations.
47
- # Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
48
- # [[migrations]]
49
- # tag = "v1"
50
- # new_classes = ["MyDurableObject"]
80
+ # [env.production.vars]
81
+ # API_KEY = "abc123"
82
+
83
+ # [[env.production.kv_namespaces]]
84
+ # binding = "MY_KV_NAMESPACE"
85
+ # id = "<PRODUCTION_NAMESPACE_ID>"
@@ -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
@@ -1,51 +1,107 @@
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/platform/environment-variables
17
+ # - https://developers.cloudflare.com/workers/configuration/secrets/
8
18
  # [vars]
9
19
  # MY_VARIABLE = "production_value"
10
20
 
21
+ # Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
22
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
23
+ # [ai]
24
+ # binding = "AI"
25
+
26
+ # Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
27
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
28
+ # [[analytics_engine_datasets]]
29
+ # binding = "MY_DATASET"
30
+
31
+ # Bind a headless browser instance running on Cloudflare's global network.
32
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
33
+ # [browser]
34
+ # binding = "MY_BROWSER"
35
+
36
+ # Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
37
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
38
+ # [[d1_databases]]
39
+ # binding = "MY_DB"
40
+ # database_name = "my-database"
41
+ # database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
42
+
43
+ # Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
44
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
45
+ # [[dispatch_namespaces]]
46
+ # binding = "MY_DISPATCHER"
47
+ # namespace = "my-namespace"
48
+
49
+ # Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
50
+ # Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
51
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
52
+ # [[durable_objects.bindings]]
53
+ # name = "MY_DURABLE_OBJECT"
54
+ # class_name = "MyDurableObject"
55
+
56
+ # Durable Object migrations.
57
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
58
+ # [[migrations]]
59
+ # tag = "v1"
60
+ # new_classes = ["MyDurableObject"]
61
+
62
+ # Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
63
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
64
+ # [[hyperdrive]]
65
+ # binding = "MY_HYPERDRIVE"
66
+ # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
67
+
11
68
  # Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
12
- # Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
69
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
13
70
  # [[kv_namespaces]]
14
71
  # binding = "MY_KV_NAMESPACE"
15
72
  # id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
16
73
 
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"
74
+ # Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
75
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
76
+ # [[mtls_certificates]]
77
+ # binding = "MY_CERTIFICATE"
78
+ # certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
22
79
 
23
80
  # 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
81
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
25
82
  # [[queues.producers]]
26
83
  # binding = "MY_QUEUE"
27
84
  # queue = "my-queue"
28
85
 
29
86
  # 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
87
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
31
88
  # [[queues.consumers]]
32
89
  # queue = "my-queue"
33
90
 
91
+ # Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
92
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
93
+ # [[r2_buckets]]
94
+ # binding = "MY_BUCKET"
95
+ # bucket_name = "my-bucket"
96
+
34
97
  # Bind another Worker service. Use this binding to call another Worker without network overhead.
35
- # Docs: https://developers.cloudflare.com/workers/platform/services
98
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
36
99
  # [[services]]
37
100
  # binding = "MY_SERVICE"
38
101
  # service = "my-service"
39
102
 
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"]
103
+ # Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
104
+ # Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
105
+ # [[vectorize]]
106
+ # binding = "MY_INDEX"
107
+ # index_name = "my-index"
@@ -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,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