wrangler 0.0.0-e51a43c7 → 0.0.0-e55f489db

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.
@@ -1,216 +1,141 @@
1
1
  {
2
- "$ref": "#/definitions/RawConfig",
3
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/RawConfig",
4
4
  "definitions": {
5
- "CloudchamberConfig": {
5
+ "RawConfig": {
6
+ "type": "object",
6
7
  "additionalProperties": false,
7
- "description": "Configuration in wrangler for Cloudchamber",
8
8
  "properties": {
9
- "memory": {
9
+ "$schema": {
10
10
  "type": "string"
11
11
  },
12
- "vcpu": {
13
- "type": "number"
14
- }
15
- },
16
- "type": "object"
17
- },
18
- "ConfigModuleRuleType": {
19
- "description": "The possible types for a `Rule`.",
20
- "enum": [
21
- "ESModule",
22
- "CommonJS",
23
- "CompiledWasm",
24
- "Text",
25
- "Data",
26
- "PythonModule",
27
- "PythonRequirement"
28
- ],
29
- "type": "string"
30
- },
31
- "CustomDomainRoute": {
32
- "additionalProperties": false,
33
- "properties": {
34
- "custom_domain": {
35
- "type": "boolean"
36
- },
37
- "pattern": {
38
- "type": "string"
39
- }
40
- },
41
- "required": [
42
- "pattern",
43
- "custom_domain"
44
- ],
45
- "type": "object"
46
- },
47
- "DeprecatedUpload": {
48
- "additionalProperties": false,
49
- "description": "Deprecated upload configuration.",
50
- "properties": {
51
- "dir": {
52
- "deprecated": true,
53
- "description": "The directory you wish to upload your Worker from, relative to the wrangler.toml file.\n\nDefaults to the directory containing the wrangler.toml file.",
54
- "type": "string"
12
+ "env": {
13
+ "type": "object",
14
+ "additionalProperties": {
15
+ "$ref": "#/definitions/RawEnvironment"
16
+ },
17
+ "description": "The `env` section defines overrides for the configuration for different environments.\n\nAll environment fields can be specified at the top level of the config indicating the default environment settings.\n\n- Some fields are inherited and overridable in each environment.\n- But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.\n\nFor more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments",
18
+ "default": {}
55
19
  },
56
- "format": {
57
- "deprecated": "We infer the format automatically now.",
58
- "description": "The format of the Worker script.",
59
- "enum": [
60
- "modules",
61
- "service-worker"
62
- ],
63
- "type": "string"
20
+ "name": {
21
+ "type": "string",
22
+ "description": "The name of your Worker. Alphanumeric + dashes only."
64
23
  },
65
- "main": {
66
- "deprecated": "This will be replaced by a command line argument.",
67
- "description": "The path to the Worker script, relative to `upload.dir`.",
68
- "type": "string"
24
+ "account_id": {
25
+ "type": "string",
26
+ "description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable."
69
27
  },
70
- "rules": {
71
- "$ref": "#/definitions/Environment",
72
- "deprecated": "This is now defined at the top level `rules` field."
73
- }
74
- },
75
- "type": "object"
76
- },
77
- "DispatchNamespaceOutbound": {
78
- "additionalProperties": false,
79
- "properties": {
80
- "environment": {
81
- "description": "(Optional) Name of the environment handling the outbound requests.",
82
- "type": "string"
28
+ "compatibility_date": {
29
+ "type": "string",
30
+ "description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/configuration/compatibility-dates"
83
31
  },
84
- "parameters": {
85
- "description": "(Optional) List of parameter names, for sending context from your dispatch Worker to the outbound handler",
32
+ "compatibility_flags": {
33
+ "type": "array",
86
34
  "items": {
87
35
  "type": "string"
88
36
  },
89
- "type": "array"
37
+ "description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_date.\n\nMore details at https://developers.cloudflare.com/workers/configuration/compatibility-flags/",
38
+ "default": []
90
39
  },
91
- "service": {
92
- "description": "Name of the service handling the outbound requests",
93
- "type": "string"
94
- }
95
- },
96
- "required": [
97
- "service"
98
- ],
99
- "type": "object"
100
- },
101
- "DurableObjectBindings": {
102
- "items": {
103
- "additionalProperties": false,
104
- "properties": {
105
- "class_name": {
106
- "description": "The exported class name of the Durable Object",
107
- "type": "string"
108
- },
109
- "environment": {
110
- "description": "The service environment of the script_name to bind to",
111
- "type": "string"
112
- },
113
- "name": {
114
- "description": "The name of the binding used to refer to the Durable Object",
115
- "type": "string"
116
- },
117
- "script_name": {
118
- "description": "The script where the Durable Object is defined (if it's external to this Worker)",
119
- "type": "string"
120
- }
40
+ "main": {
41
+ "type": "string",
42
+ "description": "The entrypoint/path to the JavaScript file that will be executed."
121
43
  },
122
- "required": [
123
- "name",
124
- "class_name"
125
- ],
126
- "type": "object"
127
- },
128
- "type": "array"
129
- },
130
- "Environment": {
131
- "additionalProperties": false,
132
- "description": "The `Environment` interface declares all the configuration fields that can be specified for an environment.\n\nThis could be the top-level default environment, or a specific named environment.",
133
- "properties": {
134
- "account_id": {
135
- "description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
136
- "type": "string"
44
+ "find_additional_modules": {
45
+ "type": "boolean",
46
+ "description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false."
137
47
  },
138
- "ai": {
139
- "additionalProperties": false,
140
- "default": "`{}`",
141
- "description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
142
- "properties": {
143
- "binding": {
144
- "type": "string"
145
- },
146
- "staging": {
147
- "type": "boolean"
148
- }
149
- },
150
- "required": [
151
- "binding"
152
- ],
153
- "type": "object"
48
+ "preserve_file_names": {
49
+ "type": "boolean",
50
+ "description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`."
154
51
  },
155
- "analytics_engine_datasets": {
156
- "default": "`[]`",
157
- "description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
52
+ "base_dir": {
53
+ "type": "string",
54
+ "description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified."
55
+ },
56
+ "workers_dev": {
57
+ "type": "boolean",
58
+ "description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.",
59
+ "default": true
60
+ },
61
+ "preview_urls": {
62
+ "type": "boolean",
63
+ "description": "Whether we use <version>-<name>.<subdomain>.workers.dev to serve Preview URLs for your Worker.",
64
+ "default": true
65
+ },
66
+ "routes": {
67
+ "type": "array",
158
68
  "items": {
159
- "additionalProperties": false,
160
- "properties": {
161
- "binding": {
162
- "description": "The binding name used to refer to the dataset in the Worker.",
163
- "type": "string"
164
- },
165
- "dataset": {
166
- "description": "The name of this dataset to write to.",
167
- "type": "string"
168
- }
169
- },
170
- "required": [
171
- "binding"
172
- ],
173
- "type": "object"
69
+ "$ref": "#/definitions/Route"
174
70
  },
175
- "type": "array"
71
+ "description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)"
176
72
  },
177
- "base_dir": {
178
- "description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
179
- "type": "string"
73
+ "route": {
74
+ "$ref": "#/definitions/Route",
75
+ "description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
180
76
  },
181
- "browser": {
182
- "additionalProperties": false,
183
- "default": "`{}`",
184
- "description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
77
+ "tsconfig": {
78
+ "type": "string",
79
+ "description": "Path to a custom tsconfig"
80
+ },
81
+ "jsx_factory": {
82
+ "type": "string",
83
+ "description": "The function to use to replace jsx syntax.",
84
+ "default": "React.createElement"
85
+ },
86
+ "jsx_fragment": {
87
+ "type": "string",
88
+ "description": "The function to use to replace jsx fragment syntax.",
89
+ "default": "React.Fragment"
90
+ },
91
+ "migrations": {
92
+ "type": "array",
93
+ "items": {
94
+ "$ref": "#/definitions/DurableObjectMigration"
95
+ },
96
+ "description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
97
+ "default": []
98
+ },
99
+ "triggers": {
100
+ "type": "object",
185
101
  "properties": {
186
- "binding": {
187
- "type": "string"
102
+ "crons": {
103
+ "type": "array",
104
+ "items": {
105
+ "type": "string"
106
+ }
188
107
  }
189
108
  },
190
109
  "required": [
191
- "binding"
110
+ "crons"
192
111
  ],
193
- "type": "object"
194
- },
195
- "build": {
196
112
  "additionalProperties": false,
113
+ "description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
197
114
  "default": {
198
- "watch_dir": "./src"
115
+ "crons": []
116
+ }
117
+ },
118
+ "limits": {
119
+ "$ref": "#/definitions/UserLimits",
120
+ "description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
121
+ },
122
+ "rules": {
123
+ "type": "array",
124
+ "items": {
125
+ "$ref": "#/definitions/Rule"
199
126
  },
200
- "description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
127
+ "description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS."
128
+ },
129
+ "build": {
130
+ "type": "object",
201
131
  "properties": {
202
132
  "command": {
203
- "description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
204
- "type": "string"
133
+ "type": "string",
134
+ "description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used."
205
135
  },
206
136
  "cwd": {
207
- "description": "The directory in which the command is executed.",
208
- "type": "string"
209
- },
210
- "upload": {
211
- "$ref": "#/definitions/DeprecatedUpload",
212
- "deprecated": true,
213
- "description": "Deprecated field previously used to configure the build and upload of the script."
137
+ "type": "string",
138
+ "description": "The directory in which the command is executed."
214
139
  },
215
140
  "watch_dir": {
216
141
  "anyOf": [
@@ -218,140 +143,133 @@
218
143
  "type": "string"
219
144
  },
220
145
  {
146
+ "type": "array",
221
147
  "items": {
222
148
  "type": "string"
223
- },
224
- "type": "array"
149
+ }
225
150
  }
226
151
  ],
227
152
  "description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
228
153
  }
229
154
  },
230
- "type": "object"
155
+ "additionalProperties": false,
156
+ "description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
157
+ "default": {
158
+ "watch_dir": "./src"
159
+ }
231
160
  },
232
- "cloudchamber": {
233
- "$ref": "#/definitions/CloudchamberConfig",
234
- "default": "`{}`",
235
- "description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
161
+ "no_bundle": {
162
+ "type": "boolean",
163
+ "description": "Skip internal build steps and directly deploy script"
236
164
  },
237
- "compatibility_date": {
238
- "description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
239
- "type": "string"
165
+ "minify": {
166
+ "type": "boolean",
167
+ "description": "Minify the script before uploading."
240
168
  },
241
- "compatibility_flags": {
242
- "default": "`[]`",
243
- "description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
244
- "items": {
245
- "type": "string"
246
- },
247
- "type": "array"
169
+ "keep_names": {
170
+ "type": "boolean",
171
+ "description": "Keep function names after javascript transpilations.",
172
+ "default": "{true}"
248
173
  },
249
- "constellation": {
250
- "default": "`[]`",
251
- "description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
252
- "items": {
253
- "additionalProperties": false,
254
- "properties": {
255
- "binding": {
256
- "description": "The binding name used to refer to the project in the Worker.",
257
- "type": "string"
258
- },
259
- "project_id": {
260
- "description": "The id of the project.",
261
- "type": "string"
174
+ "first_party_worker": {
175
+ "type": "boolean",
176
+ "description": "Designates this Worker as an internal-only \"first-party\" Worker."
177
+ },
178
+ "logfwdr": {
179
+ "type": "object",
180
+ "properties": {
181
+ "bindings": {
182
+ "type": "array",
183
+ "items": {
184
+ "type": "object",
185
+ "properties": {
186
+ "name": {
187
+ "type": "string",
188
+ "description": "The binding name used to refer to logfwdr"
189
+ },
190
+ "destination": {
191
+ "type": "string",
192
+ "description": "The destination for this logged message"
193
+ }
194
+ },
195
+ "required": [
196
+ "name",
197
+ "destination"
198
+ ],
199
+ "additionalProperties": false
262
200
  }
201
+ }
202
+ },
203
+ "required": [
204
+ "bindings"
205
+ ],
206
+ "additionalProperties": false,
207
+ "description": "List of bindings that you will send to logfwdr",
208
+ "default": {
209
+ "bindings": []
210
+ }
211
+ },
212
+ "logpush": {
213
+ "type": "boolean",
214
+ "description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/"
215
+ },
216
+ "upload_source_maps": {
217
+ "type": "boolean",
218
+ "description": "Include source maps when uploading this worker."
219
+ },
220
+ "placement": {
221
+ "type": "object",
222
+ "properties": {
223
+ "mode": {
224
+ "type": "string",
225
+ "enum": [
226
+ "off",
227
+ "smart"
228
+ ]
263
229
  },
264
- "required": [
265
- "binding",
266
- "project_id"
267
- ],
268
- "type": "object"
230
+ "hint": {
231
+ "type": "string"
232
+ }
269
233
  },
270
- "type": "array"
234
+ "required": [
235
+ "mode"
236
+ ],
237
+ "additionalProperties": false,
238
+ "description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/"
271
239
  },
272
- "d1_databases": {
273
- "default": "`[]`",
274
- "description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
275
- "items": {
276
- "additionalProperties": false,
277
- "properties": {
278
- "binding": {
279
- "description": "The binding name used to refer to the D1 database in the Worker.",
280
- "type": "string"
281
- },
282
- "database_id": {
283
- "description": "The UUID of this D1 database (not required).",
284
- "type": "string"
285
- },
286
- "database_internal_env": {
287
- "description": "Internal use only.",
288
- "type": "string"
289
- },
290
- "database_name": {
291
- "description": "The name of this D1 database.",
292
- "type": "string"
293
- },
294
- "migrations_dir": {
295
- "description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
296
- "type": "string"
297
- },
298
- "migrations_table": {
299
- "description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
300
- "type": "string"
301
- },
302
- "preview_database_id": {
303
- "description": "The UUID of this D1 database for Wrangler Dev (if specified).",
304
- "type": "string"
305
- }
306
- },
307
- "required": [
308
- "binding",
309
- "database_name",
310
- "database_id"
311
- ],
312
- "type": "object"
313
- },
314
- "type": "array"
240
+ "assets": {
241
+ "$ref": "#/definitions/Assets",
242
+ "description": "Specify the directory of static assets to deploy/serve\n\nMore details at https://developers.cloudflare.com/workers/frameworks/"
243
+ },
244
+ "observability": {
245
+ "$ref": "#/definitions/Observability",
246
+ "description": "Specify the observability behavior of the Worker."
315
247
  },
316
248
  "define": {
249
+ "type": "object",
317
250
  "additionalProperties": {
318
251
  "type": "string"
319
252
  },
320
- "default": "`{}`",
321
253
  "description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
322
- "type": "object"
254
+ "default": {}
323
255
  },
324
- "dispatch_namespaces": {
325
- "default": "`[]`",
326
- "description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
327
- "items": {
328
- "additionalProperties": false,
329
- "properties": {
330
- "binding": {
331
- "description": "The binding name used to refer to the bound service.",
332
- "type": "string"
333
- },
334
- "namespace": {
335
- "description": "The namespace to bind to.",
256
+ "vars": {
257
+ "type": "object",
258
+ "additionalProperties": {
259
+ "anyOf": [
260
+ {
336
261
  "type": "string"
337
262
  },
338
- "outbound": {
339
- "$ref": "#/definitions/DispatchNamespaceOutbound",
340
- "description": "Details about the outbound Worker which will handle outbound requests from your namespace"
263
+ {
264
+ "$ref": "#/definitions/Json"
341
265
  }
342
- },
343
- "required": [
344
- "binding",
345
- "namespace"
346
- ],
347
- "type": "object"
266
+ ]
348
267
  },
349
- "type": "array"
268
+ "description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
269
+ "default": {}
350
270
  },
351
271
  "durable_objects": {
352
- "additionalProperties": false,
353
- "default": "`{bindings:[]}`",
354
- "description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
272
+ "type": "object",
355
273
  "properties": {
356
274
  "bindings": {
357
275
  "$ref": "#/definitions/DurableObjectBindings"
@@ -360,417 +278,422 @@
360
278
  "required": [
361
279
  "bindings"
362
280
  ],
363
- "type": "object"
281
+ "additionalProperties": false,
282
+ "description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
283
+ "default": {
284
+ "bindings": []
285
+ }
364
286
  },
365
- "find_additional_modules": {
366
- "description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
367
- "type": "boolean"
287
+ "workflows": {
288
+ "type": "array",
289
+ "items": {
290
+ "$ref": "#/definitions/WorkflowBinding"
291
+ },
292
+ "description": "A list of workflows that your Worker should be bound to.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
293
+ "default": []
368
294
  },
369
- "first_party_worker": {
370
- "description": "Designates this Worker as an internal-only \"first-party\" Worker.",
371
- "type": "boolean"
295
+ "cloudchamber": {
296
+ "$ref": "#/definitions/CloudchamberConfig",
297
+ "description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
298
+ "default": {}
372
299
  },
373
- "hyperdrive": {
374
- "default": "`[]`",
375
- "description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
300
+ "containers": {
301
+ "type": "array",
302
+ "items": {
303
+ "$ref": "#/definitions/ContainerApp"
304
+ },
305
+ "description": "Container related configuration",
306
+ "default": []
307
+ },
308
+ "kv_namespaces": {
309
+ "type": "array",
376
310
  "items": {
377
- "additionalProperties": false,
311
+ "type": "object",
378
312
  "properties": {
379
313
  "binding": {
380
- "description": "The binding name used to refer to the project in the Worker.",
381
- "type": "string"
314
+ "type": "string",
315
+ "description": "The binding name used to refer to the KV Namespace"
382
316
  },
383
317
  "id": {
384
- "description": "The id of the database.",
385
- "type": "string"
318
+ "type": "string",
319
+ "description": "The ID of the KV namespace"
386
320
  },
387
- "localConnectionString": {
388
- "description": "The local database connection string for `wrangler dev`",
389
- "type": "string"
321
+ "preview_id": {
322
+ "type": "string",
323
+ "description": "The ID of the KV namespace used during `wrangler dev`"
390
324
  }
391
325
  },
392
326
  "required": [
393
- "binding",
394
- "id"
327
+ "binding"
395
328
  ],
396
- "type": "object"
329
+ "additionalProperties": false
397
330
  },
398
- "type": "array"
399
- },
400
- "jsx_factory": {
401
- "default": "`\"React.createElement\"`",
402
- "description": "The function to use to replace jsx syntax.",
403
- "type": "string"
404
- },
405
- "jsx_fragment": {
406
- "default": "`\"React.Fragment\"`",
407
- "description": "The function to use to replace jsx fragment syntax.",
408
- "type": "string"
409
- },
410
- "kv_namespaces": {
411
- "default": "`[]`",
412
331
  "description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
332
+ "default": []
333
+ },
334
+ "send_email": {
335
+ "type": "array",
413
336
  "items": {
414
- "additionalProperties": false,
337
+ "type": "object",
415
338
  "properties": {
416
- "binding": {
417
- "description": "The binding name used to refer to the KV Namespace",
418
- "type": "string"
339
+ "name": {
340
+ "type": "string",
341
+ "description": "The binding name used to refer to the this binding"
419
342
  },
420
- "id": {
421
- "description": "The ID of the KV namespace",
422
- "type": "string"
343
+ "destination_address": {
344
+ "type": "string",
345
+ "description": "If this binding should be restricted to a specific verified address"
423
346
  },
424
- "preview_id": {
425
- "description": "The ID of the KV namespace used during `wrangler dev`",
426
- "type": "string"
347
+ "allowed_destination_addresses": {
348
+ "type": "array",
349
+ "items": {
350
+ "type": "string"
351
+ },
352
+ "description": "If this binding should be restricted to a set of verified addresses"
427
353
  }
428
354
  },
429
355
  "required": [
430
- "binding",
431
- "id"
356
+ "name"
432
357
  ],
433
- "type": "object"
358
+ "additionalProperties": false
434
359
  },
435
- "type": "array"
436
- },
437
- "limits": {
438
- "$ref": "#/definitions/UserLimits",
439
- "description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
360
+ "description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
361
+ "default": []
440
362
  },
441
- "logfwdr": {
442
- "additionalProperties": false,
443
- "default": "`{bindings:[]}`",
444
- "description": "List of bindings that you will send to logfwdr",
363
+ "queues": {
364
+ "type": "object",
445
365
  "properties": {
446
- "bindings": {
366
+ "producers": {
367
+ "type": "array",
447
368
  "items": {
448
- "additionalProperties": false,
369
+ "type": "object",
449
370
  "properties": {
450
- "destination": {
451
- "description": "The destination for this logged message",
452
- "type": "string"
371
+ "binding": {
372
+ "type": "string",
373
+ "description": "The binding name used to refer to the Queue in the Worker."
453
374
  },
454
- "name": {
455
- "description": "The binding name used to refer to logfwdr",
456
- "type": "string"
375
+ "queue": {
376
+ "type": "string",
377
+ "description": "The name of this Queue."
378
+ },
379
+ "delivery_delay": {
380
+ "type": "number",
381
+ "description": "The number of seconds to wait before delivering a message"
457
382
  }
458
383
  },
459
384
  "required": [
460
- "name",
461
- "destination"
385
+ "binding",
386
+ "queue"
462
387
  ],
463
- "type": "object"
464
- },
465
- "type": "array"
466
- }
467
- },
468
- "required": [
469
- "bindings"
470
- ],
471
- "type": "object"
472
- },
473
- "logpush": {
474
- "description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
475
- "type": "boolean"
476
- },
477
- "main": {
478
- "description": "The entrypoint/path to the JavaScript file that will be executed.",
479
- "type": "string"
480
- },
481
- "minify": {
482
- "description": "Minify the script before uploading.",
483
- "type": "boolean"
484
- },
485
- "mtls_certificates": {
486
- "default": "`[]`",
487
- "description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
488
- "items": {
489
- "additionalProperties": false,
490
- "properties": {
491
- "binding": {
492
- "description": "The binding name used to refer to the certificate in the Worker",
493
- "type": "string"
388
+ "additionalProperties": false
494
389
  },
495
- "certificate_id": {
496
- "description": "The uuid of the uploaded mTLS certificate",
497
- "type": "string"
498
- }
390
+ "description": "Producer bindings"
499
391
  },
500
- "required": [
501
- "binding",
502
- "certificate_id"
503
- ],
504
- "type": "object"
505
- },
506
- "type": "array"
507
- },
508
- "name": {
509
- "description": "The name of your Worker. Alphanumeric + dashes only.",
510
- "type": "string"
511
- },
512
- "no_bundle": {
513
- "description": "Skip internal build steps and directly deploy script",
514
- "type": "boolean"
515
- },
516
- "node_compat": {
517
- "description": "Add polyfills for node builtin modules and globals",
518
- "type": "boolean"
519
- },
520
- "placement": {
521
- "additionalProperties": false,
522
- "description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
523
- "properties": {
524
- "mode": {
525
- "enum": [
526
- "off",
527
- "smart"
528
- ],
529
- "type": "string"
530
- }
531
- },
532
- "required": [
533
- "mode"
534
- ],
535
- "type": "object"
536
- },
537
- "preserve_file_names": {
538
- "description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
539
- "type": "boolean"
540
- },
541
- "queues": {
542
- "additionalProperties": false,
543
- "default": "`{consumers:[],producers:[]}`",
544
- "description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
545
- "properties": {
546
392
  "consumers": {
547
- "description": "Consumer configuration",
393
+ "type": "array",
548
394
  "items": {
549
- "additionalProperties": false,
395
+ "type": "object",
550
396
  "properties": {
551
- "dead_letter_queue": {
552
- "description": "The queue to send messages that failed to be consumed.",
553
- "type": "string"
397
+ "queue": {
398
+ "type": "string",
399
+ "description": "The name of the queue from which this consumer should consume."
400
+ },
401
+ "type": {
402
+ "type": "string",
403
+ "description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker."
554
404
  },
555
405
  "max_batch_size": {
556
- "description": "The maximum number of messages per batch",
557
- "type": "number"
406
+ "type": "number",
407
+ "description": "The maximum number of messages per batch"
558
408
  },
559
409
  "max_batch_timeout": {
560
- "description": "The maximum number of seconds to wait to fill a batch with messages.",
561
- "type": "number"
410
+ "type": "number",
411
+ "description": "The maximum number of seconds to wait to fill a batch with messages."
412
+ },
413
+ "max_retries": {
414
+ "type": "number",
415
+ "description": "The maximum number of retries for each message."
416
+ },
417
+ "dead_letter_queue": {
418
+ "type": "string",
419
+ "description": "The queue to send messages that failed to be consumed."
562
420
  },
563
421
  "max_concurrency": {
564
- "description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
565
422
  "type": [
566
423
  "number",
567
424
  "null"
568
- ]
569
- },
570
- "max_retries": {
571
- "description": "The maximum number of retries for each message.",
572
- "type": "number"
573
- },
574
- "queue": {
575
- "description": "The name of the queue from which this consumer should consume.",
576
- "type": "string"
577
- },
578
- "retry_delay": {
579
- "description": "The number of seconds to wait before retrying a message",
580
- "type": "number"
581
- },
582
- "type": {
583
- "description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
584
- "type": "string"
425
+ ],
426
+ "description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog."
585
427
  },
586
428
  "visibility_timeout_ms": {
587
- "description": "The number of milliseconds to wait for pulled messages to become visible again",
588
- "type": "number"
589
- }
590
- },
591
- "required": [
592
- "queue"
593
- ],
594
- "type": "object"
595
- },
596
- "type": "array"
597
- },
598
- "producers": {
599
- "description": "Producer bindings",
600
- "items": {
601
- "additionalProperties": false,
602
- "properties": {
603
- "binding": {
604
- "description": "The binding name used to refer to the Queue in the Worker.",
605
- "type": "string"
606
- },
607
- "delivery_delay": {
608
- "description": "The number of seconds to wait before delivering a message",
609
- "type": "number"
429
+ "type": "number",
430
+ "description": "The number of milliseconds to wait for pulled messages to become visible again"
610
431
  },
611
- "queue": {
612
- "description": "The name of this Queue.",
613
- "type": "string"
432
+ "retry_delay": {
433
+ "type": "number",
434
+ "description": "The number of seconds to wait before retrying a message"
614
435
  }
615
436
  },
616
437
  "required": [
617
- "binding",
618
438
  "queue"
619
439
  ],
620
- "type": "object"
440
+ "additionalProperties": false
621
441
  },
622
- "type": "array"
442
+ "description": "Consumer configuration"
623
443
  }
624
444
  },
625
- "type": "object"
445
+ "additionalProperties": false,
446
+ "description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
447
+ "default": {
448
+ "consumers": [],
449
+ "producers": []
450
+ }
626
451
  },
627
452
  "r2_buckets": {
628
- "default": "`[]`",
629
- "description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
453
+ "type": "array",
630
454
  "items": {
631
- "additionalProperties": false,
455
+ "type": "object",
632
456
  "properties": {
633
457
  "binding": {
634
- "description": "The binding name used to refer to the R2 bucket in the Worker.",
635
- "type": "string"
458
+ "type": "string",
459
+ "description": "The binding name used to refer to the R2 bucket in the Worker."
636
460
  },
637
461
  "bucket_name": {
638
- "description": "The name of this R2 bucket at the edge.",
639
- "type": "string"
640
- },
641
- "jurisdiction": {
642
- "description": "The jurisdiction that the bucket exists in. Default if not present.",
643
- "type": "string"
462
+ "type": "string",
463
+ "description": "The name of this R2 bucket at the edge."
644
464
  },
645
465
  "preview_bucket_name": {
646
- "description": "The preview name of this R2 bucket at the edge.",
647
- "type": "string"
466
+ "type": "string",
467
+ "description": "The preview name of this R2 bucket at the edge."
468
+ },
469
+ "jurisdiction": {
470
+ "type": "string",
471
+ "description": "The jurisdiction that the bucket exists in. Default if not present."
648
472
  }
649
473
  },
650
474
  "required": [
651
- "binding",
652
- "bucket_name"
475
+ "binding"
653
476
  ],
654
- "type": "object"
655
- },
656
- "type": "array"
657
- },
658
- "route": {
659
- "$ref": "#/definitions/Route",
660
- "description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
661
- },
662
- "routes": {
663
- "description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
664
- "items": {
665
- "$ref": "#/definitions/Route"
477
+ "additionalProperties": false
666
478
  },
667
- "type": "array"
479
+ "description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
480
+ "default": []
668
481
  },
669
- "rules": {
670
- "description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
482
+ "d1_databases": {
483
+ "type": "array",
671
484
  "items": {
672
- "$ref": "#/definitions/Rule"
673
- },
674
- "type": "array"
485
+ "type": "object",
486
+ "properties": {
487
+ "binding": {
488
+ "type": "string",
489
+ "description": "The binding name used to refer to the D1 database in the Worker."
490
+ },
491
+ "database_name": {
492
+ "type": "string",
493
+ "description": "The name of this D1 database."
494
+ },
495
+ "database_id": {
496
+ "type": "string",
497
+ "description": "The UUID of this D1 database (not required)."
498
+ },
499
+ "preview_database_id": {
500
+ "type": "string",
501
+ "description": "The UUID of this D1 database for Wrangler Dev (if specified)."
502
+ },
503
+ "migrations_table": {
504
+ "type": "string",
505
+ "description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations')."
506
+ },
507
+ "migrations_dir": {
508
+ "type": "string",
509
+ "description": "The path to the directory of migrations for this D1 database (defaults to './migrations')."
510
+ },
511
+ "database_internal_env": {
512
+ "type": "string",
513
+ "description": "Internal use only."
514
+ }
515
+ },
516
+ "required": [
517
+ "binding"
518
+ ],
519
+ "additionalProperties": false
520
+ },
521
+ "description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
522
+ "default": []
675
523
  },
676
- "send_email": {
677
- "default": "`[]`",
678
- "description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
524
+ "vectorize": {
525
+ "type": "array",
679
526
  "items": {
680
- "additionalProperties": false,
527
+ "type": "object",
681
528
  "properties": {
682
- "allowed_destination_addresses": {
683
- "description": "If this binding should be restricted to a set of verified addresses",
684
- "items": {
685
- "type": "string"
686
- },
687
- "type": "array"
529
+ "binding": {
530
+ "type": "string",
531
+ "description": "The binding name used to refer to the Vectorize index in the Worker."
688
532
  },
689
- "destination_address": {
690
- "description": "If this binding should be restricted to a specific verified address",
691
- "type": "string"
533
+ "index_name": {
534
+ "type": "string",
535
+ "description": "The name of the index."
536
+ }
537
+ },
538
+ "required": [
539
+ "binding",
540
+ "index_name"
541
+ ],
542
+ "additionalProperties": false
543
+ },
544
+ "description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
545
+ "default": []
546
+ },
547
+ "hyperdrive": {
548
+ "type": "array",
549
+ "items": {
550
+ "type": "object",
551
+ "properties": {
552
+ "binding": {
553
+ "type": "string",
554
+ "description": "The binding name used to refer to the project in the Worker."
692
555
  },
693
- "name": {
694
- "description": "The binding name used to refer to the this binding",
695
- "type": "string"
556
+ "id": {
557
+ "type": "string",
558
+ "description": "The id of the database."
559
+ },
560
+ "localConnectionString": {
561
+ "type": "string",
562
+ "description": "The local database connection string for `wrangler dev`"
696
563
  }
697
564
  },
698
565
  "required": [
699
- "name"
566
+ "binding",
567
+ "id"
700
568
  ],
701
- "type": "object"
569
+ "additionalProperties": false
702
570
  },
703
- "type": "array"
571
+ "description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
572
+ "default": []
704
573
  },
705
574
  "services": {
706
- "default": "`[]`",
707
- "description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
575
+ "type": "array",
708
576
  "items": {
709
- "additionalProperties": false,
577
+ "type": "object",
710
578
  "properties": {
711
579
  "binding": {
712
- "description": "The binding name used to refer to the bound service.",
713
- "type": "string"
580
+ "type": "string",
581
+ "description": "The binding name used to refer to the bound service."
714
582
  },
715
- "entrypoint": {
716
- "description": "Optionally, the entrypoint (named export) of the service to bind to.",
717
- "type": "string"
583
+ "service": {
584
+ "type": "string",
585
+ "description": "The name of the service."
718
586
  },
719
587
  "environment": {
720
- "description": "The environment of the service (e.g. production, staging, etc).",
721
- "type": "string"
588
+ "type": "string",
589
+ "description": "The environment of the service (e.g. production, staging, etc)."
722
590
  },
723
- "service": {
724
- "description": "The name of the service.",
725
- "type": "string"
591
+ "entrypoint": {
592
+ "type": "string",
593
+ "description": "Optionally, the entrypoint (named export) of the service to bind to."
594
+ },
595
+ "props": {
596
+ "type": "object",
597
+ "additionalProperties": {},
598
+ "description": "Optional properties that will be made available to the service via ctx.props."
726
599
  }
727
600
  },
728
601
  "required": [
729
602
  "binding",
730
603
  "service"
731
604
  ],
732
- "type": "object"
605
+ "additionalProperties": false
733
606
  },
734
- "type": "array"
607
+ "description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
608
+ "default": []
735
609
  },
736
- "tail_consumers": {
737
- "default": "`[]`",
738
- "description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
610
+ "analytics_engine_datasets": {
611
+ "type": "array",
739
612
  "items": {
740
- "$ref": "#/definitions/TailConsumer"
613
+ "type": "object",
614
+ "properties": {
615
+ "binding": {
616
+ "type": "string",
617
+ "description": "The binding name used to refer to the dataset in the Worker."
618
+ },
619
+ "dataset": {
620
+ "type": "string",
621
+ "description": "The name of this dataset to write to."
622
+ }
623
+ },
624
+ "required": [
625
+ "binding"
626
+ ],
627
+ "additionalProperties": false
741
628
  },
742
- "type": "array"
629
+ "description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
630
+ "default": []
743
631
  },
744
- "triggers": {
632
+ "browser": {
633
+ "type": "object",
634
+ "properties": {
635
+ "binding": {
636
+ "type": "string"
637
+ }
638
+ },
639
+ "required": [
640
+ "binding"
641
+ ],
745
642
  "additionalProperties": false,
746
- "default": "`{crons:[]}`",
747
- "description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
643
+ "description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
644
+ "default": {}
645
+ },
646
+ "ai": {
647
+ "type": "object",
748
648
  "properties": {
749
- "crons": {
750
- "items": {
751
- "type": "string"
752
- },
753
- "type": "array"
649
+ "binding": {
650
+ "type": "string"
651
+ },
652
+ "staging": {
653
+ "type": "boolean"
754
654
  }
755
655
  },
756
656
  "required": [
757
- "crons"
657
+ "binding"
758
658
  ],
759
- "type": "object"
659
+ "additionalProperties": false,
660
+ "description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
661
+ "default": {}
760
662
  },
761
- "tsconfig": {
762
- "description": "Path to a custom tsconfig",
763
- "type": "string"
663
+ "images": {
664
+ "type": "object",
665
+ "properties": {
666
+ "binding": {
667
+ "type": "string"
668
+ }
669
+ },
670
+ "required": [
671
+ "binding"
672
+ ],
673
+ "additionalProperties": false,
674
+ "description": "Binding to Cloudflare Images\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
675
+ "default": {}
764
676
  },
765
- "unsafe": {
677
+ "version_metadata": {
678
+ "type": "object",
679
+ "properties": {
680
+ "binding": {
681
+ "type": "string"
682
+ }
683
+ },
684
+ "required": [
685
+ "binding"
686
+ ],
766
687
  "additionalProperties": false,
767
- "default": "`{}`",
768
- "description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
688
+ "description": "Binding to the Worker Version's metadata"
689
+ },
690
+ "unsafe": {
691
+ "type": "object",
769
692
  "properties": {
770
693
  "bindings": {
771
- "description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
694
+ "type": "array",
772
695
  "items": {
773
- "additionalProperties": {},
696
+ "type": "object",
774
697
  "properties": {
775
698
  "name": {
776
699
  "type": "string"
@@ -783,33 +706,38 @@
783
706
  "name",
784
707
  "type"
785
708
  ],
786
- "type": "object"
709
+ "additionalProperties": {}
787
710
  },
788
- "type": "array"
711
+ "description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare."
712
+ },
713
+ "metadata": {
714
+ "type": "object",
715
+ "additionalProperties": {},
716
+ "description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields."
789
717
  },
790
718
  "capnp": {
791
719
  "anyOf": [
792
720
  {
793
- "additionalProperties": false,
721
+ "type": "object",
794
722
  "properties": {
795
723
  "base_path": {
796
724
  "type": "string"
797
725
  },
798
726
  "source_schemas": {
727
+ "type": "array",
799
728
  "items": {
800
729
  "type": "string"
801
- },
802
- "type": "array"
730
+ }
803
731
  }
804
732
  },
805
733
  "required": [
806
734
  "base_path",
807
735
  "source_schemas"
808
736
  ],
809
- "type": "object"
737
+ "additionalProperties": false
810
738
  },
811
739
  {
812
- "additionalProperties": false,
740
+ "type": "object",
813
741
  "properties": {
814
742
  "compiled_schema": {
815
743
  "type": "string"
@@ -818,261 +746,333 @@
818
746
  "required": [
819
747
  "compiled_schema"
820
748
  ],
821
- "type": "object"
749
+ "additionalProperties": false
822
750
  }
823
751
  ],
824
752
  "description": "Used for internal capnp uploads for the Workers runtime"
825
- },
826
- "metadata": {
827
- "additionalProperties": {},
828
- "description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
829
- "type": "object"
830
753
  }
831
754
  },
832
- "type": "object"
833
- },
834
- "upload_source_maps": {
835
- "description": "Include source maps when uploading this worker.",
836
- "type": "boolean"
837
- },
838
- "usage_model": {
839
- "description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
840
- "enum": [
841
- "bundled",
842
- "unbound"
843
- ],
844
- "type": "string"
845
- },
846
- "vars": {
847
- "additionalProperties": {
848
- "anyOf": [
849
- {
850
- "type": "string"
851
- },
852
- {
853
- "$ref": "#/definitions/Json"
854
- }
855
- ]
856
- },
857
- "default": "`{}`",
858
- "description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
859
- "type": "object"
755
+ "additionalProperties": false,
756
+ "description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
757
+ "default": {}
860
758
  },
861
- "vectorize": {
862
- "default": "`[]`",
863
- "description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
759
+ "mtls_certificates": {
760
+ "type": "array",
864
761
  "items": {
865
- "additionalProperties": false,
762
+ "type": "object",
866
763
  "properties": {
867
764
  "binding": {
868
- "description": "The binding name used to refer to the Vectorize index in the Worker.",
869
- "type": "string"
765
+ "type": "string",
766
+ "description": "The binding name used to refer to the certificate in the Worker"
870
767
  },
871
- "index_name": {
872
- "description": "The name of the index.",
873
- "type": "string"
768
+ "certificate_id": {
769
+ "type": "string",
770
+ "description": "The uuid of the uploaded mTLS certificate"
874
771
  }
875
772
  },
876
773
  "required": [
877
774
  "binding",
878
- "index_name"
775
+ "certificate_id"
879
776
  ],
880
- "type": "object"
881
- },
882
- "type": "array"
883
- },
884
- "version_metadata": {
885
- "additionalProperties": false,
886
- "description": "Binding to the Worker Version's metadata",
887
- "properties": {
888
- "binding": {
889
- "type": "string"
890
- }
891
- },
892
- "required": [
893
- "binding"
894
- ],
895
- "type": "object"
896
- },
897
- "workers_dev": {
898
- "default": "`true` (This is a breaking change from Wrangler v1)",
899
- "description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
900
- "type": "boolean"
901
- },
902
- "zone_id": {
903
- "description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
904
- "type": "string"
905
- }
906
- },
907
- "required": [
908
- "analytics_engine_datasets",
909
- "build",
910
- "cloudchamber",
911
- "compatibility_flags",
912
- "constellation",
913
- "d1_databases",
914
- "define",
915
- "dispatch_namespaces",
916
- "durable_objects",
917
- "hyperdrive",
918
- "jsx_factory",
919
- "jsx_fragment",
920
- "kv_namespaces",
921
- "logfwdr",
922
- "mtls_certificates",
923
- "queues",
924
- "r2_buckets",
925
- "rules",
926
- "send_email",
927
- "triggers",
928
- "unsafe",
929
- "vars",
930
- "vectorize"
931
- ],
932
- "type": "object"
933
- },
934
- "Json": {
935
- "anyOf": [
936
- {
937
- "$ref": "#/definitions/Literal"
938
- },
939
- {
940
- "additionalProperties": {
941
- "$ref": "#/definitions/Json"
777
+ "additionalProperties": false
942
778
  },
943
- "type": "object"
779
+ "description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
780
+ "default": []
944
781
  },
945
- {
782
+ "tail_consumers": {
783
+ "type": "array",
946
784
  "items": {
947
- "$ref": "#/definitions/Json"
785
+ "$ref": "#/definitions/TailConsumer"
948
786
  },
949
- "type": "array"
950
- }
951
- ]
952
- },
953
- "Literal": {
954
- "$ref": "#/definitions/TypeOf%3CZodUnion%3C%5Bdef-class-1315922706-6501-8772-1315922706-0-54395%2Cdef-class-1315922706-9299-10989-1315922706-0-54395%2Cdef-class-1315922706-12937-13365-1315922706-0-54395%2Cdef-class-1315922706-15083-15273-1315922706-0-54395%5D%3E%3E"
955
- },
956
- "RawConfig": {
957
- "additionalProperties": false,
958
- "properties": {
959
- "$schema": {
960
- "type": "string"
961
- },
962
- "account_id": {
963
- "description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
964
- "type": "string"
787
+ "description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
788
+ "default": []
965
789
  },
966
- "ai": {
967
- "additionalProperties": false,
968
- "default": "`{}`",
969
- "description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
970
- "properties": {
971
- "binding": {
972
- "type": "string"
790
+ "dispatch_namespaces": {
791
+ "type": "array",
792
+ "items": {
793
+ "type": "object",
794
+ "properties": {
795
+ "binding": {
796
+ "type": "string",
797
+ "description": "The binding name used to refer to the bound service."
798
+ },
799
+ "namespace": {
800
+ "type": "string",
801
+ "description": "The namespace to bind to."
802
+ },
803
+ "outbound": {
804
+ "$ref": "#/definitions/DispatchNamespaceOutbound",
805
+ "description": "Details about the outbound Worker which will handle outbound requests from your namespace"
806
+ }
973
807
  },
974
- "staging": {
975
- "type": "boolean"
976
- }
808
+ "required": [
809
+ "binding",
810
+ "namespace"
811
+ ],
812
+ "additionalProperties": false
977
813
  },
978
- "required": [
979
- "binding"
980
- ],
981
- "type": "object"
814
+ "description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
815
+ "default": []
982
816
  },
983
- "analytics_engine_datasets": {
984
- "default": "`[]`",
985
- "description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
817
+ "pipelines": {
818
+ "type": "array",
986
819
  "items": {
987
- "additionalProperties": false,
820
+ "type": "object",
988
821
  "properties": {
989
822
  "binding": {
990
- "description": "The binding name used to refer to the dataset in the Worker.",
991
- "type": "string"
823
+ "type": "string",
824
+ "description": "The binding name used to refer to the bound service."
992
825
  },
993
- "dataset": {
994
- "description": "The name of this dataset to write to.",
995
- "type": "string"
826
+ "pipeline": {
827
+ "type": "string",
828
+ "description": "Name of the Pipeline to bind"
996
829
  }
997
830
  },
998
831
  "required": [
999
- "binding"
832
+ "binding",
833
+ "pipeline"
1000
834
  ],
1001
- "type": "object"
835
+ "additionalProperties": false
1002
836
  },
1003
- "type": "array"
837
+ "description": "Specifies list of Pipelines bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
838
+ "default": []
1004
839
  },
1005
- "assets": {
1006
- "additionalProperties": false,
1007
- "description": "Serve a folder of static assets with your Worker, without any additional code. This can either be a string, or an object with additional config fields.",
1008
- "properties": {
1009
- "browser_TTL": {
1010
- "type": "number"
840
+ "secrets_store_secrets": {
841
+ "type": "array",
842
+ "items": {
843
+ "type": "object",
844
+ "properties": {
845
+ "binding": {
846
+ "type": "string",
847
+ "description": "The binding name used to refer to the bound service."
848
+ },
849
+ "store_id": {
850
+ "type": "string",
851
+ "description": "Id of the secret store"
852
+ },
853
+ "secret_name": {
854
+ "type": "string",
855
+ "description": "Name of the secret"
856
+ }
1011
857
  },
858
+ "required": [
859
+ "binding",
860
+ "store_id",
861
+ "secret_name"
862
+ ],
863
+ "additionalProperties": false
864
+ },
865
+ "description": "Specifies Secret Store bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
866
+ "default": []
867
+ },
868
+ "pages_build_output_dir": {
869
+ "type": "string",
870
+ "description": "The directory of static assets to serve.\n\nThe presence of this field in a Wrangler configuration file indicates a Pages project, and will prompt the handling of the configuration file according to the Pages-specific validation rules."
871
+ },
872
+ "legacy_env": {
873
+ "type": "boolean",
874
+ "description": "A boolean to enable \"legacy\" style wrangler environments (from Wrangler v1). These have been superseded by Services, but there may be projects that won't (or can't) use them. If you're using a legacy environment, you can set this to `true` to enable it."
875
+ },
876
+ "send_metrics": {
877
+ "type": "boolean",
878
+ "description": "Whether Wrangler should send usage metrics to Cloudflare for this project.\n\nWhen defined this will override any user settings. Otherwise, Wrangler will use the user's preference."
879
+ },
880
+ "dev": {
881
+ "$ref": "#/definitions/RawDevConfig",
882
+ "description": "Options to configure the development server that your worker will use."
883
+ },
884
+ "site": {
885
+ "type": "object",
886
+ "properties": {
1012
887
  "bucket": {
1013
- "type": "string"
888
+ "type": "string",
889
+ "description": "The directory containing your static assets.\n\nIt must be a path relative to your Wrangler configuration file. Example: bucket = \"./public\"\n\nIf there is a `site` field then it must contain this `bucket` field."
1014
890
  },
1015
- "exclude": {
891
+ "entry-point": {
892
+ "type": "string",
893
+ "description": "The location of your Worker script.",
894
+ "deprecated": "DO NOT use this (it's a holdover from Wrangler v1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument."
895
+ },
896
+ "include": {
897
+ "type": "array",
1016
898
  "items": {
1017
899
  "type": "string"
1018
900
  },
1019
- "type": "array"
901
+ "description": "An exclusive list of .gitignore-style patterns that match file or directory names from your bucket location. Only matched items will be uploaded. Example: include = [\"upload_dir\"]",
902
+ "default": []
1020
903
  },
1021
- "include": {
904
+ "exclude": {
905
+ "type": "array",
1022
906
  "items": {
1023
907
  "type": "string"
1024
908
  },
1025
- "type": "array"
1026
- },
1027
- "serve_single_page_app": {
1028
- "type": "boolean"
909
+ "description": "A list of .gitignore-style patterns that match files or directories in your bucket that should be excluded from uploads. Example: exclude = [\"ignore_dir\"]",
910
+ "default": []
1029
911
  }
1030
912
  },
1031
913
  "required": [
1032
- "bucket",
1033
- "include",
1034
- "exclude",
1035
- "serve_single_page_app"
914
+ "bucket"
1036
915
  ],
1037
- "type": "object"
916
+ "additionalProperties": false,
917
+ "description": "The definition of a Worker Site, a feature that lets you upload static assets with your Worker.\n\nMore details at https://developers.cloudflare.com/workers/platform/sites"
918
+ },
919
+ "wasm_modules": {
920
+ "type": "object",
921
+ "additionalProperties": {
922
+ "type": "string"
923
+ },
924
+ "description": "A list of wasm modules that your worker should be bound to. This is the \"legacy\" way of binding to a wasm module. ES module workers should do proper module imports."
925
+ },
926
+ "text_blobs": {
927
+ "type": "object",
928
+ "additionalProperties": {
929
+ "type": "string"
930
+ },
931
+ "description": "A list of text files that your worker should be bound to. This is the \"legacy\" way of binding to a text file. ES module workers should do proper module imports."
932
+ },
933
+ "data_blobs": {
934
+ "type": "object",
935
+ "additionalProperties": {
936
+ "type": "string"
937
+ },
938
+ "description": "A list of data files that your worker should be bound to. This is the \"legacy\" way of binding to a data file. ES module workers should do proper module imports."
939
+ },
940
+ "alias": {
941
+ "type": "object",
942
+ "additionalProperties": {
943
+ "type": "string"
944
+ },
945
+ "description": "A map of module aliases. Lets you swap out a module for any others. Corresponds with esbuild's `alias` config"
946
+ },
947
+ "keep_vars": {
948
+ "type": "boolean",
949
+ "description": "By default, the Wrangler configuration file is the source of truth for your environment configuration, like a terraform file.\n\nIf you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.\n\nIf you want to keep your dashboard vars when wrangler deploys, set this field to true.",
950
+ "default": false
951
+ }
952
+ }
953
+ },
954
+ "RawEnvironment": {
955
+ "type": "object",
956
+ "properties": {
957
+ "name": {
958
+ "type": "string",
959
+ "description": "The name of your Worker. Alphanumeric + dashes only."
960
+ },
961
+ "account_id": {
962
+ "type": "string",
963
+ "description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable."
964
+ },
965
+ "compatibility_date": {
966
+ "type": "string",
967
+ "description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/configuration/compatibility-dates"
968
+ },
969
+ "compatibility_flags": {
970
+ "type": "array",
971
+ "items": {
972
+ "type": "string"
973
+ },
974
+ "description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_date.\n\nMore details at https://developers.cloudflare.com/workers/configuration/compatibility-flags/",
975
+ "default": []
976
+ },
977
+ "main": {
978
+ "type": "string",
979
+ "description": "The entrypoint/path to the JavaScript file that will be executed."
980
+ },
981
+ "find_additional_modules": {
982
+ "type": "boolean",
983
+ "description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false."
984
+ },
985
+ "preserve_file_names": {
986
+ "type": "boolean",
987
+ "description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`."
1038
988
  },
1039
989
  "base_dir": {
1040
- "description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
1041
- "type": "string"
990
+ "type": "string",
991
+ "description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified."
1042
992
  },
1043
- "browser": {
1044
- "additionalProperties": false,
1045
- "default": "`{}`",
1046
- "description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
993
+ "workers_dev": {
994
+ "type": "boolean",
995
+ "description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.",
996
+ "default": true
997
+ },
998
+ "preview_urls": {
999
+ "type": "boolean",
1000
+ "description": "Whether we use <version>-<name>.<subdomain>.workers.dev to serve Preview URLs for your Worker.",
1001
+ "default": true
1002
+ },
1003
+ "routes": {
1004
+ "type": "array",
1005
+ "items": {
1006
+ "$ref": "#/definitions/Route"
1007
+ },
1008
+ "description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)"
1009
+ },
1010
+ "route": {
1011
+ "$ref": "#/definitions/Route",
1012
+ "description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
1013
+ },
1014
+ "tsconfig": {
1015
+ "type": "string",
1016
+ "description": "Path to a custom tsconfig"
1017
+ },
1018
+ "jsx_factory": {
1019
+ "type": "string",
1020
+ "description": "The function to use to replace jsx syntax.",
1021
+ "default": "React.createElement"
1022
+ },
1023
+ "jsx_fragment": {
1024
+ "type": "string",
1025
+ "description": "The function to use to replace jsx fragment syntax.",
1026
+ "default": "React.Fragment"
1027
+ },
1028
+ "migrations": {
1029
+ "type": "array",
1030
+ "items": {
1031
+ "$ref": "#/definitions/DurableObjectMigration"
1032
+ },
1033
+ "description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
1034
+ "default": []
1035
+ },
1036
+ "triggers": {
1037
+ "type": "object",
1047
1038
  "properties": {
1048
- "binding": {
1049
- "type": "string"
1039
+ "crons": {
1040
+ "type": "array",
1041
+ "items": {
1042
+ "type": "string"
1043
+ }
1050
1044
  }
1051
1045
  },
1052
1046
  "required": [
1053
- "binding"
1047
+ "crons"
1054
1048
  ],
1055
- "type": "object"
1056
- },
1057
- "build": {
1058
1049
  "additionalProperties": false,
1050
+ "description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
1059
1051
  "default": {
1060
- "watch_dir": "./src"
1052
+ "crons": []
1053
+ }
1054
+ },
1055
+ "limits": {
1056
+ "$ref": "#/definitions/UserLimits",
1057
+ "description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
1058
+ },
1059
+ "rules": {
1060
+ "type": "array",
1061
+ "items": {
1062
+ "$ref": "#/definitions/Rule"
1061
1063
  },
1062
- "description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
1064
+ "description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS."
1065
+ },
1066
+ "build": {
1067
+ "type": "object",
1063
1068
  "properties": {
1064
1069
  "command": {
1065
- "description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
1066
- "type": "string"
1070
+ "type": "string",
1071
+ "description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used."
1067
1072
  },
1068
1073
  "cwd": {
1069
- "description": "The directory in which the command is executed.",
1070
- "type": "string"
1071
- },
1072
- "upload": {
1073
- "$ref": "#/definitions/DeprecatedUpload",
1074
- "deprecated": true,
1075
- "description": "Deprecated field previously used to configure the build and upload of the script."
1074
+ "type": "string",
1075
+ "description": "The directory in which the command is executed."
1076
1076
  },
1077
1077
  "watch_dir": {
1078
1078
  "anyOf": [
@@ -1080,154 +1080,133 @@
1080
1080
  "type": "string"
1081
1081
  },
1082
1082
  {
1083
+ "type": "array",
1083
1084
  "items": {
1084
1085
  "type": "string"
1085
- },
1086
- "type": "array"
1086
+ }
1087
1087
  }
1088
1088
  ],
1089
1089
  "description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
1090
1090
  }
1091
1091
  },
1092
- "type": "object"
1092
+ "additionalProperties": false,
1093
+ "description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
1094
+ "default": {
1095
+ "watch_dir": "./src"
1096
+ }
1093
1097
  },
1094
- "cloudchamber": {
1095
- "$ref": "#/definitions/CloudchamberConfig",
1096
- "default": "`{}`",
1097
- "description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
1098
+ "no_bundle": {
1099
+ "type": "boolean",
1100
+ "description": "Skip internal build steps and directly deploy script"
1098
1101
  },
1099
- "compatibility_date": {
1100
- "description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
1101
- "type": "string"
1102
+ "minify": {
1103
+ "type": "boolean",
1104
+ "description": "Minify the script before uploading."
1102
1105
  },
1103
- "compatibility_flags": {
1104
- "default": "`[]`",
1105
- "description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
1106
- "items": {
1107
- "type": "string"
1108
- },
1109
- "type": "array"
1106
+ "keep_names": {
1107
+ "type": "boolean",
1108
+ "description": "Keep function names after javascript transpilations.",
1109
+ "default": "{true}"
1110
1110
  },
1111
- "configPath": {
1112
- "type": "string"
1111
+ "first_party_worker": {
1112
+ "type": "boolean",
1113
+ "description": "Designates this Worker as an internal-only \"first-party\" Worker."
1113
1114
  },
1114
- "constellation": {
1115
- "default": "`[]`",
1116
- "description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1117
- "items": {
1118
- "additionalProperties": false,
1119
- "properties": {
1120
- "binding": {
1121
- "description": "The binding name used to refer to the project in the Worker.",
1122
- "type": "string"
1123
- },
1124
- "project_id": {
1125
- "description": "The id of the project.",
1126
- "type": "string"
1115
+ "logfwdr": {
1116
+ "type": "object",
1117
+ "properties": {
1118
+ "bindings": {
1119
+ "type": "array",
1120
+ "items": {
1121
+ "type": "object",
1122
+ "properties": {
1123
+ "name": {
1124
+ "type": "string",
1125
+ "description": "The binding name used to refer to logfwdr"
1126
+ },
1127
+ "destination": {
1128
+ "type": "string",
1129
+ "description": "The destination for this logged message"
1130
+ }
1131
+ },
1132
+ "required": [
1133
+ "name",
1134
+ "destination"
1135
+ ],
1136
+ "additionalProperties": false
1127
1137
  }
1128
- },
1129
- "required": [
1130
- "binding",
1131
- "project_id"
1132
- ],
1133
- "type": "object"
1138
+ }
1134
1139
  },
1135
- "type": "array"
1140
+ "required": [
1141
+ "bindings"
1142
+ ],
1143
+ "additionalProperties": false,
1144
+ "description": "List of bindings that you will send to logfwdr",
1145
+ "default": {
1146
+ "bindings": []
1147
+ }
1136
1148
  },
1137
- "d1_databases": {
1138
- "default": "`[]`",
1139
- "description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1140
- "items": {
1141
- "additionalProperties": false,
1142
- "properties": {
1143
- "binding": {
1144
- "description": "The binding name used to refer to the D1 database in the Worker.",
1145
- "type": "string"
1146
- },
1147
- "database_id": {
1148
- "description": "The UUID of this D1 database (not required).",
1149
- "type": "string"
1150
- },
1151
- "database_internal_env": {
1152
- "description": "Internal use only.",
1153
- "type": "string"
1154
- },
1155
- "database_name": {
1156
- "description": "The name of this D1 database.",
1157
- "type": "string"
1158
- },
1159
- "migrations_dir": {
1160
- "description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
1161
- "type": "string"
1162
- },
1163
- "migrations_table": {
1164
- "description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
1165
- "type": "string"
1166
- },
1167
- "preview_database_id": {
1168
- "description": "The UUID of this D1 database for Wrangler Dev (if specified).",
1169
- "type": "string"
1170
- }
1149
+ "logpush": {
1150
+ "type": "boolean",
1151
+ "description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/"
1152
+ },
1153
+ "upload_source_maps": {
1154
+ "type": "boolean",
1155
+ "description": "Include source maps when uploading this worker."
1156
+ },
1157
+ "placement": {
1158
+ "type": "object",
1159
+ "properties": {
1160
+ "mode": {
1161
+ "type": "string",
1162
+ "enum": [
1163
+ "off",
1164
+ "smart"
1165
+ ]
1171
1166
  },
1172
- "required": [
1173
- "binding",
1174
- "database_name",
1175
- "database_id"
1176
- ],
1177
- "type": "object"
1167
+ "hint": {
1168
+ "type": "string"
1169
+ }
1178
1170
  },
1179
- "type": "array"
1171
+ "required": [
1172
+ "mode"
1173
+ ],
1174
+ "additionalProperties": false,
1175
+ "description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/"
1180
1176
  },
1181
- "data_blobs": {
1182
- "additionalProperties": {
1183
- "type": "string"
1184
- },
1185
- "description": "A list of data files that your worker should be bound to. This is the \"legacy\" way of binding to a data file. ES module workers should do proper module imports.",
1186
- "type": "object"
1177
+ "assets": {
1178
+ "$ref": "#/definitions/Assets",
1179
+ "description": "Specify the directory of static assets to deploy/serve\n\nMore details at https://developers.cloudflare.com/workers/frameworks/"
1180
+ },
1181
+ "observability": {
1182
+ "$ref": "#/definitions/Observability",
1183
+ "description": "Specify the observability behavior of the Worker."
1187
1184
  },
1188
1185
  "define": {
1186
+ "type": "object",
1189
1187
  "additionalProperties": {
1190
1188
  "type": "string"
1191
1189
  },
1192
- "default": "`{}`",
1193
1190
  "description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1194
- "type": "object"
1195
- },
1196
- "dev": {
1197
- "$ref": "#/definitions/RawDevConfig",
1198
- "description": "Options to configure the development server that your worker will use."
1191
+ "default": {}
1199
1192
  },
1200
- "dispatch_namespaces": {
1201
- "default": "`[]`",
1202
- "description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1203
- "items": {
1204
- "additionalProperties": false,
1205
- "properties": {
1206
- "binding": {
1207
- "description": "The binding name used to refer to the bound service.",
1208
- "type": "string"
1209
- },
1210
- "namespace": {
1211
- "description": "The namespace to bind to.",
1193
+ "vars": {
1194
+ "type": "object",
1195
+ "additionalProperties": {
1196
+ "anyOf": [
1197
+ {
1212
1198
  "type": "string"
1213
1199
  },
1214
- "outbound": {
1215
- "$ref": "#/definitions/DispatchNamespaceOutbound",
1216
- "description": "Details about the outbound Worker which will handle outbound requests from your namespace"
1200
+ {
1201
+ "$ref": "#/definitions/Json"
1217
1202
  }
1218
- },
1219
- "required": [
1220
- "binding",
1221
- "namespace"
1222
- ],
1223
- "type": "object"
1203
+ ]
1224
1204
  },
1225
- "type": "array"
1205
+ "description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1206
+ "default": {}
1226
1207
  },
1227
1208
  "durable_objects": {
1228
- "additionalProperties": false,
1229
- "default": "`{bindings:[]}`",
1230
- "description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1209
+ "type": "object",
1231
1210
  "properties": {
1232
1211
  "bindings": {
1233
1212
  "$ref": "#/definitions/DurableObjectBindings"
@@ -1236,584 +1215,422 @@
1236
1215
  "required": [
1237
1216
  "bindings"
1238
1217
  ],
1239
- "type": "object"
1240
- },
1241
- "env": {
1242
- "additionalProperties": {
1243
- "$ref": "#/definitions/RawEnvironment"
1244
- },
1245
- "default": {},
1246
- "description": "The `env` section defines overrides for the configuration for different environments.\n\nAll environment fields can be specified at the top level of the config indicating the default environment settings.\n\n- Some fields are inherited and overridable in each environment.\n- But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.\n\nFor more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments",
1247
- "type": "object"
1218
+ "additionalProperties": false,
1219
+ "description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1220
+ "default": {
1221
+ "bindings": []
1222
+ }
1248
1223
  },
1249
- "experimental_services": {
1250
- "default": "`[]`",
1251
- "deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
1252
- "description": "A list of services that your Worker should be bound to.",
1224
+ "workflows": {
1225
+ "type": "array",
1253
1226
  "items": {
1254
- "additionalProperties": false,
1255
- "properties": {
1256
- "environment": {
1257
- "description": "The Service's environment",
1258
- "type": "string"
1259
- },
1260
- "name": {
1261
- "description": "The binding name used to refer to the Service",
1262
- "type": "string"
1263
- },
1264
- "service": {
1265
- "description": "The name of the Service being bound",
1266
- "type": "string"
1267
- }
1268
- },
1269
- "required": [
1270
- "name",
1271
- "service",
1272
- "environment"
1273
- ],
1274
- "type": "object"
1227
+ "$ref": "#/definitions/WorkflowBinding"
1275
1228
  },
1276
- "type": "array"
1229
+ "description": "A list of workflows that your Worker should be bound to.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1230
+ "default": []
1277
1231
  },
1278
- "find_additional_modules": {
1279
- "description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
1280
- "type": "boolean"
1232
+ "cloudchamber": {
1233
+ "$ref": "#/definitions/CloudchamberConfig",
1234
+ "description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1235
+ "default": {}
1281
1236
  },
1282
- "first_party_worker": {
1283
- "description": "Designates this Worker as an internal-only \"first-party\" Worker.",
1284
- "type": "boolean"
1237
+ "containers": {
1238
+ "type": "array",
1239
+ "items": {
1240
+ "$ref": "#/definitions/ContainerApp"
1241
+ },
1242
+ "description": "Container related configuration",
1243
+ "default": []
1285
1244
  },
1286
- "hyperdrive": {
1287
- "default": "`[]`",
1288
- "description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1245
+ "kv_namespaces": {
1246
+ "type": "array",
1289
1247
  "items": {
1290
- "additionalProperties": false,
1248
+ "type": "object",
1291
1249
  "properties": {
1292
1250
  "binding": {
1293
- "description": "The binding name used to refer to the project in the Worker.",
1294
- "type": "string"
1251
+ "type": "string",
1252
+ "description": "The binding name used to refer to the KV Namespace"
1295
1253
  },
1296
1254
  "id": {
1297
- "description": "The id of the database.",
1298
- "type": "string"
1255
+ "type": "string",
1256
+ "description": "The ID of the KV namespace"
1299
1257
  },
1300
- "localConnectionString": {
1301
- "description": "The local database connection string for `wrangler dev`",
1302
- "type": "string"
1258
+ "preview_id": {
1259
+ "type": "string",
1260
+ "description": "The ID of the KV namespace used during `wrangler dev`"
1303
1261
  }
1304
1262
  },
1305
1263
  "required": [
1306
- "binding",
1307
- "id"
1264
+ "binding"
1308
1265
  ],
1309
- "type": "object"
1266
+ "additionalProperties": false
1310
1267
  },
1311
- "type": "array"
1312
- },
1313
- "jsx_factory": {
1314
- "default": "`\"React.createElement\"`",
1315
- "description": "The function to use to replace jsx syntax.",
1316
- "type": "string"
1317
- },
1318
- "jsx_fragment": {
1319
- "default": "`\"React.Fragment\"`",
1320
- "description": "The function to use to replace jsx fragment syntax.",
1321
- "type": "string"
1322
- },
1323
- "keep_vars": {
1324
- "default": false,
1325
- "description": "By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.\n\nIf you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.\n\nIf you want to keep your dashboard vars when wrangler deploys, set this field to true.",
1326
- "type": "boolean"
1327
- },
1328
- "kv-namespaces": {
1329
- "deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
1330
- "description": "Legacy way of defining KVNamespaces that is no longer supported.",
1331
- "type": "string"
1332
- },
1333
- "kv_namespaces": {
1334
- "default": "`[]`",
1335
1268
  "description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1269
+ "default": []
1270
+ },
1271
+ "send_email": {
1272
+ "type": "array",
1336
1273
  "items": {
1337
- "additionalProperties": false,
1274
+ "type": "object",
1338
1275
  "properties": {
1339
- "binding": {
1340
- "description": "The binding name used to refer to the KV Namespace",
1341
- "type": "string"
1276
+ "name": {
1277
+ "type": "string",
1278
+ "description": "The binding name used to refer to the this binding"
1342
1279
  },
1343
- "id": {
1344
- "description": "The ID of the KV namespace",
1345
- "type": "string"
1280
+ "destination_address": {
1281
+ "type": "string",
1282
+ "description": "If this binding should be restricted to a specific verified address"
1346
1283
  },
1347
- "preview_id": {
1348
- "description": "The ID of the KV namespace used during `wrangler dev`",
1349
- "type": "string"
1284
+ "allowed_destination_addresses": {
1285
+ "type": "array",
1286
+ "items": {
1287
+ "type": "string"
1288
+ },
1289
+ "description": "If this binding should be restricted to a set of verified addresses"
1350
1290
  }
1351
1291
  },
1352
1292
  "required": [
1353
- "binding",
1354
- "id"
1293
+ "name"
1355
1294
  ],
1356
- "type": "object"
1295
+ "additionalProperties": false
1357
1296
  },
1358
- "type": "array"
1359
- },
1360
- "legacy_env": {
1361
- "description": "A boolean to enable \"legacy\" style wrangler environments (from Wrangler v1). These have been superseded by Services, but there may be projects that won't (or can't) use them. If you're using a legacy environment, you can set this to `true` to enable it.",
1362
- "type": "boolean"
1363
- },
1364
- "limits": {
1365
- "$ref": "#/definitions/UserLimits",
1366
- "description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
1297
+ "description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1298
+ "default": []
1367
1299
  },
1368
- "logfwdr": {
1369
- "additionalProperties": false,
1370
- "default": "`{bindings:[]}`",
1371
- "description": "List of bindings that you will send to logfwdr",
1300
+ "queues": {
1301
+ "type": "object",
1372
1302
  "properties": {
1373
- "bindings": {
1303
+ "producers": {
1304
+ "type": "array",
1374
1305
  "items": {
1375
- "additionalProperties": false,
1306
+ "type": "object",
1376
1307
  "properties": {
1377
- "destination": {
1378
- "description": "The destination for this logged message",
1379
- "type": "string"
1308
+ "binding": {
1309
+ "type": "string",
1310
+ "description": "The binding name used to refer to the Queue in the Worker."
1380
1311
  },
1381
- "name": {
1382
- "description": "The binding name used to refer to logfwdr",
1383
- "type": "string"
1312
+ "queue": {
1313
+ "type": "string",
1314
+ "description": "The name of this Queue."
1315
+ },
1316
+ "delivery_delay": {
1317
+ "type": "number",
1318
+ "description": "The number of seconds to wait before delivering a message"
1384
1319
  }
1385
1320
  },
1386
1321
  "required": [
1387
- "name",
1388
- "destination"
1322
+ "binding",
1323
+ "queue"
1389
1324
  ],
1390
- "type": "object"
1391
- },
1392
- "type": "array"
1393
- }
1394
- },
1395
- "required": [
1396
- "bindings"
1397
- ],
1398
- "type": "object"
1399
- },
1400
- "logpush": {
1401
- "description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
1402
- "type": "boolean"
1403
- },
1404
- "main": {
1405
- "description": "The entrypoint/path to the JavaScript file that will be executed.",
1406
- "type": "string"
1407
- },
1408
- "migrations": {
1409
- "default": [],
1410
- "description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
1411
- "items": {
1412
- "additionalProperties": false,
1413
- "properties": {
1414
- "deleted_classes": {
1415
- "description": "The Durable Objects being removed.",
1416
- "items": {
1417
- "type": "string"
1418
- },
1419
- "type": "array"
1420
- },
1421
- "new_classes": {
1422
- "description": "The new Durable Objects being defined.",
1423
- "items": {
1424
- "type": "string"
1425
- },
1426
- "type": "array"
1427
- },
1428
- "renamed_classes": {
1429
- "description": "The Durable Objects being renamed.",
1430
- "items": {
1431
- "additionalProperties": false,
1432
- "properties": {
1433
- "from": {
1434
- "type": "string"
1435
- },
1436
- "to": {
1437
- "type": "string"
1438
- }
1439
- },
1440
- "required": [
1441
- "from",
1442
- "to"
1443
- ],
1444
- "type": "object"
1445
- },
1446
- "type": "array"
1447
- },
1448
- "tag": {
1449
- "description": "A unique identifier for this migration.",
1450
- "type": "string"
1451
- }
1452
- },
1453
- "required": [
1454
- "tag"
1455
- ],
1456
- "type": "object"
1457
- },
1458
- "type": "array"
1459
- },
1460
- "miniflare": {
1461
- "deprecated": true,
1462
- "description": "Configuration only used by a standalone use of the miniflare binary."
1463
- },
1464
- "minify": {
1465
- "description": "Minify the script before uploading.",
1466
- "type": "boolean"
1467
- },
1468
- "mtls_certificates": {
1469
- "default": "`[]`",
1470
- "description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1471
- "items": {
1472
- "additionalProperties": false,
1473
- "properties": {
1474
- "binding": {
1475
- "description": "The binding name used to refer to the certificate in the Worker",
1476
- "type": "string"
1325
+ "additionalProperties": false
1477
1326
  },
1478
- "certificate_id": {
1479
- "description": "The uuid of the uploaded mTLS certificate",
1480
- "type": "string"
1481
- }
1327
+ "description": "Producer bindings"
1482
1328
  },
1483
- "required": [
1484
- "binding",
1485
- "certificate_id"
1486
- ],
1487
- "type": "object"
1488
- },
1489
- "type": "array"
1490
- },
1491
- "name": {
1492
- "description": "The name of your Worker. Alphanumeric + dashes only.",
1493
- "type": "string"
1494
- },
1495
- "no_bundle": {
1496
- "description": "Skip internal build steps and directly deploy script",
1497
- "type": "boolean"
1498
- },
1499
- "node_compat": {
1500
- "description": "Add polyfills for node builtin modules and globals",
1501
- "type": "boolean"
1502
- },
1503
- "pages_build_output_dir": {
1504
- "description": "The directory of static assets to serve.\n\nThe presence of this field in `wrangler.toml` indicates a Pages project, and will prompt the handling of the configuration file according to the Pages-specific validation rules.",
1505
- "type": "string"
1506
- },
1507
- "placement": {
1508
- "additionalProperties": false,
1509
- "description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
1510
- "properties": {
1511
- "mode": {
1512
- "enum": [
1513
- "off",
1514
- "smart"
1515
- ],
1516
- "type": "string"
1517
- }
1518
- },
1519
- "required": [
1520
- "mode"
1521
- ],
1522
- "type": "object"
1523
- },
1524
- "preserve_file_names": {
1525
- "description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
1526
- "type": "boolean"
1527
- },
1528
- "queues": {
1529
- "additionalProperties": false,
1530
- "default": "`{consumers:[],producers:[]}`",
1531
- "description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1532
- "properties": {
1533
1329
  "consumers": {
1534
- "description": "Consumer configuration",
1330
+ "type": "array",
1535
1331
  "items": {
1536
- "additionalProperties": false,
1332
+ "type": "object",
1537
1333
  "properties": {
1538
- "dead_letter_queue": {
1539
- "description": "The queue to send messages that failed to be consumed.",
1540
- "type": "string"
1334
+ "queue": {
1335
+ "type": "string",
1336
+ "description": "The name of the queue from which this consumer should consume."
1337
+ },
1338
+ "type": {
1339
+ "type": "string",
1340
+ "description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker."
1541
1341
  },
1542
1342
  "max_batch_size": {
1543
- "description": "The maximum number of messages per batch",
1544
- "type": "number"
1343
+ "type": "number",
1344
+ "description": "The maximum number of messages per batch"
1545
1345
  },
1546
1346
  "max_batch_timeout": {
1547
- "description": "The maximum number of seconds to wait to fill a batch with messages.",
1548
- "type": "number"
1347
+ "type": "number",
1348
+ "description": "The maximum number of seconds to wait to fill a batch with messages."
1349
+ },
1350
+ "max_retries": {
1351
+ "type": "number",
1352
+ "description": "The maximum number of retries for each message."
1353
+ },
1354
+ "dead_letter_queue": {
1355
+ "type": "string",
1356
+ "description": "The queue to send messages that failed to be consumed."
1549
1357
  },
1550
1358
  "max_concurrency": {
1551
- "description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
1552
1359
  "type": [
1553
1360
  "number",
1554
1361
  "null"
1555
- ]
1556
- },
1557
- "max_retries": {
1558
- "description": "The maximum number of retries for each message.",
1559
- "type": "number"
1560
- },
1561
- "queue": {
1562
- "description": "The name of the queue from which this consumer should consume.",
1563
- "type": "string"
1564
- },
1565
- "retry_delay": {
1566
- "description": "The number of seconds to wait before retrying a message",
1567
- "type": "number"
1568
- },
1569
- "type": {
1570
- "description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
1571
- "type": "string"
1362
+ ],
1363
+ "description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog."
1572
1364
  },
1573
1365
  "visibility_timeout_ms": {
1574
- "description": "The number of milliseconds to wait for pulled messages to become visible again",
1575
- "type": "number"
1576
- }
1577
- },
1578
- "required": [
1579
- "queue"
1580
- ],
1581
- "type": "object"
1582
- },
1583
- "type": "array"
1584
- },
1585
- "producers": {
1586
- "description": "Producer bindings",
1587
- "items": {
1588
- "additionalProperties": false,
1589
- "properties": {
1590
- "binding": {
1591
- "description": "The binding name used to refer to the Queue in the Worker.",
1592
- "type": "string"
1593
- },
1594
- "delivery_delay": {
1595
- "description": "The number of seconds to wait before delivering a message",
1596
- "type": "number"
1366
+ "type": "number",
1367
+ "description": "The number of milliseconds to wait for pulled messages to become visible again"
1597
1368
  },
1598
- "queue": {
1599
- "description": "The name of this Queue.",
1600
- "type": "string"
1369
+ "retry_delay": {
1370
+ "type": "number",
1371
+ "description": "The number of seconds to wait before retrying a message"
1601
1372
  }
1602
1373
  },
1603
1374
  "required": [
1604
- "binding",
1605
1375
  "queue"
1606
1376
  ],
1607
- "type": "object"
1377
+ "additionalProperties": false
1608
1378
  },
1609
- "type": "array"
1379
+ "description": "Consumer configuration"
1610
1380
  }
1611
1381
  },
1612
- "type": "object"
1382
+ "additionalProperties": false,
1383
+ "description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1384
+ "default": {
1385
+ "consumers": [],
1386
+ "producers": []
1387
+ }
1613
1388
  },
1614
1389
  "r2_buckets": {
1615
- "default": "`[]`",
1616
- "description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1390
+ "type": "array",
1617
1391
  "items": {
1618
- "additionalProperties": false,
1392
+ "type": "object",
1619
1393
  "properties": {
1620
1394
  "binding": {
1621
- "description": "The binding name used to refer to the R2 bucket in the Worker.",
1622
- "type": "string"
1395
+ "type": "string",
1396
+ "description": "The binding name used to refer to the R2 bucket in the Worker."
1623
1397
  },
1624
1398
  "bucket_name": {
1625
- "description": "The name of this R2 bucket at the edge.",
1626
- "type": "string"
1627
- },
1628
- "jurisdiction": {
1629
- "description": "The jurisdiction that the bucket exists in. Default if not present.",
1630
- "type": "string"
1399
+ "type": "string",
1400
+ "description": "The name of this R2 bucket at the edge."
1631
1401
  },
1632
1402
  "preview_bucket_name": {
1633
- "description": "The preview name of this R2 bucket at the edge.",
1634
- "type": "string"
1403
+ "type": "string",
1404
+ "description": "The preview name of this R2 bucket at the edge."
1405
+ },
1406
+ "jurisdiction": {
1407
+ "type": "string",
1408
+ "description": "The jurisdiction that the bucket exists in. Default if not present."
1635
1409
  }
1636
1410
  },
1637
1411
  "required": [
1638
- "binding",
1639
- "bucket_name"
1412
+ "binding"
1640
1413
  ],
1641
- "type": "object"
1414
+ "additionalProperties": false
1642
1415
  },
1643
- "type": "array"
1644
- },
1645
- "route": {
1646
- "$ref": "#/definitions/Route",
1647
- "description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
1416
+ "description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1417
+ "default": []
1648
1418
  },
1649
- "routes": {
1650
- "description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
1419
+ "d1_databases": {
1420
+ "type": "array",
1651
1421
  "items": {
1652
- "$ref": "#/definitions/Route"
1422
+ "type": "object",
1423
+ "properties": {
1424
+ "binding": {
1425
+ "type": "string",
1426
+ "description": "The binding name used to refer to the D1 database in the Worker."
1427
+ },
1428
+ "database_name": {
1429
+ "type": "string",
1430
+ "description": "The name of this D1 database."
1431
+ },
1432
+ "database_id": {
1433
+ "type": "string",
1434
+ "description": "The UUID of this D1 database (not required)."
1435
+ },
1436
+ "preview_database_id": {
1437
+ "type": "string",
1438
+ "description": "The UUID of this D1 database for Wrangler Dev (if specified)."
1439
+ },
1440
+ "migrations_table": {
1441
+ "type": "string",
1442
+ "description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations')."
1443
+ },
1444
+ "migrations_dir": {
1445
+ "type": "string",
1446
+ "description": "The path to the directory of migrations for this D1 database (defaults to './migrations')."
1447
+ },
1448
+ "database_internal_env": {
1449
+ "type": "string",
1450
+ "description": "Internal use only."
1451
+ }
1452
+ },
1453
+ "required": [
1454
+ "binding"
1455
+ ],
1456
+ "additionalProperties": false
1653
1457
  },
1654
- "type": "array"
1458
+ "description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1459
+ "default": []
1655
1460
  },
1656
- "rules": {
1657
- "description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
1461
+ "vectorize": {
1462
+ "type": "array",
1658
1463
  "items": {
1659
- "$ref": "#/definitions/Rule"
1464
+ "type": "object",
1465
+ "properties": {
1466
+ "binding": {
1467
+ "type": "string",
1468
+ "description": "The binding name used to refer to the Vectorize index in the Worker."
1469
+ },
1470
+ "index_name": {
1471
+ "type": "string",
1472
+ "description": "The name of the index."
1473
+ }
1474
+ },
1475
+ "required": [
1476
+ "binding",
1477
+ "index_name"
1478
+ ],
1479
+ "additionalProperties": false
1660
1480
  },
1661
- "type": "array"
1481
+ "description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1482
+ "default": []
1662
1483
  },
1663
- "send_email": {
1664
- "default": "`[]`",
1665
- "description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1484
+ "hyperdrive": {
1485
+ "type": "array",
1666
1486
  "items": {
1667
- "additionalProperties": false,
1487
+ "type": "object",
1668
1488
  "properties": {
1669
- "allowed_destination_addresses": {
1670
- "description": "If this binding should be restricted to a set of verified addresses",
1671
- "items": {
1672
- "type": "string"
1673
- },
1674
- "type": "array"
1489
+ "binding": {
1490
+ "type": "string",
1491
+ "description": "The binding name used to refer to the project in the Worker."
1675
1492
  },
1676
- "destination_address": {
1677
- "description": "If this binding should be restricted to a specific verified address",
1678
- "type": "string"
1493
+ "id": {
1494
+ "type": "string",
1495
+ "description": "The id of the database."
1679
1496
  },
1680
- "name": {
1681
- "description": "The binding name used to refer to the this binding",
1682
- "type": "string"
1497
+ "localConnectionString": {
1498
+ "type": "string",
1499
+ "description": "The local database connection string for `wrangler dev`"
1683
1500
  }
1684
1501
  },
1685
1502
  "required": [
1686
- "name"
1503
+ "binding",
1504
+ "id"
1687
1505
  ],
1688
- "type": "object"
1506
+ "additionalProperties": false
1689
1507
  },
1690
- "type": "array"
1691
- },
1692
- "send_metrics": {
1693
- "description": "Whether Wrangler should send usage metrics to Cloudflare for this project.\n\nWhen defined this will override any user settings. Otherwise, Wrangler will use the user's preference.",
1694
- "type": "boolean"
1508
+ "description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1509
+ "default": []
1695
1510
  },
1696
1511
  "services": {
1697
- "default": "`[]`",
1698
- "description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1512
+ "type": "array",
1699
1513
  "items": {
1700
- "additionalProperties": false,
1514
+ "type": "object",
1701
1515
  "properties": {
1702
1516
  "binding": {
1703
- "description": "The binding name used to refer to the bound service.",
1704
- "type": "string"
1517
+ "type": "string",
1518
+ "description": "The binding name used to refer to the bound service."
1705
1519
  },
1706
- "entrypoint": {
1707
- "description": "Optionally, the entrypoint (named export) of the service to bind to.",
1708
- "type": "string"
1520
+ "service": {
1521
+ "type": "string",
1522
+ "description": "The name of the service."
1709
1523
  },
1710
1524
  "environment": {
1711
- "description": "The environment of the service (e.g. production, staging, etc).",
1712
- "type": "string"
1525
+ "type": "string",
1526
+ "description": "The environment of the service (e.g. production, staging, etc)."
1713
1527
  },
1714
- "service": {
1715
- "description": "The name of the service.",
1716
- "type": "string"
1528
+ "entrypoint": {
1529
+ "type": "string",
1530
+ "description": "Optionally, the entrypoint (named export) of the service to bind to."
1531
+ },
1532
+ "props": {
1533
+ "type": "object",
1534
+ "additionalProperties": {},
1535
+ "description": "Optional properties that will be made available to the service via ctx.props."
1717
1536
  }
1718
1537
  },
1719
1538
  "required": [
1720
1539
  "binding",
1721
1540
  "service"
1722
1541
  ],
1723
- "type": "object"
1542
+ "additionalProperties": false
1724
1543
  },
1725
- "type": "array"
1544
+ "description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1545
+ "default": []
1726
1546
  },
1727
- "site": {
1728
- "additionalProperties": false,
1729
- "description": "The definition of a Worker Site, a feature that lets you upload static assets with your Worker.\n\nMore details at https://developers.cloudflare.com/workers/platform/sites",
1730
- "properties": {
1731
- "bucket": {
1732
- "description": "The directory containing your static assets.\n\nIt must be a path relative to your wrangler.toml file. Example: bucket = \"./public\"\n\nIf there is a `site` field then it must contain this `bucket` field.",
1733
- "type": "string"
1734
- },
1735
- "entry-point": {
1736
- "deprecated": "DO NOT use this (it's a holdover from Wrangler v1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.",
1737
- "description": "The location of your Worker script.",
1738
- "type": "string"
1739
- },
1740
- "exclude": {
1741
- "default": [],
1742
- "description": "A list of .gitignore-style patterns that match files or directories in your bucket that should be excluded from uploads. Example: exclude = [\"ignore_dir\"]",
1743
- "items": {
1744
- "type": "string"
1547
+ "analytics_engine_datasets": {
1548
+ "type": "array",
1549
+ "items": {
1550
+ "type": "object",
1551
+ "properties": {
1552
+ "binding": {
1553
+ "type": "string",
1554
+ "description": "The binding name used to refer to the dataset in the Worker."
1745
1555
  },
1746
- "type": "array"
1556
+ "dataset": {
1557
+ "type": "string",
1558
+ "description": "The name of this dataset to write to."
1559
+ }
1747
1560
  },
1748
- "include": {
1749
- "default": [],
1750
- "description": "An exclusive list of .gitignore-style patterns that match file or directory names from your bucket location. Only matched items will be uploaded. Example: include = [\"upload_dir\"]",
1751
- "items": {
1752
- "type": "string"
1753
- },
1754
- "type": "array"
1561
+ "required": [
1562
+ "binding"
1563
+ ],
1564
+ "additionalProperties": false
1565
+ },
1566
+ "description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1567
+ "default": []
1568
+ },
1569
+ "browser": {
1570
+ "type": "object",
1571
+ "properties": {
1572
+ "binding": {
1573
+ "type": "string"
1755
1574
  }
1756
1575
  },
1757
1576
  "required": [
1758
- "bucket"
1577
+ "binding"
1759
1578
  ],
1760
- "type": "object"
1761
- },
1762
- "tail_consumers": {
1763
- "default": "`[]`",
1764
- "description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1765
- "items": {
1766
- "$ref": "#/definitions/TailConsumer"
1767
- },
1768
- "type": "array"
1579
+ "additionalProperties": false,
1580
+ "description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1581
+ "default": {}
1769
1582
  },
1770
- "text_blobs": {
1771
- "additionalProperties": {
1772
- "type": "string"
1583
+ "ai": {
1584
+ "type": "object",
1585
+ "properties": {
1586
+ "binding": {
1587
+ "type": "string"
1588
+ },
1589
+ "staging": {
1590
+ "type": "boolean"
1591
+ }
1773
1592
  },
1774
- "description": "A list of text files that your worker should be bound to. This is the \"legacy\" way of binding to a text file. ES module workers should do proper module imports.",
1775
- "type": "object"
1776
- },
1777
- "triggers": {
1593
+ "required": [
1594
+ "binding"
1595
+ ],
1778
1596
  "additionalProperties": false,
1779
- "default": "`{crons:[]}`",
1780
- "description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
1597
+ "description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1598
+ "default": {}
1599
+ },
1600
+ "images": {
1601
+ "type": "object",
1781
1602
  "properties": {
1782
- "crons": {
1783
- "items": {
1784
- "type": "string"
1785
- },
1786
- "type": "array"
1603
+ "binding": {
1604
+ "type": "string"
1787
1605
  }
1788
1606
  },
1789
1607
  "required": [
1790
- "crons"
1608
+ "binding"
1791
1609
  ],
1792
- "type": "object"
1793
- },
1794
- "tsconfig": {
1795
- "description": "Path to a custom tsconfig",
1796
- "type": "string"
1610
+ "additionalProperties": false,
1611
+ "description": "Binding to Cloudflare Images\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1612
+ "default": {}
1797
1613
  },
1798
- "type": {
1799
- "deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
1800
- "description": "The project \"type\". A holdover from Wrangler v1.x. Valid values were \"webpack\", \"javascript\", and \"rust\".",
1801
- "enum": [
1802
- "webpack",
1803
- "javascript",
1804
- "rust"
1614
+ "version_metadata": {
1615
+ "type": "object",
1616
+ "properties": {
1617
+ "binding": {
1618
+ "type": "string"
1619
+ }
1620
+ },
1621
+ "required": [
1622
+ "binding"
1805
1623
  ],
1806
- "type": "string"
1624
+ "additionalProperties": false,
1625
+ "description": "Binding to the Worker Version's metadata"
1807
1626
  },
1808
1627
  "unsafe": {
1809
- "additionalProperties": false,
1810
- "default": "`{}`",
1811
- "description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1628
+ "type": "object",
1812
1629
  "properties": {
1813
1630
  "bindings": {
1814
- "description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
1631
+ "type": "array",
1815
1632
  "items": {
1816
- "additionalProperties": {},
1633
+ "type": "object",
1817
1634
  "properties": {
1818
1635
  "name": {
1819
1636
  "type": "string"
@@ -1826,33 +1643,38 @@
1826
1643
  "name",
1827
1644
  "type"
1828
1645
  ],
1829
- "type": "object"
1646
+ "additionalProperties": {}
1830
1647
  },
1831
- "type": "array"
1648
+ "description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare."
1649
+ },
1650
+ "metadata": {
1651
+ "type": "object",
1652
+ "additionalProperties": {},
1653
+ "description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields."
1832
1654
  },
1833
1655
  "capnp": {
1834
1656
  "anyOf": [
1835
1657
  {
1836
- "additionalProperties": false,
1658
+ "type": "object",
1837
1659
  "properties": {
1838
1660
  "base_path": {
1839
1661
  "type": "string"
1840
1662
  },
1841
1663
  "source_schemas": {
1664
+ "type": "array",
1842
1665
  "items": {
1843
1666
  "type": "string"
1844
- },
1845
- "type": "array"
1667
+ }
1846
1668
  }
1847
1669
  },
1848
1670
  "required": [
1849
1671
  "base_path",
1850
1672
  "source_schemas"
1851
1673
  ],
1852
- "type": "object"
1674
+ "additionalProperties": false
1853
1675
  },
1854
1676
  {
1855
- "additionalProperties": false,
1677
+ "type": "object",
1856
1678
  "properties": {
1857
1679
  "compiled_schema": {
1858
1680
  "type": "string"
@@ -1861,1079 +1683,706 @@
1861
1683
  "required": [
1862
1684
  "compiled_schema"
1863
1685
  ],
1864
- "type": "object"
1686
+ "additionalProperties": false
1865
1687
  }
1866
1688
  ],
1867
1689
  "description": "Used for internal capnp uploads for the Workers runtime"
1868
- },
1869
- "metadata": {
1870
- "additionalProperties": {},
1871
- "description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
1872
- "type": "object"
1873
1690
  }
1874
1691
  },
1875
- "type": "object"
1876
- },
1877
- "upload_source_maps": {
1878
- "description": "Include source maps when uploading this worker.",
1879
- "type": "boolean"
1880
- },
1881
- "usage_model": {
1882
- "description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
1883
- "enum": [
1884
- "bundled",
1885
- "unbound"
1886
- ],
1887
- "type": "string"
1692
+ "additionalProperties": false,
1693
+ "description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1694
+ "default": {}
1888
1695
  },
1889
- "vars": {
1890
- "additionalProperties": {
1891
- "anyOf": [
1892
- {
1893
- "type": "string"
1696
+ "mtls_certificates": {
1697
+ "type": "array",
1698
+ "items": {
1699
+ "type": "object",
1700
+ "properties": {
1701
+ "binding": {
1702
+ "type": "string",
1703
+ "description": "The binding name used to refer to the certificate in the Worker"
1894
1704
  },
1895
- {
1896
- "$ref": "#/definitions/Json"
1705
+ "certificate_id": {
1706
+ "type": "string",
1707
+ "description": "The uuid of the uploaded mTLS certificate"
1897
1708
  }
1898
- ]
1709
+ },
1710
+ "required": [
1711
+ "binding",
1712
+ "certificate_id"
1713
+ ],
1714
+ "additionalProperties": false
1899
1715
  },
1900
- "default": "`{}`",
1901
- "description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1902
- "type": "object"
1716
+ "description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1717
+ "default": []
1903
1718
  },
1904
- "vectorize": {
1905
- "default": "`[]`",
1906
- "description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1719
+ "tail_consumers": {
1720
+ "type": "array",
1907
1721
  "items": {
1908
- "additionalProperties": false,
1722
+ "$ref": "#/definitions/TailConsumer"
1723
+ },
1724
+ "description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1725
+ "default": []
1726
+ },
1727
+ "dispatch_namespaces": {
1728
+ "type": "array",
1729
+ "items": {
1730
+ "type": "object",
1909
1731
  "properties": {
1910
1732
  "binding": {
1911
- "description": "The binding name used to refer to the Vectorize index in the Worker.",
1912
- "type": "string"
1733
+ "type": "string",
1734
+ "description": "The binding name used to refer to the bound service."
1913
1735
  },
1914
- "index_name": {
1915
- "description": "The name of the index.",
1916
- "type": "string"
1736
+ "namespace": {
1737
+ "type": "string",
1738
+ "description": "The namespace to bind to."
1739
+ },
1740
+ "outbound": {
1741
+ "$ref": "#/definitions/DispatchNamespaceOutbound",
1742
+ "description": "Details about the outbound Worker which will handle outbound requests from your namespace"
1917
1743
  }
1918
1744
  },
1919
1745
  "required": [
1920
1746
  "binding",
1921
- "index_name"
1747
+ "namespace"
1922
1748
  ],
1923
- "type": "object"
1749
+ "additionalProperties": false
1924
1750
  },
1925
- "type": "array"
1751
+ "description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1752
+ "default": []
1926
1753
  },
1927
- "version_metadata": {
1928
- "additionalProperties": false,
1929
- "description": "Binding to the Worker Version's metadata",
1930
- "properties": {
1931
- "binding": {
1932
- "type": "string"
1933
- }
1754
+ "pipelines": {
1755
+ "type": "array",
1756
+ "items": {
1757
+ "type": "object",
1758
+ "properties": {
1759
+ "binding": {
1760
+ "type": "string",
1761
+ "description": "The binding name used to refer to the bound service."
1762
+ },
1763
+ "pipeline": {
1764
+ "type": "string",
1765
+ "description": "Name of the Pipeline to bind"
1766
+ }
1767
+ },
1768
+ "required": [
1769
+ "binding",
1770
+ "pipeline"
1771
+ ],
1772
+ "additionalProperties": false
1934
1773
  },
1935
- "required": [
1936
- "binding"
1937
- ],
1938
- "type": "object"
1774
+ "description": "Specifies list of Pipelines bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1775
+ "default": []
1939
1776
  },
1940
- "wasm_modules": {
1941
- "additionalProperties": {
1942
- "type": "string"
1777
+ "secrets_store_secrets": {
1778
+ "type": "array",
1779
+ "items": {
1780
+ "type": "object",
1781
+ "properties": {
1782
+ "binding": {
1783
+ "type": "string",
1784
+ "description": "The binding name used to refer to the bound service."
1785
+ },
1786
+ "store_id": {
1787
+ "type": "string",
1788
+ "description": "Id of the secret store"
1789
+ },
1790
+ "secret_name": {
1791
+ "type": "string",
1792
+ "description": "Name of the secret"
1793
+ }
1794
+ },
1795
+ "required": [
1796
+ "binding",
1797
+ "store_id",
1798
+ "secret_name"
1799
+ ],
1800
+ "additionalProperties": false
1943
1801
  },
1944
- "description": "A list of wasm modules that your worker should be bound to. This is the \"legacy\" way of binding to a wasm module. ES module workers should do proper module imports.",
1945
- "type": "object"
1946
- },
1947
- "webpack_config": {
1948
- "deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
1949
- "description": "Path to the webpack config to use when building your worker. A holdover from Wrangler v1.x, used with `type: \"webpack\"`.",
1802
+ "description": "Specifies Secret Store bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1803
+ "default": []
1804
+ }
1805
+ },
1806
+ "additionalProperties": false,
1807
+ "description": "The raw environment configuration that we read from the config file.\n\nAll the properties are optional, and will be replaced with defaults in the configuration that is used in the rest of the codebase."
1808
+ },
1809
+ "Route": {
1810
+ "anyOf": [
1811
+ {
1950
1812
  "type": "string"
1951
1813
  },
1952
- "workers_dev": {
1953
- "default": "`true` (This is a breaking change from Wrangler v1)",
1954
- "description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
1955
- "type": "boolean"
1814
+ {
1815
+ "$ref": "#/definitions/ZoneIdRoute"
1816
+ },
1817
+ {
1818
+ "$ref": "#/definitions/ZoneNameRoute"
1819
+ },
1820
+ {
1821
+ "$ref": "#/definitions/CustomDomainRoute"
1822
+ }
1823
+ ]
1824
+ },
1825
+ "ZoneIdRoute": {
1826
+ "type": "object",
1827
+ "properties": {
1828
+ "pattern": {
1829
+ "type": "string"
1956
1830
  },
1957
1831
  "zone_id": {
1958
- "description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
1959
1832
  "type": "string"
1833
+ },
1834
+ "custom_domain": {
1835
+ "type": "boolean"
1960
1836
  }
1961
1837
  },
1962
- "type": "object"
1838
+ "required": [
1839
+ "pattern",
1840
+ "zone_id"
1841
+ ],
1842
+ "additionalProperties": false
1963
1843
  },
1964
- "RawDevConfig": {
1965
- "additionalProperties": false,
1844
+ "ZoneNameRoute": {
1845
+ "type": "object",
1966
1846
  "properties": {
1967
- "host": {
1968
- "description": "Host to forward requests to, defaults to the host of the first route of project",
1847
+ "pattern": {
1969
1848
  "type": "string"
1970
1849
  },
1971
- "inspector_port": {
1972
- "default": 9229,
1973
- "description": "Port for the local dev server's inspector to listen on",
1974
- "type": "number"
1975
- },
1976
- "ip": {
1977
- "default": "localhost",
1978
- "description": "IP address for the local dev server to listen on,",
1850
+ "zone_name": {
1979
1851
  "type": "string"
1980
1852
  },
1981
- "local_protocol": {
1982
- "default": "http",
1983
- "description": "Protocol that local wrangler dev server listens to requests on.",
1984
- "enum": [
1985
- "http",
1986
- "https"
1987
- ],
1853
+ "custom_domain": {
1854
+ "type": "boolean"
1855
+ }
1856
+ },
1857
+ "required": [
1858
+ "pattern",
1859
+ "zone_name"
1860
+ ],
1861
+ "additionalProperties": false
1862
+ },
1863
+ "CustomDomainRoute": {
1864
+ "type": "object",
1865
+ "properties": {
1866
+ "pattern": {
1988
1867
  "type": "string"
1989
1868
  },
1990
- "port": {
1991
- "default": 8787,
1992
- "description": "Port for the local dev server to listen on",
1993
- "type": "number"
1994
- },
1995
- "upstream_protocol": {
1996
- "default": "https",
1997
- "description": "Protocol that wrangler dev forwards requests on\n\nSetting this to `http` is not currently implemented for remote mode. See https://github.com/cloudflare/workers-sdk/issues/583",
1998
- "enum": [
1999
- "https",
2000
- "http"
2001
- ],
2002
- "type": "string"
1869
+ "custom_domain": {
1870
+ "type": "boolean"
2003
1871
  }
2004
1872
  },
2005
- "type": "object"
1873
+ "required": [
1874
+ "pattern",
1875
+ "custom_domain"
1876
+ ],
1877
+ "additionalProperties": false
2006
1878
  },
2007
- "RawEnvironment": {
2008
- "additionalProperties": false,
2009
- "description": "The raw environment configuration that we read from the config file.\n\nAll the properties are optional, and will be replaced with defaults in the configuration that is used in the rest of the codebase.",
1879
+ "DurableObjectMigration": {
1880
+ "type": "object",
2010
1881
  "properties": {
2011
- "account_id": {
2012
- "description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
2013
- "type": "string"
1882
+ "tag": {
1883
+ "type": "string",
1884
+ "description": "A unique identifier for this migration."
2014
1885
  },
2015
- "ai": {
2016
- "additionalProperties": false,
2017
- "default": "`{}`",
2018
- "description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2019
- "properties": {
2020
- "binding": {
2021
- "type": "string"
2022
- },
2023
- "staging": {
2024
- "type": "boolean"
2025
- }
1886
+ "new_classes": {
1887
+ "type": "array",
1888
+ "items": {
1889
+ "type": "string"
2026
1890
  },
2027
- "required": [
2028
- "binding"
2029
- ],
2030
- "type": "object"
1891
+ "description": "The new Durable Objects being defined."
2031
1892
  },
2032
- "analytics_engine_datasets": {
2033
- "default": "`[]`",
2034
- "description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
1893
+ "new_sqlite_classes": {
1894
+ "type": "array",
1895
+ "items": {
1896
+ "type": "string"
1897
+ },
1898
+ "description": "The new SQLite Durable Objects being defined."
1899
+ },
1900
+ "renamed_classes": {
1901
+ "type": "array",
2035
1902
  "items": {
2036
- "additionalProperties": false,
1903
+ "type": "object",
2037
1904
  "properties": {
2038
- "binding": {
2039
- "description": "The binding name used to refer to the dataset in the Worker.",
1905
+ "from": {
2040
1906
  "type": "string"
2041
1907
  },
2042
- "dataset": {
2043
- "description": "The name of this dataset to write to.",
1908
+ "to": {
2044
1909
  "type": "string"
2045
1910
  }
2046
1911
  },
2047
1912
  "required": [
2048
- "binding"
1913
+ "from",
1914
+ "to"
2049
1915
  ],
2050
- "type": "object"
1916
+ "additionalProperties": false
2051
1917
  },
2052
- "type": "array"
2053
- },
2054
- "base_dir": {
2055
- "description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
2056
- "type": "string"
1918
+ "description": "The Durable Objects being renamed."
2057
1919
  },
2058
- "browser": {
2059
- "additionalProperties": false,
2060
- "default": "`{}`",
2061
- "description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2062
- "properties": {
2063
- "binding": {
2064
- "type": "string"
2065
- }
1920
+ "deleted_classes": {
1921
+ "type": "array",
1922
+ "items": {
1923
+ "type": "string"
2066
1924
  },
2067
- "required": [
2068
- "binding"
1925
+ "description": "The Durable Objects being removed."
1926
+ }
1927
+ },
1928
+ "required": [
1929
+ "tag"
1930
+ ],
1931
+ "additionalProperties": false,
1932
+ "description": "Configuration in wrangler for Durable Object Migrations"
1933
+ },
1934
+ "UserLimits": {
1935
+ "type": "object",
1936
+ "properties": {
1937
+ "cpu_ms": {
1938
+ "type": "number",
1939
+ "description": "Maximum allowed CPU time for a Worker's invocation in milliseconds"
1940
+ }
1941
+ },
1942
+ "required": [
1943
+ "cpu_ms"
1944
+ ],
1945
+ "additionalProperties": false
1946
+ },
1947
+ "Rule": {
1948
+ "type": "object",
1949
+ "properties": {
1950
+ "type": {
1951
+ "$ref": "#/definitions/ConfigModuleRuleType"
1952
+ },
1953
+ "globs": {
1954
+ "type": "array",
1955
+ "items": {
1956
+ "type": "string"
1957
+ }
1958
+ },
1959
+ "fallthrough": {
1960
+ "type": "boolean"
1961
+ }
1962
+ },
1963
+ "required": [
1964
+ "type",
1965
+ "globs"
1966
+ ],
1967
+ "additionalProperties": false,
1968
+ "description": "A bundling resolver rule, defining the modules type for paths that match the specified globs."
1969
+ },
1970
+ "ConfigModuleRuleType": {
1971
+ "type": "string",
1972
+ "enum": [
1973
+ "ESModule",
1974
+ "CommonJS",
1975
+ "CompiledWasm",
1976
+ "Text",
1977
+ "Data",
1978
+ "PythonModule",
1979
+ "PythonRequirement"
1980
+ ],
1981
+ "description": "The possible types for a `Rule`."
1982
+ },
1983
+ "Assets": {
1984
+ "type": "object",
1985
+ "properties": {
1986
+ "directory": {
1987
+ "type": "string",
1988
+ "description": "Absolute path to assets directory"
1989
+ },
1990
+ "binding": {
1991
+ "type": "string",
1992
+ "description": "Name of `env` binding property in the User Worker."
1993
+ },
1994
+ "html_handling": {
1995
+ "type": "string",
1996
+ "enum": [
1997
+ "auto-trailing-slash",
1998
+ "force-trailing-slash",
1999
+ "drop-trailing-slash",
2000
+ "none"
2069
2001
  ],
2070
- "type": "object"
2002
+ "description": "How to handle HTML requests."
2071
2003
  },
2072
- "build": {
2073
- "additionalProperties": false,
2074
- "default": {
2075
- "watch_dir": "./src"
2076
- },
2077
- "description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
2004
+ "not_found_handling": {
2005
+ "type": "string",
2006
+ "enum": [
2007
+ "single-page-application",
2008
+ "404-page",
2009
+ "none"
2010
+ ],
2011
+ "description": "How to handle requests that do not match an asset."
2012
+ },
2013
+ "run_worker_first": {
2014
+ "type": "boolean",
2015
+ "description": "If true, route every request to the User Worker, whether or not it matches an asset. If false, then respond to requests that match an asset with that asset directly."
2016
+ }
2017
+ },
2018
+ "additionalProperties": false
2019
+ },
2020
+ "Observability": {
2021
+ "type": "object",
2022
+ "properties": {
2023
+ "enabled": {
2024
+ "type": "boolean",
2025
+ "description": "If observability is enabled for this Worker"
2026
+ },
2027
+ "head_sampling_rate": {
2028
+ "type": "number",
2029
+ "description": "The sampling rate"
2030
+ },
2031
+ "logs": {
2032
+ "type": "object",
2078
2033
  "properties": {
2079
- "command": {
2080
- "description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
2081
- "type": "string"
2082
- },
2083
- "cwd": {
2084
- "description": "The directory in which the command is executed.",
2085
- "type": "string"
2034
+ "enabled": {
2035
+ "type": "boolean"
2086
2036
  },
2087
- "upload": {
2088
- "$ref": "#/definitions/DeprecatedUpload",
2089
- "deprecated": true,
2090
- "description": "Deprecated field previously used to configure the build and upload of the script."
2037
+ "head_sampling_rate": {
2038
+ "type": "number",
2039
+ "description": "The sampling rate"
2091
2040
  },
2092
- "watch_dir": {
2093
- "anyOf": [
2094
- {
2095
- "type": "string"
2096
- },
2097
- {
2098
- "items": {
2099
- "type": "string"
2100
- },
2101
- "type": "array"
2102
- }
2103
- ],
2104
- "description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
2041
+ "invocation_logs": {
2042
+ "type": "boolean",
2043
+ "description": "Set to false to disable invocation logs"
2105
2044
  }
2106
2045
  },
2107
- "type": "object"
2108
- },
2109
- "cloudchamber": {
2110
- "$ref": "#/definitions/CloudchamberConfig",
2111
- "default": "`{}`",
2112
- "description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
2046
+ "additionalProperties": false
2047
+ }
2048
+ },
2049
+ "additionalProperties": false
2050
+ },
2051
+ "Json": {
2052
+ "anyOf": [
2053
+ {
2054
+ "$ref": "#/definitions/Literal"
2113
2055
  },
2114
- "compatibility_date": {
2115
- "description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
2116
- "type": "string"
2056
+ {
2057
+ "type": "object",
2058
+ "additionalProperties": {
2059
+ "$ref": "#/definitions/Json"
2060
+ }
2117
2061
  },
2118
- "compatibility_flags": {
2119
- "default": "`[]`",
2120
- "description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
2062
+ {
2063
+ "type": "array",
2121
2064
  "items": {
2122
- "type": "string"
2065
+ "$ref": "#/definitions/Json"
2066
+ }
2067
+ }
2068
+ ]
2069
+ },
2070
+ "Literal": {
2071
+ "$ref": "#/definitions/TypeOf%3CZodUnion%3C%5Bdef-class-1315922706-6501-8772-1315922706-0-54395%2Cdef-class-1315922706-9299-10989-1315922706-0-54395%2Cdef-class-1315922706-12937-13365-1315922706-0-54395%2Cdef-class-1315922706-15083-15273-1315922706-0-54395%5D%3E%3E"
2072
+ },
2073
+ "TypeOf<ZodUnion<[def-class-1315922706-6501-8772-1315922706-0-54395,def-class-1315922706-9299-10989-1315922706-0-54395,def-class-1315922706-12937-13365-1315922706-0-54395,def-class-1315922706-15083-15273-1315922706-0-54395]>>": {
2074
+ "type": [
2075
+ "string",
2076
+ "number",
2077
+ "boolean",
2078
+ "null"
2079
+ ]
2080
+ },
2081
+ "DurableObjectBindings": {
2082
+ "type": "array",
2083
+ "items": {
2084
+ "type": "object",
2085
+ "properties": {
2086
+ "name": {
2087
+ "type": "string",
2088
+ "description": "The name of the binding used to refer to the Durable Object"
2123
2089
  },
2124
- "type": "array"
2125
- },
2126
- "constellation": {
2127
- "default": "`[]`",
2128
- "description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2129
- "items": {
2130
- "additionalProperties": false,
2131
- "properties": {
2132
- "binding": {
2133
- "description": "The binding name used to refer to the project in the Worker.",
2134
- "type": "string"
2135
- },
2136
- "project_id": {
2137
- "description": "The id of the project.",
2138
- "type": "string"
2139
- }
2140
- },
2141
- "required": [
2142
- "binding",
2143
- "project_id"
2144
- ],
2145
- "type": "object"
2090
+ "class_name": {
2091
+ "type": "string",
2092
+ "description": "The exported class name of the Durable Object"
2146
2093
  },
2147
- "type": "array"
2148
- },
2149
- "d1_databases": {
2150
- "default": "`[]`",
2151
- "description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2152
- "items": {
2153
- "additionalProperties": false,
2154
- "properties": {
2155
- "binding": {
2156
- "description": "The binding name used to refer to the D1 database in the Worker.",
2157
- "type": "string"
2158
- },
2159
- "database_id": {
2160
- "description": "The UUID of this D1 database (not required).",
2161
- "type": "string"
2162
- },
2163
- "database_internal_env": {
2164
- "description": "Internal use only.",
2165
- "type": "string"
2166
- },
2167
- "database_name": {
2168
- "description": "The name of this D1 database.",
2169
- "type": "string"
2170
- },
2171
- "migrations_dir": {
2172
- "description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
2173
- "type": "string"
2174
- },
2175
- "migrations_table": {
2176
- "description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
2177
- "type": "string"
2178
- },
2179
- "preview_database_id": {
2180
- "description": "The UUID of this D1 database for Wrangler Dev (if specified).",
2181
- "type": "string"
2182
- }
2183
- },
2184
- "required": [
2185
- "binding",
2186
- "database_name",
2187
- "database_id"
2188
- ],
2189
- "type": "object"
2190
- },
2191
- "type": "array"
2192
- },
2193
- "define": {
2194
- "additionalProperties": {
2195
- "type": "string"
2196
- },
2197
- "default": "`{}`",
2198
- "description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2199
- "type": "object"
2200
- },
2201
- "dispatch_namespaces": {
2202
- "default": "`[]`",
2203
- "description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2204
- "items": {
2205
- "additionalProperties": false,
2206
- "properties": {
2207
- "binding": {
2208
- "description": "The binding name used to refer to the bound service.",
2209
- "type": "string"
2210
- },
2211
- "namespace": {
2212
- "description": "The namespace to bind to.",
2213
- "type": "string"
2214
- },
2215
- "outbound": {
2216
- "$ref": "#/definitions/DispatchNamespaceOutbound",
2217
- "description": "Details about the outbound Worker which will handle outbound requests from your namespace"
2218
- }
2219
- },
2220
- "required": [
2221
- "binding",
2222
- "namespace"
2223
- ],
2224
- "type": "object"
2225
- },
2226
- "type": "array"
2227
- },
2228
- "durable_objects": {
2229
- "additionalProperties": false,
2230
- "default": "`{bindings:[]}`",
2231
- "description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2232
- "properties": {
2233
- "bindings": {
2234
- "$ref": "#/definitions/DurableObjectBindings"
2235
- }
2236
- },
2237
- "required": [
2238
- "bindings"
2239
- ],
2240
- "type": "object"
2241
- },
2242
- "experimental_services": {
2243
- "default": "`[]`",
2244
- "deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
2245
- "description": "A list of services that your Worker should be bound to.",
2246
- "items": {
2247
- "additionalProperties": false,
2248
- "properties": {
2249
- "environment": {
2250
- "description": "The Service's environment",
2251
- "type": "string"
2252
- },
2253
- "name": {
2254
- "description": "The binding name used to refer to the Service",
2255
- "type": "string"
2256
- },
2257
- "service": {
2258
- "description": "The name of the Service being bound",
2259
- "type": "string"
2260
- }
2261
- },
2262
- "required": [
2263
- "name",
2264
- "service",
2265
- "environment"
2266
- ],
2267
- "type": "object"
2268
- },
2269
- "type": "array"
2270
- },
2271
- "find_additional_modules": {
2272
- "description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
2273
- "type": "boolean"
2274
- },
2275
- "first_party_worker": {
2276
- "description": "Designates this Worker as an internal-only \"first-party\" Worker.",
2277
- "type": "boolean"
2278
- },
2279
- "hyperdrive": {
2280
- "default": "`[]`",
2281
- "description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2282
- "items": {
2283
- "additionalProperties": false,
2284
- "properties": {
2285
- "binding": {
2286
- "description": "The binding name used to refer to the project in the Worker.",
2287
- "type": "string"
2288
- },
2289
- "id": {
2290
- "description": "The id of the database.",
2291
- "type": "string"
2292
- },
2293
- "localConnectionString": {
2294
- "description": "The local database connection string for `wrangler dev`",
2295
- "type": "string"
2296
- }
2297
- },
2298
- "required": [
2299
- "binding",
2300
- "id"
2301
- ],
2302
- "type": "object"
2303
- },
2304
- "type": "array"
2305
- },
2306
- "jsx_factory": {
2307
- "default": "`\"React.createElement\"`",
2308
- "description": "The function to use to replace jsx syntax.",
2309
- "type": "string"
2310
- },
2311
- "jsx_fragment": {
2312
- "default": "`\"React.Fragment\"`",
2313
- "description": "The function to use to replace jsx fragment syntax.",
2314
- "type": "string"
2315
- },
2316
- "kv-namespaces": {
2317
- "deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
2318
- "description": "Legacy way of defining KVNamespaces that is no longer supported.",
2319
- "type": "string"
2320
- },
2321
- "kv_namespaces": {
2322
- "default": "`[]`",
2323
- "description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2324
- "items": {
2325
- "additionalProperties": false,
2326
- "properties": {
2327
- "binding": {
2328
- "description": "The binding name used to refer to the KV Namespace",
2329
- "type": "string"
2330
- },
2331
- "id": {
2332
- "description": "The ID of the KV namespace",
2333
- "type": "string"
2334
- },
2335
- "preview_id": {
2336
- "description": "The ID of the KV namespace used during `wrangler dev`",
2337
- "type": "string"
2338
- }
2339
- },
2340
- "required": [
2341
- "binding",
2342
- "id"
2343
- ],
2344
- "type": "object"
2345
- },
2346
- "type": "array"
2347
- },
2348
- "limits": {
2349
- "$ref": "#/definitions/UserLimits",
2350
- "description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
2351
- },
2352
- "logfwdr": {
2353
- "additionalProperties": false,
2354
- "default": "`{bindings:[]}`",
2355
- "description": "List of bindings that you will send to logfwdr",
2356
- "properties": {
2357
- "bindings": {
2358
- "items": {
2359
- "additionalProperties": false,
2360
- "properties": {
2361
- "destination": {
2362
- "description": "The destination for this logged message",
2363
- "type": "string"
2364
- },
2365
- "name": {
2366
- "description": "The binding name used to refer to logfwdr",
2367
- "type": "string"
2368
- }
2369
- },
2370
- "required": [
2371
- "name",
2372
- "destination"
2373
- ],
2374
- "type": "object"
2375
- },
2376
- "type": "array"
2377
- }
2094
+ "script_name": {
2095
+ "type": "string",
2096
+ "description": "The script where the Durable Object is defined (if it's external to this Worker)"
2378
2097
  },
2379
- "required": [
2380
- "bindings"
2381
- ],
2382
- "type": "object"
2383
- },
2384
- "logpush": {
2385
- "description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
2386
- "type": "boolean"
2387
- },
2388
- "main": {
2389
- "description": "The entrypoint/path to the JavaScript file that will be executed.",
2390
- "type": "string"
2391
- },
2392
- "minify": {
2393
- "description": "Minify the script before uploading.",
2394
- "type": "boolean"
2098
+ "environment": {
2099
+ "type": "string",
2100
+ "description": "The service environment of the script_name to bind to"
2101
+ }
2395
2102
  },
2396
- "mtls_certificates": {
2397
- "default": "`[]`",
2398
- "description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2399
- "items": {
2400
- "additionalProperties": false,
2401
- "properties": {
2402
- "binding": {
2403
- "description": "The binding name used to refer to the certificate in the Worker",
2404
- "type": "string"
2405
- },
2406
- "certificate_id": {
2407
- "description": "The uuid of the uploaded mTLS certificate",
2408
- "type": "string"
2409
- }
2410
- },
2411
- "required": [
2412
- "binding",
2413
- "certificate_id"
2414
- ],
2415
- "type": "object"
2416
- },
2417
- "type": "array"
2103
+ "required": [
2104
+ "name",
2105
+ "class_name"
2106
+ ],
2107
+ "additionalProperties": false
2108
+ }
2109
+ },
2110
+ "WorkflowBinding": {
2111
+ "type": "object",
2112
+ "properties": {
2113
+ "binding": {
2114
+ "type": "string",
2115
+ "description": "The name of the binding used to refer to the Workflow"
2418
2116
  },
2419
2117
  "name": {
2420
- "description": "The name of your Worker. Alphanumeric + dashes only.",
2421
- "type": "string"
2422
- },
2423
- "no_bundle": {
2424
- "description": "Skip internal build steps and directly deploy script",
2425
- "type": "boolean"
2118
+ "type": "string",
2119
+ "description": "The name of the Workflow"
2426
2120
  },
2427
- "node_compat": {
2428
- "description": "Add polyfills for node builtin modules and globals",
2429
- "type": "boolean"
2121
+ "class_name": {
2122
+ "type": "string",
2123
+ "description": "The exported class name of the Workflow"
2430
2124
  },
2431
- "placement": {
2432
- "additionalProperties": false,
2433
- "description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
2434
- "properties": {
2435
- "mode": {
2436
- "enum": [
2437
- "off",
2438
- "smart"
2439
- ],
2440
- "type": "string"
2441
- }
2442
- },
2443
- "required": [
2444
- "mode"
2445
- ],
2446
- "type": "object"
2447
- },
2448
- "preserve_file_names": {
2449
- "description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
2450
- "type": "boolean"
2451
- },
2452
- "queues": {
2453
- "additionalProperties": false,
2454
- "default": "`{consumers:[],producers:[]}`",
2455
- "description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2456
- "properties": {
2457
- "consumers": {
2458
- "description": "Consumer configuration",
2459
- "items": {
2460
- "additionalProperties": false,
2461
- "properties": {
2462
- "dead_letter_queue": {
2463
- "description": "The queue to send messages that failed to be consumed.",
2464
- "type": "string"
2465
- },
2466
- "max_batch_size": {
2467
- "description": "The maximum number of messages per batch",
2468
- "type": "number"
2469
- },
2470
- "max_batch_timeout": {
2471
- "description": "The maximum number of seconds to wait to fill a batch with messages.",
2472
- "type": "number"
2473
- },
2474
- "max_concurrency": {
2475
- "description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
2476
- "type": [
2477
- "number",
2478
- "null"
2479
- ]
2480
- },
2481
- "max_retries": {
2482
- "description": "The maximum number of retries for each message.",
2483
- "type": "number"
2484
- },
2485
- "queue": {
2486
- "description": "The name of the queue from which this consumer should consume.",
2487
- "type": "string"
2488
- },
2489
- "retry_delay": {
2490
- "description": "The number of seconds to wait before retrying a message",
2491
- "type": "number"
2492
- },
2493
- "type": {
2494
- "description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
2495
- "type": "string"
2496
- },
2497
- "visibility_timeout_ms": {
2498
- "description": "The number of milliseconds to wait for pulled messages to become visible again",
2499
- "type": "number"
2500
- }
2501
- },
2502
- "required": [
2503
- "queue"
2504
- ],
2505
- "type": "object"
2506
- },
2507
- "type": "array"
2508
- },
2509
- "producers": {
2510
- "description": "Producer bindings",
2511
- "items": {
2512
- "additionalProperties": false,
2513
- "properties": {
2514
- "binding": {
2515
- "description": "The binding name used to refer to the Queue in the Worker.",
2516
- "type": "string"
2517
- },
2518
- "delivery_delay": {
2519
- "description": "The number of seconds to wait before delivering a message",
2520
- "type": "number"
2521
- },
2522
- "queue": {
2523
- "description": "The name of this Queue.",
2524
- "type": "string"
2525
- }
2526
- },
2527
- "required": [
2528
- "binding",
2529
- "queue"
2530
- ],
2531
- "type": "object"
2532
- },
2533
- "type": "array"
2534
- }
2535
- },
2536
- "type": "object"
2537
- },
2538
- "r2_buckets": {
2539
- "default": "`[]`",
2540
- "description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2541
- "items": {
2542
- "additionalProperties": false,
2543
- "properties": {
2544
- "binding": {
2545
- "description": "The binding name used to refer to the R2 bucket in the Worker.",
2546
- "type": "string"
2547
- },
2548
- "bucket_name": {
2549
- "description": "The name of this R2 bucket at the edge.",
2550
- "type": "string"
2551
- },
2552
- "jurisdiction": {
2553
- "description": "The jurisdiction that the bucket exists in. Default if not present.",
2554
- "type": "string"
2555
- },
2556
- "preview_bucket_name": {
2557
- "description": "The preview name of this R2 bucket at the edge.",
2558
- "type": "string"
2559
- }
2560
- },
2561
- "required": [
2562
- "binding",
2563
- "bucket_name"
2564
- ],
2565
- "type": "object"
2566
- },
2567
- "type": "array"
2568
- },
2569
- "route": {
2570
- "$ref": "#/definitions/Route",
2571
- "description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
2572
- },
2573
- "routes": {
2574
- "description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
2575
- "items": {
2576
- "$ref": "#/definitions/Route"
2577
- },
2578
- "type": "array"
2579
- },
2580
- "rules": {
2581
- "description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
2582
- "items": {
2583
- "$ref": "#/definitions/Rule"
2584
- },
2585
- "type": "array"
2586
- },
2587
- "send_email": {
2588
- "default": "`[]`",
2589
- "description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2590
- "items": {
2591
- "additionalProperties": false,
2592
- "properties": {
2593
- "allowed_destination_addresses": {
2594
- "description": "If this binding should be restricted to a set of verified addresses",
2595
- "items": {
2596
- "type": "string"
2597
- },
2598
- "type": "array"
2599
- },
2600
- "destination_address": {
2601
- "description": "If this binding should be restricted to a specific verified address",
2602
- "type": "string"
2603
- },
2604
- "name": {
2605
- "description": "The binding name used to refer to the this binding",
2606
- "type": "string"
2607
- }
2608
- },
2609
- "required": [
2610
- "name"
2611
- ],
2612
- "type": "object"
2613
- },
2614
- "type": "array"
2615
- },
2616
- "services": {
2617
- "default": "`[]`",
2618
- "description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2619
- "items": {
2620
- "additionalProperties": false,
2621
- "properties": {
2622
- "binding": {
2623
- "description": "The binding name used to refer to the bound service.",
2624
- "type": "string"
2625
- },
2626
- "entrypoint": {
2627
- "description": "Optionally, the entrypoint (named export) of the service to bind to.",
2628
- "type": "string"
2629
- },
2630
- "environment": {
2631
- "description": "The environment of the service (e.g. production, staging, etc).",
2632
- "type": "string"
2633
- },
2634
- "service": {
2635
- "description": "The name of the service.",
2636
- "type": "string"
2637
- }
2638
- },
2639
- "required": [
2640
- "binding",
2641
- "service"
2642
- ],
2643
- "type": "object"
2644
- },
2645
- "type": "array"
2125
+ "script_name": {
2126
+ "type": "string",
2127
+ "description": "The script where the Workflow is defined (if it's external to this Worker)"
2128
+ }
2129
+ },
2130
+ "required": [
2131
+ "binding",
2132
+ "name",
2133
+ "class_name"
2134
+ ],
2135
+ "additionalProperties": false
2136
+ },
2137
+ "CloudchamberConfig": {
2138
+ "type": "object",
2139
+ "properties": {
2140
+ "image": {
2141
+ "type": "string"
2646
2142
  },
2647
- "tail_consumers": {
2648
- "default": "`[]`",
2649
- "description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2650
- "items": {
2651
- "$ref": "#/definitions/TailConsumer"
2652
- },
2653
- "type": "array"
2143
+ "location": {
2144
+ "type": "string"
2654
2145
  },
2655
- "triggers": {
2656
- "additionalProperties": false,
2657
- "default": "`{crons:[]}`",
2658
- "description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
2659
- "properties": {
2660
- "crons": {
2661
- "items": {
2662
- "type": "string"
2663
- },
2664
- "type": "array"
2665
- }
2146
+ "vcpu": {
2147
+ "type": "number"
2148
+ },
2149
+ "memory": {
2150
+ "type": "string"
2151
+ },
2152
+ "ipv4": {
2153
+ "type": "boolean"
2154
+ }
2155
+ },
2156
+ "additionalProperties": false,
2157
+ "description": "Configuration in wrangler for Cloudchamber"
2158
+ },
2159
+ "ContainerApp": {
2160
+ "type": "object",
2161
+ "properties": {
2162
+ "name": {
2163
+ "type": "string",
2164
+ "description": "Name of the application"
2165
+ },
2166
+ "instances": {
2167
+ "type": "number",
2168
+ "description": "Number of application instances"
2169
+ },
2170
+ "max_instances": {
2171
+ "type": "number",
2172
+ "description": "Number of maximum application instances. Only applicable to Durable Object container applications"
2173
+ },
2174
+ "image": {
2175
+ "type": "string",
2176
+ "description": "The path to a Dockerfile, or an image URI. Can be defined both here or by setting the `image` key in the `ContainerApp` configuration"
2177
+ },
2178
+ "image_build_context": {
2179
+ "type": "string",
2180
+ "description": "Build context of the application. By default it is the directory of `image`."
2181
+ },
2182
+ "image_vars": {
2183
+ "type": "object",
2184
+ "additionalProperties": {
2185
+ "type": "string"
2666
2186
  },
2667
- "required": [
2668
- "crons"
2669
- ],
2670
- "type": "object"
2187
+ "description": "Image variables to be passed along the image"
2671
2188
  },
2672
- "tsconfig": {
2673
- "description": "Path to a custom tsconfig",
2189
+ "class_name": {
2674
2190
  "type": "string"
2675
2191
  },
2676
- "unsafe": {
2677
- "additionalProperties": false,
2678
- "default": "`{}`",
2679
- "description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2192
+ "scheduling_policy": {
2193
+ "type": "string",
2194
+ "enum": [
2195
+ "regional",
2196
+ "moon"
2197
+ ],
2198
+ "description": "The scheduling policy of the application, default is regional"
2199
+ },
2200
+ "configuration": {
2201
+ "type": "object",
2680
2202
  "properties": {
2681
- "bindings": {
2682
- "description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
2203
+ "image": {
2204
+ "type": "string"
2205
+ },
2206
+ "labels": {
2207
+ "type": "array",
2683
2208
  "items": {
2684
- "additionalProperties": {},
2209
+ "type": "object",
2685
2210
  "properties": {
2686
2211
  "name": {
2687
2212
  "type": "string"
2688
2213
  },
2689
- "type": {
2214
+ "value": {
2690
2215
  "type": "string"
2691
2216
  }
2692
2217
  },
2693
2218
  "required": [
2694
2219
  "name",
2695
- "type"
2220
+ "value"
2696
2221
  ],
2697
- "type": "object"
2698
- },
2699
- "type": "array"
2222
+ "additionalProperties": false
2223
+ }
2700
2224
  },
2701
- "capnp": {
2702
- "anyOf": [
2703
- {
2704
- "additionalProperties": false,
2705
- "properties": {
2706
- "base_path": {
2707
- "type": "string"
2708
- },
2709
- "source_schemas": {
2710
- "items": {
2711
- "type": "string"
2712
- },
2713
- "type": "array"
2714
- }
2225
+ "secrets": {
2226
+ "type": "array",
2227
+ "items": {
2228
+ "type": "object",
2229
+ "properties": {
2230
+ "name": {
2231
+ "type": "string"
2715
2232
  },
2716
- "required": [
2717
- "base_path",
2718
- "source_schemas"
2719
- ],
2720
- "type": "object"
2721
- },
2722
- {
2723
- "additionalProperties": false,
2724
- "properties": {
2725
- "compiled_schema": {
2726
- "type": "string"
2727
- }
2233
+ "type": {
2234
+ "type": "string",
2235
+ "const": "env"
2728
2236
  },
2729
- "required": [
2730
- "compiled_schema"
2731
- ],
2732
- "type": "object"
2733
- }
2734
- ],
2735
- "description": "Used for internal capnp uploads for the Workers runtime"
2736
- },
2737
- "metadata": {
2738
- "additionalProperties": {},
2739
- "description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
2740
- "type": "object"
2237
+ "secret": {
2238
+ "type": "string"
2239
+ }
2240
+ },
2241
+ "required": [
2242
+ "name",
2243
+ "type",
2244
+ "secret"
2245
+ ],
2246
+ "additionalProperties": false
2247
+ }
2741
2248
  }
2742
2249
  },
2743
- "type": "object"
2744
- },
2745
- "upload_source_maps": {
2746
- "description": "Include source maps when uploading this worker.",
2747
- "type": "boolean"
2748
- },
2749
- "usage_model": {
2750
- "description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
2751
- "enum": [
2752
- "bundled",
2753
- "unbound"
2250
+ "required": [
2251
+ "image"
2754
2252
  ],
2755
- "type": "string"
2253
+ "additionalProperties": false
2756
2254
  },
2757
- "vars": {
2758
- "additionalProperties": {
2759
- "anyOf": [
2760
- {
2255
+ "constraints": {
2256
+ "type": "object",
2257
+ "properties": {
2258
+ "regions": {
2259
+ "type": "array",
2260
+ "items": {
2761
2261
  "type": "string"
2762
- },
2763
- {
2764
- "$ref": "#/definitions/Json"
2765
2262
  }
2766
- ]
2767
- },
2768
- "default": "`{}`",
2769
- "description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2770
- "type": "object"
2771
- },
2772
- "vectorize": {
2773
- "default": "`[]`",
2774
- "description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
2775
- "items": {
2776
- "additionalProperties": false,
2777
- "properties": {
2778
- "binding": {
2779
- "description": "The binding name used to refer to the Vectorize index in the Worker.",
2780
- "type": "string"
2781
- },
2782
- "index_name": {
2783
- "description": "The name of the index.",
2263
+ },
2264
+ "cities": {
2265
+ "type": "array",
2266
+ "items": {
2784
2267
  "type": "string"
2785
2268
  }
2786
2269
  },
2787
- "required": [
2788
- "binding",
2789
- "index_name"
2790
- ],
2791
- "type": "object"
2270
+ "tier": {
2271
+ "type": "number"
2272
+ }
2792
2273
  },
2793
- "type": "array"
2794
- },
2795
- "version_metadata": {
2796
2274
  "additionalProperties": false,
2797
- "description": "Binding to the Worker Version's metadata",
2275
+ "description": "Scheduling constraints"
2276
+ },
2277
+ "durable_objects": {
2278
+ "type": "object",
2798
2279
  "properties": {
2799
- "binding": {
2280
+ "namespace_id": {
2800
2281
  "type": "string"
2801
2282
  }
2802
2283
  },
2803
2284
  "required": [
2804
- "binding"
2285
+ "namespace_id"
2805
2286
  ],
2806
- "type": "object"
2807
- },
2808
- "workers_dev": {
2809
- "default": "`true` (This is a breaking change from Wrangler v1)",
2810
- "description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
2811
- "type": "boolean"
2812
- },
2813
- "zone_id": {
2814
- "description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
2815
- "type": "string"
2816
- }
2817
- },
2818
- "type": "object"
2819
- },
2820
- "Route": {
2821
- "anyOf": [
2822
- {
2823
- "$ref": "#/definitions/SimpleRoute"
2824
- },
2825
- {
2826
- "$ref": "#/definitions/ZoneIdRoute"
2827
- },
2828
- {
2829
- "$ref": "#/definitions/ZoneNameRoute"
2830
- },
2831
- {
2832
- "$ref": "#/definitions/CustomDomainRoute"
2833
- }
2834
- ]
2835
- },
2836
- "Rule": {
2837
- "additionalProperties": false,
2838
- "description": "A bundling resolver rule, defining the modules type for paths that match the specified globs.",
2839
- "properties": {
2840
- "fallthrough": {
2841
- "type": "boolean"
2842
- },
2843
- "globs": {
2844
- "items": {
2845
- "type": "string"
2846
- },
2847
- "type": "array"
2287
+ "additionalProperties": false
2848
2288
  },
2849
- "type": {
2850
- "$ref": "#/definitions/ConfigModuleRuleType"
2289
+ "rollout_step_percentage": {
2290
+ "type": "number",
2291
+ "description": "How a rollout should be done, defining the size of it"
2851
2292
  }
2852
2293
  },
2853
2294
  "required": [
2854
- "type",
2855
- "globs"
2295
+ "name",
2296
+ "class_name",
2297
+ "configuration"
2856
2298
  ],
2857
- "type": "object"
2858
- },
2859
- "SimpleRoute": {
2860
- "type": "string"
2299
+ "additionalProperties": false,
2300
+ "description": "Configuration for a container application"
2861
2301
  },
2862
2302
  "TailConsumer": {
2863
- "additionalProperties": false,
2303
+ "type": "object",
2864
2304
  "properties": {
2865
- "environment": {
2866
- "description": "(Optional) The environt of the service.",
2867
- "type": "string"
2868
- },
2869
2305
  "service": {
2870
- "description": "The name of the service tail events will be forwarded to.",
2871
- "type": "string"
2306
+ "type": "string",
2307
+ "description": "The name of the service tail events will be forwarded to."
2308
+ },
2309
+ "environment": {
2310
+ "type": "string",
2311
+ "description": "(Optional) The environment of the service."
2872
2312
  }
2873
2313
  },
2874
2314
  "required": [
2875
2315
  "service"
2876
2316
  ],
2877
- "type": "object"
2878
- },
2879
- "TypeOf<ZodUnion<[def-class-1315922706-6501-8772-1315922706-0-54395,def-class-1315922706-9299-10989-1315922706-0-54395,def-class-1315922706-12937-13365-1315922706-0-54395,def-class-1315922706-15083-15273-1315922706-0-54395]>>": {
2880
- "type": [
2881
- "string",
2882
- "number",
2883
- "boolean",
2884
- "null"
2885
- ]
2886
- },
2887
- "UserLimits": {
2888
- "additionalProperties": false,
2889
- "properties": {
2890
- "cpu_ms": {
2891
- "description": "Maximum allowed CPU time for a Worker's invocation in milliseconds",
2892
- "type": "number"
2893
- }
2894
- },
2895
- "required": [
2896
- "cpu_ms"
2897
- ],
2898
- "type": "object"
2317
+ "additionalProperties": false
2899
2318
  },
2900
- "ZoneIdRoute": {
2901
- "additionalProperties": false,
2319
+ "DispatchNamespaceOutbound": {
2320
+ "type": "object",
2902
2321
  "properties": {
2903
- "custom_domain": {
2904
- "type": "boolean"
2322
+ "service": {
2323
+ "type": "string",
2324
+ "description": "Name of the service handling the outbound requests"
2905
2325
  },
2906
- "pattern": {
2907
- "type": "string"
2326
+ "environment": {
2327
+ "type": "string",
2328
+ "description": "(Optional) Name of the environment handling the outbound requests."
2908
2329
  },
2909
- "zone_id": {
2910
- "type": "string"
2330
+ "parameters": {
2331
+ "type": "array",
2332
+ "items": {
2333
+ "type": "string"
2334
+ },
2335
+ "description": "(Optional) List of parameter names, for sending context from your dispatch Worker to the outbound handler"
2911
2336
  }
2912
2337
  },
2913
2338
  "required": [
2914
- "pattern",
2915
- "zone_id"
2339
+ "service"
2916
2340
  ],
2917
- "type": "object"
2341
+ "additionalProperties": false
2918
2342
  },
2919
- "ZoneNameRoute": {
2920
- "additionalProperties": false,
2343
+ "RawDevConfig": {
2344
+ "type": "object",
2921
2345
  "properties": {
2922
- "custom_domain": {
2923
- "type": "boolean"
2346
+ "ip": {
2347
+ "type": "string",
2348
+ "description": "IP address for the local dev server to listen on,",
2349
+ "default": "localhost"
2924
2350
  },
2925
- "pattern": {
2926
- "type": "string"
2351
+ "port": {
2352
+ "type": "number",
2353
+ "description": "Port for the local dev server to listen on",
2354
+ "default": 8787
2927
2355
  },
2928
- "zone_name": {
2929
- "type": "string"
2356
+ "inspector_port": {
2357
+ "type": "number",
2358
+ "description": "Port for the local dev server's inspector to listen on",
2359
+ "default": 9229
2360
+ },
2361
+ "local_protocol": {
2362
+ "type": "string",
2363
+ "enum": [
2364
+ "http",
2365
+ "https"
2366
+ ],
2367
+ "description": "Protocol that local wrangler dev server listens to requests on.",
2368
+ "default": "http"
2369
+ },
2370
+ "upstream_protocol": {
2371
+ "type": "string",
2372
+ "enum": [
2373
+ "https",
2374
+ "http"
2375
+ ],
2376
+ "description": "Protocol that wrangler dev forwards requests on\n\nSetting this to `http` is not currently implemented for remote mode. See https://github.com/cloudflare/workers-sdk/issues/583",
2377
+ "default": "https"
2378
+ },
2379
+ "host": {
2380
+ "type": "string",
2381
+ "description": "Host to forward requests to, defaults to the host of the first route of project"
2930
2382
  }
2931
2383
  },
2932
- "required": [
2933
- "pattern",
2934
- "zone_name"
2935
- ],
2936
- "type": "object"
2384
+ "additionalProperties": false
2937
2385
  }
2938
- }
2386
+ },
2387
+ "allowTrailingCommas": true
2939
2388
  }