@gleanwork/api-client 0.1.0-beta.3 → 0.1.0-beta.5

package/src/funcs/clientChatStart.ts

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
 import { GleanCore } from "../core.js";
 import { encodeFormQuery, encodeJSON } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
@@ -38,7 +37,7 @@ export function clientChatStart(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    string,
+    components.ChatResponse,
     | GleanError
     | SDKValidationError
     | UnexpectedClientError
@@ -64,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      string,
+      components.ChatResponse,
       | GleanError
       | SDKValidationError
       | UnexpectedClientError
@@ -100,7 +99,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "text/plain",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.bearerAuth);
@@ -148,7 +147,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    string,
+    components.ChatResponse,
     | GleanError
     | SDKValidationError
     | UnexpectedClientError
@@ -157,7 +156,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.text(200, z.string()),
+    M.json(200, components.ChatResponse$inboundSchema),
     M.fail([400, 401, 408, 429, "4XX"]),
     M.fail("5XX"),
   )(response);

package/src/funcs/clientChatStartStream.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { GleanCore } from "../core.js";
+import { encodeFormQuery, encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GleanError } from "../models/errors/gleanerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Chat
+ *
+ * @remarks
+ * Have a conversation with Glean AI.
+ */
+export function clientChatStartStream(
+  client: GleanCore,
+  chatRequest: components.ChatRequest,
+  timezoneOffset?: number | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    string,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    chatRequest,
+    timezoneOffset,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  chatRequest: components.ChatRequest,
+  timezoneOffset?: number | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      string,
+      | GleanError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.ChatStreamRequest = {
+    chatRequest: chatRequest,
+    timezoneOffset: timezoneOffset,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.ChatStreamRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.ChatRequest, { explode: true });
+
+  const path = pathToFunc("/rest/api/v1/chat#stream")();
+
+  const query = encodeFormQuery({
+    "timezoneOffset": payload.timezoneOffset,
+  });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "text/plain",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "chatStream",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "408", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    string,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.text(200, z.string()),
+    M.fail([400, 401, 408, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.1.0-beta.3",
+  sdkVersion: "0.1.0-beta.5",
   genVersion: "2.596.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-beta.3 2.596.2 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.1.0-beta.5 2.596.2 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/workflow.ts

@@ -33,8 +33,6 @@ export type Workflow = {
   permissions?: ObjectPermissions | undefined;
   /**
    * The name of the workflow.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   name?: string | undefined;
   /**

package/src/models/operations/chatstream.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChatStreamRequest = {
+  /**
+   * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
+   */
+  timezoneOffset?: number | undefined;
+  /**
+   * Includes chat history for Glean AI to respond to.
+   */
+  chatRequest: components.ChatRequest;
+};
+
+/** @internal */
+export const ChatStreamRequest$inboundSchema: z.ZodType<
+  ChatStreamRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timezoneOffset: z.number().int().optional(),
+  ChatRequest: components.ChatRequest$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "ChatRequest": "chatRequest",
+  });
+});
+
+/** @internal */
+export type ChatStreamRequest$Outbound = {
+  timezoneOffset?: number | undefined;
+  ChatRequest: components.ChatRequest$Outbound;
+};
+
+/** @internal */
+export const ChatStreamRequest$outboundSchema: z.ZodType<
+  ChatStreamRequest$Outbound,
+  z.ZodTypeDef,
+  ChatStreamRequest
+> = z.object({
+  timezoneOffset: z.number().int().optional(),
+  chatRequest: components.ChatRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    chatRequest: "ChatRequest",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChatStreamRequest$ {
+  /** @deprecated use `ChatStreamRequest$inboundSchema` instead. */
+  export const inboundSchema = ChatStreamRequest$inboundSchema;
+  /** @deprecated use `ChatStreamRequest$outboundSchema` instead. */
+  export const outboundSchema = ChatStreamRequest$outboundSchema;
+  /** @deprecated use `ChatStreamRequest$Outbound` instead. */
+  export type Outbound = ChatStreamRequest$Outbound;
+}
+
+export function chatStreamRequestToJSON(
+  chatStreamRequest: ChatStreamRequest,
+): string {
+  return JSON.stringify(
+    ChatStreamRequest$outboundSchema.parse(chatStreamRequest),
+  );
+}
+
+export function chatStreamRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatStreamRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatStreamRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatStreamRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from "./chat.js";
+export * from "./chatstream.js";
 export * from "./deleteallchats.js";
 export * from "./deletechatfiles.js";
 export * from "./deletechats.js";

package/src/react-query/clientChatStart.ts

@@ -22,7 +22,7 @@ export type ClientChatStartMutationVariables = {
   options?: RequestOptions;
 };
 
-export type ClientChatStartMutationData = string;
+export type ClientChatStartMutationData = components.ChatResponse;
 
 /**
  * Chat

package/src/react-query/clientChatStartStream.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientChatStartStream } from "../funcs/clientChatStartStream.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ClientChatStartStreamMutationVariables = {
+  chatRequest: components.ChatRequest;
+  timezoneOffset?: number | undefined;
+  options?: RequestOptions;
+};
+
+export type ClientChatStartStreamMutationData = string;
+
+/**
+ * Chat
+ *
+ * @remarks
+ * Have a conversation with Glean AI.
+ */
+export function useClientChatStartStreamMutation(
+  options?: MutationHookOptions<
+    ClientChatStartStreamMutationData,
+    Error,
+    ClientChatStartStreamMutationVariables
+  >,
+): UseMutationResult<
+  ClientChatStartStreamMutationData,
+  Error,
+  ClientChatStartStreamMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildClientChatStartStreamMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyClientChatStartStream(): MutationKey {
+  return ["@gleanwork/api-client", "chat", "startStream"];
+}
+
+export function buildClientChatStartStreamMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ClientChatStartStreamMutationVariables,
+  ) => Promise<ClientChatStartStreamMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyClientChatStartStream(),
+    mutationFn: function clientChatStartStreamMutationFn({
+      chatRequest,
+      timezoneOffset,
+      options,
+    }): Promise<ClientChatStartStreamMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(clientChatStartStream(
+        client$,
+        chatRequest,
+        timezoneOffset,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/index.ts

@@ -27,6 +27,7 @@ export * from "./clientChatGetApplication.js";
 export * from "./clientChatGetFiles.js";
 export * from "./clientChatList.js";
 export * from "./clientChatStart.js";
+export * from "./clientChatStartStream.js";
 export * from "./clientChatUploadFiles.js";
 export * from "./clientCollectionsAddItems.js";
 export * from "./clientCollectionsCreate.js";

package/src/sdk/chat.ts

@@ -10,6 +10,7 @@ import { clientChatGetApplication } from "../funcs/clientChatGetApplication.js";
 import { clientChatGetFiles } from "../funcs/clientChatGetFiles.js";
 import { clientChatList } from "../funcs/clientChatList.js";
 import { clientChatStart } from "../funcs/clientChatStart.js";
+import { clientChatStartStream } from "../funcs/clientChatStartStream.js";
 import { clientChatUploadFiles } from "../funcs/clientChatUploadFiles.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -26,7 +27,7 @@ export class Chat extends ClientSDK {
     chatRequest: components.ChatRequest,
     timezoneOffset?: number | undefined,
     options?: RequestOptions,
-  ): Promise<string> {
+  ): Promise<components.ChatResponse> {
     return unwrapAsync(clientChatStart(
       this,
       chatRequest,
@@ -182,4 +183,23 @@ export class Chat extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Chat
+   *
+   * @remarks
+   * Have a conversation with Glean AI.
+   */
+  async startStream(
+    chatRequest: components.ChatRequest,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(clientChatStartStream(
+      this,
+      chatRequest,
+      timezoneOffset,
+      options,
+    ));
+  }
 }