@gleanwork/api-client 0.14.4 → 0.14.6

package/src/models/components/chatmessage.ts

@@ -48,6 +48,30 @@ export const MessageType = {
    * A message providing context in addition to the user query.
    */
   Context: "CONTEXT",
+  /**
+   * Control signal for message streaming.
+   */
+  Control: "CONTROL",
+  /**
+   * Control signal indicating the start of a message stream.
+   */
+  ControlStart: "CONTROL_START",
+  /**
+   * Control signal indicating the end of a message stream.
+   */
+  ControlFinish: "CONTROL_FINISH",
+  /**
+   * Control signal indicating the message stream was cancelled.
+   */
+  ControlCancel: "CONTROL_CANCEL",
+  /**
+   * Indicates the message streaming needed to be retried.
+   */
+  ControlRetry: "CONTROL_RETRY",
+  /**
+   * Fallback control signal for unrecognized control types.
+   */
+  ControlUnknown: "CONTROL_UNKNOWN",
   /**
    * A debug message. Strictly used internally.
    */

package/src/models/components/chatresponse.ts

@@ -7,6 +7,10 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { ChatMessage, ChatMessage$inboundSchema } from "./chatmessage.js";
+import {
+  UnauthorizedDatasourceInstance,
+  UnauthorizedDatasourceInstance$inboundSchema,
+} from "./unauthorizeddatasourceinstance.js";
 
 /**
  * A single response from the /chat backend.
@@ -29,6 +33,14 @@ export type ChatResponse = {
    * A token that is used to track the session.
    */
   chatSessionTrackingToken?: string | undefined;
+  /**
+   * Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth, aggregated across all tools invoked in this turn.
+   *
+   * @remarks
+   */
+  unauthorizedDatasourceInstances?:
+    | Array<UnauthorizedDatasourceInstance>
+    | undefined;
 };
 
 /** @internal */
@@ -42,6 +54,9 @@ export const ChatResponse$inboundSchema: z.ZodType<
   followUpPrompts: z.array(z.string()).optional(),
   backendTimeMillis: z.number().int().optional(),
   chatSessionTrackingToken: z.string().optional(),
+  unauthorizedDatasourceInstances: z.array(
+    UnauthorizedDatasourceInstance$inboundSchema,
+  ).optional(),
 });
 
 export function chatResponseFromJSON(

package/src/models/components/checkdatasourceauthresponse.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  UnauthorizedDatasourceInstance,
+  UnauthorizedDatasourceInstance$inboundSchema,
+} from "./unauthorizeddatasourceinstance.js";
+
+export type CheckDatasourceAuthResponse = {
+  /**
+   * Datasource instances that require per-user OAuth authorization. Empty or absent when all datasources are authorized.
+   *
+   * @remarks
+   */
+  unauthorizedDatasourceInstances?:
+    | Array<UnauthorizedDatasourceInstance>
+    | undefined;
+};
+
+/** @internal */
+export const CheckDatasourceAuthResponse$inboundSchema: z.ZodType<
+  CheckDatasourceAuthResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  unauthorizedDatasourceInstances: z.array(
+    UnauthorizedDatasourceInstance$inboundSchema,
+  ).optional(),
+});
+
+export function checkDatasourceAuthResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckDatasourceAuthResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckDatasourceAuthResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckDatasourceAuthResponse' from JSON`,
+  );
+}

package/src/models/components/gleandataerror.ts

@@ -11,6 +11,10 @@ import {
   InvalidOperatorValueError,
   InvalidOperatorValueError$inboundSchema,
 } from "./invalidoperatorvalueerror.js";
+import {
+  UnauthorizedDatasourceInstance,
+  UnauthorizedDatasourceInstance$inboundSchema,
+} from "./unauthorizeddatasourceinstance.js";
 
 export type GleanDataError = {
   /**
@@ -30,6 +34,14 @@ export type GleanDataError = {
    * Indicates the federated search results could not be fetched due to rate limiting.
    */
   federatedSearchRateLimitError?: boolean | undefined;
+  /**
+   * Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth.
+   *
+   * @remarks
+   */
+  unauthorizedDatasourceInstances?:
+    | Array<UnauthorizedDatasourceInstance>
+    | undefined;
 };
 
 /** @internal */
@@ -43,6 +55,9 @@ export const GleanDataError$inboundSchema: z.ZodType<
   invalidOperators: z.array(InvalidOperatorValueError$inboundSchema).optional(),
   errorMessages: z.array(ErrorMessage$inboundSchema).optional(),
   federatedSearchRateLimitError: z.boolean().optional(),
+  unauthorizedDatasourceInstances: z.array(
+    UnauthorizedDatasourceInstance$inboundSchema,
+  ).optional(),
 });
 
 export function gleanDataErrorFromJSON(

package/src/models/components/index.ts

@@ -32,6 +32,7 @@ export * from "./answerresult.js";
 export * from "./appresult.js";
 export * from "./assistantinsightsresponse.js";
 export * from "./authconfig.js";
+export * from "./authstatus.js";
 export * from "./authtoken.js";
 export * from "./autocompleterequest.js";
 export * from "./autocompleteresponse.js";
@@ -67,6 +68,7 @@ export * from "./chatrestrictionfilters.js";
 export * from "./chatresult.js";
 export * from "./chatsuggestion.js";
 export * from "./chatzerostatesuggestionoptions.js";
+export * from "./checkdatasourceauthresponse.js";
 export * from "./checkdocumentaccessrequest.js";
 export * from "./checkdocumentaccessresponse.js";
 export * from "./clustergroup.js";
@@ -394,6 +396,7 @@ export * from "./toolscallresponse.js";
 export * from "./toolsets.js";
 export * from "./toolslistresponse.js";
 export * from "./ugctype.js";
+export * from "./unauthorizeddatasourceinstance.js";
 export * from "./unpin.js";
 export * from "./updateannouncementrequest.js";
 export * from "./updatedlpconfigrequest.js";

package/src/models/components/unauthorizeddatasourceinstance.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AuthStatus, AuthStatus$inboundSchema } from "./authstatus.js";
+
+/**
+ * A datasource instance that could not return results for this request because the user has not completed or has expired per-user OAuth.
+ *
+ * @remarks
+ */
+export type UnauthorizedDatasourceInstance = {
+  /**
+   * The instance identifier (e.g. "github", "github_enterprise_0", "slack_0"). Matches the instance names used in datasource configuration.
+   *
+   * @remarks
+   */
+  datasourceInstance?: string | undefined;
+  /**
+   * Human-readable name of the datasource instance for display.
+   */
+  displayName?: string | undefined;
+  /**
+   * The per-user authorization status for a datasource.
+   */
+  authStatus?: AuthStatus | undefined;
+  /**
+   * Relative path to initiate or resume OAuth for the current user and instance, including a one-time authentication token as a query parameter. Clients should prepend their configured Glean backend base URL.
+   *
+   * @remarks
+   */
+  authUrlRelativePath?: string | undefined;
+};
+
+/** @internal */
+export const UnauthorizedDatasourceInstance$inboundSchema: z.ZodType<
+  UnauthorizedDatasourceInstance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  datasourceInstance: z.string().optional(),
+  displayName: z.string().optional(),
+  authStatus: AuthStatus$inboundSchema.optional(),
+  authUrlRelativePath: z.string().optional(),
+});
+
+export function unauthorizedDatasourceInstanceFromJSON(
+  jsonString: string,
+): SafeParseResult<UnauthorizedDatasourceInstance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnauthorizedDatasourceInstance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnauthorizedDatasourceInstance' from JSON`,
+  );
+}

package/src/models/errors/gleandataerror.ts

@@ -24,6 +24,14 @@ export type GleanDataErrorData = {
    * Indicates the federated search results could not be fetched due to rate limiting.
    */
   federatedSearchRateLimitError?: boolean | undefined;
+  /**
+   * Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth.
+   *
+   * @remarks
+   */
+  unauthorizedDatasourceInstances?:
+    | Array<components.UnauthorizedDatasourceInstance>
+    | undefined;
 };
 
 export class GleanDataError extends GleanBaseError {
@@ -44,6 +52,14 @@ export class GleanDataError extends GleanBaseError {
    * Indicates the federated search results could not be fetched due to rate limiting.
    */
   federatedSearchRateLimitError?: boolean | undefined;
+  /**
+   * Datasource instances that could not be queried because the user has not completed or has expired per-user OAuth.
+   *
+   * @remarks
+   */
+  unauthorizedDatasourceInstances?:
+    | Array<components.UnauthorizedDatasourceInstance>
+    | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: GleanDataErrorData;
@@ -66,6 +82,10 @@ export class GleanDataError extends GleanBaseError {
     if (err.federatedSearchRateLimitError != null) {
       this.federatedSearchRateLimitError = err.federatedSearchRateLimitError;
     }
+    if (err.unauthorizedDatasourceInstances != null) {
+      this.unauthorizedDatasourceInstances =
+        err.unauthorizedDatasourceInstances;
+    }
 
     this.name = "GleanDataError";
   }
@@ -83,6 +103,9 @@ export const GleanDataError$inboundSchema: z.ZodType<
     .optional(),
   errorMessages: z.array(components.ErrorMessage$inboundSchema).optional(),
   federatedSearchRateLimitError: z.boolean().optional(),
+  unauthorizedDatasourceInstances: z.array(
+    components.UnauthorizedDatasourceInstance$inboundSchema,
+  ).optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

package/src/react-query/authenticationCheckdatasourceauth.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { authenticationCheckdatasourceauth } from "../funcs/authenticationCheckdatasourceauth.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type AuthenticationCheckdatasourceauthMutationVariables = {
+  options?: RequestOptions;
+};
+
+export type AuthenticationCheckdatasourceauthMutationData =
+  components.CheckDatasourceAuthResponse;
+
+export type AuthenticationCheckdatasourceauthMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Check datasource authorization
+ *
+ * @remarks
+ * Returns all datasource instances that require per-user OAuth authorization
+ * for the authenticated user, along with a transient auth token that can be
+ * appended to auth URLs to complete OAuth flows.
+ *
+ * Clients construct the full OAuth URL by combining the backend base URL,
+ * the `authUrlRelativePath` from each instance, and the transient auth token:
+ * `<backend>/<authUrlRelativePath>?transient_auth_token=<token>`.
+ */
+export function useAuthenticationCheckdatasourceauthMutation(
+  options?: MutationHookOptions<
+    AuthenticationCheckdatasourceauthMutationData,
+    AuthenticationCheckdatasourceauthMutationError,
+    AuthenticationCheckdatasourceauthMutationVariables
+  >,
+): UseMutationResult<
+  AuthenticationCheckdatasourceauthMutationData,
+  AuthenticationCheckdatasourceauthMutationError,
+  AuthenticationCheckdatasourceauthMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildAuthenticationCheckdatasourceauthMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAuthenticationCheckdatasourceauth(): MutationKey {
+  return ["@gleanwork/api-client", "Authentication", "checkdatasourceauth"];
+}
+
+export function buildAuthenticationCheckdatasourceauthMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AuthenticationCheckdatasourceauthMutationVariables,
+  ) => Promise<AuthenticationCheckdatasourceauthMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAuthenticationCheckdatasourceauth(),
+    mutationFn: function authenticationCheckdatasourceauthMutationFn({
+      options,
+    }): Promise<AuthenticationCheckdatasourceauthMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(authenticationCheckdatasourceauth(
+        client$,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/index.ts

@@ -5,6 +5,7 @@
 export { GleanProvider, useGleanContext } from "./_context.js";
 export * from "./_types.js";
 
+export * from "./authenticationCheckdatasourceauth.js";
 export * from "./clientActivityFeedback.js";
 export * from "./clientActivityReport.js";
 export * from "./clientAgentsList.js";

package/src/sdk/authentication.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { authenticationCheckdatasourceauth } from "../funcs/authenticationCheckdatasourceauth.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Authentication extends ClientSDK {
+  /**
+   * Check datasource authorization
+   *
+   * @remarks
+   * Returns all datasource instances that require per-user OAuth authorization
+   * for the authenticated user, along with a transient auth token that can be
+   * appended to auth URLs to complete OAuth flows.
+   *
+   * Clients construct the full OAuth URL by combining the backend base URL,
+   * the `authUrlRelativePath` from each instance, and the transient auth token:
+   * `<backend>/<authUrlRelativePath>?transient_auth_token=<token>`.
+   */
+  async checkdatasourceauth(
+    options?: RequestOptions,
+  ): Promise<components.CheckDatasourceAuthResponse> {
+    return unwrapAsync(authenticationCheckdatasourceauth(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Authentication } from "./authentication.js";
 import { Client } from "./client.js";
 import { Governance } from "./governance.js";
 import { Indexing } from "./indexing.js";
@@ -13,6 +14,11 @@ export class Glean extends ClientSDK {
     return (this._client ??= new Client(this._options));
   }
 
+  private _authentication?: Authentication;
+  get authentication(): Authentication {
+    return (this._authentication ??= new Authentication(this._options));
+  }
+
   private _indexing?: Indexing;
   get indexing(): Indexing {
     return (this._indexing ??= new Indexing(this._options));