@cloudflare/workers-utils 0.2.0 → 0.3.0

package/dist/browser.mjs

@@ -1 +1,2 @@
-export { constructWranglerConfig } from './chunk-DBPNILFW.mjs';
+export { constructWranglerConfig } from './chunk-73TUG5Z7.mjs';
+import './chunk-DCOBXSFB.mjs';

package/dist/{chunk-DBPNILFW.mjs → chunk-73TUG5Z7.mjs}

@@ -1,5 +1,4 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { __name } from './chunk-DCOBXSFB.mjs';
 
 // src/constants.ts
 var INHERIT_SYMBOL = Symbol.for("inherit_binding");
@@ -437,4 +436,4 @@ function constructWranglerConfig(workerOrWorkers) {
 }
 __name(constructWranglerConfig, "constructWranglerConfig");
 
-export { ENVIRONMENT_TAG_PREFIX, INHERIT_SYMBOL, PATH_TO_DEPLOY_CONFIG, SERVICE_TAG_PREFIX, __name, assertNever, constructWranglerConfig, formatCompatibilityDate, mapWorkerMetadataBindings };
+export { ENVIRONMENT_TAG_PREFIX, INHERIT_SYMBOL, PATH_TO_DEPLOY_CONFIG, SERVICE_TAG_PREFIX, assertNever, constructWranglerConfig, formatCompatibilityDate, mapWorkerMetadataBindings };

package/dist/chunk-DCOBXSFB.mjs

@@ -0,0 +1,39 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+export { __commonJS, __export, __name, __reExport, __require, __toESM };

package/dist/index.d.mts

@@ -349,4 +349,315 @@ declare function formatCompatibilityDate(date: Date): string;
  */
 declare function mapWorkerMetadataBindings(bindings: WorkerMetadataBinding[]): RawConfig;
 
-export { APIError, CfWorkerInit, CommandLineArgsError, Config, type ConfigBindingOptions, DeprecationError, FatalError, type File, JsonFriendlyFatalError, type Location, type Message, MissingConfigError, type NormalizeAndValidateConfigArgs, type PackageJSON, ParseError, PatchConfigError, RawConfig, type ResolveConfigPathOptions, type TelemetryMessage, UserError, WorkerMetadataBinding, assertNever, bucketFormatMessage, configFileName, configFormat, createFatalError, experimental_patchConfig, experimental_readRawConfig, findWranglerConfig, formatCompatibilityDate, formatConfigSnippet, friendlyBindingNames, hasProperty, indexLocation, isOptionalProperty, isPagesConfig, isRequiredProperty, isValidR2BucketName, mapWorkerMetadataBindings, normalizeAndValidateConfig, parseByteSize, parseHumanDuration, parseJSON, parseJSONC, parseNonHyphenedUuid, parsePackageJSON, parseTOML, readFileSync, readFileSyncToBuffer, resolveWranglerConfigPath, searchLocation, validatePagesConfig };
+/**
+ * Environment variables supported by Wrangler for configuration and authentication.
+ * Each variable is documented with its individual JSDoc comment below.
+ */
+type VariableNames = 
+/** Overrides the account ID for API requests. Can also be set in Wrangler config via `account_id` field. */
+"CLOUDFLARE_ACCOUNT_ID"
+/** API token for authentication. Preferred over API key + email. */
+ | "CLOUDFLARE_API_TOKEN"
+/** Legacy API key for authentication. Requires CLOUDFLARE_EMAIL. It is preferred to use `CLOUDFLARE_API_TOKEN`. */
+ | "CLOUDFLARE_API_KEY"
+/** Email address for API key authentication. Used with `CLOUDFLARE_API_KEY`. It is preferred to use `CLOUDFLARE_API_TOKEN`. */
+ | "CLOUDFLARE_EMAIL"
+/** Custom API base URL. Defaults to https://api.cloudflare.com/client/v4 */
+ | "CLOUDFLARE_API_BASE_URL"
+/** Set to "fedramp_high" for FedRAMP High compliance region. This will update the API/AUTH URLs used to make requests to Cloudflare. */
+ | "CLOUDFLARE_COMPLIANCE_REGION"
+/** API token for R2 SQL service. */
+ | "WRANGLER_R2_SQL_AUTH_TOKEN"
+/** Local database connection strings for Hyperdrive development. The * should be replaced with the Hyperdrive binding name in the Worker. */
+ | `CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_${string}`
+/** Suppress Hyperdrive-related warnings during development. */
+ | "NO_HYPERDRIVE_WARNING"
+/** Path to HTTPS private key file for running the local development server in HTTPS mode. Without this Wrangler will generate keys automatically. */
+ | "WRANGLER_HTTPS_KEY_PATH"
+/** Path to HTTPS certificate file for running the local development server in HTTPS mode. Without this Wrangler will generate keys automatically. */
+ | "WRANGLER_HTTPS_CERT_PATH"
+/** Load development variables from .env files (default: true). */
+ | "CLOUDFLARE_LOAD_DEV_VARS_FROM_DOT_ENV"
+/** Include process.env in development variables (default: false). */
+ | "CLOUDFLARE_INCLUDE_PROCESS_ENV"
+/** Include a trace header in all API requests that Wrangler makes (for internal use only) */
+ | "WRANGLER_TRACE_ID"
+/** Disable the check for mixed state of subdomain flags (`workers_dev`, `preview_urls`, etc.) (default: false). */
+ | "WRANGLER_DISABLE_SUBDOMAIN_MIXED_STATE_CHECK"
+/** Set log level: "debug", "info", "log", "warn", "error". */
+ | "WRANGLER_LOG"
+/** Directory for debug log files. */
+ | "WRANGLER_LOG_PATH"
+/** Sanitize sensitive data in debug logs (default: true). */
+ | "WRANGLER_LOG_SANITIZE"
+/** Directory for ND-JSON output files. */
+ | "WRANGLER_OUTPUT_FILE_DIRECTORY"
+/** Hide the Wrangler version banner */
+ | "WRANGLER_HIDE_BANNER"
+/** Specific path for ND-JSON output file. */
+ | "WRANGLER_OUTPUT_FILE_PATH"
+/** Comma-separated list of build conditions for esbuild. */
+ | "WRANGLER_BUILD_CONDITIONS"
+/** Build platform for esbuild (e.g., "node", "browser"). */
+ | "WRANGLER_BUILD_PLATFORM"
+/** Path to file-based dev registry folder. */
+ | "WRANGLER_REGISTRY_PATH"
+/** Additional D1 location choices (internal use). */
+ | "WRANGLER_D1_EXTRA_LOCATION_CHOICES"
+/** The Workers environment to target (equivalent to the `--env` CLI param) */
+ | "CLOUDFLARE_ENV"
+/** Set to "staging" to use staging APIs instead of production. */
+ | "WRANGLER_API_ENVIRONMENT"
+/** Custom auth domain (usually auto-configured). */
+ | "WRANGLER_AUTH_DOMAIN"
+/** Custom auth URL (usually auto-configured). */
+ | "WRANGLER_AUTH_URL"
+/** Custom OAuth client ID (usually auto-configured). */
+ | "WRANGLER_CLIENT_ID"
+/** Custom token URL (usually auto-configured). */
+ | "WRANGLER_TOKEN_URL"
+/** Custom token revocation URL (usually auto-configured). */
+ | "WRANGLER_REVOKE_URL"
+/** Direct authorization token for API requests. */
+ | "WRANGLER_CF_AUTHORIZATION_TOKEN"
+/** Override command used by `wrangler init` (default: "create cloudflare@^2.5.0"). */
+ | "WRANGLER_C3_COMMAND"
+/** Enable/disable telemetry data collection. */
+ | "WRANGLER_SEND_METRICS"
+/** Enable/disable error reporting to Sentry. */
+ | "WRANGLER_SEND_ERROR_REPORTS"
+/** CI branch name (internal use). */
+ | "WORKERS_CI_BRANCH"
+/** CI tag matching configuration (internal use). */
+ | "WRANGLER_CI_MATCH_TAG"
+/** CI override name configuration (internal use). */
+ | "WRANGLER_CI_OVERRIDE_NAME"
+/** CI network mode host override (internal use). */
+ | "WRANGLER_CI_OVERRIDE_NETWORK_MODE_HOST"
+/** CI preview alias generation (internal use). */
+ | "WRANGLER_CI_GENERATE_PREVIEW_ALIAS"
+/** Disable config watching in ConfigController. */
+ | "WRANGLER_CI_DISABLE_CONFIG_WATCHING"
+/** Path to docker binary (default: "docker"). */
+ | "WRANGLER_DOCKER_BIN"
+/** Docker host configuration (handled separately from environment variable factory). */
+ | "WRANGLER_DOCKER_HOST"
+/** Docker host configuration (handled separately from environment variable factory). */
+ | "DOCKER_HOST";
+type DeprecatedNames = "CF_ACCOUNT_ID" | "CF_API_TOKEN" | "CF_API_KEY" | "CF_EMAIL" | "CF_API_BASE_URL";
+type ElementType<A> = A extends readonly (infer T)[] ? T : never;
+/**
+ * Create a function used to access a boolean environment variable. It may return undefined if the variable is not set.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ *
+ * The environment variable must be either "true" or "false" (after lowercasing), otherwise it will throw an error.
+ */
+declare function getBooleanEnvironmentVariableFactory(options: {
+    variableName: VariableNames;
+}): () => boolean | undefined;
+declare function getBooleanEnvironmentVariableFactory(options: {
+    variableName: VariableNames;
+    defaultValue: boolean | (() => boolean);
+}): () => boolean;
+/**
+ * Create a function used to access an environment variable. It may return undefined if the variable is not set.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ * A warning is shown if the client is using a deprecated version - but only once.
+ * If a list of choices is provided, then the environment variable must be one of those given.
+ */
+declare function getEnvironmentVariableFactory<Choices extends readonly string[]>(options: {
+    variableName: VariableNames;
+    deprecatedName?: DeprecatedNames;
+    choices?: Choices;
+}): () => ElementType<Choices> | undefined;
+/**
+ * Create a function used to access an environment variable, with a default value if the variable is not set.
+ *
+ * This is not memoized to allow us to change the value at runtime, such as in testing.
+ * A warning is shown if the client is using a deprecated version - but only once.
+ * If a list of choices is provided, then the environment variable must be one of those given.
+ */
+declare function getEnvironmentVariableFactory<Choices extends readonly string[]>(options: {
+    variableName: VariableNames;
+    deprecatedName?: DeprecatedNames;
+    defaultValue: () => ElementType<Choices>;
+    readonly choices?: Choices;
+}): () => ElementType<Choices>;
+
+/**
+ * `WRANGLER_C3_COMMAND` can override the command used by `wrangler init` when delegating to C3.
+ *
+ * By default this will use `create cloudflare@2`.
+ *
+ * To run against the beta release of C3 use:
+ *
+ * ```sh
+ * # Tell Wrangler to use the beta version of create-cloudflare
+ * WRANGLER_C3_COMMAND="create cloudflare@beta" npx wrangler init
+ * ```
+ *
+ * To test the integration between wrangler and C3 locally, use:
+ *
+ * ```sh
+ * # Ensure both Wrangler and C3 are built
+ * npm run build
+ * # Tell Wrangler to use the local version of create-cloudflare
+ * WRANGLER_C3_COMMAND="exec ./packages/create-cloudflare" npx wrangler init temp
+ * ```
+ *
+ * Note that you cannot use `WRANGLER_C3_COMMAND="create cloudflare@2"` if you are
+ * running Wrangler from inside the monorepo as the bin paths get messed up.
+ */
+declare const getC3CommandFromEnv: () => string;
+/**
+ * `WRANGLER_SEND_METRICS` can override whether we attempt to send metrics information to Sparrow.
+ */
+declare const getWranglerSendMetricsFromEnv: () => boolean | undefined;
+/**
+ * `WRANGLER_SEND_ERROR_REPORTS` can override whether we attempt to send error reports to Sentry.
+ */
+declare const getWranglerSendErrorReportsFromEnv: () => boolean | undefined;
+/**
+ * Set `WRANGLER_API_ENVIRONMENT` environment variable to "staging" to tell Wrangler to hit the staging APIs rather than production.
+ */
+declare const getCloudflareApiEnvironmentFromEnv: () => "staging" | "production";
+/**
+ * The compliance region to use for the API requests.
+ */
+type ComplianceConfig = Partial<Pick<Config, "compliance_region">>;
+/** Used for commands that explicitly do not support compliance regions other than "public" */
+declare const COMPLIANCE_REGION_CONFIG_PUBLIC: ComplianceConfig;
+/**
+ * Used for commands where there is no configuration available and
+ * we rely upon the CLOUDFLARE_COMPLIANCE_REGION environment variable
+ * to determine the compliance region.
+ */
+declare const COMPLIANCE_REGION_CONFIG_UNKNOWN: ComplianceConfig;
+/**
+ * Set `CLOUDFLARE_COMPLIANCE_REGION` environment variable to "fedramp_high"
+ * or set the `compliance_region` property in the Wrangler configuration
+ * to tell Wrangler to run in FedRAMP High compliance region mode, rather than "public" mode.
+ */
+declare const getCloudflareComplianceRegion: (complianceConfig: ComplianceConfig) => "public" | "fedramp_high";
+/**
+ * `CLOUDFLARE_API_BASE_URL` specifies the URL to the Cloudflare API.
+ *
+ * If this environment variable is not set, it will default to a URL computed from the
+ * Cloudflare compliance region and the API environment.
+ */
+declare const getCloudflareApiBaseUrl: (complianceConfig: ComplianceConfig) => string;
+/**
+ * Compute the subdomain for the compliance region.
+ */
+declare function getComplianceRegionSubdomain(complianceConfig: ComplianceConfig): string;
+/**
+ * `WRANGLER_LOG_SANITIZE` specifies whether we sanitize debug logs.
+ *
+ * By default we do, since debug logs could be added to GitHub issues and shouldn't include sensitive information.
+ */
+declare const getSanitizeLogs: () => boolean;
+/**
+ * `WRANGLER_OUTPUT_FILE_DIRECTORY` specifies a directory where we should write a file containing output data in ND-JSON format.
+ *
+ * If this is set a random file will be created in this directory, and certain Wrangler commands will write entries to this file.
+ * This is overridden by the `WRANGLER_OUTPUT_FILE_PATH` environment variable.
+ */
+declare const getOutputFileDirectoryFromEnv: () => string | undefined;
+/**
+ * `WRANGLER_OUTPUT_FILE_PATH` specifies a path to a file where we should write output data in ND-JSON format.
+ *
+ * If this is set certain Wrangler commands will write entries to this file.
+ * This overrides the `WRANGLER_OUTPUT_FILE_DIRECTORY` environment variable.
+ */
+declare const getOutputFilePathFromEnv: () => string | undefined;
+/**
+ * `WRANGLER_CI_MATCH_TAG` specifies a Worker tag
+ *
+ * If this is set, Wrangler will ensure the Worker being targeted has this tag
+ */
+declare const getCIMatchTag: () => string | undefined;
+/**
+ * `WRANGLER_CI_OVERRIDE_NAME` specifies a Worker name
+ *
+ * If this is set, Wrangler will override the Worker name with this one
+ */
+declare const getCIOverrideName: () => string | undefined;
+/**
+ * `WRANGLER_CI_OVERRIDE_NETWORK_MODE_HOST` specifies whether --network=host should be set
+ *
+ * If this is set to true, Wrangler will use the --network=host flag when calling out to docker to build container images
+ */
+declare const getCIOverrideNetworkModeHost: () => string | undefined;
+/**
+ * `WRANGLER_CI_GENERATE_PREVIEW_ALIAS` specifies whether to generate a preview alias during version upload
+ *
+ * If this is set to true, Wrangler will attempt to autogenerate the preview alias by using the branch
+ * name. If the branch name is too long and an alias cannot be created, a warning will be printed to the console.
+ */
+declare const getCIGeneratePreviewAlias: () => "true" | "false";
+/**
+ * `WORKERS_CI_BRANCH` is the branch name exposed by Workers CI
+ *
+ */
+declare const getWorkersCIBranchName: () => string | undefined;
+/**
+ * `WRANGLER_BUILD_CONDITIONS` specifies the "build conditions" to use when importing packages at build time.
+ *
+ * See https://nodejs.org/api/packages.html#conditional-exports
+ * and https://esbuild.github.io/api/#how-conditions-work.
+ *
+ * If this is set, Wrangler will configure esbuild to use this list of conditions.
+ * The format is a string of comma separated conditions.
+ */
+declare const getBuildConditionsFromEnv: () => string | undefined;
+/**
+ * `WRANGLER_BUILD_PLATFORM` specifies the "build platform" to use when importing packages at build time.
+ *
+ * See https://esbuild.github.io/api/#platform
+ * and https://esbuild.github.io/api/#how-conditions-work.
+ *
+ * If this is set, Wrangler will configure esbuild to use this platform.
+ */
+declare const getBuildPlatformFromEnv: () => string | undefined;
+/**
+ * `WRANGLER_REGISTRY_PATH` specifies the file based dev registry folder
+ */
+declare const getRegistryPath: () => string;
+/**
+ * `WRANGLER_D1_EXTRA_LOCATION_CHOICES` is an internal variable to let D1 team target their testing environments.
+ *
+ * External accounts cannot access testing environments, so should not set this variable.
+ */
+declare const getD1ExtraLocationChoices: () => string | undefined;
+/**
+ * `WRANGLER_DOCKER_BIN` specifies the path to a docker binary.
+ *
+ * By default it's `docker`.
+ */
+declare const getDockerPath: () => string;
+declare const getSubdomainMixedStateCheckDisabled: () => boolean;
+/**
+/**
+ * `CLOUDFLARE_LOAD_DEV_VARS_FROM_DOT_ENV` specifies whether to load vars for local dev from `.env` files.
+ */
+declare const getCloudflareLoadDevVarsFromDotEnv: () => boolean;
+/**
+ * `CLOUDFLARE_INCLUDE_PROCESS_ENV` specifies whether to include the `process.env` in vars loaded from `.env` for local development.
+ */
+declare const getCloudflareIncludeProcessEnvFromEnv: () => boolean;
+declare const getTraceHeader: () => string | undefined;
+declare const getDisableConfigWatching: () => boolean;
+/**
+ * Hide the Wrangler version banner and command status (deprecated/experimental) warnings
+ */
+declare const getWranglerHideBanner: () => boolean;
+/**
+ * `CLOUDFLARE_ENV` specifies the currently selected Wrangler/Cloudflare environment.
+ */
+declare const getCloudflareEnv: () => string | undefined;
+
+declare function getGlobalWranglerConfigPath(): string;
+
+export { APIError, COMPLIANCE_REGION_CONFIG_PUBLIC, COMPLIANCE_REGION_CONFIG_UNKNOWN, CfWorkerInit, CommandLineArgsError, type ComplianceConfig, Config, type ConfigBindingOptions, DeprecationError, FatalError, type File, JsonFriendlyFatalError, type Location, type Message, MissingConfigError, type NormalizeAndValidateConfigArgs, type PackageJSON, ParseError, PatchConfigError, RawConfig, type ResolveConfigPathOptions, type TelemetryMessage, UserError, WorkerMetadataBinding, assertNever, bucketFormatMessage, configFileName, configFormat, createFatalError, experimental_patchConfig, experimental_readRawConfig, findWranglerConfig, formatCompatibilityDate, formatConfigSnippet, friendlyBindingNames, getBooleanEnvironmentVariableFactory, getBuildConditionsFromEnv, getBuildPlatformFromEnv, getC3CommandFromEnv, getCIGeneratePreviewAlias, getCIMatchTag, getCIOverrideName, getCIOverrideNetworkModeHost, getCloudflareApiBaseUrl, getCloudflareApiEnvironmentFromEnv, getCloudflareComplianceRegion, getCloudflareEnv, getCloudflareIncludeProcessEnvFromEnv, getCloudflareLoadDevVarsFromDotEnv, getComplianceRegionSubdomain, getD1ExtraLocationChoices, getDisableConfigWatching, getDockerPath, getEnvironmentVariableFactory, getGlobalWranglerConfigPath, getOutputFileDirectoryFromEnv, getOutputFilePathFromEnv, getRegistryPath, getSanitizeLogs, getSubdomainMixedStateCheckDisabled, getTraceHeader, getWorkersCIBranchName, getWranglerHideBanner, getWranglerSendErrorReportsFromEnv, getWranglerSendMetricsFromEnv, hasProperty, indexLocation, isOptionalProperty, isPagesConfig, isRequiredProperty, isValidR2BucketName, mapWorkerMetadataBindings, normalizeAndValidateConfig, parseByteSize, parseHumanDuration, parseJSON, parseJSONC, parseNonHyphenedUuid, parsePackageJSON, parseTOML, readFileSync, readFileSyncToBuffer, resolveWranglerConfigPath, searchLocation, validatePagesConfig };