miniflare 0.0.0-7bbed63fb → 0.0.0-7ca37bcbb

package/dist/src/index.d.ts

@@ -58,6 +58,13 @@ 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<{
@@ -66,23 +73,41 @@ export declare const AssetsOptionsSchema: z.ZodObject<{
         path: z.ZodEffects<z.ZodString, string, string>;
         bindingName: z.ZodOptional<z.ZodString>;
         routingConfig: z.ZodObject<{
-            hasUserWorker: z.ZodBoolean;
+            has_user_worker: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
         }, {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
+        }>;
+        assetConfig: 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, {
+            html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
+            not_found_handling?: "none" | "single-page-application" | "404-page";
+        }, {
+            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: {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
+        };
+        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;
     }, {
         path: string;
         routingConfig: {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
+        };
+        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;
@@ -91,7 +116,11 @@ export declare const AssetsOptionsSchema: z.ZodObject<{
     assets?: {
         path: string;
         routingConfig: {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
+        };
+        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;
@@ -100,7 +129,11 @@ export declare const AssetsOptionsSchema: z.ZodObject<{
     assets?: {
         path: string;
         routingConfig: {
-            hasUserWorker: boolean;
+            has_user_worker?: boolean;
+        };
+        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;
@@ -115,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>;
 
@@ -1321,6 +1366,7 @@ export declare const DURABLE_OBJECTS_PLUGIN_NAME = "do";
 export declare const DURABLE_OBJECTS_STORAGE_SERVICE_NAME = "do:storage";
 
 export declare type DurableObjectClassNames = Map<string, Map<string, {
+    enableSql?: boolean;
     unsafeUniqueKey?: UnsafeUniqueKey;
     unsafePreventEviction?: boolean;
 }>>;
@@ -1329,16 +1375,19 @@ export declare const DurableObjectsOptionsSchema: z.ZodObject<{
     durableObjects: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodObject<{
         className: z.ZodString;
         scriptName: z.ZodOptional<z.ZodString>;
+        useSQLite: z.ZodOptional<z.ZodBoolean>;
         unsafeUniqueKey: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<typeof kUnsafeEphemeralUniqueKey>]>>;
         unsafePreventEviction: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         className: string;
         scriptName?: string | undefined;
+        useSQLite?: boolean | undefined;
         unsafeUniqueKey?: string | typeof kUnsafeEphemeralUniqueKey | undefined;
         unsafePreventEviction?: boolean | undefined;
     }, {
         className: string;
         scriptName?: string | undefined;
+        useSQLite?: boolean | undefined;
         unsafeUniqueKey?: string | typeof kUnsafeEphemeralUniqueKey | undefined;
         unsafePreventEviction?: boolean | undefined;
     }>]>>>;
@@ -1346,6 +1395,7 @@ export declare const DurableObjectsOptionsSchema: z.ZodObject<{
     durableObjects?: Record<string, string | {
         className: string;
         scriptName?: string | undefined;
+        useSQLite?: boolean | undefined;
         unsafeUniqueKey?: string | typeof kUnsafeEphemeralUniqueKey | undefined;
         unsafePreventEviction?: boolean | undefined;
     }> | undefined;
@@ -1353,6 +1403,7 @@ export declare const DurableObjectsOptionsSchema: z.ZodObject<{
     durableObjects?: Record<string, string | {
         className: string;
         scriptName?: string | undefined;
+        useSQLite?: boolean | undefined;
         unsafeUniqueKey?: string | typeof kUnsafeEphemeralUniqueKey | undefined;
         unsafePreventEviction?: boolean | undefined;
     }> | undefined;
@@ -1443,6 +1494,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;
@@ -1641,6 +1716,11 @@ export declare interface LogOptions {
     suffix?: string;
 }
 
+export declare type ManifestEntry = {
+    pathHash: Uint8Array;
+    contentHash: Uint8Array;
+};
+
 export declare interface MatcherRegExps {
     include: RegExp[];
     exclude: RegExp[];
@@ -1694,7 +1774,7 @@ export declare class Miniflare {
 export declare class MiniflareCoreError extends MiniflareError<MiniflareCoreErrorCode> {
 }
 
-export declare type MiniflareCoreErrorCode = "ERR_RUNTIME_FAILURE" | "ERR_DISPOSED" | "ERR_MODULE_PARSE" | "ERR_MODULE_STRING_SCRIPT" | "ERR_MODULE_DYNAMIC_SPEC" | "ERR_MODULE_RULE" | "ERR_PERSIST_UNSUPPORTED" | "ERR_PERSIST_REMOTE_UNAUTHENTICATED" | "ERR_PERSIST_REMOTE_UNSUPPORTED" | "ERR_FUTURE_COMPATIBILITY_DATE" | "ERR_NO_WORKERS" | "ERR_VALIDATION" | "ERR_DUPLICATE_NAME" | "ERR_DIFFERENT_UNIQUE_KEYS" | "ERR_DIFFERENT_PREVENT_EVICTION" | "ERR_MULTIPLE_OUTBOUNDS" | "ERR_INVALID_WRAPPED" | "ERR_CYCLIC";
+export declare type MiniflareCoreErrorCode = "ERR_RUNTIME_FAILURE" | "ERR_DISPOSED" | "ERR_MODULE_PARSE" | "ERR_MODULE_STRING_SCRIPT" | "ERR_MODULE_DYNAMIC_SPEC" | "ERR_MODULE_RULE" | "ERR_PERSIST_UNSUPPORTED" | "ERR_PERSIST_REMOTE_UNAUTHENTICATED" | "ERR_PERSIST_REMOTE_UNSUPPORTED" | "ERR_FUTURE_COMPATIBILITY_DATE" | "ERR_NO_WORKERS" | "ERR_VALIDATION" | "ERR_DUPLICATE_NAME" | "ERR_DIFFERENT_STORAGE_BACKEND" | "ERR_DIFFERENT_UNIQUE_KEYS" | "ERR_DIFFERENT_PREVENT_EVICTION" | "ERR_MULTIPLE_OUTBOUNDS" | "ERR_INVALID_WRAPPED" | "ERR_CYCLIC";
 
 export declare class MiniflareError<Code extends string | number = string | number> extends Error {
     readonly code: Code;
@@ -1765,6 +1845,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;
@@ -1774,6 +1865,7 @@ export declare class NoOpLog extends Log {
 export declare function normaliseDurableObject(designator: NonNullable<z.infer<typeof DurableObjectsOptionsSchema>["durableObjects"]>[string]): {
     className: string;
     serviceName?: string;
+    enableSql?: boolean;
     unsafeUniqueKey?: UnsafeUniqueKey;
     unsafePreventEviction?: boolean;
 };
@@ -2948,16 +3040,19 @@ export declare const PLUGINS: {
     durableObjects: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodObject<{
     className: z.ZodString;
     scriptName: z.ZodOptional<z.ZodString>;
+    useSQLite: z.ZodOptional<z.ZodBoolean>;
     unsafeUniqueKey: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<kUnsafeEphemeralUniqueKey>]>>;
     unsafePreventEviction: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
     className: string;
     scriptName?: string | undefined;
+    useSQLite?: boolean | undefined;
     unsafeUniqueKey?: string | kUnsafeEphemeralUniqueKey | undefined;
     unsafePreventEviction?: boolean | undefined;
     }, {
     className: string;
     scriptName?: string | undefined;
+    useSQLite?: boolean | undefined;
     unsafeUniqueKey?: string | kUnsafeEphemeralUniqueKey | undefined;
     unsafePreventEviction?: boolean | undefined;
     }>]>>>;
@@ -2965,6 +3060,7 @@ export declare const PLUGINS: {
     durableObjects?: Record<string, string | {
     className: string;
     scriptName?: string | undefined;
+    useSQLite?: boolean | undefined;
     unsafeUniqueKey?: string | kUnsafeEphemeralUniqueKey | undefined;
     unsafePreventEviction?: boolean | undefined;
     }> | undefined;
@@ -2972,6 +3068,7 @@ export declare const PLUGINS: {
     durableObjects?: Record<string, string | {
     className: string;
     scriptName?: string | undefined;
+    useSQLite?: boolean | undefined;
     unsafeUniqueKey?: string | kUnsafeEphemeralUniqueKey | undefined;
     unsafePreventEviction?: boolean | undefined;
     }> | undefined;
@@ -3123,23 +3220,41 @@ export declare const PLUGINS: {
     path: z.ZodEffects<z.ZodString, string, string>;
     bindingName: z.ZodOptional<z.ZodString>;
     routingConfig: z.ZodObject<{
-    hasUserWorker: z.ZodBoolean;
+    has_user_worker: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+    has_user_worker?: boolean;
+    }, {
+    has_user_worker?: boolean;
+    }>;
+    assetConfig: 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, {
-    hasUserWorker: boolean;
+    html_handling?: "none" | "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash";
+    not_found_handling?: "none" | "single-page-application" | "404-page";
     }, {
-    hasUserWorker: boolean;
+    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: {
-    hasUserWorker: boolean;
+    has_user_worker?: boolean;
+    };
+    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;
     }, {
     path: string;
     routingConfig: {
-    hasUserWorker: boolean;
+    has_user_worker?: boolean;
+    };
+    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;
@@ -3148,7 +3263,11 @@ export declare const PLUGINS: {
     assets?: {
     path: string;
     routingConfig: {
-    hasUserWorker: boolean;
+    has_user_worker?: boolean;
+    };
+    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;
@@ -3157,7 +3276,11 @@ export declare const PLUGINS: {
     assets?: {
     path: string;
     routingConfig: {
-    hasUserWorker: boolean;
+    has_user_worker?: boolean;
+    };
+    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;
@@ -3640,14 +3763,6 @@ export declare class RouterError extends MiniflareError<RouterErrorCode> {
 
 export declare type RouterErrorCode = "ERR_QUERY_STRING" | "ERR_INFIX_WILDCARD";
 
-export declare const RoutingConfigSchema: z.ZodObject<{
-    hasUserWorker: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    hasUserWorker: boolean;
-}, {
-    hasUserWorker: boolean;
-}>;
-
 export declare class Runtime {
     #private;
     updateConfig(configBuffer: Buffer, options: Abortable & RuntimeOptions): Promise<SocketPorts | undefined>;
@@ -4130,6 +4245,7 @@ export declare interface Worker_Binding_WrappedBinding {
 export declare type Worker_DurableObjectNamespace = {
     className?: string;
     preventEviction?: boolean;
+    enableSql?: boolean;
 } & ({
     uniqueKey?: string;
 } | {