miniflare 0.0.0-e4fe35cc5 → 0.0.0-eaf71b86c

package/README.md

@@ -574,6 +574,17 @@ parameter in module format Workers.
   have at most one consumer. If a `string[]` of queue names is specified,
   default consumer options will be used.
 
+#### Assets
+
+- `directory?: string`
+  Path to serve Workers static asset files from.
+
+- `binding?: string`
+  Binding name to inject as a `Fetcher` binding to allow access to static assets from within the Worker.
+
+- `assetOptions?: { html_handling?: HTMLHandlingOptions, not_found_handling?: NotFoundHandlingOptions}`
+  Configuration for file-based asset routing - see [docs](https://developers.cloudflare.com/workers/static-assets/routing/#routing-configuration) for options
+
 #### Analytics Engine, Sending Email, Vectorize and Workers for Platforms
 
 _Not yet supported_

package/dist/src/index.d.ts

@@ -58,21 +58,28 @@ export declare class __MiniflareFunctionWrapper {
 
 export declare type AnyHeaders = http.IncomingHttpHeaders | string[];
 
+export declare type AssetReverseMap = {
+    [pathHash: string]: {
+        filePath: string;
+        contentType: string;
+    };
+};
+
 export declare const ASSETS_PLUGIN: Plugin<typeof AssetsOptionsSchema>;
 
 export declare const AssetsOptionsSchema: z.ZodObject<{
     assets: z.ZodOptional<z.ZodObject<{
         workerName: z.ZodOptional<z.ZodString>;
-        path: z.ZodEffects<z.ZodString, string, string>;
-        bindingName: z.ZodOptional<z.ZodString>;
-        routingConfig: z.ZodObject<{
+        directory: z.ZodEffects<z.ZodString, string, string>;
+        binding: z.ZodOptional<z.ZodString>;
+        routingConfig: z.ZodOptional<z.ZodObject<{
             has_user_worker: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             has_user_worker?: boolean;
         }, {
             has_user_worker?: boolean;
-        }>;
-        assetConfig: z.ZodObject<{
+        }>>;
+        assetConfig: z.ZodOptional<z.ZodObject<{
             html_handling: z.ZodOptional<z.ZodEnum<["auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none"]>>;
             not_found_handling: z.ZodOptional<z.ZodEnum<["single-page-application", "404-page", "none"]>>;
         }, "strip", z.ZodTypeAny, {
@@ -81,55 +88,55 @@ export declare const AssetsOptionsSchema: z.ZodObject<{
         }, {
             html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
             not_found_handling?: "none" | "single-page-application" | "404-page";
-        }>;
+        }>>;
     }, "strip", z.ZodTypeAny, {
-        path: string;
-        routingConfig: {
+        directory: string;
+        workerName?: string | undefined;
+        binding?: string | undefined;
+        routingConfig?: {
             has_user_worker?: boolean;
-        };
-        assetConfig: {
+        } | undefined;
+        assetConfig?: {
             html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
             not_found_handling?: "none" | "single-page-application" | "404-page";
-        };
-        workerName?: string | undefined;
-        bindingName?: string | undefined;
+        } | undefined;
     }, {
-        path: string;
-        routingConfig: {
+        directory: string;
+        workerName?: string | undefined;
+        binding?: string | undefined;
+        routingConfig?: {
             has_user_worker?: boolean;
-        };
-        assetConfig: {
+        } | undefined;
+        assetConfig?: {
             html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
             not_found_handling?: "none" | "single-page-application" | "404-page";
-        };
-        workerName?: string | undefined;
-        bindingName?: string | undefined;
+        } | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     assets?: {
-        path: string;
-        routingConfig: {
+        directory: string;
+        workerName?: string | undefined;
+        binding?: string | undefined;
+        routingConfig?: {
             has_user_worker?: boolean;
-        };
-        assetConfig: {
+        } | undefined;
+        assetConfig?: {
             html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
             not_found_handling?: "none" | "single-page-application" | "404-page";
-        };
-        workerName?: string | undefined;
-        bindingName?: string | undefined;
+        } | undefined;
     } | undefined;
 }, {
     assets?: {
-        path: string;
-        routingConfig: {
+        directory: string;
+        workerName?: string | undefined;
+        binding?: string | undefined;
+        routingConfig?: {
             has_user_worker?: boolean;
-        };
-        assetConfig: {
+        } | undefined;
+        assetConfig?: {
             html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
             not_found_handling?: "none" | "single-page-application" | "404-page";
-        };
-        workerName?: string | undefined;
-        bindingName?: string | undefined;
+        } | undefined;
     } | undefined;
 }>;
 
@@ -141,7 +148,19 @@ export declare function base64Encode(value: string): string;
 
 export { BodyInit }
 
-export declare const buildAssetsManifest: (dir: string) => Promise<Uint8Array>;
+/**
+ * The Asset Manifest and Asset Reverse Map are used to map a request path to an asset.
+ * 1. Hash path of request
+ * 2. Use this path hash to find the manifest entry
+ * 3. Get content hash from manifest entry
+ * 4a. In prod, use content hash to get asset from KV
+ * 4b. In dev, we fake out the KV store and use the file system instead.
+ * 	   Use content hash to get file path from asset reverse map.
+ */
+export declare const buildAssetManifest: (dir: string) => Promise<{
+    encodedAssetManifest: Uint8Array;
+    assetsReverseMap: AssetReverseMap;
+}>;
 
 export declare const CACHE_PLUGIN: Plugin<typeof CacheOptionsSchema, typeof CacheSharedOptionsSchema>;
 
@@ -666,6 +685,10 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }>, "many">>;
     unsafeEvalBinding: z.ZodOptional<z.ZodString>;
     unsafeUseModuleFallbackService: z.ZodOptional<z.ZodBoolean>;
+    /** Used to set the vitest pool worker SELF binding to point to the router worker if there are assets.
+     (If there are assets but we're not using vitest, the miniflare entry worker can point directly to RW.)
+     */
+    hasAssetsAndIsVitest: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     rootPath?: undefined;
@@ -745,6 +768,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }, {
     name?: string | undefined;
     rootPath?: string | undefined;
@@ -824,6 +848,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }>>, ({
     modules: {
         type: "ESModule" | "CommonJS" | "NodeJsCompatModule" | "Text" | "Data" | "CompiledWasm" | "PythonModule" | "PythonRequirement";
@@ -910,6 +935,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }) | ({
     script: string;
     scriptPath?: string | undefined;
@@ -999,6 +1025,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }) | ({
     scriptPath: string;
     modules?: boolean | undefined;
@@ -1087,6 +1114,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }), ({
     modules: {
         type: "ESModule" | "CommonJS" | "NodeJsCompatModule" | "Text" | "Data" | "CompiledWasm" | "PythonModule" | "PythonRequirement";
@@ -1192,6 +1220,7 @@ export declare const CoreOptionsSchema: z.ZodEffects<z.ZodIntersection<z.ZodUnio
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
 }>;
 
 export declare const CoreSharedOptionsSchema: z.ZodObject<{
@@ -1475,6 +1504,30 @@ export declare function getGlobalServices({ sharedOptions, allWorkerRoutes, fall
 
 export declare function getMiniflareObjectBindings(unsafeStickyBlobs: boolean): Worker_Binding[];
 
+/**
+ * Computes the Node.js compatibility mode we are running.
+ *
+ * NOTES:
+ * - The v2 mode is configured via `nodejs_compat_v2` compat flag or via `nodejs_compat` plus a compatibility date of Sept 23rd. 2024 or later.
+ * - See `EnvironmentInheritable` for `nodeCompat` and `noBundle`.
+ *
+ * @param compatibilityDateStr The compatibility date
+ * @param compatibilityFlags The compatibility flags
+ * @param opts.nodeCompat Whether the legacy node_compat arg is being used
+ * @returns the mode and flags to indicate specific configuration for validating.
+ */
+export declare function getNodeCompat(compatibilityDate: string | undefined, // Default to some arbitrary old date
+compatibilityFlags: string[], opts?: {
+    nodeCompat?: boolean;
+}): {
+    mode: NodeJSCompatMode;
+    hasNodejsAlsFlag: boolean;
+    hasNodejsCompatFlag: boolean;
+    hasNodejsCompatV2Flag: boolean;
+    hasNoNodejsCompatV2Flag: boolean;
+    hasExperimentalNodejsCompatV2Flag: boolean;
+};
+
 export declare function getPersistPath(pluginName: string, tmpPath: string, persist: Persistence): string;
 
 export declare function getRootPath(opts: unknown): string;
@@ -1673,6 +1726,11 @@ export declare interface LogOptions {
     suffix?: string;
 }
 
+export declare type ManifestEntry = {
+    pathHash: Uint8Array;
+    contentHash: Uint8Array;
+};
+
 export declare interface MatcherRegExps {
     include: RegExp[];
     exclude: RegExp[];
@@ -1797,6 +1855,17 @@ export declare interface Network {
 
 export declare const NODE_PLATFORM_IMPL: PlatformImpl<ReadableStream_2>;
 
+/**
+ * We can provide Node.js compatibility in a number of different modes:
+ * - "legacy" - this mode adds compile-time polyfills that are not well maintained and cannot work with workerd runtime builtins.
+ * - "als": this mode tells the workerd runtime to enable only the Async Local Storage builtin library (accessible via `node:async_hooks`).
+ * - "v1" - this mode tells the workerd runtime to enable some Node.js builtin libraries (accessible only via `node:...` imports) but no globals.
+ * - "v2" - this mode tells the workerd runtime to enable more Node.js builtin libraries (accessible both with and without the `node:` prefix)
+ *   and also some Node.js globals such as `Buffer`; it also turns on additional compile-time polyfills for those that are not provided by the runtime.
+ *  - null - no Node.js compatibility.
+ */
+export declare type NodeJSCompatMode = "legacy" | "als" | "v1" | "v2" | null;
+
 export declare class NoOpLog extends Log {
     constructor();
     protected log(): void;
@@ -2364,6 +2433,7 @@ export declare const PLUGINS: {
     }>, "many">>;
     unsafeEvalBinding: z.ZodOptional<z.ZodString>;
     unsafeUseModuleFallbackService: z.ZodOptional<z.ZodBoolean>;
+    hasAssetsAndIsVitest: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     rootPath?: undefined;
@@ -2443,6 +2513,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }, {
     name?: string | undefined;
     rootPath?: string | undefined;
@@ -2522,6 +2593,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }>>, ({
     modules: {
     type: "ESModule" | "CommonJS" | "NodeJsCompatModule" | "Text" | "Data" | "CompiledWasm" | "PythonModule" | "PythonRequirement";
@@ -2608,6 +2680,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }) | ({
     script: string;
     scriptPath?: string | undefined;
@@ -2697,6 +2770,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }) | ({
     scriptPath: string;
     modules?: boolean | undefined;
@@ -2785,6 +2859,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }), ({
     modules: {
     type: "ESModule" | "CommonJS" | "NodeJsCompatModule" | "Text" | "Data" | "CompiledWasm" | "PythonModule" | "PythonRequirement";
@@ -2890,6 +2965,7 @@ export declare const PLUGINS: {
     }[] | undefined;
     unsafeEvalBinding?: string | undefined;
     unsafeUseModuleFallbackService?: boolean | undefined;
+    hasAssetsAndIsVitest?: boolean | undefined;
     }>, z.ZodObject<{
     rootPath: z.ZodOptional<z.ZodEffects<z.ZodString, undefined, string>>;
     host: z.ZodOptional<z.ZodString>;
@@ -3158,16 +3234,16 @@ export declare const PLUGINS: {
     assets: Plugin<z.ZodObject<{
     assets: z.ZodOptional<z.ZodObject<{
     workerName: z.ZodOptional<z.ZodString>;
-    path: z.ZodEffects<z.ZodString, string, string>;
-    bindingName: z.ZodOptional<z.ZodString>;
-    routingConfig: z.ZodObject<{
+    directory: z.ZodEffects<z.ZodString, string, string>;
+    binding: z.ZodOptional<z.ZodString>;
+    routingConfig: z.ZodOptional<z.ZodObject<{
     has_user_worker: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
     has_user_worker?: boolean;
     }, {
     has_user_worker?: boolean;
-    }>;
-    assetConfig: z.ZodObject<{
+    }>>;
+    assetConfig: z.ZodOptional<z.ZodObject<{
     html_handling: z.ZodOptional<z.ZodEnum<["auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none"]>>;
     not_found_handling: z.ZodOptional<z.ZodEnum<["single-page-application", "404-page", "none"]>>;
     }, "strip", z.ZodTypeAny, {
@@ -3176,55 +3252,55 @@ export declare const PLUGINS: {
     }, {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
-    }>;
+    }>>;
     }, "strip", z.ZodTypeAny, {
-    path: string;
-    routingConfig: {
+    directory: string;
+    workerName?: string | undefined;
+    binding?: string | undefined;
+    routingConfig?: {
     has_user_worker?: boolean;
-    };
-    assetConfig: {
+    } | undefined;
+    assetConfig?: {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
-    };
-    workerName?: string | undefined;
-    bindingName?: string | undefined;
+    } | undefined;
     }, {
-    path: string;
-    routingConfig: {
+    directory: string;
+    workerName?: string | undefined;
+    binding?: string | undefined;
+    routingConfig?: {
     has_user_worker?: boolean;
-    };
-    assetConfig: {
+    } | undefined;
+    assetConfig?: {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
-    };
-    workerName?: string | undefined;
-    bindingName?: string | undefined;
+    } | undefined;
     }>>;
     }, "strip", z.ZodTypeAny, {
     assets?: {
-    path: string;
-    routingConfig: {
+    directory: string;
+    workerName?: string | undefined;
+    binding?: string | undefined;
+    routingConfig?: {
     has_user_worker?: boolean;
-    };
-    assetConfig: {
+    } | undefined;
+    assetConfig?: {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
-    };
-    workerName?: string | undefined;
-    bindingName?: string | undefined;
+    } | undefined;
     } | undefined;
     }, {
     assets?: {
-    path: string;
-    routingConfig: {
+    directory: string;
+    workerName?: string | undefined;
+    binding?: string | undefined;
+    routingConfig?: {
     has_user_worker?: boolean;
-    };
-    assetConfig: {
+    } | undefined;
+    assetConfig?: {
     html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
     not_found_handling?: "none" | "single-page-application" | "404-page";
-    };
-    workerName?: string | undefined;
-    bindingName?: string | undefined;
+    } | undefined;
     } | undefined;
     }>>;
 };