@gleanwork/api-client 0.10.3 → 0.11.0

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { GleanBaseError } from "./gleanbaseerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends GleanBaseError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/react-query/_types.ts

@@ -6,15 +6,88 @@ import { RequestOptions } from "../lib/sdks.js";
 import { PageIterator } from "../types/operations.js";
 
 import type {
+  DefaultError,
   InfiniteData,
+  InfiniteQueryPageParamsOptions,
+  OmitKeyof,
   QueryKey,
-  UseInfiniteQueryOptions,
+  QueryObserverOptions,
+  SkipToken,
   UseMutationOptions,
   UseQueryOptions,
-  UseSuspenseInfiniteQueryOptions,
   UseSuspenseQueryOptions,
 } from "@tanstack/react-query";
 
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface UseInfiniteQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  OmitKeyof<
+    InfiniteQueryObserverOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey,
+      TPageParam
+    >,
+    "suspense"
+  >
+{
+  /**
+   * Set this to `false` to unsubscribe this observer from updates to the query cache.
+   * Defaults to `true`.
+   */
+  subscribed?: boolean;
+}
+
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface InfiniteQueryObserverOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  QueryObserverOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    InfiniteData<TQueryFnData, TPageParam>,
+    TQueryKey,
+    TPageParam
+  >,
+  InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam>
+{
+}
+
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface UseSuspenseInfiniteQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  OmitKeyof<
+    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
+    "queryFn" | "enabled" | "throwOnError" | "placeholderData"
+  >
+{
+  queryFn?: Exclude<
+    UseInfiniteQueryOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey,
+      TPageParam
+    >["queryFn"],
+    SkipToken
+  >;
+}
 export type TupleToPrefixes<T extends any[]> = T extends [...infer Prefix, any]
   ? TupleToPrefixes<Prefix> | T
   : never;
@@ -41,7 +114,6 @@ export type InfiniteQueryHookOptions<
       Data,
       Error,
       InfiniteData<Data, Data["~next"]>,
-      Data,
       QueryKey,
       Data["~next"]
     >,
@@ -64,7 +136,6 @@ export type SuspenseInfiniteQueryHookOptions<
       Data,
       Error,
       InfiniteData<Data, Data["~next"]>,
-      Data,
       QueryKey,
       Data["~next"]
     >,

package/src/react-query/clientInsightsRetrieve.ts

@@ -24,10 +24,10 @@ export type ClientInsightsRetrieveMutationVariables = {
 export type ClientInsightsRetrieveMutationData = components.InsightsResponse;
 
 /**
- * Read insights
+ * Get insights
  *
  * @remarks
- * Reads the aggregate information for each user, query, and content.
+ * Gets the aggregate usage insights data displayed in the Insights Dashboards.
  */
 export function useClientInsightsRetrieveMutation(
   options?: MutationHookOptions<

package/src/sdk/insights.ts

@@ -9,10 +9,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Insights extends ClientSDK {
   /**
-   * Read insights
+   * Get insights
    *
    * @remarks
-   * Reads the aggregate information for each user, query, and content.
+   * Gets the aggregate usage insights data displayed in the Insights Dashboards.
    */
   async retrieve(
     request: components.InsightsRequest,

package/src/types/constdatetime.ts

@@ -11,5 +11,5 @@ export function constDateTime(
     return (
       typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
     );
-  }, `Value must be equivelant to ${val}`);
+  }, `Value must be equivalent to ${val}`);
 }

package/docs/sdks/data/README.md

@@ -1,6 +0,0 @@
-# Data
-(*client.governance.data*)
-
-## Overview
-
-### Available Operations

package/docs/sdks/governance/README.md

@@ -1,6 +0,0 @@
-# Governance
-(*client.governance*)
-
-## Overview
-
-### Available Operations

package/docs/sdks/governancedocuments/README.md

@@ -1,6 +0,0 @@
-# GovernanceDocuments
-(*client.governance.documents*)
-
-## Overview
-
-### Available Operations