@cloudflare/workers-utils 0.24.0 → 0.25.1

package/dist/index.d.mts

@@ -1,7 +1,9 @@
-import { C as ComputedFields, B as Binding, R as RawConfig, b as Config, W as WorkerMetadataBinding, L as Logger, c as Route } from './config-8UymS5SL.mjs';
-export { bw as ApiCredentials, aA as AssetConfigMetadata, A as Assets, aB as AssetsOptions, aN as AsyncHook, aI as BinaryFile, b0 as COMPLIANCE_REGION_CONFIG_PUBLIC, b1 as COMPLIANCE_REGION_CONFIG_UNKNOWN, t as CacheOptions, K as CfAIBinding, a4 as CfAISearch, a3 as CfAISearchNamespace, aK as CfAccount, a6 as CfAgentMemory, ai as CfAnalyticsEngineDataset, a8 as CfArtifacts, an as CfAssetsBinding, J as CfBrowserBinding, aq as CfCapnp, a1 as CfD1Database, X as CfDataBlobBindings, ae as CfDevPluginCfg, aj as CfDispatchNamespace, Y as CfDurableObject, as as CfDurableObjectMigrations, aa as CfFlagship, a9 as CfHelloWorld, ad as CfHyperdrive, M as CfImagesBinding, F as CfKvNamespace, al as CfLogfwdr, am as CfLogfwdrBinding, ak as CfMTlsCertificate, N as CfMediaBinding, y as CfModule, x as CfModuleType, ao as CfPipeline, at as CfPlacement, $ as CfQueue, a0 as CfR2Bucket, ac as CfRateLimit, w as CfScriptFormat, a7 as CfSecretsStoreSecrets, G as CfSendEmailBindings, af as CfService, Q as CfStreamBinding, au as CfTailConsumer, I as CfTextBlobBindings, ar as CfUnsafe, ap as CfUnsafeBinding, av as CfUserLimits, z as CfVars, a2 as CfVectorize, V as CfVersionMetadataBinding, ah as CfVpcNetwork, ag as CfVpcService, H as CfWasmModuleBindings, a5 as CfWebSearch, ax as CfWorkerContext, aw as CfWorkerInit, ab as CfWorkerLoader, ay as CfWorkerSourceMap, _ as CfWorkflow, l as CloudchamberConfig, a$ as ComplianceConfig, e as ConfigFields, r as ConfigModuleRuleType, m as ContainerApp, v as ContainerEngine, k as CustomDomainRoute, s as DispatchNamespaceOutbound, u as DockerConfiguration, n as DurableObjectBindings, D as DurableObjectMigration, aU as ENVIRONMENT_TAG_PREFIX, aR as Entry, E as Environment, p as EnvironmentNonInheritable, bO as FetchKVGetValueFetcher, bz as FetchListResultFetcher, bA as FetchPagedListResultFetcher, bx as FetchResult, by as FetchResultFetcher, aH as File, aM as Hook, aL as HookValues, aS as INHERIT_SYMBOL, aW as JSON_CONFIG_FORMATS, az as Json, h as LOGGER_LEVELS, aD as LegacyAssetPaths, aO as LogLevel, i as LoggerLevel, aP as NodeJSCompatMode, O as Observability, aV as PATH_TO_DEPLOY_CONFIG, P as PreviewsConfig, d as RawDevConfig, f as RawEnvironment, a as RedirectedRawConfig, q as Rule, aT as SERVICE_TAG_PREFIX, aG as ServiceFetch, aF as ServiceMetadataRes, aQ as StartDevWorkerInput, S as StreamingTailConsumer, T as TailConsumer, aJ as Trigger, U as UserLimits, aC as ValidatedAssetsOptions, aE as WorkerMetadata, o as WorkflowBinding, Z as ZoneIdRoute, j as ZoneNameRoute, bL as addAuthorizationHeader, g as defaultWranglerConfig, bI as extractAccountTag, bH as extractWAFBlockRayId, bC as fetchInternalBase, bN as fetchKVGetValueBase, bE as fetchListResultBase, bD as fetchResultBase, br as getBrowserRenderingHeadfulFromEnv, bd as getBuildConditionsFromEnv, be as getBuildPlatformFromEnv, aX as getC3CommandFromEnv, bb as getCIGeneratePreviewAlias, b8 as getCIMatchTag, b9 as getCIOverrideName, ba as getCIOverrideNetworkModeHost, bs as getCfFetchEnabledFromEnv, bt as getCfFetchPathFromEnv, b3 as getCloudflareApiBaseUrl, a_ as getCloudflareApiEnvironmentFromEnv, b2 as getCloudflareComplianceRegion, bo as getCloudflareEnv, bk as getCloudflareIncludeProcessEnvFromEnv, bj as getCloudflareLoadDevVarsFromDotEnv, bv as getCloudflaredPathFromEnv, b4 as getComplianceRegionSubdomain, bg as getD1ExtraLocationChoices, bm as getDisableConfigWatching, bh as getDockerPath, bq as getLocalExplorerEnabledFromEnv, bp as getOpenNextDeployFromEnv, b6 as getOutputFileDirectoryFromEnv, b7 as getOutputFilePathFromEnv, bf as getRegistryPath, b5 as getSanitizeLogs, bi as getSubdomainMixedStateCheckDisabled, bl as getTraceHeader, bc as getWorkersCIBranchName, bu as getWranglerCacheDirFromEnv, bn as getWranglerHideBanner, aZ as getWranglerSendErrorReportsFromEnv, aY as getWranglerSendMetricsFromEnv, bP as hasCursor, bJ as hasMorePages, bG as isWAFBlockResponse, bQ as maybeAddTraceHeader, bB as performApiFetchBase, bK as renderError, bM as throwFetchError, bF as truncate } from './config-8UymS5SL.mjs';
+import { C as ComputedFields, B as Binding, R as RawConfig, b as Config, E as Exports, D as DurableObjectExport, W as WorkerEntrypointExport, c as WorkerMetadataBinding, L as Logger, d as Route } from './config-B_-PmLum.mjs';
+export { bK as ApiCredentials, aG as AssetConfigMetadata, A as Assets, aH as AssetsOptions, a$ as AsyncHook, aW as BinaryFile, be as COMPLIANCE_REGION_CONFIG_PUBLIC, bf as COMPLIANCE_REGION_CONFIG_UNKNOWN, y as CacheOptions, X as CfAIBinding, a9 as CfAISearch, a8 as CfAISearchNamespace, aY as CfAccount, ab as CfAgentMemory, an as CfAnalyticsEngineDataset, ad as CfArtifacts, as as CfAssetsBinding, V as CfBrowserBinding, av as CfCapnp, a6 as CfD1Database, a1 as CfDataBlobBindings, aj as CfDevPluginCfg, ao as CfDispatchNamespace, a2 as CfDurableObject, ax as CfDurableObjectMigrations, ay as CfExports, af as CfFlagship, ae as CfHelloWorld, ai as CfHyperdrive, Y as CfImagesBinding, K as CfKvNamespace, aq as CfLogfwdr, ar as CfLogfwdrBinding, ap as CfMTlsCertificate, _ as CfMediaBinding, I as CfModule, H as CfModuleType, at as CfPipeline, az as CfPlacement, a4 as CfQueue, a5 as CfR2Bucket, ah as CfRateLimit, G as CfScriptFormat, ac as CfSecretsStoreSecrets, M as CfSendEmailBindings, ak as CfService, $ as CfStreamBinding, aA as CfTailConsumer, Q as CfTextBlobBindings, aw as CfUnsafe, au as CfUnsafeBinding, aB as CfUserLimits, J as CfVars, a7 as CfVectorize, a0 as CfVersionMetadataBinding, am as CfVpcNetwork, al as CfVpcService, N as CfWasmModuleBindings, aa as CfWebSearch, aD as CfWorkerContext, aC as CfWorkerInit, ag as CfWorkerLoader, aE as CfWorkerSourceMap, a3 as CfWorkflow, n as CloudchamberConfig, bd as ComplianceConfig, f as ConfigFields, w as ConfigModuleRuleType, r as ConfiguredExport, o as ContainerApp, F as ContainerEngine, m as CustomDomainRoute, x as DispatchNamespaceOutbound, z as DockerConfiguration, s as DurableObjectBindings, q as DurableObjectExportStorage, p as DurableObjectMigration, b6 as ENVIRONMENT_TAG_PREFIX, b3 as Entry, k as Environment, u as EnvironmentNonInheritable, aL as ExportsReconciliationEntryBase, aO as ExportsReconciliationErrorDetail, aM as ExportsReconciliationInfo, aP as ExportsReconciliationRename, aS as ExportsReconciliationResult, aQ as ExportsReconciliationTransfer, aR as ExportsReconciliationTransferPending, aN as ExportsReconciliationWarning, c0 as FetchKVGetValueFetcher, bN as FetchListResultFetcher, bO as FetchPagedListResultFetcher, bL as FetchResult, bM as FetchResultFetcher, aV as File, a_ as Hook, aZ as HookValues, b4 as INHERIT_SYMBOL, b8 as JSON_CONFIG_FORMATS, aF as Json, i as LOGGER_LEVELS, aJ as LegacyAssetPaths, b0 as LogLevel, j as LoggerLevel, b1 as NodeJSCompatMode, O as Observability, b7 as PATH_TO_DEPLOY_CONFIG, P as PreviewsConfig, e as RawDevConfig, g as RawEnvironment, a as RedirectedRawConfig, v as Rule, b5 as SERVICE_TAG_PREFIX, aU as ServiceFetch, aT as ServiceMetadataRes, b2 as StartDevWorkerInput, S as StreamingTailConsumer, T as TailConsumer, aX as Trigger, U as UserLimits, aI as ValidatedAssetsOptions, aK as WorkerMetadata, t as WorkflowBinding, Z as ZoneIdRoute, l as ZoneNameRoute, bZ as addAuthorizationHeader, h as defaultWranglerConfig, bW as extractAccountTag, bV as extractWAFBlockRayId, bQ as fetchInternalBase, b$ as fetchKVGetValueBase, bS as fetchListResultBase, bR as fetchResultBase, bF as getBrowserRenderingHeadfulFromEnv, br as getBuildConditionsFromEnv, bs as getBuildPlatformFromEnv, b9 as getC3CommandFromEnv, bp as getCIGeneratePreviewAlias, bm as getCIMatchTag, bn as getCIOverrideName, bo as getCIOverrideNetworkModeHost, bG as getCfFetchEnabledFromEnv, bH as getCfFetchPathFromEnv, bh as getCloudflareApiBaseUrl, bc as getCloudflareApiEnvironmentFromEnv, bg as getCloudflareComplianceRegion, bC as getCloudflareEnv, by as getCloudflareIncludeProcessEnvFromEnv, bx as getCloudflareLoadDevVarsFromDotEnv, bJ as getCloudflaredPathFromEnv, bi as getComplianceRegionSubdomain, bu as getD1ExtraLocationChoices, bA as getDisableConfigWatching, bv as getDockerPath, bE as getLocalExplorerEnabledFromEnv, bD as getOpenNextDeployFromEnv, bk as getOutputFileDirectoryFromEnv, bl as getOutputFilePathFromEnv, bt as getRegistryPath, bj as getSanitizeLogs, bw as getSubdomainMixedStateCheckDisabled, bz as getTraceHeader, bq as getWorkersCIBranchName, bI as getWranglerCacheDirFromEnv, bB as getWranglerHideBanner, bb as getWranglerSendErrorReportsFromEnv, ba as getWranglerSendMetricsFromEnv, c1 as hasCursor, bX as hasMorePages, bU as isWAFBlockResponse, c2 as maybeAddTraceHeader, bP as performApiFetchBase, bY as renderError, b_ as throwFetchError, bT as truncate } from './config-B_-PmLum.mjs';
 import * as jsoncParser from 'jsonc-parser';
 export { constructWranglerConfig } from './browser.mjs';
+export { GetGlobalConfigPathOptions, getGlobalConfigPath, getGlobalWranglerCachePath } from './global-wrangler-config-path.mjs';
+export { isDirectory, removeDir, removeDirSync } from './fs-helpers.mjs';
 export { Counter, MetricsRegistry } from './prometheus-metrics.mjs';
 import { ChildProcess } from 'node:child_process';
 import 'node:url';
@@ -93,10 +95,6 @@ declare const bucketFormatMessage = "Bucket names must begin and end with an alp
  * These are the keys used in Wrangler's config file
  */
 type ConfigBindingFieldName = "data_blobs" | "durable_objects" | "kv_namespaces" | "send_email" | "queues" | "d1_databases" | "vectorize" | "ai_search_namespaces" | "ai_search" | "websearch" | "agent_memory" | "hyperdrive" | "r2_buckets" | "logfwdr" | "services" | "analytics_engine_datasets" | "text_blobs" | "browser" | "ai" | "images" | "stream" | "media" | "version_metadata" | "unsafe" | "vars" | "wasm_modules" | "dispatch_namespaces" | "mtls_certificates" | "workflows" | "pipelines" | "secrets_store_secrets" | "artifacts" | "ratelimits" | "assets" | "unsafe_hello_world" | "flagship" | "worker_loaders" | "vpc_services" | "vpc_networks";
-/**
- * @deprecated new code should use getBindingTypeFriendlyName() instead
- */
-declare const friendlyBindingNames: Record<ConfigBindingFieldName, string>;
 /**
  * Get a friendly name for a binding type, handling unsafe bindings
  */
@@ -142,6 +140,13 @@ declare function normalizeAndValidateConfig(rawConfig: RawConfig, configPath: st
  */
 declare function isDockerfile(imagePath: string, configPath: string | undefined): boolean;
 
+type ExportType = Exports[string]["type"];
+interface PartitionedExports {
+    "durable-object": Record<string, DurableObjectExport>;
+    worker: Record<string, WorkerEntrypointExport>;
+}
+declare function partitionExports(exports: Exports | undefined): PartitionedExports;
+
 type ConfigBindingOptions = Pick<Config, "ai" | "browser" | "d1_databases" | "dispatch_namespaces" | "durable_objects" | "queues" | "r2_buckets" | "services" | "kv_namespaces" | "mtls_certificates" | "vectorize" | "workflows" | "vpc_services">;
 
 declare function configFormat(configPath: string | undefined): "json" | "jsonc" | "toml" | "none";
@@ -163,6 +168,12 @@ declare const experimental_readRawConfig: (args: ReadConfigCommandArgs, options?
     redirected: boolean;
 };
 
+/**
+ * Returns a map of exports that are only of type "durable-object".
+ */
+declare function getDurableObjectExports(exports: Config["exports"] | undefined): Record<string, DurableObjectExport>;
+declare function hasDurableObjectExports(exports: Config["exports"] | undefined): boolean;
+
 declare const experimental_patchConfig: (configPath: string, 
 /**
  * if you want to add something new, e.g. a binding, you can just provide that {kv_namespace:[{binding:"KV"}]}
@@ -265,6 +276,14 @@ declare class APIError extends ParseError {
     #private;
     code?: number;
     accountTag?: string;
+    /**
+     * Optional structured metadata hoisted from the first `FetchError.meta`
+     * on the v4 response envelope. Consumers can inspect this to render
+     * endpoint-specific structured error payloads.
+     */
+    meta?: {
+        details?: unknown;
+    } & Record<string, unknown>;
     constructor({ status, ...rest }: MessageInit & {
         status?: number;
     });
@@ -293,6 +312,18 @@ type PackageJSON = {
     devDependencies?: Record<string, unknown>;
     dependencies?: Record<string, unknown>;
     scripts?: Record<string, unknown>;
+    /**
+     * NOTE: This is **not** a standard `package.json` field — don't confuse it
+     * with the standard `bundledDependencies`. It is a convention introduced by
+     * vite+ (https://viteplus.dev): vite+ installs `@voidzero-dev/vite-plus-core`
+     * under the `vite` npm alias and records the versions of the tools it bundles
+     * here, keyed by package name
+     * (e.g. `{ "vite": "8.1.2", "rolldown": "...", "tsdown": "..." }`).
+     *
+     * We read it to recover the underlying Vite version when Vite is installed via
+     * such an alias. It is optional and absent for the vast majority of packages.
+     */
+    bundledVersions?: Record<string, string | undefined>;
 };
 /**
  * A typed version of `parseJSON()`.
@@ -485,6 +516,12 @@ type VariableNames =
  | "CLOUDFLARE_ACCESS_CLIENT_ID"
 /** Cloudflare Access Service Token Client Secret. Used with CLOUDFLARE_ACCESS_CLIENT_ID. */
  | "CLOUDFLARE_ACCESS_CLIENT_SECRET"
+/**
+ * Store OAuth credentials in the OS keychain instead of a plaintext TOML
+ * file. Overrides the persistent `keyring_enabled` preference written by
+ * `wrangler login --use-keyring`.
+ */
+ | "CLOUDFLARE_AUTH_USE_KEYRING"
 /** Enable the local explorer UI at /cdn-cgi/explorer (experimental, default: false). */
  | "X_LOCAL_EXPLORER"
 /** Open the browser in headful (visible) mode when using the Browser Run API in local dev (default: false). */
@@ -557,37 +594,6 @@ declare function getEnvironmentVariableFactory<Choices extends readonly string[]
     readonly choices?: Choices;
 }): () => ElementType<Choices>;
 
-interface GetGlobalConfigPathOptions {
-    /**
-     * The application namespace. Defaults to `"wrangler"`.
-     */
-    appName?: string;
-    /**
-     * Whether to prepend a `.` to `appName` when resolving the XDG path and the
-     * legacy `$HOME` directory. Defaults to `true` to match wrangler's
-     * historical behaviour (`.wrangler`).
-     */
-    leadingDot?: boolean;
-    /**
-     * When `true` (the default, matching wrangler's historical behaviour), a
-     * pre-existing `~/.<appName>` directory takes precedence over the XDG path.
-     * Pass `false` to always use the XDG-compliant path.
-     */
-    useLegacyHomeDir?: boolean;
-}
-/**
- * Resolve the global config directory for a Cloudflare CLI.
- *
- * Defaults to wrangler's directory (`.wrangler`) so existing callers are
- * unaffected, but accepts an `appName` so other first-party CLIs (e.g. `cf`)
- * can reuse the same XDG-compliant resolution under their own namespace.
- */
-declare function getGlobalConfigPath({ appName, leadingDot, useLegacyHomeDir, }?: GetGlobalConfigPathOptions): string;
-/**
- * @deprecated Use {@link getGlobalConfigPath} instead.
- */
-declare function getGlobalWranglerConfigPath(): string;
-
 type YYYY = `${number}${number}${number}${number}`;
 type MM = `${number}${number}`;
 type DD = `${number}${number}`;
@@ -607,45 +613,6 @@ declare function isCompatDate(str: string): str is CompatDate;
  */
 declare function getTodaysCompatDate(): CompatDate;
 
-/**
- * Returns whether the given path is a directory
- *
- * Note: this function never throws; if the path does not exist or is inaccessible, it returns false.
- *
- * @param path The file system path to check
- * @returns `true` if the path is a directory, `false` otherwise
- */
-declare function isDirectory(path: string): boolean;
-/**
- * Recursively remove a directory without waiting for completion or throwing any errors.
- *
- * @param dirPath The directory path to remove
- * @param options An object with a `fireAndForget` property set to `true`
- * @return `void` - the removal is fire-and-forget with errors suppressed
- */
-declare function removeDir(dirPath: string, { fireAndForget }: {
-    fireAndForget: true;
-}): void;
-/**
- * Recursively remove a directory with retries for Windows compatibility.
- *
- * @param dirPath The directory path to remove
- * @param options An optional object with a `fireAndForget` property set to `false`, if defined
- * @return `Promise<void>` - resolves when the removal is complete, or rejects if the removal fails
- */
-declare function removeDir(dirPath: string, options?: {
-    fireAndForget?: false;
-}): Promise<void>;
-/**
- * Synchronously and recursively remove a directory, with retries for Windows compatibility.
- *
- * @see {@link removeDir} for the async version and rationale.
- *
- * @param dirPath The directory path to remove
- * @throws If the removal fails after retries, an error will be thrown
- */
-declare function removeDirSync(dirPath: string): void;
-
 /**
  * A short-lived directory. Automatically removed when the process exits, but
  * can be removed earlier by calling `remove()`.
@@ -902,4 +869,9 @@ declare function getWorkerName(projectOrWorkerName: string | undefined, projectP
  */
 declare function getWorkerNameFromProject(projectPath: string): string;
 
-export { APIError, Binding, type BindingLocalSupport, BunPackageManager, CommandLineArgsError, type CompatDate, Config, type ConfigBindingFieldName, type ConfigBindingOptions, DeprecationError, Diagnostics, type EphemeralDirectory, FatalError, type GetGlobalConfigPathOptions, JsonFriendlyFatalError, type Location, Logger, type Message, MissingConfigError, type NormalizeAndValidateConfigArgs, NpmPackageManager, type NpmVersionCheckResult, type PackageJSON, type PackageManager, ParseError, type ParseFile, PatchConfigError, PnpmPackageManager, RawConfig, type ResolveConfigPathOptions, Route, type TelemetryMessage, type Tunnel, type TunnelOptions, UserError, WorkerMetadataBinding, YarnPackageManager, assertNever, bucketFormatMessage, checkWorkerNameValidity, configFileName, configFormat, createFatalError, experimental_patchConfig, experimental_readRawConfig, fetchLatestNpmVersion, findWranglerConfig, formatConfigSnippet, formatTime, friendlyBindingNames, getBindingLocalSupport, getBindingTypeFriendlyName, getBooleanEnvironmentVariableFactory, getEnvironmentVariableFactory, getGlobalConfigPath, getGlobalWranglerConfigPath, getHostFromRoute, getHostFromUrl, getTodaysCompatDate, getWorkerName, getWorkerNameFromProject, getWranglerHiddenDirPath, getWranglerTmpDir, getZoneFromRoute, hasProperty, indexLocation, isCompatDate, isDirectory, isDockerfile, isOptionalProperty, isPagesConfig, isRedirectedConfig, isRequiredProperty, isValidR2BucketName, mapWorkerMetadataBindings, normalizeAndValidateConfig, parseByteSize, parseHumanDuration, parseJSON, parseJSONC, parseNonHyphenedUuid, parsePackageJSON, parseTOML, readFileSync, readFileSyncToBuffer, removeDir, removeDirSync, resolveWranglerConfigPath, retryOnAPIFailure, searchLocation, spawnCloudflared, startTunnel, sweepStaleWranglerTmpDirs, toValidWorkerName, validatePagesConfig };
+/**
+ * @deprecated new code should use getBindingTypeFriendlyName() instead
+ */
+declare const friendlyBindingNames: Record<ConfigBindingFieldName, string>;
+
+export { APIError, Binding, type BindingLocalSupport, BunPackageManager, CommandLineArgsError, type CompatDate, Config, type ConfigBindingFieldName, type ConfigBindingOptions, DeprecationError, Diagnostics, DurableObjectExport, type EphemeralDirectory, type ExportType, Exports, FatalError, JsonFriendlyFatalError, type Location, Logger, type Message, MissingConfigError, type NormalizeAndValidateConfigArgs, NpmPackageManager, type NpmVersionCheckResult, type PackageJSON, type PackageManager, ParseError, type ParseFile, type PartitionedExports, PatchConfigError, PnpmPackageManager, RawConfig, type ResolveConfigPathOptions, Route, type TelemetryMessage, type Tunnel, type TunnelOptions, UserError, WorkerEntrypointExport, WorkerMetadataBinding, YarnPackageManager, assertNever, bucketFormatMessage, checkWorkerNameValidity, configFileName, configFormat, createFatalError, experimental_patchConfig, experimental_readRawConfig, fetchLatestNpmVersion, findWranglerConfig, formatConfigSnippet, formatTime, friendlyBindingNames, getBindingLocalSupport, getBindingTypeFriendlyName, getBooleanEnvironmentVariableFactory, getDurableObjectExports, getEnvironmentVariableFactory, getHostFromRoute, getHostFromUrl, getTodaysCompatDate, getWorkerName, getWorkerNameFromProject, getWranglerHiddenDirPath, getWranglerTmpDir, getZoneFromRoute, hasDurableObjectExports, hasProperty, indexLocation, isCompatDate, isDockerfile, isOptionalProperty, isPagesConfig, isRedirectedConfig, isRequiredProperty, isValidR2BucketName, mapWorkerMetadataBindings, normalizeAndValidateConfig, parseByteSize, parseHumanDuration, parseJSON, parseJSONC, parseNonHyphenedUuid, parsePackageJSON, parseTOML, partitionExports, readFileSync, readFileSyncToBuffer, resolveWranglerConfigPath, retryOnAPIFailure, searchLocation, spawnCloudflared, startTunnel, sweepStaleWranglerTmpDirs, toValidWorkerName, validatePagesConfig };