wrangler 0.0.0-e1c2f5b9 → 0.0.0-e1d50407

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 (287) hide show
  1. package/README.md +12 -14
  2. package/bin/wrangler.js +14 -75
  3. package/package.json +213 -194
  4. package/templates/__tests__/tsconfig.json +1 -1
  5. package/templates/checked-fetch.js +19 -6
  6. package/templates/facade.d.ts +4 -1
  7. package/templates/gitignore +1 -0
  8. package/templates/init-tests/test-vitest-new-worker.ts +1 -1
  9. package/templates/middleware/common.ts +9 -4
  10. package/templates/middleware/loader-modules.ts +64 -9
  11. package/templates/middleware/loader-sw.ts +2 -7
  12. package/templates/middleware/middleware-d1-beta.d.ts +3 -0
  13. package/templates/middleware/middleware-miniflare3-json-error.ts +18 -5
  14. package/templates/middleware/middleware-multiworker-dev.d.ts +4 -0
  15. package/templates/middleware/middleware-multiworker-dev.ts +68 -0
  16. package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
  17. package/templates/middleware/middleware-serve-static-assets.ts +56 -0
  18. package/templates/modules-watch-stub.js +4 -0
  19. package/templates/new-worker-scheduled.ts +1 -1
  20. package/templates/new-worker.ts +4 -1
  21. package/templates/pages-dev-util.ts +4 -1
  22. package/templates/pages-shim.ts +0 -3
  23. package/templates/pages-template-plugin.ts +30 -11
  24. package/templates/pages-template-worker.ts +11 -2
  25. package/templates/startDevWorker/InspectorProxyWorker.ts +652 -0
  26. package/templates/startDevWorker/ProxyWorker.ts +252 -0
  27. package/templates/tsconfig.init.json +1 -2
  28. package/templates/tsconfig.json +1 -1
  29. package/wrangler-dist/InspectorProxyWorker.js +460 -0
  30. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  31. package/wrangler-dist/ProxyWorker.js +186 -0
  32. package/wrangler-dist/ProxyWorker.js.map +6 -0
  33. package/wrangler-dist/cli.d.ts +23110 -509
  34. package/wrangler-dist/cli.js +133619 -137696
  35. package/wrangler-dist/wasm-sync.wasm +0 -0
  36. package/import_meta_url.js +0 -3
  37. package/miniflare-config-stubs/.env.empty +0 -0
  38. package/miniflare-config-stubs/package.empty.json +0 -1
  39. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  40. package/miniflare-dist/index.mjs +0 -6364
  41. package/src/__tests__/access.test.ts +0 -25
  42. package/src/__tests__/api-dev.test.ts +0 -238
  43. package/src/__tests__/api-devregistry.test.js +0 -64
  44. package/src/__tests__/api.test.ts +0 -80
  45. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  46. package/src/__tests__/config-cache.test.ts +0 -42
  47. package/src/__tests__/configuration.test.ts +0 -4163
  48. package/src/__tests__/d1.test.ts +0 -123
  49. package/src/__tests__/delete.test.ts +0 -263
  50. package/src/__tests__/deployments.test.ts +0 -105
  51. package/src/__tests__/dev.test.tsx +0 -1586
  52. package/src/__tests__/dialogs.test.tsx +0 -40
  53. package/src/__tests__/generate.test.ts +0 -235
  54. package/src/__tests__/get-host-from-url.test.ts +0 -16
  55. package/src/__tests__/guess-worker-format.test.ts +0 -85
  56. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  57. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  58. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  59. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  60. package/src/__tests__/helpers/mock-bin.ts +0 -36
  61. package/src/__tests__/helpers/mock-cfetch.ts +0 -277
  62. package/src/__tests__/helpers/mock-console.ts +0 -106
  63. package/src/__tests__/helpers/mock-dialogs.ts +0 -153
  64. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -8
  65. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  66. package/src/__tests__/helpers/mock-istty.ts +0 -74
  67. package/src/__tests__/helpers/mock-known-routes.ts +0 -7
  68. package/src/__tests__/helpers/mock-kv.ts +0 -33
  69. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -271
  70. package/src/__tests__/helpers/mock-process.ts +0 -34
  71. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  72. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  73. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  74. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -59
  75. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -104
  76. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  77. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -80
  78. package/src/__tests__/helpers/msw/handlers/script.ts +0 -75
  79. package/src/__tests__/helpers/msw/handlers/user.ts +0 -63
  80. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -22
  81. package/src/__tests__/helpers/msw/index.ts +0 -21
  82. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  83. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  84. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  85. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  86. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  87. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  88. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  89. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  90. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  91. package/src/__tests__/https-options.test.ts +0 -163
  92. package/src/__tests__/index.test.ts +0 -268
  93. package/src/__tests__/init.test.ts +0 -3094
  94. package/src/__tests__/jest.setup.ts +0 -203
  95. package/src/__tests__/kv.test.ts +0 -1786
  96. package/src/__tests__/logger.test.ts +0 -141
  97. package/src/__tests__/logout.test.ts +0 -47
  98. package/src/__tests__/metrics.test.ts +0 -495
  99. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  100. package/src/__tests__/middleware.test.ts +0 -750
  101. package/src/__tests__/package-manager.test.ts +0 -353
  102. package/src/__tests__/pages-deployment-tail.test.ts +0 -884
  103. package/src/__tests__/pages.test.ts +0 -2443
  104. package/src/__tests__/parse.test.ts +0 -330
  105. package/src/__tests__/paths.test.ts +0 -39
  106. package/src/__tests__/publish.test.ts +0 -7757
  107. package/src/__tests__/pubsub.test.ts +0 -490
  108. package/src/__tests__/queues.test.ts +0 -522
  109. package/src/__tests__/r2.test.ts +0 -393
  110. package/src/__tests__/route.test.ts +0 -45
  111. package/src/__tests__/secret.test.ts +0 -694
  112. package/src/__tests__/tail.test.ts +0 -899
  113. package/src/__tests__/test-old-node-version.js +0 -31
  114. package/src/__tests__/tsconfig-sanity.ts +0 -12
  115. package/src/__tests__/tsconfig.json +0 -8
  116. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  117. package/src/__tests__/type-generation.test.ts +0 -233
  118. package/src/__tests__/user.test.ts +0 -129
  119. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  120. package/src/__tests__/validate-dev-props.test.ts +0 -56
  121. package/src/__tests__/version.test.ts +0 -35
  122. package/src/__tests__/whoami.test.tsx +0 -278
  123. package/src/__tests__/worker-namespace.test.ts +0 -326
  124. package/src/abort.d.ts +0 -3
  125. package/src/api/dev.ts +0 -218
  126. package/src/api/index.ts +0 -2
  127. package/src/bundle-reporter.tsx +0 -68
  128. package/src/bundle.ts +0 -823
  129. package/src/cfetch/index.ts +0 -158
  130. package/src/cfetch/internal.ts +0 -261
  131. package/src/cli.ts +0 -28
  132. package/src/config/README.md +0 -107
  133. package/src/config/config.ts +0 -275
  134. package/src/config/diagnostics.ts +0 -80
  135. package/src/config/environment.ts +0 -577
  136. package/src/config/index.ts +0 -358
  137. package/src/config/validation-helpers.ts +0 -597
  138. package/src/config/validation.ts +0 -2151
  139. package/src/config-cache.ts +0 -85
  140. package/src/create-worker-preview.ts +0 -282
  141. package/src/create-worker-upload-form.ts +0 -325
  142. package/src/d1/backups.tsx +0 -223
  143. package/src/d1/constants.ts +0 -2
  144. package/src/d1/create.tsx +0 -63
  145. package/src/d1/delete.tsx +0 -56
  146. package/src/d1/execute.tsx +0 -352
  147. package/src/d1/formatTimeAgo.ts +0 -14
  148. package/src/d1/index.ts +0 -101
  149. package/src/d1/list.tsx +0 -48
  150. package/src/d1/migrations/apply.tsx +0 -196
  151. package/src/d1/migrations/create.tsx +0 -77
  152. package/src/d1/migrations/helpers.ts +0 -147
  153. package/src/d1/migrations/index.tsx +0 -3
  154. package/src/d1/migrations/list.tsx +0 -79
  155. package/src/d1/migrations/options.ts +0 -18
  156. package/src/d1/options.ts +0 -22
  157. package/src/d1/types.tsx +0 -24
  158. package/src/d1/utils.ts +0 -48
  159. package/src/delete.ts +0 -108
  160. package/src/deployments.ts +0 -83
  161. package/src/deprecated/index.ts +0 -145
  162. package/src/dev/dev-vars.ts +0 -39
  163. package/src/dev/dev.tsx +0 -614
  164. package/src/dev/get-local-persistence-path.tsx +0 -31
  165. package/src/dev/local.tsx +0 -932
  166. package/src/dev/remote.tsx +0 -603
  167. package/src/dev/start-server.ts +0 -543
  168. package/src/dev/use-esbuild.ts +0 -204
  169. package/src/dev/validate-dev-props.ts +0 -31
  170. package/src/dev-registry.tsx +0 -201
  171. package/src/dev.tsx +0 -949
  172. package/src/dialogs.tsx +0 -168
  173. package/src/dispatch-namespace.ts +0 -207
  174. package/src/docs/index.ts +0 -97
  175. package/src/durable.ts +0 -102
  176. package/src/entry.ts +0 -329
  177. package/src/environment-variables/factory.ts +0 -88
  178. package/src/environment-variables/misc-variables.ts +0 -30
  179. package/src/errors.ts +0 -11
  180. package/src/generate/index.ts +0 -300
  181. package/src/git-client.ts +0 -135
  182. package/src/global-wrangler-config-path.ts +0 -26
  183. package/src/https-options.ts +0 -127
  184. package/src/index.tsx +0 -694
  185. package/src/init.ts +0 -1025
  186. package/src/inspect.ts +0 -767
  187. package/src/intl-polyfill.d.ts +0 -139
  188. package/src/is-ci.ts +0 -14
  189. package/src/is-interactive.ts +0 -16
  190. package/src/jest.d.ts +0 -4
  191. package/src/kv/helpers.ts +0 -430
  192. package/src/kv/index.ts +0 -596
  193. package/src/logger.ts +0 -92
  194. package/src/metrics/index.ts +0 -5
  195. package/src/metrics/metrics-config.ts +0 -239
  196. package/src/metrics/metrics-dispatcher.ts +0 -96
  197. package/src/metrics/metrics-usage-headers.ts +0 -24
  198. package/src/metrics/send-event.ts +0 -97
  199. package/src/miniflare-cli/README.md +0 -30
  200. package/src/miniflare-cli/assets.ts +0 -250
  201. package/src/miniflare-cli/index.ts +0 -210
  202. package/src/miniflare-cli/request-context.ts +0 -40
  203. package/src/miniflare-cli/tsconfig.json +0 -9
  204. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  205. package/src/miniflare-cli/types.ts +0 -11
  206. package/src/module-collection.ts +0 -267
  207. package/src/open-in-browser.ts +0 -17
  208. package/src/package-manager.ts +0 -219
  209. package/src/pages/build.tsx +0 -270
  210. package/src/pages/constants.ts +0 -18
  211. package/src/pages/deployment-tails.tsx +0 -284
  212. package/src/pages/deployments.tsx +0 -84
  213. package/src/pages/dev.tsx +0 -710
  214. package/src/pages/errors.ts +0 -66
  215. package/src/pages/functions/buildPlugin.ts +0 -107
  216. package/src/pages/functions/buildWorker.ts +0 -166
  217. package/src/pages/functions/filepath-routing.test.ts +0 -234
  218. package/src/pages/functions/filepath-routing.ts +0 -189
  219. package/src/pages/functions/identifiers.ts +0 -78
  220. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  221. package/src/pages/functions/routes-consolidation.ts +0 -73
  222. package/src/pages/functions/routes-transformation.test.ts +0 -282
  223. package/src/pages/functions/routes-transformation.ts +0 -115
  224. package/src/pages/functions/routes-validation.test.ts +0 -403
  225. package/src/pages/functions/routes-validation.ts +0 -202
  226. package/src/pages/functions/routes.ts +0 -151
  227. package/src/pages/functions/tsconfig.json +0 -8
  228. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  229. package/src/pages/functions.tsx +0 -82
  230. package/src/pages/hash.tsx +0 -13
  231. package/src/pages/index.tsx +0 -102
  232. package/src/pages/projects.tsx +0 -169
  233. package/src/pages/prompt-select-project.tsx +0 -31
  234. package/src/pages/publish.tsx +0 -461
  235. package/src/pages/types.ts +0 -41
  236. package/src/pages/upload.tsx +0 -447
  237. package/src/pages/utils.ts +0 -23
  238. package/src/parse.ts +0 -286
  239. package/src/paths.ts +0 -71
  240. package/src/proxy.ts +0 -694
  241. package/src/publish/index.ts +0 -270
  242. package/src/publish/publish.ts +0 -1036
  243. package/src/pubsub/index.ts +0 -286
  244. package/src/pubsub/pubsub-commands.tsx +0 -624
  245. package/src/queues/cli/commands/consumer/add.ts +0 -71
  246. package/src/queues/cli/commands/consumer/index.ts +0 -22
  247. package/src/queues/cli/commands/consumer/remove.ts +0 -38
  248. package/src/queues/cli/commands/create.ts +0 -25
  249. package/src/queues/cli/commands/delete.ts +0 -26
  250. package/src/queues/cli/commands/index.ts +0 -36
  251. package/src/queues/cli/commands/list.ts +0 -25
  252. package/src/queues/client.ts +0 -135
  253. package/src/queues/utils.ts +0 -18
  254. package/src/r2/constants.ts +0 -4
  255. package/src/r2/helpers.ts +0 -131
  256. package/src/r2/index.ts +0 -289
  257. package/src/routes.ts +0 -140
  258. package/src/secret/index.ts +0 -379
  259. package/src/selfsigned.d.ts +0 -29
  260. package/src/sites.tsx +0 -372
  261. package/src/tail/createTail.ts +0 -379
  262. package/src/tail/filters.ts +0 -277
  263. package/src/tail/index.ts +0 -214
  264. package/src/tail/printing.ts +0 -107
  265. package/src/tsconfig-sanity.ts +0 -16
  266. package/src/type-generation.ts +0 -181
  267. package/src/update-check.ts +0 -19
  268. package/src/user/access.ts +0 -68
  269. package/src/user/auth-variables.ts +0 -113
  270. package/src/user/choose-account.tsx +0 -69
  271. package/src/user/generate-auth-url.ts +0 -33
  272. package/src/user/generate-random-state.ts +0 -16
  273. package/src/user/index.ts +0 -2
  274. package/src/user/user.tsx +0 -1238
  275. package/src/utils/collectKeyValues.ts +0 -14
  276. package/src/whoami.tsx +0 -169
  277. package/src/worker.ts +0 -251
  278. package/src/yargs-types.ts +0 -24
  279. package/src/zones.ts +0 -191
  280. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  281. package/templates/d1-beta-facade.js +0 -205
  282. package/templates/first-party-worker-module-facade.ts +0 -19
  283. package/templates/format-dev-errors.ts +0 -33
  284. package/templates/serve-static-assets.ts +0 -65
  285. package/templates/service-bindings-module-facade.js +0 -54
  286. package/templates/service-bindings-sw-facade.js +0 -42
  287. package/templates/tsconfig.tsbuildinfo +0 -1
@@ -1,14 +0,0 @@
1
- /**
2
- * a function that takes an array of strings in `key:value` format
3
- * (typically from yargs or config) and returns back
4
- * a neat object with the keys and values
5
- */
6
- export function collectKeyValues(array?: string[]) {
7
- return (
8
- array?.reduce<Record<string, string>>((recordsToCollect, v) => {
9
- const [key, ...value] = v.split(":");
10
- recordsToCollect[key] = value.join(":");
11
- return recordsToCollect;
12
- }, {}) || {}
13
- );
14
- }
package/src/whoami.tsx DELETED
@@ -1,169 +0,0 @@
1
- import { Text, render } from "ink";
2
- import Table from "ink-table";
3
- import React, { Fragment } from "react";
4
- import { fetchListResult, fetchResult } from "./cfetch";
5
- import { logger } from "./logger";
6
- import { getAPIToken, getAuthFromEnv, getScopes } from "./user";
7
-
8
- export async function whoami() {
9
- logger.log("Getting User settings...");
10
- const user = await getUserInfo();
11
- const { unmount } = render(<WhoAmI user={user}></WhoAmI>);
12
- unmount();
13
- }
14
-
15
- export function WhoAmI({ user }: { user: UserInfo | undefined }) {
16
- return user ? (
17
- <>
18
- <Email tokenType={user.authType} email={user.email}></Email>
19
- <Accounts accounts={user.accounts}></Accounts>
20
- <Permissions
21
- tokenType={user.authType}
22
- tokenPermissions={user.tokenPermissions}
23
- />
24
- </>
25
- ) : (
26
- <Text>You are not authenticated. Please run `wrangler login`.</Text>
27
- );
28
- }
29
-
30
- function Email(props: { tokenType: string; email: string | undefined }) {
31
- return props.email === undefined ? (
32
- <Text>
33
- 👋 You are logged in with an {props.tokenType}. Unable to retrieve email
34
- for this user. Are you missing the `User-&gt;User Details-&gt;Read`
35
- permission?
36
- </Text>
37
- ) : (
38
- <Text>
39
- 👋 You are logged in with an {props.tokenType}, associated with the email
40
- &apos;{props.email}&apos;!
41
- </Text>
42
- );
43
- }
44
-
45
- function Accounts(props: { accounts: AccountInfo[] }) {
46
- const accounts = props.accounts.map((account) => ({
47
- "Account Name": account.name,
48
- "Account ID": account.id,
49
- }));
50
- return <Table data={accounts}></Table>;
51
- }
52
-
53
- function Permissions(props: {
54
- tokenPermissions: string[] | undefined;
55
- tokenType: string;
56
- }) {
57
- const permissions =
58
- props.tokenPermissions?.map((scope) => scope.split(":")) || [];
59
- return props.tokenType === "OAuth Token" ? (
60
- props.tokenPermissions ? (
61
- <>
62
- <Text>
63
- 🔓 Token Permissions: If scopes are missing, you may need to logout
64
- and re-login.
65
- </Text>
66
- <Text>Scope (Access)</Text>
67
- {permissions.map(([scope, access], index) => (
68
- <Fragment key={`${scope}${index}`}>
69
- <Text>
70
- - {scope} {access && `(${access})`}
71
- </Text>
72
- </Fragment>
73
- ))}
74
- </>
75
- ) : null
76
- ) : (
77
- <Text>
78
- 🔓 To see token permissions visit
79
- https://dash.cloudflare.com/profile/api-tokens
80
- </Text>
81
- );
82
- }
83
-
84
- export interface UserInfo {
85
- apiToken: string;
86
- authType: string;
87
- email: string | undefined;
88
- accounts: AccountInfo[];
89
- tokenPermissions: string[] | undefined;
90
- }
91
-
92
- export async function getUserInfo(): Promise<UserInfo | undefined> {
93
- const apiToken = getAPIToken();
94
- if (!apiToken) return;
95
-
96
- const tokenPermissions = await getTokenPermissions();
97
-
98
- const usingEnvAuth = !!getAuthFromEnv();
99
- const usingGlobalAuthKey = "authKey" in apiToken;
100
- return {
101
- apiToken: usingGlobalAuthKey ? apiToken.authKey : apiToken.apiToken,
102
- authType: usingGlobalAuthKey
103
- ? "Global API Key"
104
- : usingEnvAuth
105
- ? "API Token"
106
- : "OAuth Token",
107
- email: "authEmail" in apiToken ? apiToken.authEmail : await getEmail(),
108
- accounts: await getAccounts(),
109
- tokenPermissions,
110
- };
111
- }
112
-
113
- async function getEmail(): Promise<string | undefined> {
114
- try {
115
- const { email } = await fetchResult<{ email: string }>("/user");
116
- return email;
117
- } catch (e) {
118
- if ((e as { code?: number }).code === 9109) {
119
- return undefined;
120
- } else {
121
- throw e;
122
- }
123
- }
124
- }
125
-
126
- type AccountInfo = { name: string; id: string };
127
-
128
- async function getAccounts(): Promise<AccountInfo[]> {
129
- return await fetchListResult<AccountInfo>("/accounts");
130
- }
131
-
132
- async function getTokenPermissions(): Promise<string[] | undefined> {
133
- // Tokens can either be API tokens or Oauth tokens.
134
- // Here we only extract permissions from OAuth tokens.
135
-
136
- return getScopes() as string[];
137
-
138
- // In future we may be able to get the token permissions on an API token,
139
- // but currently we cannot as that permission is not able to be added to
140
- // an API token.
141
-
142
- // try {
143
- // // First we get the token identifier (only returned on API tokens)
144
- // const { id } = await fetchResult<{ id: string }>("/user/tokens/verify");
145
-
146
- // // Get the token permissions for the current token
147
- // const { policies } = await fetchResult<{
148
- // policies: { id: string; name: string }[];
149
- // }>(`/user/tokens/${id}`);
150
-
151
- // return policies.map((p) => p.name);
152
- // } catch (e) {
153
- // if ((e as { code?: number }).code === 1000) {
154
- // // Invalid token - Oauth token
155
-
156
- // // Get scopes
157
- // const scopes = getScopes() as string[];
158
- // // We may not get scopes back if they are not currently cached,
159
- // // however next time an access token is requested,
160
- // // the scopes will be added to the cache.
161
- // return scopes;
162
- // } else if ((e as { code?: number }).code === 9109) {
163
- // // Token cannot view its permissions
164
- // return undefined;
165
- // } else {
166
- // throw e;
167
- // }
168
- // }
169
- }
package/src/worker.ts DELETED
@@ -1,251 +0,0 @@
1
- import type { Environment } from "./config";
2
- import type { Route } from "./config/environment";
3
- import type { ApiCredentials } from "./user";
4
-
5
- /**
6
- * A Cloudflare account.
7
- */
8
-
9
- export interface CfAccount {
10
- /**
11
- * An API token.
12
- *
13
- * @link https://api.cloudflare.com/#user-api-tokens-properties
14
- */
15
- apiToken: ApiCredentials;
16
- /**
17
- * An account ID.
18
- */
19
- accountId: string;
20
- }
21
-
22
- /**
23
- * The type of Worker
24
- */
25
- export type CfScriptFormat = "modules" | "service-worker";
26
-
27
- /**
28
- * A module type.
29
- */
30
- export type CfModuleType =
31
- | "esm"
32
- | "commonjs"
33
- | "compiled-wasm"
34
- | "text"
35
- | "buffer";
36
-
37
- /**
38
- * An imported module.
39
- */
40
- export interface CfModule {
41
- /**
42
- * The module name.
43
- *
44
- * @example
45
- * './src/index.js'
46
- */
47
- name: string;
48
- /**
49
- * The module content, usually JavaScript or WASM code.
50
- *
51
- * @example
52
- * export default {
53
- * async fetch(request) {
54
- * return new Response('Ok')
55
- * }
56
- * }
57
- */
58
- content: string | Buffer;
59
- /**
60
- * The module type.
61
- *
62
- * If absent, will default to the main module's type.
63
- */
64
- type?: CfModuleType;
65
- }
66
-
67
- /**
68
- * A map of variable names to values.
69
- */
70
- export interface CfVars {
71
- [key: string]: unknown;
72
- }
73
-
74
- /**
75
- * A KV namespace.
76
- */
77
- export interface CfKvNamespace {
78
- binding: string;
79
- id: string;
80
- }
81
-
82
- /**
83
- * A binding to a wasm module (in service-worker format)
84
- */
85
-
86
- export interface CfWasmModuleBindings {
87
- [key: string]: string;
88
- }
89
-
90
- /**
91
- * A binding to a text blob (in service-worker format)
92
- */
93
-
94
- export interface CfTextBlobBindings {
95
- [key: string]: string;
96
- }
97
-
98
- /**
99
- * A binding to a data blob (in service-worker format)
100
- */
101
-
102
- export interface CfDataBlobBindings {
103
- [key: string]: string;
104
- }
105
-
106
- /**
107
- * A Durable Object.
108
- */
109
- export interface CfDurableObject {
110
- name: string;
111
- class_name: string;
112
- script_name?: string;
113
- environment?: string;
114
- }
115
-
116
- export interface CfQueue {
117
- binding: string;
118
- queue_name: string;
119
- }
120
-
121
- export interface CfR2Bucket {
122
- binding: string;
123
- bucket_name: string;
124
- }
125
-
126
- export const D1_BETA_PREFIX = `__D1_BETA__` as const;
127
- export type D1PrefixedBinding = `${typeof D1_BETA_PREFIX}${string}`;
128
-
129
- // TODO: figure out if this is duplicated in packages/wrangler/src/config/environment.ts
130
- export interface CfD1Database {
131
- // For now, all D1 bindings are alpha
132
- binding: D1PrefixedBinding;
133
- database_id: string;
134
- database_name?: string;
135
- preview_database_id?: string;
136
- database_internal_env?: string;
137
- migrations_table?: string;
138
- migrations_dir?: string;
139
- }
140
-
141
- interface CfService {
142
- binding: string;
143
- service: string;
144
- environment?: string;
145
- }
146
-
147
- interface CfAnalyticsEngineDataset {
148
- binding: string;
149
- dataset?: string;
150
- }
151
-
152
- interface CfDispatchNamespace {
153
- binding: string;
154
- namespace: string;
155
- }
156
-
157
- interface CfLogfwdr {
158
- schema: string | undefined;
159
- bindings: CfLogfwdrBinding[];
160
- }
161
-
162
- interface CfLogfwdrBinding {
163
- name: string;
164
- destination: string;
165
- }
166
-
167
- interface CfUnsafeBinding {
168
- name: string;
169
- type: string;
170
- }
171
-
172
- export interface CfDurableObjectMigrations {
173
- old_tag?: string;
174
- new_tag: string;
175
- steps: {
176
- new_classes?: string[];
177
- renamed_classes?: {
178
- from: string;
179
- to: string;
180
- }[];
181
- deleted_classes?: string[];
182
- }[];
183
- }
184
-
185
- /**
186
- * Options for creating a `CfWorker`.
187
- */
188
- export interface CfWorkerInit {
189
- /**
190
- * The name of the worker.
191
- */
192
- name: string | undefined;
193
- /**
194
- * The entrypoint module.
195
- */
196
- main: CfModule;
197
- /**
198
- * The list of additional modules.
199
- */
200
- modules: CfModule[] | undefined;
201
- /**
202
- * All the bindings
203
- */
204
- bindings: {
205
- vars: CfVars | undefined;
206
- kv_namespaces: CfKvNamespace[] | undefined;
207
- wasm_modules: CfWasmModuleBindings | undefined;
208
- text_blobs: CfTextBlobBindings | undefined;
209
- data_blobs: CfDataBlobBindings | undefined;
210
- durable_objects: { bindings: CfDurableObject[] } | undefined;
211
- queues: CfQueue[] | undefined;
212
- r2_buckets: CfR2Bucket[] | undefined;
213
- d1_databases: CfD1Database[] | undefined;
214
- services: CfService[] | undefined;
215
- analytics_engine_datasets: CfAnalyticsEngineDataset[] | undefined;
216
- dispatch_namespaces: CfDispatchNamespace[] | undefined;
217
- logfwdr: CfLogfwdr | undefined;
218
- unsafe: CfUnsafeBinding[] | undefined;
219
- };
220
- migrations: CfDurableObjectMigrations | undefined;
221
- compatibility_date: string | undefined;
222
- compatibility_flags: string[] | undefined;
223
- usage_model: "bundled" | "unbound" | undefined;
224
- keepVars: boolean | undefined;
225
- logpush: boolean | undefined;
226
- }
227
-
228
- export interface CfWorkerContext {
229
- env: string | undefined;
230
- legacyEnv: boolean | undefined;
231
- zone: string | undefined;
232
- host: string | undefined;
233
- routes: Route[] | undefined;
234
- sendMetrics: boolean | undefined;
235
- }
236
-
237
- // Prefix binding with identifier which will then get picked up by the D1 shim.
238
- // Once the D1 Api is out of beta, this function can be removed.
239
- export function identifyD1BindingsAsBeta(
240
- dbs: Environment["d1_databases"]
241
- ): CfD1Database[] | undefined {
242
- return dbs?.map((db) => ({
243
- ...db,
244
- binding: `${D1_BETA_PREFIX}${db.binding}`,
245
- }));
246
- }
247
-
248
- // Remove beta prefix
249
- export function removeD1BetaPrefix(binding: D1PrefixedBinding): string {
250
- return binding.slice(D1_BETA_PREFIX.length);
251
- }
@@ -1,24 +0,0 @@
1
- import type { ArgumentsCamelCase, Argv } from "yargs";
2
-
3
- /**
4
- * Yargs options included in every wrangler command.
5
- */
6
- export interface CommonYargsOptions {
7
- v: boolean | undefined;
8
- config: string | undefined;
9
- env: string | undefined;
10
- }
11
-
12
- export type YargvToInterface<T> = T extends Argv<infer P>
13
- ? ArgumentsCamelCase<P>
14
- : never;
15
-
16
- /**
17
- * Given some Yargs Options function factory, extract the interface
18
- * that corresponds to the yargs arguments
19
- */
20
- export type YargsOptionsToInterface<
21
- T extends (yargs: Argv<CommonYargsOptions>) => Argv
22
- > = T extends (yargs: Argv<CommonYargsOptions>) => Argv<infer P>
23
- ? ArgumentsCamelCase<P>
24
- : never;
package/src/zones.ts DELETED
@@ -1,191 +0,0 @@
1
- import { fetchListResult } from "./cfetch";
2
- import type { Route } from "./config/environment";
3
-
4
- /**
5
- * An object holding information about a zone for publishing.
6
- */
7
- export interface Zone {
8
- id: string;
9
- host: string;
10
- }
11
-
12
- /**
13
- * Get the hostname on which to run a Worker.
14
- *
15
- * The most accurate place is usually
16
- * `route.pattern`, as that includes any subdomains. For example:
17
- * ```js
18
- * {
19
- * pattern: foo.example.com
20
- * zone_name: example.com
21
- * }
22
- * ```
23
- * However, in the case of patterns that _can't_ be parsed as a hostname
24
- * (primarily the pattern `*/ /*`), we fall back to the `zone_name`
25
- * (and in the absence of that throw an error).
26
- * @param route
27
- */
28
- export function getHostFromRoute(route: Route): string | undefined {
29
- if (typeof route === "string") {
30
- return getHostFromUrl(route);
31
- } else if (typeof route === "object") {
32
- try {
33
- return getHostFromUrl(route.pattern);
34
- } catch (e) {
35
- if (
36
- (e as { code: string }).code === "ERR_INVALID_URL" &&
37
- "zone_name" in route
38
- ) {
39
- return getHostFromUrl(route.zone_name);
40
- }
41
- throw e;
42
- }
43
- }
44
- }
45
-
46
- /**
47
- * Try to compute the a zone ID and host name for one or more routes.
48
- *
49
- * When we're given a route, we do 2 things:
50
- * - We try to extract a host from it
51
- * - We try to get a zone id from the host
52
- */
53
- export async function getZoneForRoute(route: Route): Promise<Zone | undefined> {
54
- const host = getHostFromRoute(route);
55
- const id =
56
- typeof route === "object" && "zone_id" in route
57
- ? route.zone_id
58
- : host
59
- ? await getZoneIdFromHost(host)
60
- : undefined;
61
- return id && host ? { id, host } : undefined;
62
- }
63
-
64
- /**
65
- * Given something that resembles a URL, try to extract a host from it.
66
- */
67
- export function getHostFromUrl(urlLike: string): string | undefined {
68
- // strip leading * / *.
69
- urlLike = urlLike.replace(/\*(\.)?/g, "");
70
-
71
- if (!(urlLike.startsWith("http://") || urlLike.startsWith("https://"))) {
72
- urlLike = "http://" + urlLike;
73
- }
74
- return new URL(urlLike).host;
75
- }
76
-
77
- /**
78
- * Given something that resembles a host, try to infer a zone id from it.
79
- *
80
- * It's hard to get a 'valid' domain from a string, so we don't even try to validate TLDs, etc.
81
- * For each domain-like part of the host (e.g. w.x.y.z) try to get a zone id for it by
82
- * lopping off subdomains until we get a hit from the API.
83
- */
84
- export async function getZoneIdFromHost(host: string): Promise<string> {
85
- const hostPieces = host.split(".");
86
-
87
- while (hostPieces.length > 1) {
88
- const zones = await fetchListResult<{ id: string }>(
89
- `/zones`,
90
- {},
91
- new URLSearchParams({ name: hostPieces.join(".") })
92
- );
93
- if (zones.length > 0) {
94
- return zones[0].id;
95
- }
96
- hostPieces.shift();
97
- }
98
-
99
- throw new Error(`Could not find zone for ${host}`);
100
- }
101
-
102
- /**
103
- * An object holding information about an assigned worker route, returned from the API
104
- */
105
- interface WorkerRoute {
106
- id: string;
107
- pattern: string;
108
- script: string;
109
- }
110
-
111
- /**
112
- * Given a zone within the user's account, return a list of all assigned worker routes
113
- */
114
- export async function getRoutesForZone(zone: string): Promise<WorkerRoute[]> {
115
- const routes = await fetchListResult<WorkerRoute>(
116
- `/zones/${zone}/workers/routes`
117
- );
118
- return routes;
119
- }
120
-
121
- /**
122
- * Given two strings, return the levenshtein distance between them as a simple text match heuristic
123
- */
124
- function distanceBetween(a: string, b: string, cache = new Map()): number {
125
- if (cache.has(`${a}|${b}`)) {
126
- return cache.get(`${a}|${b}`);
127
- }
128
- let result;
129
- if (b == "") {
130
- result = a.length;
131
- } else if (a == "") {
132
- result = b.length;
133
- } else if (a[0] === b[0]) {
134
- result = distanceBetween(a.slice(1), b.slice(1), cache);
135
- } else {
136
- result =
137
- 1 +
138
- Math.min(
139
- distanceBetween(a.slice(1), b, cache),
140
- distanceBetween(a, b.slice(1), cache),
141
- distanceBetween(a.slice(1), b.slice(1), cache)
142
- );
143
- }
144
- cache.set(`${a}|${b}`, result);
145
- return result;
146
- }
147
-
148
- /**
149
- * Given an invalid route, sort the valid routes by closeness to the invalid route (levenstein distance)
150
- */
151
- export function findClosestRoute(
152
- providedRoute: string,
153
- assignedRoutes: WorkerRoute[]
154
- ): WorkerRoute[] {
155
- return assignedRoutes.sort((a, b) => {
156
- const distanceA = distanceBetween(providedRoute, a.pattern);
157
- const distanceB = distanceBetween(providedRoute, b.pattern);
158
- return distanceA - distanceB;
159
- });
160
- }
161
-
162
- /**
163
- * Given a route (must be assigned and within the correct zone), return the name of the worker assigned to it
164
- */
165
- export async function getWorkerForZone(worker: string) {
166
- const zone = await getZoneForRoute(worker);
167
- if (!zone) {
168
- throw new Error(
169
- `The route '${worker}' is not part of one of your zones. Either add this zone from the Cloudflare dashboard, or try using a route within one of your existing zones.`
170
- );
171
- }
172
- const routes = await getRoutesForZone(zone.id);
173
-
174
- const scriptName = routes.find((route) => route.pattern === worker)?.script;
175
-
176
- if (!scriptName) {
177
- const closestRoute = findClosestRoute(worker, routes)?.[0];
178
-
179
- if (!closestRoute) {
180
- throw new Error(
181
- `The route '${worker}' has no workers assigned. You can assign a worker to it from wrangler.toml or the Cloudflare dashboard`
182
- );
183
- } else {
184
- throw new Error(
185
- `The route '${worker}' has no workers assigned. Did you mean to tail the route '${closestRoute.pattern}'?`
186
- );
187
- }
188
- }
189
-
190
- return scriptName;
191
- }