getMiniflareFetchMock global type not defined

[lourd]

When trying to use the new fetch mocking capability, it doesn't appear that the getMiniflareFetchMock global function has a type definition that's set up for end users to consume. I would expect that adding 'jest-environment-miniflare' to the compilerOptions.types array of my tsconfig would add that function to the global types, but it does not. Which makes sense because looking at the index.d.ts in the published npm module, getMiniflareFetchMock is nowhere to be found.

[mrbbot]

Hey! 👋 I agree these should be declared somewhere. They're actually here...

miniflare/packages/jest-environment-miniflare/src/index.ts

Lines 33 to 42 in 3e459b7

	declare global {
	function getMiniflareBindings<Bindings = Context>(): Bindings;
	function getMiniflareDurableObjectStorage(
	id: DurableObjectId
	): Promise<DurableObjectStorage>;
	function getMiniflareFetchMock(): MockAgent;
	function flushMiniflareDurableObjectAlarms(
	ids: DurableObjectId[]
	): Promise<void>;
	}

...but API Extractor, the tool we use for bundling type definitions, doesn't include them. 😢

I would suggest you declare them yourself like this: https://github.com/mrbbot/miniflare-typescript-esbuild-jest/blob/master/test/globals.d.ts
...but I've just tried to upgrade that template and hit a bunch of errors due to conflicting @cloudflare/workers-types and @types/node (required by undici) types. 😅

Will have a think about this, but I suspect the quickest solution will be to manually define the MockAgent types yourself. 😢

I'm also going to close this as a duplicate of #94.

[aeneasr]

Could this be fixed? Looks like it's just some configuration you need to do in the API Extractor. Anyone using this library with TypeScript hits this sooner or later.

[tizmagik]

I just hit this today (in vitest). For now I just did this:

import type { MockAgent } from "undici";
declare const getMiniflareFetchMock: () => MockAgent;

Which, yes, unfortunately means I had to add undici as a direct devDependency

[lucaslago]

+1 a bit of a hassle to setup the types for jest environment ourselves