next-ts-api/dist/index.d.ts

A powerful TypeScript-first API client generator for Next.js applications with full type safety and automatic api type generation.

import type { NextRequest, NextResponse } from "next/server";
/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams) */
interface URLSearchParamsType<T = unknown> {
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/size) */
    readonly size: number;
    /**
     * Appends a specified key/value pair as a new search parameter.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/append)
     */
    append(name: keyof T, value: string): void;
    /**
     * Deletes the given search parameter, and its associated value, from the list of all search parameters.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/delete)
     */
    delete(name: keyof T, value?: string): void;
    /**
     * Returns the first value associated to the given search parameter.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/get)
     */
    get(name: keyof T): string | null;
    /**
     * Returns all the values association with a given search parameter.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/getAll)
     */
    getAll(name: keyof T): string[];
    /**
     * Returns a Boolean indicating if such a search parameter exists.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/has)
     */
    has(name: keyof T, value?: string): boolean;
    /**
     * Sets the value associated to a given search parameter to the given value. If there were several values, delete the others.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/set)
     */
    set(name: keyof T, value: string): void;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/sort) */
    sort(): void;
    /** Returns a string containing a query string suitable for use in a URL. Does not include the question mark. */
    toString(): string;
    /**
     * Executes a provided function once for each key/value pair in the URLSearchParams object.
     *
     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/URLSearchParams/forEach)
     */
    forEach(callbackfn: (value: string, key: keyof T, parent: URLSearchParamsType<T>) => void, thisArg?: any): void;
}
/**
 * Extends NextRequest to add typed request body and URL search params
 * @template T - The type of the request body
 * @template P - The type of URL search params, defaults to Record<string,string>
 */
export type NextApiRequest<T, P = Record<string, string>> = Omit<NextRequest, 'nextUrl' | 'json'> & {
    json: () => Promise<T>;
    nextUrl: {
        searchParams: URLSearchParamsType<P>;
    };
};
/**
 * Extracts the request body type from a Next.js API route handler
 * @template T - The API route handler function type
 */
export type ExtractNextBody<T> = T extends (req: NextApiRequest<infer B, any>, ...args: any) => any ? B : never;
/**
 * Extracts the URL search params type from a Next.js API route handler
 * @template T - The API route handler function type
 */
export type ExtractNextQuery<T> = T extends (req: NextApiRequest<any, infer P>, ...args: any) => any ? P : never;
/**
 * Extracts the URL params type from a Next.js API route handler
 * @template T - The API route handler function type
 */
export type ExtractNextParams<T> = T extends (req: any, ctx: {
    params: infer P;
}) => any ? P : never;
/**
 * Extracts the response type from a Next.js API route handler, excluding error responses
 * @template T - The API route handler function type that returns a NextResponse
 */
export type ExtractNextResponse<T extends (...args: any) => any> = Awaited<ReturnType<T>> extends NextResponse<infer R> | infer _ ? R extends {
    error: any;
} ? never : R : never;
type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
/**
 * Creates a typed fetch API for API routes
 * @template AT - The API routes type
 * @returns A function that can be used to fetch data from API routes
 */
export declare const createNextFetchApi: <AT>({ baseUrl }?: {
    baseUrl?: string | undefined;
}) => <M extends HttpMethod, P extends { [K in keyof AT]: M extends keyof AT[K] ? K : never; }[keyof AT]>(path: P, options: {
    method: M;
    query?: (M extends keyof AT[P] ? "query" extends keyof AT[P][M] ? AT[P][M][keyof AT[P][M] & "query"] : never : never) | undefined;
    params?: (M extends keyof AT[P] ? "params" extends keyof AT[P][M] ? Awaited<AT[P][M][keyof AT[P][M] & "params"]> : never : never) | undefined;
    body?: (M extends "DELETE" | "POST" | "PUT" | "PATCH" ? M extends keyof AT[P] ? "body" extends keyof AT[P][M] ? AT[P][M][keyof AT[P][M] & "body"] : never : never : never) | undefined;
} & Omit<RequestInit, "method" | "body">) => Promise<Omit<Response, "json"> & {
    json: () => Promise<M extends keyof AT[P] ? "response" extends keyof AT[P][M] ? AT[P][M][keyof AT[P][M] & "response"] : never : never>;
}>;
export {};