feat: support additional input from plugins

Author: Bekacru

packages/better-fetch/src/create-fetch/types.ts

@@ -1,5 +1,5 @@
 import type { StandardSchemaV1 } from "../standard-schema";
-import { BetterFetchPlugin } from "../plugins";
+import type { BetterFetchPlugin } from "../plugins";
 import type { Prettify, StringLiteralUnion } from "../type-utils";
 import type { BetterFetchOption, BetterFetchResponse } from "../types";
 import type { FetchSchema, Schema } from "./schema";
@@ -124,7 +124,11 @@ export type GetKey<S, K> = S extends Schema
 					? AP
 					: string
 				: string
-		: K
+		: S["config"]["prefix"] extends string
+			? K extends `${S["config"]["prefix"]}${infer AP}`
+				? AP
+				: K
+			: K
 	: K;
 
 export type UnionToIntersection<U> = (
@@ -148,11 +152,9 @@ export type MergeSchema<Options extends CreateFetchOption> =
 
 export type InferPluginOptions<Options extends CreateFetchOption> =
 	Options["plugins"] extends Array<infer P>
-		? P extends BetterFetchPlugin
-			? P["getOptions"] extends () => infer O
-				? O extends StandardSchemaV1
-					? UnionToIntersection<StandardSchemaV1.InferOutput<O>>
-					: {}
+		? P extends BetterFetchPlugin<infer O>
+			? O extends Record<string, any>
+				? UnionToIntersection<O>
 				: {}
 			: {}
 		: {};

packages/better-fetch/src/plugins.ts

@@ -1,6 +1,6 @@
 import type { StandardSchemaV1 } from "./standard-schema";
-import { Schema } from "./create-fetch";
-import { BetterFetchError } from "./error";
+import type { Schema } from "./create-fetch";
+import type { BetterFetchError } from "./error";
 import type { BetterFetchOption } from "./types";
 
 export type RequestContext<T extends Record<string, any> = any> = {
@@ -80,7 +80,9 @@ export interface FetchHooks<Res = any> {
 /**
  * A plugin that returns an id and hooks
  */
-export type BetterFetchPlugin = {
+export type BetterFetchPlugin<
+	ExtraOptions extends Record<string, any> = Record<string, any>,
+> = {
 	/**
 	 * A unique id for the plugin
 	 */
@@ -111,7 +113,7 @@ export type BetterFetchPlugin = {
 	 */
 	init?: (
 		url: string,
-		options?: BetterFetchOption,
+		options?: BetterFetchOption & ExtraOptions,
 	) =>
 		| Promise<{
 				url: string;
@@ -127,6 +129,15 @@ export type BetterFetchPlugin = {
 	schema?: Schema;
 	/**
 	 * Additional options that can be passed to the plugin
+	 *
+	 * @deprecated Use type inference through direct typescript instead
+	 * ```ts
+	 * const plugin = {
+	 *
+	 * } satisfies BetterFetchPlugin<{
+	 *  myCustomOptions: string;
+	 * }>
+	 * ```
 	 */
 	getOptions?: () => StandardSchemaV1;
 };

packages/better-fetch/src/test/create.test.ts

@@ -18,7 +18,7 @@ import {
 } from "../create-fetch";
 import type { BetterFetchResponse } from "../types";
 
-import { BetterFetchPlugin } from "../plugins";
+import type { BetterFetchPlugin } from "../plugins";
 import { ValidationError } from "../utils";
 import { router } from "./test-router";
 
@@ -455,8 +455,8 @@ describe("plugin", () => {
 	const plugin = {
 		id: "test",
 		name: "Test",
-		schema: createSchema(
-			{
+		schema: {
+			schema: {
 				"/path": {
 					output: z.object({
 						message: z.string(),
@@ -471,16 +471,11 @@ describe("plugin", () => {
 					}),
 				},
 			},
-			{
-				baseURL: "http://localhost:4001",
+			config: {
 				prefix: "prefix",
 				strict: true,
+				baseURL: "http://localhost:4001",
 			},
-		),
-		getOptions() {
-			return z.object({
-				onUpload: z.function(),
-			});
 		},
 	} satisfies BetterFetchPlugin;
 	const plugin2 = {
@@ -511,16 +506,17 @@ describe("plugin", () => {
 			plugins: [plugin],
 			baseURL: "http://localhost:4001",
 		});
-		expectTypeOf($fetch)
-			.parameter(0)
+
+		expectTypeOf($fetch.call)
+			.parameter(1)
 			.toMatchTypeOf<"prefix/path" | "prefix/path/:param">();
 	});
-
 	it("should infer baseURL", async () => {
 		const $fetch = createFetch({
 			plugins: [plugin2],
 			baseURL: "http://localhost:4001",
 		});
+
 		expectTypeOf($fetch)
 			.parameter(0)
 			.toMatchTypeOf<"http://localhost:4001/path">();
@@ -631,7 +627,12 @@ describe("plugin", () => {
 				{
 					id: "test",
 					name: "Test",
-				},
+					getOptions() {
+						return z.object({
+							onUpload: z.function(),
+						});
+					},
+				} satisfies BetterFetchPlugin,
 			],
 			schema: createSchema(
 				{