wrangler 0.0.0-e7a0cd5b → 0.0.0-e81b1611

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (258) hide show
  1. package/README.md +12 -14
  2. package/bin/wrangler.js +19 -65
  3. package/package.json +209 -191
  4. package/templates/__tests__/tsconfig-sanity.ts +12 -0
  5. package/templates/__tests__/tsconfig.json +8 -0
  6. package/templates/checked-fetch.js +19 -6
  7. package/templates/facade.d.ts +17 -0
  8. package/templates/gitignore +1 -0
  9. package/templates/init-tests/test-jest-new-worker.js +3 -5
  10. package/templates/init-tests/test-vitest-new-worker.js +3 -5
  11. package/templates/init-tests/test-vitest-new-worker.ts +25 -0
  12. package/templates/middleware/common.ts +9 -4
  13. package/templates/middleware/loader-modules.ts +64 -11
  14. package/templates/middleware/loader-sw.ts +47 -32
  15. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  16. package/templates/middleware/middleware-miniflare3-json-error.ts +33 -0
  17. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  18. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  19. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  20. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  21. package/templates/modules-watch-stub.js +4 -0
  22. package/templates/new-worker-scheduled.ts +1 -1
  23. package/templates/new-worker.ts +4 -1
  24. package/templates/pages-dev-pipeline.ts +4 -1
  25. package/templates/pages-dev-util.ts +4 -1
  26. package/templates/pages-shim.ts +1 -1
  27. package/templates/pages-template-plugin.ts +31 -12
  28. package/templates/pages-template-worker.ts +11 -2
  29. package/templates/tsconfig-sanity.ts +11 -0
  30. package/templates/tsconfig.init.json +105 -0
  31. package/templates/tsconfig.json +5 -103
  32. package/wrangler-dist/cli.d.ts +951 -121
  33. package/wrangler-dist/cli.js +133766 -143686
  34. package/wrangler-dist/wasm-sync.wasm +0 -0
  35. package/import_meta_url.js +0 -3
  36. package/miniflare-config-stubs/.env.empty +0 -0
  37. package/miniflare-config-stubs/package.empty.json +0 -1
  38. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  39. package/miniflare-dist/index.mjs +0 -6316
  40. package/src/__tests__/access.test.ts +0 -25
  41. package/src/__tests__/api-dev.test.ts +0 -209
  42. package/src/__tests__/api-devregistry.test.js +0 -57
  43. package/src/__tests__/api.test.ts +0 -80
  44. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  45. package/src/__tests__/config-cache.test.ts +0 -42
  46. package/src/__tests__/configuration.test.ts +0 -4028
  47. package/src/__tests__/d1.test.ts +0 -72
  48. package/src/__tests__/delete.test.ts +0 -230
  49. package/src/__tests__/deployments.test.ts +0 -95
  50. package/src/__tests__/dev.test.tsx +0 -1509
  51. package/src/__tests__/dialogs.test.tsx +0 -40
  52. package/src/__tests__/generate.test.ts +0 -235
  53. package/src/__tests__/get-host-from-url.test.ts +0 -16
  54. package/src/__tests__/guess-worker-format.test.ts +0 -85
  55. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  56. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  57. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  58. package/src/__tests__/helpers/mock-bin.ts +0 -36
  59. package/src/__tests__/helpers/mock-cfetch.ts +0 -333
  60. package/src/__tests__/helpers/mock-console.ts +0 -106
  61. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  62. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  63. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  64. package/src/__tests__/helpers/mock-istty.ts +0 -74
  65. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  66. package/src/__tests__/helpers/mock-kv.ts +0 -33
  67. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -252
  68. package/src/__tests__/helpers/mock-process.ts +0 -39
  69. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  70. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  71. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  72. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -59
  73. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  74. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -36
  75. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  76. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  77. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  78. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -22
  79. package/src/__tests__/helpers/msw/index.ts +0 -21
  80. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  81. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  82. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  83. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  84. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  85. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  86. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  87. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  88. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  89. package/src/__tests__/https-options.test.ts +0 -163
  90. package/src/__tests__/index.test.ts +0 -262
  91. package/src/__tests__/init.test.ts +0 -2900
  92. package/src/__tests__/jest.setup.ts +0 -202
  93. package/src/__tests__/kv.test.ts +0 -1675
  94. package/src/__tests__/logger.test.ts +0 -141
  95. package/src/__tests__/metrics.test.ts +0 -450
  96. package/src/__tests__/middleware.scheduled.test.ts +0 -135
  97. package/src/__tests__/middleware.test.ts +0 -726
  98. package/src/__tests__/package-manager.test.ts +0 -353
  99. package/src/__tests__/pages.test.ts +0 -2223
  100. package/src/__tests__/parse.test.ts +0 -330
  101. package/src/__tests__/paths.test.ts +0 -39
  102. package/src/__tests__/publish.test.ts +0 -7660
  103. package/src/__tests__/pubsub.test.ts +0 -370
  104. package/src/__tests__/queues.test.ts +0 -371
  105. package/src/__tests__/r2.test.ts +0 -376
  106. package/src/__tests__/route.test.ts +0 -45
  107. package/src/__tests__/secret.test.ts +0 -644
  108. package/src/__tests__/tail.test.ts +0 -800
  109. package/src/__tests__/test-old-node-version.js +0 -31
  110. package/src/__tests__/type-generation.test.ts +0 -217
  111. package/src/__tests__/user.test.ts +0 -155
  112. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  113. package/src/__tests__/validate-dev-props.test.ts +0 -56
  114. package/src/__tests__/version.test.ts +0 -35
  115. package/src/__tests__/whoami.test.tsx +0 -278
  116. package/src/__tests__/worker-namespace.test.ts +0 -326
  117. package/src/abort.d.ts +0 -3
  118. package/src/api/dev.ts +0 -208
  119. package/src/api/index.ts +0 -2
  120. package/src/bundle-reporter.tsx +0 -68
  121. package/src/bundle.ts +0 -785
  122. package/src/cfetch/index.ts +0 -160
  123. package/src/cfetch/internal.ts +0 -263
  124. package/src/cli.ts +0 -28
  125. package/src/config/README.md +0 -107
  126. package/src/config/config.ts +0 -275
  127. package/src/config/diagnostics.ts +0 -80
  128. package/src/config/environment.ts +0 -563
  129. package/src/config/index.ts +0 -342
  130. package/src/config/validation-helpers.ts +0 -597
  131. package/src/config/validation.ts +0 -2113
  132. package/src/config-cache.ts +0 -85
  133. package/src/create-worker-preview.ts +0 -282
  134. package/src/create-worker-upload-form.ts +0 -321
  135. package/src/d1/backups.tsx +0 -218
  136. package/src/d1/create.tsx +0 -54
  137. package/src/d1/delete.tsx +0 -56
  138. package/src/d1/execute.tsx +0 -299
  139. package/src/d1/formatTimeAgo.ts +0 -14
  140. package/src/d1/index.ts +0 -76
  141. package/src/d1/list.tsx +0 -48
  142. package/src/d1/options.ts +0 -12
  143. package/src/d1/types.tsx +0 -14
  144. package/src/d1/utils.ts +0 -39
  145. package/src/delete.ts +0 -108
  146. package/src/deployments.ts +0 -74
  147. package/src/deprecated/index.ts +0 -438
  148. package/src/dev/dev-vars.ts +0 -39
  149. package/src/dev/dev.tsx +0 -587
  150. package/src/dev/get-local-persistence-path.tsx +0 -31
  151. package/src/dev/local.tsx +0 -717
  152. package/src/dev/remote.tsx +0 -603
  153. package/src/dev/start-server.ts +0 -513
  154. package/src/dev/use-esbuild.ts +0 -204
  155. package/src/dev/validate-dev-props.ts +0 -31
  156. package/src/dev-registry.tsx +0 -201
  157. package/src/dev.tsx +0 -869
  158. package/src/dialogs.tsx +0 -163
  159. package/src/dispatch-namespace.ts +0 -207
  160. package/src/durable.ts +0 -102
  161. package/src/entry.ts +0 -329
  162. package/src/environment-variables.ts +0 -50
  163. package/src/errors.ts +0 -11
  164. package/src/git-client.ts +0 -124
  165. package/src/global-wrangler-config-path.ts +0 -26
  166. package/src/https-options.ts +0 -127
  167. package/src/index.tsx +0 -684
  168. package/src/init.ts +0 -970
  169. package/src/inspect.ts +0 -767
  170. package/src/intl-polyfill.d.ts +0 -139
  171. package/src/is-ci.ts +0 -14
  172. package/src/is-interactive.ts +0 -16
  173. package/src/kv/helpers.ts +0 -430
  174. package/src/kv/index.ts +0 -596
  175. package/src/logger.ts +0 -92
  176. package/src/metrics/index.ts +0 -5
  177. package/src/metrics/metrics-config.ts +0 -239
  178. package/src/metrics/metrics-dispatcher.ts +0 -96
  179. package/src/metrics/metrics-usage-headers.ts +0 -24
  180. package/src/metrics/send-event.ts +0 -94
  181. package/src/miniflare-cli/README.md +0 -30
  182. package/src/miniflare-cli/assets.ts +0 -215
  183. package/src/miniflare-cli/index.ts +0 -213
  184. package/src/miniflare-cli/request-context.ts +0 -40
  185. package/src/module-collection.ts +0 -267
  186. package/src/open-in-browser.ts +0 -17
  187. package/src/package-manager.ts +0 -219
  188. package/src/pages/build.tsx +0 -238
  189. package/src/pages/constants.ts +0 -18
  190. package/src/pages/deployments.tsx +0 -106
  191. package/src/pages/dev.tsx +0 -693
  192. package/src/pages/errors.ts +0 -66
  193. package/src/pages/functions/buildPlugin.ts +0 -110
  194. package/src/pages/functions/buildWorker.ts +0 -156
  195. package/src/pages/functions/filepath-routing.test.ts +0 -234
  196. package/src/pages/functions/filepath-routing.ts +0 -189
  197. package/src/pages/functions/identifiers.ts +0 -78
  198. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  199. package/src/pages/functions/routes-consolidation.ts +0 -73
  200. package/src/pages/functions/routes-transformation.test.ts +0 -282
  201. package/src/pages/functions/routes-transformation.ts +0 -115
  202. package/src/pages/functions/routes-validation.test.ts +0 -403
  203. package/src/pages/functions/routes-validation.ts +0 -202
  204. package/src/pages/functions/routes.ts +0 -151
  205. package/src/pages/functions.tsx +0 -82
  206. package/src/pages/hash.tsx +0 -13
  207. package/src/pages/index.tsx +0 -94
  208. package/src/pages/projects.tsx +0 -169
  209. package/src/pages/publish.tsx +0 -436
  210. package/src/pages/types.ts +0 -49
  211. package/src/pages/upload.tsx +0 -425
  212. package/src/pages/utils.ts +0 -12
  213. package/src/parse.ts +0 -286
  214. package/src/paths.ts +0 -71
  215. package/src/proxy.ts +0 -689
  216. package/src/publish/index.ts +0 -270
  217. package/src/publish/publish.ts +0 -1035
  218. package/src/pubsub/index.ts +0 -286
  219. package/src/pubsub/pubsub-commands.tsx +0 -624
  220. package/src/queues/cli/commands/consumer/add.ts +0 -71
  221. package/src/queues/cli/commands/consumer/index.ts +0 -22
  222. package/src/queues/cli/commands/consumer/remove.ts +0 -38
  223. package/src/queues/cli/commands/create.ts +0 -25
  224. package/src/queues/cli/commands/delete.ts +0 -26
  225. package/src/queues/cli/commands/index.ts +0 -33
  226. package/src/queues/cli/commands/list.ts +0 -25
  227. package/src/queues/client.ts +0 -135
  228. package/src/r2/helpers.ts +0 -131
  229. package/src/r2/index.ts +0 -277
  230. package/src/routes.ts +0 -140
  231. package/src/secret/index.ts +0 -379
  232. package/src/selfsigned.d.ts +0 -29
  233. package/src/sites.tsx +0 -372
  234. package/src/tail/createTail.ts +0 -315
  235. package/src/tail/filters.ts +0 -277
  236. package/src/tail/index.ts +0 -214
  237. package/src/tail/printing.ts +0 -107
  238. package/src/type-generation.ts +0 -159
  239. package/src/update-check.ts +0 -19
  240. package/src/user/access.ts +0 -69
  241. package/src/user/choose-account.tsx +0 -69
  242. package/src/user/env-vars.ts +0 -46
  243. package/src/user/generate-auth-url.ts +0 -33
  244. package/src/user/generate-random-state.ts +0 -16
  245. package/src/user/index.ts +0 -3
  246. package/src/user/user.tsx +0 -1192
  247. package/src/utils/collectKeyValues.ts +0 -14
  248. package/src/whoami.tsx +0 -169
  249. package/src/worker.ts +0 -242
  250. package/src/yargs-types.ts +0 -20
  251. package/src/zones.ts +0 -191
  252. package/templates/d1-beta-facade.js +0 -174
  253. package/templates/experimental-local-cache-stubs.js +0 -27
  254. package/templates/first-party-worker-module-facade.ts +0 -18
  255. package/templates/format-dev-errors.ts +0 -32
  256. package/templates/serve-static-assets.ts +0 -63
  257. package/templates/service-bindings-module-facade.js +0 -54
  258. package/templates/service-bindings-sw-facade.js +0 -42
@@ -1,38 +0,0 @@
1
- import { type Argv } from "yargs";
2
- import { readConfig } from "../../../../config";
3
- import { logger } from "../../../../logger";
4
- import { deleteConsumer } from "../../../client";
5
- import type { CommonYargsOptions } from "../../../../yargs-types";
6
-
7
- type Args = CommonYargsOptions & {
8
- config?: string;
9
- ["queue-name"]: string;
10
- ["script-name"]: string;
11
- };
12
-
13
- export function options(yargs: Argv<CommonYargsOptions>): Argv<Args> {
14
- return yargs
15
- .positional("queue-name", {
16
- type: "string",
17
- demandOption: true,
18
- description: "Name of the queue to configure",
19
- })
20
- .positional("script-name", {
21
- type: "string",
22
- demandOption: true,
23
- description: "Name of the consumer script",
24
- });
25
- }
26
-
27
- export async function handler(args: Args) {
28
- const config = readConfig(args.config, args);
29
-
30
- logger.log(`Removing consumer from queue ${args["queue-name"]}.`);
31
- await deleteConsumer(
32
- config,
33
- args["queue-name"],
34
- args["script-name"],
35
- args.env
36
- );
37
- logger.log(`Removed consumer from queue ${args["queue-name"]}.`);
38
- }
@@ -1,25 +0,0 @@
1
- import { type Argv } from "yargs";
2
- import { readConfig } from "../../../config";
3
- import { logger } from "../../../logger";
4
- import { createQueue } from "../../client";
5
-
6
- interface Args {
7
- config?: string;
8
- name: string;
9
- }
10
-
11
- export function options(yargs: Argv): Argv<Args> {
12
- return yargs.positional("name", {
13
- type: "string",
14
- demandOption: true,
15
- description: "The name of the queue",
16
- });
17
- }
18
-
19
- export async function handler(args: Args) {
20
- const config = readConfig(args.config, args);
21
-
22
- logger.log(`Creating queue ${args.name}.`);
23
- await createQueue(config, { queue_name: args.name });
24
- logger.log(`Created queue ${args.name}.`);
25
- }
@@ -1,26 +0,0 @@
1
- import { type Argv } from "yargs";
2
- import { readConfig } from "../../../config";
3
- import { logger } from "../../../logger";
4
- import { deleteQueue } from "../../client";
5
-
6
- interface Args {
7
- config?: string;
8
- name: string;
9
- }
10
-
11
- export function options(yargs: Argv): Argv<Args> {
12
- // TODO(soon) --force option
13
- return yargs.positional("name", {
14
- type: "string",
15
- demandOption: true,
16
- description: "The name of the queue",
17
- });
18
- }
19
-
20
- export async function handler(args: Args) {
21
- const config = readConfig(args.config, args);
22
-
23
- logger.log(`Deleting queue ${args.name}.`);
24
- await deleteQueue(config, args.name);
25
- logger.log(`Deleted queue ${args.name}.`);
26
- }
@@ -1,33 +0,0 @@
1
- import { type BuilderCallback } from "yargs";
2
- import { type CommonYargsOptions } from "../../../yargs-types";
3
- import { consumers } from "./consumer";
4
-
5
- import { options as createOptions, handler as createHandler } from "./create";
6
- import { options as deleteOptions, handler as deleteHandler } from "./delete";
7
- import { options as listOptions, handler as listHandler } from "./list";
8
-
9
- export const queues: BuilderCallback<CommonYargsOptions, unknown> = (yargs) => {
10
- yargs.command("list", "List Queues", listOptions, listHandler);
11
-
12
- yargs.command(
13
- "create <name>",
14
- "Create a Queue",
15
- createOptions,
16
- createHandler
17
- );
18
-
19
- yargs.command(
20
- "delete <name>",
21
- "Delete a Queue",
22
- deleteOptions,
23
- deleteHandler
24
- );
25
-
26
- yargs.command(
27
- "consumer",
28
- "Configure Queue Consumers",
29
- async (consumersYargs) => {
30
- await consumers(consumersYargs);
31
- }
32
- );
33
- };
@@ -1,25 +0,0 @@
1
- import { type Argv } from "yargs";
2
- import { readConfig } from "../../../config";
3
- import { logger } from "../../../logger";
4
- import { listQueues } from "../../client";
5
-
6
- interface Args {
7
- config?: string;
8
- page?: number;
9
- }
10
-
11
- export function options(yargs: Argv): Argv<Args> {
12
- return yargs.options({
13
- page: {
14
- type: "number",
15
- describe: "Page number for pagination",
16
- },
17
- });
18
- }
19
-
20
- export async function handler(args: Args) {
21
- const config = readConfig(args.config, args);
22
-
23
- const queues = await listQueues(config, args.page);
24
- logger.log(JSON.stringify(queues));
25
- }
@@ -1,135 +0,0 @@
1
- import { fetchResult } from "../cfetch";
2
- import { type Config } from "../config";
3
- import { requireAuth } from "../user";
4
-
5
- export async function createQueue(
6
- config: Config,
7
- body: CreateQueueBody
8
- ): Promise<QueueResponse> {
9
- const accountId = await requireAuth(config);
10
- return await fetchResult(`/accounts/${accountId}/workers/queues`, {
11
- method: "POST",
12
- body: JSON.stringify(body),
13
- });
14
- }
15
-
16
- export interface CreateQueueBody {
17
- queue_name: string;
18
- }
19
-
20
- export interface QueueResponse {
21
- queue_name: string;
22
- created_on: string;
23
- modified_on: string;
24
- }
25
-
26
- export async function deleteQueue(
27
- config: Config,
28
- queueName: string
29
- ): Promise<void> {
30
- const accountId = await requireAuth(config);
31
- return await fetchResult(
32
- `/accounts/${accountId}/workers/queues/${queueName}`,
33
- {
34
- method: "DELETE",
35
- }
36
- );
37
- }
38
-
39
- // TODO(soon) show detailed queue response
40
- export async function listQueues(
41
- config: Config,
42
- page?: number
43
- ): Promise<QueueResponse[]> {
44
- page = page ?? 1;
45
- const accountId = await requireAuth(config);
46
- return await fetchResult(
47
- `/accounts/${accountId}/workers/queues`,
48
- {},
49
- new URLSearchParams({ page: page.toString() })
50
- );
51
- }
52
-
53
- export async function getQueue(
54
- config: Config,
55
- queueName: string
56
- ): Promise<QueueResponse> {
57
- const accountId = await requireAuth(config);
58
- return await fetchResult(
59
- `/accounts/${accountId}/workers/queues/${queueName}`,
60
- {}
61
- );
62
- }
63
-
64
- export async function postConsumer(
65
- config: Config,
66
- queueName: string,
67
- body: PostConsumerBody
68
- ): Promise<ConsumerResponse> {
69
- const accountId = await requireAuth(config);
70
- return fetchResult(
71
- `/accounts/${accountId}/workers/queues/${queueName}/consumers`,
72
- {
73
- method: "POST",
74
- body: JSON.stringify(body),
75
- }
76
- );
77
- }
78
-
79
- export interface PutConsumerBody {
80
- settings: ConsumerSettings;
81
- dead_letter_queue?: string;
82
- }
83
-
84
- export interface PostConsumerBody extends PutConsumerBody {
85
- script_name: string;
86
- environment_name: string;
87
- }
88
-
89
- export interface ConsumerSettings {
90
- batch_size?: number;
91
- max_retries?: number;
92
- max_wait_time_ms?: number;
93
- }
94
-
95
- export interface ConsumerResponse extends PostConsumerBody {
96
- queue_name: string;
97
- script_name: string;
98
- environment_name: string;
99
- settings: ConsumerSettings;
100
- dead_letter_queue?: string;
101
- }
102
-
103
- export async function deleteConsumer(
104
- config: Config,
105
- queueName: string,
106
- scriptName: string,
107
- envName?: string
108
- ): Promise<void> {
109
- const accountId = await requireAuth(config);
110
- let resource = `/accounts/${accountId}/workers/queues/${queueName}/consumers/${scriptName}`;
111
- if (envName !== undefined) {
112
- resource += `/environments/${envName}`;
113
- }
114
- return fetchResult(resource, {
115
- method: "DELETE",
116
- });
117
- }
118
-
119
- export async function putConsumer(
120
- config: Config,
121
- queueName: string,
122
- scriptName: string,
123
- envName: string | undefined,
124
- body: PutConsumerBody
125
- ): Promise<ConsumerResponse> {
126
- const accountId = await requireAuth(config);
127
- let resource = `/accounts/${accountId}/workers/queues/${queueName}/consumers/${scriptName}`;
128
- if (envName !== undefined) {
129
- resource += `/environments/${envName}`;
130
- }
131
- return fetchResult(resource, {
132
- method: "PUT",
133
- body: JSON.stringify(body),
134
- });
135
- }
package/src/r2/helpers.ts DELETED
@@ -1,131 +0,0 @@
1
- import { Readable } from "node:stream";
2
- import { fetchResult } from "../cfetch";
3
- import { fetchR2Objects } from "../cfetch/internal";
4
- import type { HeadersInit } from "undici";
5
-
6
- /**
7
- * Information about a bucket, returned from `listR2Buckets()`.
8
- */
9
- export interface R2BucketInfo {
10
- name: string;
11
- creation_date: string;
12
- }
13
-
14
- /**
15
- * Fetch a list of all the buckets under the given `accountId`.
16
- */
17
- export async function listR2Buckets(
18
- accountId: string
19
- ): Promise<R2BucketInfo[]> {
20
- const results = await fetchResult<{
21
- buckets: R2BucketInfo[];
22
- }>(`/accounts/${accountId}/r2/buckets`);
23
- return results.buckets;
24
- }
25
-
26
- /**
27
- * Create a bucket with the given `bucketName` within the account given by `accountId`.
28
- *
29
- * A 400 is returned if the account already owns a bucket with this name.
30
- * A bucket must be explicitly deleted to be replaced.
31
- */
32
- export async function createR2Bucket(
33
- accountId: string,
34
- bucketName: string
35
- ): Promise<void> {
36
- return await fetchResult<void>(`/accounts/${accountId}/r2/buckets`, {
37
- method: "POST",
38
- body: JSON.stringify({ name: bucketName }),
39
- });
40
- }
41
-
42
- /**
43
- * Delete a bucket with the given name
44
- */
45
- export async function deleteR2Bucket(
46
- accountId: string,
47
- bucketName: string
48
- ): Promise<void> {
49
- return await fetchResult<void>(
50
- `/accounts/${accountId}/r2/buckets/${bucketName}`,
51
- { method: "DELETE" }
52
- );
53
- }
54
-
55
- export function bucketAndKeyFromObjectPath(objectPath = ""): {
56
- bucket: string;
57
- key: string;
58
- } {
59
- const match = /^([^/]+)\/(.*)/.exec(objectPath);
60
- if (match === null) {
61
- throw new Error(
62
- `The object path must be in the form of {bucket}/{key} you provided ${objectPath}`
63
- );
64
- }
65
-
66
- return { bucket: match[1], key: match[2] };
67
- }
68
-
69
- /**
70
- * Downloads an object
71
- */
72
- export async function getR2Object(
73
- accountId: string,
74
- bucketName: string,
75
- objectName: string
76
- ): Promise<Readable> {
77
- const response = await fetchR2Objects(
78
- `/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
79
- { method: "GET" }
80
- );
81
-
82
- return Readable.from(response.body);
83
- }
84
-
85
- /**
86
- * Uploads an object
87
- */
88
- export async function putR2Object(
89
- accountId: string,
90
- bucketName: string,
91
- objectName: string,
92
- object: Readable | Buffer,
93
- options: Record<string, unknown>
94
- ): Promise<void> {
95
- const headerKeys = [
96
- "content-length",
97
- "content-type",
98
- "content-disposition",
99
- "content-encoding",
100
- "content-language",
101
- "cache-control",
102
- "expires",
103
- ];
104
- const headers: HeadersInit = {};
105
- for (const key of headerKeys) {
106
- const value = options[key] || "";
107
- if (value && typeof value === "string") headers[key] = value;
108
- }
109
-
110
- await fetchR2Objects(
111
- `/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
112
- {
113
- body: object,
114
- headers,
115
- method: "PUT",
116
- }
117
- );
118
- }
119
- /**
120
- * Delete an Object
121
- */
122
- export async function deleteR2Object(
123
- accountId: string,
124
- bucketName: string,
125
- objectName: string
126
- ): Promise<void> {
127
- await fetchR2Objects(
128
- `/accounts/${accountId}/r2/buckets/${bucketName}/objects/${objectName}`,
129
- { method: "DELETE" }
130
- );
131
- }
package/src/r2/index.ts DELETED
@@ -1,277 +0,0 @@
1
- import * as fs from "node:fs";
2
- import * as stream from "node:stream";
3
-
4
- import { readConfig } from "../config";
5
- import { CommandLineArgsError, printWranglerBanner } from "../index";
6
- import { logger } from "../logger";
7
- import * as metrics from "../metrics";
8
- import { requireAuth } from "../user";
9
- import {
10
- bucketAndKeyFromObjectPath,
11
- createR2Bucket,
12
- deleteR2Bucket,
13
- deleteR2Object,
14
- getR2Object,
15
- listR2Buckets,
16
- putR2Object,
17
- } from "./helpers";
18
-
19
- import type { ConfigPath } from "../index";
20
- import type { Readable } from "node:stream";
21
- import type { BuilderCallback } from "yargs";
22
-
23
- export const r2: BuilderCallback<unknown, unknown> = (r2Yargs) => {
24
- return r2Yargs
25
- .command("object", "Manage R2 objects", (r2ObjectYargs) => {
26
- return r2ObjectYargs
27
- .command(
28
- "get <objectPath>",
29
- "Fetch an object from an R2 bucket",
30
- (Objectyargs) => {
31
- return Objectyargs.positional("objectPath", {
32
- describe: "The source object path in the form of {bucket}/{key}",
33
- type: "string",
34
- })
35
- .option("file", {
36
- describe: "The destination file to create",
37
- alias: "f",
38
- conflicts: "pipe",
39
- requiresArg: true,
40
- type: "string",
41
- })
42
- .option("pipe", {
43
- describe:
44
- "Enables the file to be piped to a destination, rather than specified with the --file option",
45
- alias: "p",
46
- conflicts: "file",
47
- type: "boolean",
48
- });
49
- },
50
- async (objectGetYargs) => {
51
- const config = readConfig(
52
- objectGetYargs.config as ConfigPath,
53
- objectGetYargs
54
- );
55
- const accountId = await requireAuth(config);
56
- const { objectPath, pipe } = objectGetYargs;
57
- const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
58
-
59
- let file = objectGetYargs.file;
60
- if (!file && !pipe) {
61
- file = key;
62
- }
63
- if (!pipe) {
64
- await printWranglerBanner();
65
- logger.log(`Downloading "${key}" from "${bucket}".`);
66
- }
67
- const input = await getR2Object(accountId, bucket, key);
68
- const output = file ? fs.createWriteStream(file) : process.stdout;
69
- await new Promise<void>((resolve, reject) => {
70
- stream.pipeline(input, output, (err: unknown) => {
71
- err ? reject(err) : resolve();
72
- });
73
- });
74
- if (!pipe) logger.log("Download complete.");
75
- }
76
- )
77
- .command(
78
- "put <objectPath>",
79
- "Create an object in an R2 bucket",
80
- (Objectyargs) => {
81
- return Objectyargs.positional("objectPath", {
82
- describe:
83
- "The destination object path in the form of {bucket}/{key}",
84
- type: "string",
85
- })
86
- .option("file", {
87
- describe: "The path of the file to upload",
88
- alias: "f",
89
- conflicts: "pipe",
90
- requiresArg: true,
91
- type: "string",
92
- })
93
- .option("pipe", {
94
- describe:
95
- "Enables the file to be piped in, rather than specified with the --file option",
96
- alias: "p",
97
- conflicts: "file",
98
- type: "boolean",
99
- })
100
- .option("content-type", {
101
- describe:
102
- "A standard MIME type describing the format of the object data",
103
- alias: "ct",
104
- requiresArg: true,
105
- type: "string",
106
- })
107
- .option("content-disposition", {
108
- describe: "Specifies presentational information for the object",
109
- alias: "cd",
110
- requiresArg: true,
111
- type: "string",
112
- })
113
- .option("content-encoding", {
114
- describe:
115
- "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field",
116
- alias: "ce",
117
- requiresArg: true,
118
- type: "string",
119
- })
120
- .option("content-language", {
121
- describe: "The language the content is in",
122
- alias: "cl",
123
- requiresArg: true,
124
- type: "string",
125
- })
126
- .option("cache-control", {
127
- describe:
128
- "Specifies caching behavior along the request/reply chain",
129
- alias: "cc",
130
- requiresArg: true,
131
- type: "string",
132
- })
133
- .option("expires", {
134
- describe:
135
- "The date and time at which the object is no longer cacheable",
136
- alias: "e",
137
- requiresArg: true,
138
- type: "string",
139
- });
140
- },
141
- async (objectPutYargs) => {
142
- await printWranglerBanner();
143
-
144
- const config = readConfig(
145
- objectPutYargs.config as ConfigPath,
146
- objectPutYargs
147
- );
148
- const accountId = await requireAuth(config);
149
- const { objectPath, file, pipe, ...options } = objectPutYargs;
150
- const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
151
- if (!file && !pipe) {
152
- throw new CommandLineArgsError(
153
- "Either the --file or --pipe options are required."
154
- );
155
- }
156
- let object: Readable | Buffer;
157
- let objectSize: number;
158
- if (file) {
159
- object = fs.createReadStream(file);
160
- const stats = fs.statSync(file);
161
- objectSize = stats.size;
162
- } else {
163
- object = await new Promise<Buffer>((resolve, reject) => {
164
- const stdin = process.stdin;
165
- const chunks = Array<Buffer>();
166
- stdin.on("data", (chunk) => chunks.push(chunk));
167
- stdin.on("end", () => resolve(Buffer.concat(chunks)));
168
- stdin.on("error", (err) =>
169
- reject(
170
- new CommandLineArgsError(
171
- `Could not pipe. Reason: "${err.message}"`
172
- )
173
- )
174
- );
175
- });
176
- objectSize = object.byteLength;
177
- }
178
-
179
- logger.log(`Creating object "${key}" in bucket "${bucket}".`);
180
- await putR2Object(accountId, bucket, key, object, {
181
- ...options,
182
- "content-length": `${objectSize}`,
183
- });
184
- logger.log("Upload complete.");
185
- }
186
- )
187
- .command(
188
- "delete <objectPath>",
189
- "Delete an object in an R2 bucket",
190
- (objectDeleteYargs) => {
191
- return objectDeleteYargs.positional("objectPath", {
192
- describe:
193
- "The destination object path in the form of {bucket}/{key}",
194
- type: "string",
195
- });
196
- },
197
- async (args) => {
198
- const { objectPath } = args;
199
- await printWranglerBanner();
200
-
201
- const config = readConfig(args.config as ConfigPath, args);
202
- const accountId = await requireAuth(config);
203
- const { bucket, key } = bucketAndKeyFromObjectPath(objectPath);
204
- logger.log(`Deleting object "${key}" from bucket "${bucket}".`);
205
-
206
- await deleteR2Object(accountId, bucket, key);
207
- logger.log("Delete complete.");
208
- }
209
- );
210
- })
211
-
212
- .command("bucket", "Manage R2 buckets", (r2BucketYargs) => {
213
- r2BucketYargs.command(
214
- "create <name>",
215
- "Create a new R2 bucket",
216
- (yargs) => {
217
- return yargs.positional("name", {
218
- describe: "The name of the new bucket",
219
- type: "string",
220
- demandOption: true,
221
- });
222
- },
223
- async (args) => {
224
- await printWranglerBanner();
225
-
226
- const config = readConfig(args.config as ConfigPath, args);
227
-
228
- const accountId = await requireAuth(config);
229
-
230
- logger.log(`Creating bucket ${args.name}.`);
231
- await createR2Bucket(accountId, args.name);
232
- logger.log(`Created bucket ${args.name}.`);
233
- await metrics.sendMetricsEvent("create r2 bucket", {
234
- sendMetrics: config.send_metrics,
235
- });
236
- }
237
- );
238
-
239
- r2BucketYargs.command("list", "List R2 buckets", {}, async (args) => {
240
- const config = readConfig(args.config as ConfigPath, args);
241
-
242
- const accountId = await requireAuth(config);
243
-
244
- logger.log(JSON.stringify(await listR2Buckets(accountId), null, 2));
245
- await metrics.sendMetricsEvent("list r2 buckets", {
246
- sendMetrics: config.send_metrics,
247
- });
248
- });
249
-
250
- r2BucketYargs.command(
251
- "delete <name>",
252
- "Delete an R2 bucket",
253
- (yargs) => {
254
- return yargs.positional("name", {
255
- describe: "The name of the bucket to delete",
256
- type: "string",
257
- demandOption: true,
258
- });
259
- },
260
- async (args) => {
261
- await printWranglerBanner();
262
-
263
- const config = readConfig(args.config as ConfigPath, args);
264
-
265
- const accountId = await requireAuth(config);
266
-
267
- logger.log(`Deleting bucket ${args.name}.`);
268
- await deleteR2Bucket(accountId, args.name);
269
- logger.log(`Deleted bucket ${args.name}.`);
270
- await metrics.sendMetricsEvent("delete r2 bucket", {
271
- sendMetrics: config.send_metrics,
272
- });
273
- }
274
- );
275
- return r2BucketYargs;
276
- });
277
- };