wrangler 0.0.0-e33bea9b → 0.0.0-e34d19867

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 (314) hide show
  1. package/README.md +33 -43
  2. package/bin/wrangler.js +16 -111
  3. package/config-schema.json +2422 -0
  4. package/package.json +182 -194
  5. package/templates/__tests__/tsconfig.json +1 -1
  6. package/templates/checked-fetch.js +11 -4
  7. package/templates/facade.d.ts +7 -2
  8. package/templates/gitignore +2 -4
  9. package/templates/init-tests/test-vitest-new-worker.js +1 -1
  10. package/templates/init-tests/test-vitest-new-worker.ts +3 -3
  11. package/templates/middleware/common.ts +9 -4
  12. package/templates/middleware/loader-modules.ts +94 -44
  13. package/templates/middleware/loader-sw.ts +6 -10
  14. package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
  15. package/templates/middleware/middleware-patch-console-prefix.d.ts +3 -0
  16. package/templates/middleware/middleware-patch-console-prefix.ts +21 -0
  17. package/templates/middleware/middleware-scheduled.ts +15 -1
  18. package/templates/mixedMode/proxyServerWorker/index.ts +40 -0
  19. package/templates/mixedMode/proxyServerWorker/wrangler.jsonc +4 -0
  20. package/templates/modules-watch-stub.js +4 -0
  21. package/templates/new-worker-scheduled.ts +1 -1
  22. package/templates/new-worker.ts +1 -1
  23. package/templates/pages-dev-pipeline.ts +5 -3
  24. package/templates/pages-dev-util.ts +4 -1
  25. package/templates/pages-shim.ts +0 -3
  26. package/templates/pages-template-plugin.ts +14 -4
  27. package/templates/pages-template-worker.ts +12 -3
  28. package/templates/startDevWorker/InspectorProxyWorker.ts +679 -0
  29. package/templates/startDevWorker/ProxyWorker.ts +336 -0
  30. package/templates/strip-cf-connecting-ip-header.js +13 -0
  31. package/templates/tsconfig.init.json +4 -87
  32. package/templates/tsconfig.json +9 -2
  33. package/templates/tsconfig.tsbuildinfo +1 -1
  34. package/wrangler-dist/InspectorProxyWorker.js +471 -0
  35. package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
  36. package/wrangler-dist/ProxyWorker.js +238 -0
  37. package/wrangler-dist/ProxyWorker.js.map +6 -0
  38. package/wrangler-dist/cli.d.ts +25620 -367
  39. package/wrangler-dist/cli.js +171822 -147792
  40. package/wrangler-dist/cli.js.map +7 -0
  41. package/Cloudflare_CA.pem +0 -18
  42. package/import_meta_url.js +0 -3
  43. package/miniflare-config-stubs/.env.empty +0 -0
  44. package/miniflare-config-stubs/package.empty.json +0 -1
  45. package/miniflare-config-stubs/wrangler.empty.toml +0 -0
  46. package/miniflare-dist/index.mjs +0 -6368
  47. package/src/__tests__/access.test.ts +0 -25
  48. package/src/__tests__/api-dev.test.ts +0 -238
  49. package/src/__tests__/api-devregistry.test.js +0 -64
  50. package/src/__tests__/api.test.ts +0 -80
  51. package/src/__tests__/config-cache-without-cache-dir.test.ts +0 -38
  52. package/src/__tests__/config-cache.test.ts +0 -42
  53. package/src/__tests__/configuration.test.ts +0 -4462
  54. package/src/__tests__/d1/d1.test.ts +0 -82
  55. package/src/__tests__/d1/execute.test.ts +0 -64
  56. package/src/__tests__/d1/migrate.test.ts +0 -155
  57. package/src/__tests__/d1/splitter.test.ts +0 -255
  58. package/src/__tests__/delete.test.ts +0 -266
  59. package/src/__tests__/deployments.test.ts +0 -129
  60. package/src/__tests__/dev.test.tsx +0 -1602
  61. package/src/__tests__/generate.test.ts +0 -238
  62. package/src/__tests__/get-host-from-url.test.ts +0 -16
  63. package/src/__tests__/guess-worker-format.test.ts +0 -120
  64. package/src/__tests__/helpers/clipboardy-mock.js +0 -4
  65. package/src/__tests__/helpers/cmd-shim.d.ts +0 -11
  66. package/src/__tests__/helpers/end-event-loop.ts +0 -6
  67. package/src/__tests__/helpers/mock-account-id.ts +0 -48
  68. package/src/__tests__/helpers/mock-auth-domain.ts +0 -20
  69. package/src/__tests__/helpers/mock-bin.ts +0 -36
  70. package/src/__tests__/helpers/mock-console.ts +0 -106
  71. package/src/__tests__/helpers/mock-dialogs.ts +0 -139
  72. package/src/__tests__/helpers/mock-get-pages-upload-token.ts +0 -25
  73. package/src/__tests__/helpers/mock-get-zone-from-host.ts +0 -11
  74. package/src/__tests__/helpers/mock-http-server.ts +0 -46
  75. package/src/__tests__/helpers/mock-istty.ts +0 -74
  76. package/src/__tests__/helpers/mock-known-routes.ts +0 -12
  77. package/src/__tests__/helpers/mock-kv.ts +0 -46
  78. package/src/__tests__/helpers/mock-oauth-flow.ts +0 -263
  79. package/src/__tests__/helpers/mock-process.ts +0 -34
  80. package/src/__tests__/helpers/mock-set-timeout.ts +0 -16
  81. package/src/__tests__/helpers/mock-stdin.ts +0 -108
  82. package/src/__tests__/helpers/mock-web-socket.ts +0 -29
  83. package/src/__tests__/helpers/msw/blob-worker.cjs +0 -19
  84. package/src/__tests__/helpers/msw/handlers/access.ts +0 -13
  85. package/src/__tests__/helpers/msw/handlers/deployments.ts +0 -93
  86. package/src/__tests__/helpers/msw/handlers/namespaces.ts +0 -81
  87. package/src/__tests__/helpers/msw/handlers/oauth.ts +0 -31
  88. package/src/__tests__/helpers/msw/handlers/r2.ts +0 -60
  89. package/src/__tests__/helpers/msw/handlers/script.ts +0 -56
  90. package/src/__tests__/helpers/msw/handlers/user.ts +0 -52
  91. package/src/__tests__/helpers/msw/handlers/zones.ts +0 -20
  92. package/src/__tests__/helpers/msw/index.ts +0 -50
  93. package/src/__tests__/helpers/msw/read-file-sync.js +0 -61
  94. package/src/__tests__/helpers/run-in-tmp.ts +0 -38
  95. package/src/__tests__/helpers/run-wrangler.ts +0 -16
  96. package/src/__tests__/helpers/string-dynamic-values-matcher.ts +0 -28
  97. package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +0 -1
  98. package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +0 -5
  99. package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +0 -1
  100. package/src/__tests__/helpers/worker-scripts/parent-worker.js +0 -8
  101. package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +0 -5
  102. package/src/__tests__/helpers/write-worker-source.ts +0 -31
  103. package/src/__tests__/helpers/write-wrangler-toml.ts +0 -17
  104. package/src/__tests__/https-options.test.ts +0 -163
  105. package/src/__tests__/index.test.ts +0 -274
  106. package/src/__tests__/init.test.ts +0 -3165
  107. package/src/__tests__/jest.setup.ts +0 -175
  108. package/src/__tests__/kv.test.ts +0 -1799
  109. package/src/__tests__/logger.test.ts +0 -141
  110. package/src/__tests__/logout.test.ts +0 -47
  111. package/src/__tests__/metrics.test.ts +0 -493
  112. package/src/__tests__/middleware.scheduled.test.ts +0 -145
  113. package/src/__tests__/middleware.test.ts +0 -816
  114. package/src/__tests__/mtls-certificates.test.ts +0 -585
  115. package/src/__tests__/package-manager.test.ts +0 -353
  116. package/src/__tests__/pages/deployment-list.test.ts +0 -78
  117. package/src/__tests__/pages/functions-build.test.ts +0 -452
  118. package/src/__tests__/pages/pages.test.ts +0 -81
  119. package/src/__tests__/pages/project-create.test.ts +0 -63
  120. package/src/__tests__/pages/project-list.test.ts +0 -108
  121. package/src/__tests__/pages/project-upload.test.ts +0 -481
  122. package/src/__tests__/pages/publish.test.ts +0 -2820
  123. package/src/__tests__/pages-deployment-tail.test.ts +0 -955
  124. package/src/__tests__/parse.test.ts +0 -436
  125. package/src/__tests__/paths.test.ts +0 -39
  126. package/src/__tests__/publish.test.ts +0 -8303
  127. package/src/__tests__/pubsub.test.ts +0 -493
  128. package/src/__tests__/queues.test.ts +0 -529
  129. package/src/__tests__/r2.test.ts +0 -374
  130. package/src/__tests__/route.test.ts +0 -45
  131. package/src/__tests__/secret.test.ts +0 -693
  132. package/src/__tests__/tail.test.ts +0 -958
  133. package/src/__tests__/test-old-node-version.js +0 -31
  134. package/src/__tests__/tsconfig-sanity.ts +0 -12
  135. package/src/__tests__/tsconfig.json +0 -8
  136. package/src/__tests__/tsconfig.tsbuildinfo +0 -1
  137. package/src/__tests__/type-generation.test.ts +0 -234
  138. package/src/__tests__/user.test.ts +0 -118
  139. package/src/__tests__/utils-collectKeyValues.test.ts +0 -47
  140. package/src/__tests__/validate-dev-props.test.ts +0 -56
  141. package/src/__tests__/version.test.ts +0 -35
  142. package/src/__tests__/whoami.test.tsx +0 -172
  143. package/src/__tests__/worker-namespace.test.ts +0 -339
  144. package/src/abort.d.ts +0 -3
  145. package/src/api/dev.ts +0 -327
  146. package/src/api/index.ts +0 -11
  147. package/src/api/mtls-certificate.ts +0 -148
  148. package/src/api/pages/create-worker-bundle-contents.ts +0 -75
  149. package/src/api/pages/index.ts +0 -5
  150. package/src/api/pages/publish.tsx +0 -355
  151. package/src/bundle-reporter.ts +0 -68
  152. package/src/bundle.ts +0 -894
  153. package/src/cfetch/index.ts +0 -158
  154. package/src/cfetch/internal.ts +0 -258
  155. package/src/cli.ts +0 -28
  156. package/src/config/README.md +0 -107
  157. package/src/config/config.ts +0 -282
  158. package/src/config/diagnostics.ts +0 -80
  159. package/src/config/environment.ts +0 -591
  160. package/src/config/index.ts +0 -385
  161. package/src/config/validation-helpers.ts +0 -597
  162. package/src/config/validation.ts +0 -2252
  163. package/src/config-cache.ts +0 -85
  164. package/src/create-worker-preview.ts +0 -293
  165. package/src/create-worker-upload-form.ts +0 -342
  166. package/src/d1/backups.tsx +0 -215
  167. package/src/d1/constants.ts +0 -2
  168. package/src/d1/create.tsx +0 -64
  169. package/src/d1/delete.ts +0 -53
  170. package/src/d1/execute.tsx +0 -354
  171. package/src/d1/formatTimeAgo.ts +0 -14
  172. package/src/d1/index.ts +0 -100
  173. package/src/d1/list.tsx +0 -60
  174. package/src/d1/migrations/apply.tsx +0 -206
  175. package/src/d1/migrations/create.tsx +0 -76
  176. package/src/d1/migrations/helpers.ts +0 -172
  177. package/src/d1/migrations/index.ts +0 -3
  178. package/src/d1/migrations/list.tsx +0 -92
  179. package/src/d1/migrations/options.ts +0 -23
  180. package/src/d1/options.ts +0 -22
  181. package/src/d1/splitter.ts +0 -161
  182. package/src/d1/types.ts +0 -25
  183. package/src/d1/utils.ts +0 -49
  184. package/src/delete.ts +0 -100
  185. package/src/deployments.ts +0 -116
  186. package/src/deprecated/index.ts +0 -144
  187. package/src/dev/dev-vars.ts +0 -39
  188. package/src/dev/dev.tsx +0 -600
  189. package/src/dev/get-local-persistence-path.ts +0 -31
  190. package/src/dev/local.tsx +0 -920
  191. package/src/dev/remote.tsx +0 -632
  192. package/src/dev/start-server.ts +0 -540
  193. package/src/dev/use-esbuild.ts +0 -209
  194. package/src/dev/validate-dev-props.ts +0 -40
  195. package/src/dev-registry.ts +0 -201
  196. package/src/dev.tsx +0 -928
  197. package/src/dialogs.ts +0 -136
  198. package/src/dispatch-namespace.ts +0 -211
  199. package/src/docs/index.ts +0 -97
  200. package/src/durable.ts +0 -102
  201. package/src/entry.ts +0 -327
  202. package/src/environment-variables/factory.ts +0 -88
  203. package/src/environment-variables/misc-variables.ts +0 -30
  204. package/src/errors.ts +0 -11
  205. package/src/generate/index.ts +0 -298
  206. package/src/git-client.ts +0 -135
  207. package/src/global-wrangler-config-path.ts +0 -26
  208. package/src/https-options.ts +0 -127
  209. package/src/index.ts +0 -705
  210. package/src/init.ts +0 -1023
  211. package/src/inspect.ts +0 -782
  212. package/src/intl-polyfill.d.ts +0 -139
  213. package/src/is-ci.ts +0 -14
  214. package/src/is-interactive.ts +0 -16
  215. package/src/jest.d.ts +0 -4
  216. package/src/kv/helpers.ts +0 -430
  217. package/src/kv/index.ts +0 -594
  218. package/src/logger.ts +0 -104
  219. package/src/metrics/index.ts +0 -5
  220. package/src/metrics/metrics-config.ts +0 -239
  221. package/src/metrics/metrics-dispatcher.ts +0 -96
  222. package/src/metrics/metrics-usage-headers.ts +0 -24
  223. package/src/metrics/send-event.ts +0 -98
  224. package/src/miniflare-cli/README.md +0 -30
  225. package/src/miniflare-cli/assets.ts +0 -251
  226. package/src/miniflare-cli/index.ts +0 -210
  227. package/src/miniflare-cli/request-context.ts +0 -40
  228. package/src/miniflare-cli/tsconfig.json +0 -9
  229. package/src/miniflare-cli/tsconfig.tsbuildinfo +0 -1
  230. package/src/miniflare-cli/types.ts +0 -11
  231. package/src/module-collection.ts +0 -267
  232. package/src/mtls-certificate/cli.ts +0 -155
  233. package/src/open-in-browser.ts +0 -17
  234. package/src/package-manager.ts +0 -219
  235. package/src/pages/build.ts +0 -410
  236. package/src/pages/buildFunctions.ts +0 -140
  237. package/src/pages/constants.ts +0 -18
  238. package/src/pages/deployment-tails.ts +0 -281
  239. package/src/pages/deployments.tsx +0 -86
  240. package/src/pages/dev.ts +0 -716
  241. package/src/pages/errors.ts +0 -67
  242. package/src/pages/functions/buildPlugin.ts +0 -112
  243. package/src/pages/functions/buildWorker.ts +0 -297
  244. package/src/pages/functions/filepath-routing.test.ts +0 -234
  245. package/src/pages/functions/filepath-routing.ts +0 -189
  246. package/src/pages/functions/identifiers.ts +0 -78
  247. package/src/pages/functions/routes-consolidation.test.ts +0 -250
  248. package/src/pages/functions/routes-consolidation.ts +0 -73
  249. package/src/pages/functions/routes-transformation.test.ts +0 -282
  250. package/src/pages/functions/routes-transformation.ts +0 -115
  251. package/src/pages/functions/routes-validation.test.ts +0 -403
  252. package/src/pages/functions/routes-validation.ts +0 -202
  253. package/src/pages/functions/routes.ts +0 -151
  254. package/src/pages/functions/tsconfig.json +0 -8
  255. package/src/pages/functions/tsconfig.tsbuildinfo +0 -1
  256. package/src/pages/functions.ts +0 -86
  257. package/src/pages/hash.ts +0 -13
  258. package/src/pages/index.ts +0 -102
  259. package/src/pages/projects.tsx +0 -162
  260. package/src/pages/prompt-select-project.tsx +0 -31
  261. package/src/pages/publish.tsx +0 -267
  262. package/src/pages/types.ts +0 -46
  263. package/src/pages/upload.tsx +0 -449
  264. package/src/pages/utils.ts +0 -23
  265. package/src/parse.ts +0 -308
  266. package/src/paths.ts +0 -71
  267. package/src/proxy.ts +0 -694
  268. package/src/publish/index.ts +0 -274
  269. package/src/publish/publish.ts +0 -1076
  270. package/src/pubsub/index.ts +0 -286
  271. package/src/pubsub/pubsub-commands.ts +0 -623
  272. package/src/queues/cli/commands/consumer/add.ts +0 -65
  273. package/src/queues/cli/commands/consumer/index.ts +0 -19
  274. package/src/queues/cli/commands/consumer/remove.ts +0 -31
  275. package/src/queues/cli/commands/create.ts +0 -25
  276. package/src/queues/cli/commands/delete.ts +0 -26
  277. package/src/queues/cli/commands/index.ts +0 -35
  278. package/src/queues/cli/commands/list.ts +0 -25
  279. package/src/queues/client.ts +0 -135
  280. package/src/queues/utils.ts +0 -18
  281. package/src/r2/constants.ts +0 -4
  282. package/src/r2/helpers.ts +0 -132
  283. package/src/r2/index.ts +0 -289
  284. package/src/routes.ts +0 -140
  285. package/src/secret/index.ts +0 -375
  286. package/src/selfsigned.d.ts +0 -29
  287. package/src/sites.ts +0 -372
  288. package/src/tail/createTail.ts +0 -406
  289. package/src/tail/filters.ts +0 -277
  290. package/src/tail/index.ts +0 -211
  291. package/src/tail/printing.ts +0 -122
  292. package/src/tsconfig-sanity.ts +0 -16
  293. package/src/type-generation.ts +0 -181
  294. package/src/update-check.ts +0 -19
  295. package/src/user/access.ts +0 -68
  296. package/src/user/auth-variables.ts +0 -113
  297. package/src/user/choose-account.tsx +0 -39
  298. package/src/user/generate-auth-url.ts +0 -33
  299. package/src/user/generate-random-state.ts +0 -16
  300. package/src/user/index.ts +0 -2
  301. package/src/user/user.ts +0 -1233
  302. package/src/utils/collectKeyValues.ts +0 -14
  303. package/src/whoami.ts +0 -135
  304. package/src/worker.ts +0 -264
  305. package/src/yargs-types.ts +0 -37
  306. package/src/zones.ts +0 -191
  307. package/templates/__tests__/tsconfig.tsbuildinfo +0 -1
  308. package/templates/d1-beta-facade.js +0 -244
  309. package/templates/first-party-worker-module-facade.ts +0 -19
  310. package/templates/format-dev-errors.ts +0 -34
  311. package/templates/serve-static-assets.ts +0 -66
  312. package/templates/service-bindings-module-facade.js +0 -55
  313. package/templates/service-bindings-sw-facade.js +0 -42
  314. package/wrangler-dist/wasm-sync.wasm +0 -0
@@ -1,597 +0,0 @@
1
- import type { RawConfig } from "./config";
2
- import type { Diagnostics } from "./diagnostics";
3
- import type { Environment, RawEnvironment } from "./environment";
4
-
5
- /**
6
- * Mark a field as deprecated.
7
- *
8
- * This function will add a diagnostics warning if the deprecated field is found in the `rawEnv` (or an error if it's also a breaking deprecation)
9
- * The `fieldPath` is a dot separated property path, e.g. `"build.upload.format"`.
10
- */
11
- export function deprecated<T extends object>(
12
- diagnostics: Diagnostics,
13
- config: T,
14
- fieldPath: DeepKeyOf<T>,
15
- message: string,
16
- remove: boolean,
17
- title = "Deprecation",
18
- type: "warning" | "error" = "warning"
19
- ): void {
20
- const BOLD = "\x1b[1m";
21
- const NORMAL = "\x1b[0m";
22
- const diagnosticMessage = `${BOLD}${title}${NORMAL}: "${fieldPath}":\n${message}`;
23
- const result = unwindPropertyPath(config, fieldPath);
24
- if (result !== undefined && result.field in result.container) {
25
- diagnostics[`${type}s`].push(diagnosticMessage);
26
- if (remove) {
27
- delete (result.container as Record<string, unknown>)[result.field];
28
- }
29
- }
30
- }
31
-
32
- /**
33
- * Mark a field as experimental.
34
- *
35
- * This function will add a diagnostics warning if the experimental field is found in the `rawEnv`.
36
- * The `fieldPath` is a dot separated property path, e.g. `"build.upload.format"`.
37
- */
38
- export function experimental<T extends object>(
39
- diagnostics: Diagnostics,
40
- config: T,
41
- fieldPath: DeepKeyOf<T>
42
- ): void {
43
- const result = unwindPropertyPath(config, fieldPath);
44
- if (result !== undefined && result.field in result.container) {
45
- diagnostics.warnings.push(
46
- `"${fieldPath}" fields are experimental and may change or break at any time.`
47
- );
48
- }
49
- }
50
-
51
- /**
52
- * Get an inheritable environment field, after computing and validating its value.
53
- *
54
- * If the field is not defined in the given environment, then fallback to the value from the top-level config,
55
- * and then the `defaultValue`.
56
- */
57
- export function inheritable<K extends keyof Environment>(
58
- diagnostics: Diagnostics,
59
- topLevelEnv: Environment | undefined,
60
- rawEnv: RawEnvironment,
61
- field: K,
62
- validate: ValidatorFn,
63
- defaultValue: Environment[K],
64
- transformFn: TransformFn<Environment[K]> = (v) => v
65
- ): Environment[K] {
66
- validate(diagnostics, field, rawEnv[field], topLevelEnv);
67
- return (
68
- (rawEnv[field] as Environment[K]) ??
69
- transformFn(topLevelEnv?.[field]) ??
70
- defaultValue
71
- );
72
- }
73
-
74
- /**
75
- * Get an inheritable environment field, but only if we are in legacy environments
76
- */
77
- export function inheritableInLegacyEnvironments<K extends keyof Environment>(
78
- diagnostics: Diagnostics,
79
- isLegacyEnv: boolean | undefined,
80
- topLevelEnv: Environment | undefined,
81
- rawEnv: RawEnvironment,
82
- field: K,
83
- validate: ValidatorFn,
84
- transformFn: TransformFn<Environment[K]> = (v) => v,
85
- defaultValue: Environment[K]
86
- ): Environment[K] {
87
- return topLevelEnv === undefined || isLegacyEnv === true
88
- ? inheritable(
89
- diagnostics,
90
- topLevelEnv,
91
- rawEnv,
92
- field,
93
- validate,
94
- defaultValue,
95
- transformFn
96
- )
97
- : notAllowedInNamedServiceEnvironment(
98
- diagnostics,
99
- topLevelEnv,
100
- rawEnv,
101
- field
102
- );
103
- }
104
-
105
- /**
106
- * Type of function that is used to transform an inheritable environment field.
107
- */
108
- type TransformFn<T> = (fieldValue: T | undefined) => T | undefined;
109
-
110
- /**
111
- * Transform an environment field by appending current environment name to it.
112
- */
113
- export const appendEnvName =
114
- (envName: string): TransformFn<string | undefined> =>
115
- (fieldValue) =>
116
- fieldValue ? `${fieldValue}-${envName}` : undefined;
117
-
118
- /**
119
- * Log an error if this named environment is trying to override the value in the top-level
120
- * environment, which is not allow for this field.
121
- */
122
- function notAllowedInNamedServiceEnvironment<K extends keyof Environment>(
123
- diagnostics: Diagnostics,
124
- topLevelEnv: Environment,
125
- rawEnv: RawEnvironment,
126
- field: K
127
- ): Environment[K] {
128
- if (field in rawEnv) {
129
- diagnostics.errors.push(
130
- `The "${field}" field is not allowed in named service environments.\n` +
131
- `Please remove the field from this environment.`
132
- );
133
- }
134
- return topLevelEnv[field];
135
- }
136
-
137
- /**
138
- * Get a not inheritable environment field, after computing and validating its value.
139
- *
140
- * If the field is not defined in the given environment but it is defined in the top-level config,
141
- * then log a warning and return the `defaultValue`.
142
- */
143
- export function notInheritable<K extends keyof Environment>(
144
- diagnostics: Diagnostics,
145
- topLevelEnv: Environment | undefined,
146
- rawConfig: RawConfig | undefined,
147
- rawEnv: RawEnvironment,
148
- envName: string,
149
- field: K,
150
- validate: ValidatorFn,
151
- defaultValue: Environment[K]
152
- ): Environment[K] {
153
- if (rawEnv[field] !== undefined) {
154
- validate(diagnostics, field, rawEnv[field], topLevelEnv);
155
- } else {
156
- if (rawConfig?.[field] !== undefined) {
157
- diagnostics.warnings.push(
158
- `"${field}" exists at the top level, but not on "env.${envName}".\n` +
159
- `This is not what you probably want, since "${field}" is not inherited by environments.\n` +
160
- `Please add "${field}" to "env.${envName}".`
161
- );
162
- }
163
- }
164
- return (rawEnv[field] as Environment[K]) ?? defaultValue;
165
- }
166
-
167
- // Idea taken from https://stackoverflow.com/a/66661477
168
- type DeepKeyOf<T> = (
169
- T extends object
170
- ? {
171
- [K in Exclude<keyof T, symbol>]: `${K}${DotPrefix<DeepKeyOf<T[K]>>}`;
172
- }[Exclude<keyof T, symbol>]
173
- : ""
174
- ) extends infer D
175
- ? Extract<D, string>
176
- : never;
177
-
178
- type DotPrefix<T extends string> = T extends "" ? "" : `.${T}`;
179
-
180
- /**
181
- * Return a container object and field name for the last property in a given property path.
182
- *
183
- * For example, given a path of `"build.upload.format"`) and a starting `root` object
184
- * this will return:
185
- *
186
- * ```
187
- * { container: root.build.upload, field: "format" }
188
- * ```
189
- */
190
- function unwindPropertyPath<T extends object>(
191
- root: T,
192
- path: DeepKeyOf<T>
193
- ): { container: object; field: string } | undefined {
194
- let container: object = root;
195
- const parts = (path as string).split(".");
196
- for (let i = 0; i < parts.length - 1; i++) {
197
- if (!hasProperty(container, parts[i])) {
198
- return;
199
- }
200
- container = container[parts[i]];
201
- }
202
- return { container, field: parts[parts.length - 1] };
203
- }
204
-
205
- /**
206
- * The type of a function that can be used to validate a configuration field.
207
- */
208
- export type ValidatorFn = (
209
- diagnostics: Diagnostics,
210
- field: string,
211
- value: unknown,
212
- topLevelEnv: Environment | undefined
213
- ) => boolean;
214
-
215
- /**
216
- * Validate that the field is a string.
217
- */
218
- export const isString: ValidatorFn = (diagnostics, field, value) => {
219
- if (value !== undefined && typeof value !== "string") {
220
- diagnostics.errors.push(
221
- `Expected "${field}" to be of type string but got ${JSON.stringify(
222
- value
223
- )}.`
224
- );
225
- return false;
226
- }
227
- return true;
228
- };
229
-
230
- /**
231
- * Validate that the `name` field is compliant with EWC constraints.
232
- */
233
- export const isValidName: ValidatorFn = (diagnostics, field, value) => {
234
- if (
235
- (typeof value === "string" && /^$|^[a-z0-9_ ][a-z0-9-_ ]*$/.test(value)) ||
236
- value === undefined
237
- ) {
238
- return true;
239
- } else {
240
- diagnostics.errors.push(
241
- `Expected "${field}" to be of type string, alphanumeric and lowercase with dashes only but got ${JSON.stringify(
242
- value
243
- )}.`
244
- );
245
- return false;
246
- }
247
- };
248
-
249
- /**
250
- * Validate that the field is an array of strings.
251
- */
252
- export const isStringArray: ValidatorFn = (diagnostics, field, value) => {
253
- if (
254
- value !== undefined &&
255
- (!Array.isArray(value) || value.some((item) => typeof item !== "string"))
256
- ) {
257
- diagnostics.errors.push(
258
- `Expected "${field}" to be of type string array but got ${JSON.stringify(
259
- value
260
- )}.`
261
- );
262
- return false;
263
- }
264
- return true;
265
- };
266
-
267
- /**
268
- * Validate that the field is an object containing the given properties.
269
- */
270
- export const isObjectWith =
271
- (...properties: string[]): ValidatorFn =>
272
- (diagnostics, field, value) => {
273
- if (
274
- value !== undefined &&
275
- (typeof value !== "object" ||
276
- value === null ||
277
- !properties.every((prop) => prop in value))
278
- ) {
279
- diagnostics.errors.push(
280
- `Expected "${field}" to be of type object, containing only properties ${properties}, but got ${JSON.stringify(
281
- value
282
- )}.`
283
- );
284
- return false;
285
- }
286
- // it's an object with the field as desired,
287
- // but let's also check for unexpected fields
288
- if (value !== undefined) {
289
- const restFields = Object.keys(value).filter(
290
- (key) => !properties.includes(key)
291
- );
292
- validateAdditionalProperties(diagnostics, field, restFields, []);
293
- }
294
-
295
- return true;
296
- };
297
-
298
- /**
299
- * Validate that the field value is one of the given choices.
300
- */
301
- export const isOneOf =
302
- (...choices: unknown[]): ValidatorFn =>
303
- (diagnostics, field, value) => {
304
- if (value !== undefined && !choices.some((choice) => value === choice)) {
305
- diagnostics.errors.push(
306
- `Expected "${field}" field to be one of ${JSON.stringify(
307
- choices
308
- )} but got ${JSON.stringify(value)}.`
309
- );
310
- return false;
311
- }
312
- return true;
313
- };
314
-
315
- /**
316
- * Aggregate multiple validator functions
317
- */
318
- export const all = (...validations: ValidatorFn[]): ValidatorFn => {
319
- return (diagnostics, field, value, config) => {
320
- let passedValidations = true;
321
-
322
- for (const validate of validations) {
323
- if (!validate(diagnostics, field, value, config)) {
324
- passedValidations = false;
325
- }
326
- }
327
-
328
- return passedValidations;
329
- };
330
- };
331
-
332
- /**
333
- * Check that the field is mutually exclusive with a list of other fields.
334
- *
335
- * @param container the container of the fields to check against.
336
- * @param fields the names of the fields to check against.
337
- */
338
- export const isMutuallyExclusiveWith = <T extends RawEnvironment | RawConfig>(
339
- container: T,
340
- ...fields: (keyof T)[]
341
- ): ValidatorFn => {
342
- return (diagnostics, field, value) => {
343
- if (value === undefined) {
344
- return true;
345
- }
346
-
347
- for (const exclusiveWith of fields) {
348
- if (container[exclusiveWith] !== undefined) {
349
- diagnostics.errors.push(
350
- `Expected exactly one of the following fields ${JSON.stringify([
351
- field,
352
- ...fields,
353
- ])}.`
354
- );
355
- return false;
356
- }
357
- }
358
-
359
- return true;
360
- };
361
- };
362
-
363
- /**
364
- * Validate that the field is a boolean.
365
- */
366
- export const isBoolean: ValidatorFn = (diagnostics, field, value) => {
367
- if (value !== undefined && typeof value !== "boolean") {
368
- diagnostics.errors.push(
369
- `Expected "${field}" to be of type boolean but got ${JSON.stringify(
370
- value
371
- )}.`
372
- );
373
- return false;
374
- }
375
- return true;
376
- };
377
-
378
- /**
379
- * Validate that the required field exists and has the expected type.
380
- */
381
- export const validateRequiredProperty = (
382
- diagnostics: Diagnostics,
383
- container: string,
384
- key: string,
385
- value: unknown,
386
- type: TypeofType,
387
- choices?: unknown[]
388
- ): boolean => {
389
- if (container) {
390
- container += ".";
391
- }
392
- if (value === undefined) {
393
- diagnostics.errors.push(`"${container}${key}" is a required field.`);
394
- return false;
395
- } else if (typeof value !== type) {
396
- diagnostics.errors.push(
397
- `Expected "${container}${key}" to be of type ${type} but got ${JSON.stringify(
398
- value
399
- )}.`
400
- );
401
- return false;
402
- } else if (choices) {
403
- if (
404
- !isOneOf(...choices)(diagnostics, `${container}${key}`, value, undefined)
405
- ) {
406
- return false;
407
- }
408
- }
409
- return true;
410
- };
411
-
412
- /**
413
- * Validate that, if the optional field exists, then it has the expected type.
414
- */
415
- export const validateOptionalProperty = (
416
- diagnostics: Diagnostics,
417
- container: string,
418
- key: string,
419
- value: unknown,
420
- type: TypeofType,
421
- choices?: unknown[]
422
- ): boolean => {
423
- if (value !== undefined) {
424
- return validateRequiredProperty(
425
- diagnostics,
426
- container,
427
- key,
428
- value,
429
- type,
430
- choices
431
- );
432
- }
433
- return true;
434
- };
435
-
436
- /**
437
- * Validate that the field is an array of elements of the given type.
438
- */
439
- export const validateTypedArray = (
440
- diagnostics: Diagnostics,
441
- container: string,
442
- value: unknown,
443
- type: TypeofType
444
- ): boolean => {
445
- let isValid = true;
446
- if (!Array.isArray(value)) {
447
- diagnostics.errors.push(
448
- `Expected "${container}" to be an array of ${type}s but got ${JSON.stringify(
449
- value
450
- )}`
451
- );
452
- isValid = false;
453
- } else {
454
- for (let i = 0; i < value.length; i++) {
455
- isValid =
456
- validateRequiredProperty(
457
- diagnostics,
458
- container,
459
- `[${i}]`,
460
- value[i],
461
- type
462
- ) && isValid;
463
- }
464
- }
465
- return isValid;
466
- };
467
-
468
- /**
469
- * Validate that, if the optional field exists, it is an array of elements of the given type.
470
- */
471
- export const validateOptionalTypedArray = (
472
- diagnostics: Diagnostics,
473
- container: string,
474
- value: unknown,
475
- type: TypeofType
476
- ) => {
477
- if (value !== undefined) {
478
- return validateTypedArray(diagnostics, container, value, type);
479
- }
480
- return true;
481
- };
482
-
483
- /**
484
- * Test to see if `obj` has the required property `prop` of type `type`.
485
- */
486
- export const isRequiredProperty = <T extends object>(
487
- obj: object,
488
- prop: keyof T,
489
- type: TypeofType,
490
- choices?: unknown[]
491
- ): obj is T =>
492
- hasProperty<T>(obj, prop) &&
493
- typeof obj[prop] === type &&
494
- (choices === undefined || choices.includes(obj[prop]));
495
-
496
- /**
497
- * Test to see if `obj` has the optional property `prop` of type `type`.
498
- */
499
- export const isOptionalProperty = <T extends object>(
500
- obj: object,
501
- prop: keyof T,
502
- type: TypeofType
503
- ): obj is T => !hasProperty<T>(obj, prop) || typeof obj[prop] === type;
504
-
505
- /**
506
- * Test to see if `obj` has the property `prop`.
507
- */
508
- export const hasProperty = <T extends object>(
509
- obj: object,
510
- property: keyof T
511
- ): obj is T => property in obj;
512
-
513
- /**
514
- * Add warning messages about any properties in the given field that are not expected to be there.
515
- */
516
- export const validateAdditionalProperties = (
517
- diagnostics: Diagnostics,
518
- fieldPath: string,
519
- restProps: Iterable<string>,
520
- knownProps: Iterable<string>
521
- ): boolean => {
522
- const restPropSet = new Set(restProps);
523
- for (const knownProp of knownProps) {
524
- restPropSet.delete(knownProp);
525
- }
526
- if (restPropSet.size > 0) {
527
- const fields = Array.from(restPropSet.keys()).map((field) => `"${field}"`);
528
- diagnostics.warnings.push(
529
- `Unexpected fields found in ${fieldPath} field: ${fields}`
530
- );
531
- return false;
532
- }
533
- return true;
534
- };
535
-
536
- /**
537
- * Get the names of the bindings collection in `value`.
538
- *
539
- * Will return an empty array if it doesn't understand the value
540
- * passed in, so another form of validation should be
541
- * performed externally.
542
- */
543
- export const getBindingNames = (value: unknown): string[] => {
544
- if (typeof value !== "object" || value === null) {
545
- return [];
546
- }
547
-
548
- if (isBindingList(value)) {
549
- return value.bindings.map(({ name }) => name);
550
- } else if (isNamespaceList(value)) {
551
- return value.map(({ binding }) => binding);
552
- } else if (isRecord(value)) {
553
- return Object.keys(value).filter((k) => value[k] !== undefined);
554
- } else {
555
- return [];
556
- }
557
- };
558
-
559
- const isBindingList = (
560
- value: unknown
561
- ): value is {
562
- bindings: {
563
- name: string;
564
- }[];
565
- } =>
566
- isRecord(value) &&
567
- "bindings" in value &&
568
- Array.isArray(value.bindings) &&
569
- value.bindings.every(
570
- (binding) =>
571
- isRecord(binding) && "name" in binding && typeof binding.name === "string"
572
- );
573
-
574
- const isNamespaceList = (value: unknown): value is { binding: string }[] =>
575
- Array.isArray(value) &&
576
- value.every(
577
- (entry) =>
578
- isRecord(entry) && "binding" in entry && typeof entry.binding === "string"
579
- );
580
-
581
- const isRecord = (
582
- value: unknown
583
- ): value is Record<string | number | symbol, unknown> =>
584
- typeof value === "object" && value !== null && !Array.isArray(value);
585
-
586
- /**
587
- * JavaScript `typeof` operator return values.
588
- */
589
- type TypeofType =
590
- | "string"
591
- | "number"
592
- | "bigint"
593
- | "boolean"
594
- | "symbol"
595
- | "undefined"
596
- | "object"
597
- | "function";