/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKError } from "../models/errors/sdkerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { useSDKContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildSandboxGetBrowserUrlQuery,
  prefetchSandboxGetBrowserUrl,
  queryKeySandboxGetBrowserUrl,
  SandboxGetBrowserUrlQueryData,
} from "./sandboxGetBrowserUrl.core.js";
export {
  buildSandboxGetBrowserUrlQuery,
  prefetchSandboxGetBrowserUrl,
  queryKeySandboxGetBrowserUrl,
  type SandboxGetBrowserUrlQueryData,
};

export type SandboxGetBrowserUrlQueryError =
  | errors.HTTPValidationError
  | SDKError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Get Browser Session URL
 *
 * @remarks
 * Return the public gateway URL for a browser session's Chrome DevTools Protocol endpoint. Playwright can use this HTTP endpoint directly. For clients that require a WebSocket endpoint, request `json/version` and use its rewritten `webSocketDebuggerUrl`. Insert subpaths before the query string; for example, use `/ports/9222/json/version?session_token=...`. Send the same MKA1 API-key authorization header on the HTTP and WebSocket requests. Standard sessions do not expose a public URL; use the command, code, and workspace operations instead.
 */
export function useSandboxGetBrowserUrl(
  request: operations.GetBrowserSessionUrlRequest,
  options?: QueryHookOptions<
    SandboxGetBrowserUrlQueryData,
    SandboxGetBrowserUrlQueryError
  >,
): UseQueryResult<
  SandboxGetBrowserUrlQueryData,
  SandboxGetBrowserUrlQueryError
> {
  const client = useSDKContext();
  return useQuery({
    ...buildSandboxGetBrowserUrlQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get Browser Session URL
 *
 * @remarks
 * Return the public gateway URL for a browser session's Chrome DevTools Protocol endpoint. Playwright can use this HTTP endpoint directly. For clients that require a WebSocket endpoint, request `json/version` and use its rewritten `webSocketDebuggerUrl`. Insert subpaths before the query string; for example, use `/ports/9222/json/version?session_token=...`. Send the same MKA1 API-key authorization header on the HTTP and WebSocket requests. Standard sessions do not expose a public URL; use the command, code, and workspace operations instead.
 */
export function useSandboxGetBrowserUrlSuspense(
  request: operations.GetBrowserSessionUrlRequest,
  options?: SuspenseQueryHookOptions<
    SandboxGetBrowserUrlQueryData,
    SandboxGetBrowserUrlQueryError
  >,
): UseSuspenseQueryResult<
  SandboxGetBrowserUrlQueryData,
  SandboxGetBrowserUrlQueryError
> {
  const client = useSDKContext();
  return useSuspenseQuery({
    ...buildSandboxGetBrowserUrlQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSandboxGetBrowserUrlData(
  client: QueryClient,
  queryKeyBase: [
    sessionId: string,
    parameters: {
      sessionToken?: string | null | undefined;
      xOnBehalfOf?: string | undefined;
    },
  ],
  data: SandboxGetBrowserUrlQueryData,
): SandboxGetBrowserUrlQueryData | undefined {
  const key = queryKeySandboxGetBrowserUrl(...queryKeyBase);

  return client.setQueryData<SandboxGetBrowserUrlQueryData>(key, data);
}

export function invalidateSandboxGetBrowserUrl(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      sessionId: string,
      parameters: {
        sessionToken?: string | null | undefined;
        xOnBehalfOf?: string | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@meetkai/mka1", "sandbox", "getBrowserUrl", ...queryKeyBase],
  });
}

export function invalidateAllSandboxGetBrowserUrl(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@meetkai/mka1", "sandbox", "getBrowserUrl"],
  });
}