import nock from "nock";

/**
 * Mocks the API calls, add some defaults so it doesn't cause too much friction
 *
 * @internal
 */
export declare function mockApi({
  apiHost,
  apiVersion,
  includeQueryTag,
  method,
  projectId,
  query,
  uri,
}: MockApiOptions): nock.Interceptor;

/**
 * @internal
 */
export declare interface MockApiOptions {
  /**
   * Uri to mock
   */
  uri: string;
  /**
   * Api host to mock, defaults to `https://api.sanity.io`
   */
  apiHost?: string;
  /**
   * Api version to mock, defaults to `v2025-05-14`
   */
  apiVersion?: string;
  /**
   * Whether to include `tag: 'sanity.cli'` in query parameters.
   * Defaults to `true`. Set to `false` for endpoints that don't use CLI tagging.
   */
  includeQueryTag?: boolean;
  /**
   * HTTP method to mock
   *
   * Defaults to 'get'
   */
  method?: "delete" | "get" | "patch" | "post" | "put";
  /**
   * Project ID to mock. When provided, constructs apiHost as `https://{projectId}.api.sanity.io`
   * Takes precedence over apiHost if both are provided.
   */
  projectId?: string;
  /**
   * Query parameters to mock
   */
  query?: Record<string, string>;
}

export {};