@meetkai/mka1 0.53.6 → 0.53.7

package/src/react-query/sandboxDownloadFile.core.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { SDKCore } from "../core.js";
+import { sandboxDownloadFile } from "../funcs/sandboxDownloadFile.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SandboxDownloadFileQueryData = ReadableStream<Uint8Array>;
+
+export function prefetchSandboxDownloadFile(
+  queryClient: QueryClient,
+  client$: SDKCore,
+  request: operations.DownloadWorkspaceFileRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSandboxDownloadFileQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildSandboxDownloadFileQuery(
+  client$: SDKCore,
+  request: operations.DownloadWorkspaceFileRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SandboxDownloadFileQueryData>;
+} {
+  return {
+    queryKey: queryKeySandboxDownloadFile(request.sessionId, request.filePath, {
+      sessionToken: request.sessionToken,
+      xOnBehalfOf: request.xOnBehalfOf,
+    }),
+    queryFn: async function sandboxDownloadFileQueryFn(
+      ctx,
+    ): Promise<SandboxDownloadFileQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(sandboxDownloadFile(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySandboxDownloadFile(
+  sessionId: string,
+  filePath: string,
+  parameters: {
+    sessionToken?: string | null | undefined;
+    xOnBehalfOf?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@meetkai/mka1",
+    "sandbox",
+    "downloadFile",
+    sessionId,
+    filePath,
+    parameters,
+  ];
+}

package/src/react-query/sandboxDownloadFile.ts

@@ -0,0 +1,151 @@
+/*
+ * 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 {
+  buildSandboxDownloadFileQuery,
+  prefetchSandboxDownloadFile,
+  queryKeySandboxDownloadFile,
+  SandboxDownloadFileQueryData,
+} from "./sandboxDownloadFile.core.js";
+export {
+  buildSandboxDownloadFileQuery,
+  prefetchSandboxDownloadFile,
+  queryKeySandboxDownloadFile,
+  type SandboxDownloadFileQueryData,
+};
+
+export type SandboxDownloadFileQueryError =
+  | errors.HTTPValidationError
+  | SDKError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Download Workspace File
+ *
+ * @remarks
+ * Download raw bytes from a file in the session workspace.
+ */
+export function useSandboxDownloadFile(
+  request: operations.DownloadWorkspaceFileRequest,
+  options?: QueryHookOptions<
+    SandboxDownloadFileQueryData,
+    SandboxDownloadFileQueryError
+  >,
+): UseQueryResult<SandboxDownloadFileQueryData, SandboxDownloadFileQueryError> {
+  const client = useSDKContext();
+  return useQuery({
+    ...buildSandboxDownloadFileQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download Workspace File
+ *
+ * @remarks
+ * Download raw bytes from a file in the session workspace.
+ */
+export function useSandboxDownloadFileSuspense(
+  request: operations.DownloadWorkspaceFileRequest,
+  options?: SuspenseQueryHookOptions<
+    SandboxDownloadFileQueryData,
+    SandboxDownloadFileQueryError
+  >,
+): UseSuspenseQueryResult<
+  SandboxDownloadFileQueryData,
+  SandboxDownloadFileQueryError
+> {
+  const client = useSDKContext();
+  return useSuspenseQuery({
+    ...buildSandboxDownloadFileQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSandboxDownloadFileData(
+  client: QueryClient,
+  queryKeyBase: [
+    sessionId: string,
+    filePath: string,
+    parameters: {
+      sessionToken?: string | null | undefined;
+      xOnBehalfOf?: string | undefined;
+    },
+  ],
+  data: SandboxDownloadFileQueryData,
+): SandboxDownloadFileQueryData | undefined {
+  const key = queryKeySandboxDownloadFile(...queryKeyBase);
+
+  return client.setQueryData<SandboxDownloadFileQueryData>(key, data);
+}
+
+export function invalidateSandboxDownloadFile(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      sessionId: string,
+      filePath: 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", "downloadFile", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllSandboxDownloadFile(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@meetkai/mka1", "sandbox", "downloadFile"],
+  });
+}

package/src/react-query/sandboxGet.core.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { SDKCore } from "../core.js";
+import { sandboxGet } from "../funcs/sandboxGet.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SandboxGetQueryData = components.SessionRecord;
+
+export function prefetchSandboxGet(
+  queryClient: QueryClient,
+  client$: SDKCore,
+  request: operations.GetSessionRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSandboxGetQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildSandboxGetQuery(
+  client$: SDKCore,
+  request: operations.GetSessionRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<SandboxGetQueryData>;
+} {
+  return {
+    queryKey: queryKeySandboxGet(request.sessionId, {
+      xOnBehalfOf: request.xOnBehalfOf,
+    }),
+    queryFn: async function sandboxGetQueryFn(
+      ctx,
+    ): Promise<SandboxGetQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(sandboxGet(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySandboxGet(
+  sessionId: string,
+  parameters: { xOnBehalfOf?: string | undefined },
+): QueryKey {
+  return ["@meetkai/mka1", "sandbox", "get", sessionId, parameters];
+}

package/src/react-query/sandboxGet.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 {
+  buildSandboxGetQuery,
+  prefetchSandboxGet,
+  queryKeySandboxGet,
+  SandboxGetQueryData,
+} from "./sandboxGet.core.js";
+export {
+  buildSandboxGetQuery,
+  prefetchSandboxGet,
+  queryKeySandboxGet,
+  type SandboxGetQueryData,
+};
+
+export type SandboxGetQueryError =
+  | errors.HTTPValidationError
+  | SDKError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get Session
+ *
+ * @remarks
+ * Return the current state, configuration, and resource allocation for a sandbox session.
+ */
+export function useSandboxGet(
+  request: operations.GetSessionRequest,
+  options?: QueryHookOptions<SandboxGetQueryData, SandboxGetQueryError>,
+): UseQueryResult<SandboxGetQueryData, SandboxGetQueryError> {
+  const client = useSDKContext();
+  return useQuery({
+    ...buildSandboxGetQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get Session
+ *
+ * @remarks
+ * Return the current state, configuration, and resource allocation for a sandbox session.
+ */
+export function useSandboxGetSuspense(
+  request: operations.GetSessionRequest,
+  options?: SuspenseQueryHookOptions<SandboxGetQueryData, SandboxGetQueryError>,
+): UseSuspenseQueryResult<SandboxGetQueryData, SandboxGetQueryError> {
+  const client = useSDKContext();
+  return useSuspenseQuery({
+    ...buildSandboxGetQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSandboxGetData(
+  client: QueryClient,
+  queryKeyBase: [
+    sessionId: string,
+    parameters: { xOnBehalfOf?: string | undefined },
+  ],
+  data: SandboxGetQueryData,
+): SandboxGetQueryData | undefined {
+  const key = queryKeySandboxGet(...queryKeyBase);
+
+  return client.setQueryData<SandboxGetQueryData>(key, data);
+}
+
+export function invalidateSandboxGet(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [sessionId: string, parameters: { xOnBehalfOf?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@meetkai/mka1", "sandbox", "get", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllSandboxGet(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@meetkai/mka1", "sandbox", "get"],
+  });
+}

package/src/react-query/sandboxGetBrowserUrl.core.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { SDKCore } from "../core.js";
+import { sandboxGetBrowserUrl } from "../funcs/sandboxGetBrowserUrl.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SandboxGetBrowserUrlQueryData = components.SessionUrlResponse;
+
+export function prefetchSandboxGetBrowserUrl(
+  queryClient: QueryClient,
+  client$: SDKCore,
+  request: operations.GetBrowserSessionUrlRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSandboxGetBrowserUrlQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildSandboxGetBrowserUrlQuery(
+  client$: SDKCore,
+  request: operations.GetBrowserSessionUrlRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SandboxGetBrowserUrlQueryData>;
+} {
+  return {
+    queryKey: queryKeySandboxGetBrowserUrl(request.sessionId, {
+      sessionToken: request.sessionToken,
+      xOnBehalfOf: request.xOnBehalfOf,
+    }),
+    queryFn: async function sandboxGetBrowserUrlQueryFn(
+      ctx,
+    ): Promise<SandboxGetBrowserUrlQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(sandboxGetBrowserUrl(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySandboxGetBrowserUrl(
+  sessionId: string,
+  parameters: {
+    sessionToken?: string | null | undefined;
+    xOnBehalfOf?: string | undefined;
+  },
+): QueryKey {
+  return ["@meetkai/mka1", "sandbox", "getBrowserUrl", sessionId, parameters];
+}

package/src/react-query/sandboxGetBrowserUrl.ts

@@ -0,0 +1,152 @@
+/*
+ * 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"],
+  });
+}