@gleanwork/api-client 0.10.3 → 0.11.0

package/src/funcs/indexingShortcutsBulkIndex.ts

@@ -12,7 +12,7 @@ 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 { GleanBaseError } from "../models/errors/gleanbaseerror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +20,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
@@ -37,13 +38,14 @@ export function indexingShortcutsBulkIndex(
 ): APIPromise<
   Result<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -61,13 +63,14 @@ async function $do(
   [
     Result<
       void,
-      | GleanError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -95,6 +98,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "post_/api/index/v1/bulkindexshortcuts",
     oAuth2Scopes: [],
@@ -115,6 +119,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -135,18 +140,19 @@ async function $do(
 
   const [result] = await M.match<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.nil(200, z.void()),
     M.fail([400, 401, 409, "4XX"]),
     M.fail("5XX"),
-  )(response);
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/indexingShortcutsUpload.ts

@@ -12,7 +12,7 @@ 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 { GleanBaseError } from "../models/errors/gleanbaseerror.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -20,6 +20,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
@@ -37,13 +38,14 @@ export function indexingShortcutsUpload(
 ): APIPromise<
   Result<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >
 > {
   return new APIPromise($do(
@@ -61,13 +63,14 @@ async function $do(
   [
     Result<
       void,
-      | GleanError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
       | RequestAbortedError
       | RequestTimeoutError
-      | ConnectionError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
     >,
     APICall,
   ]
@@ -95,6 +98,7 @@ async function $do(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
+    options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "post_/api/index/v1/uploadshortcuts",
     oAuth2Scopes: [],
@@ -115,6 +119,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
@@ -135,18 +140,19 @@ async function $do(
 
   const [result] = await M.match<
     void,
-    | GleanError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
-    | ConnectionError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
   >(
     M.nil(200, z.void()),
     M.fail([400, 401, 409, "4XX"]),
     M.fail("5XX"),
-  )(response);
+  )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/hooks/types.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { SDKOptions } from "../lib/config.js";
 import { HTTPClient, RequestInput } from "../lib/http.js";
 import { RetryConfig } from "../lib/retries.js";
 import { SecurityState } from "../lib/security.js";
@@ -13,6 +14,7 @@ export type HookContext = {
   securitySource?: any | (() => Promise<any>);
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
+  options: SDKOptions;
 };
 
 export type Awaitable<T> = T | Promise<T>;

package/src/index.ts

@@ -4,4 +4,6 @@
 
 export * from "./lib/config.js";
 export * as files from "./lib/files.js";
+export { HTTPClient } from "./lib/http.js";
+export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";

package/src/lib/config.ts

@@ -30,6 +30,10 @@ export type SDKOptions = {
    * Allows overriding the default server URL used by the SDK
    */
   serverURL?: string | undefined;
+  /**
+   * Allows overriding the default user agent used by the SDK
+   */
+  userAgent?: string | undefined;
   /**
    * Allows overriding the default retry config used by the SDK
    */
@@ -64,8 +68,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.10.3",
-  genVersion: "2.610.0",
+  sdkVersion: "0.11.0",
+  genVersion: "2.716.16",
   userAgent:
-    "speakeasy-sdk/typescript 0.10.3 2.610.0 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.11.0 2.716.16 0.9.0 @gleanwork/api-client",
 } as const;

package/src/lib/files.ts

@@ -38,3 +38,45 @@ export async function readableStreamToArrayBuffer(
 
   return concatenatedChunks.buffer as ArrayBuffer;
 }
+
+/**
+ * Determines the MIME content type based on a file's extension.
+ * Returns null if the extension is not recognized.
+ */
+export function getContentTypeFromFileName(fileName: string): string | null {
+  if (!fileName) return null;
+
+  const ext = fileName.toLowerCase().split(".").pop();
+  if (!ext) return null;
+
+  const mimeTypes: Record<string, string> = {
+    json: "application/json",
+    xml: "application/xml",
+    html: "text/html",
+    htm: "text/html",
+    txt: "text/plain",
+    csv: "text/csv",
+    pdf: "application/pdf",
+    png: "image/png",
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    gif: "image/gif",
+    svg: "image/svg+xml",
+    js: "application/javascript",
+    css: "text/css",
+    zip: "application/zip",
+    tar: "application/x-tar",
+    gz: "application/gzip",
+    mp4: "video/mp4",
+    mp3: "audio/mpeg",
+    wav: "audio/wav",
+    webp: "image/webp",
+    ico: "image/x-icon",
+    woff: "font/woff",
+    woff2: "font/woff2",
+    ttf: "font/ttf",
+    otf: "font/otf",
+  };
+
+  return mimeTypes[ext] || null;
+}

package/src/lib/matchers.ts

@@ -3,11 +3,10 @@
  */
 
 import { GleanError } from "../models/errors/gleanerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { Result } from "../types/fp.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { ERR, OK, Result } from "../types/fp.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
 import { isPlainObject } from "./is-plain-object.js";
-import { safeParse } from "./schemas.js";
 
 export type Encoding =
   | "jsonl"
@@ -176,17 +175,19 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
+  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
-): MatchFunc<T, E | GleanError | SDKValidationError> {
+): MatchFunc<T, E | GleanError | ResponseValidationError> {
   return async function matchFunc(
     response: Response,
+    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
-    [result: Result<T, E | GleanError | SDKValidationError>, raw: unknown]
+    [result: Result<T, E | GleanError | ResponseValidationError>, raw: unknown]
   > {
     let raw: unknown;
     let matcher: Matcher<T, E> | undefined;
@@ -205,21 +206,22 @@ export function match<T, E>(
     }
 
     if (!matcher) {
-      const responseBody = await response.text();
       return [{
         ok: false,
-        error: new GleanError(
-          "Unexpected API response status or content-type",
+        error: new GleanError("Unexpected Status or Content-Type", {
           response,
-          responseBody,
-        ),
-      }, responseBody];
+          request,
+          body: await response.text().catch(() => ""),
+        }),
+      }, raw];
     }
 
     const encoding = matcher.enc;
+    let body = "";
     switch (encoding) {
       case "json":
-        raw = await response.json();
+        body = await response.text();
+        raw = JSON.parse(body);
         break;
       case "jsonl":
         raw = response.body;
@@ -231,16 +233,19 @@ export function match<T, E>(
         raw = response.body;
         break;
       case "text":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       case "sse":
         raw = response.body;
         break;
       case "nil":
-        raw = await discardResponseBody(response);
+        body = await response.text();
+        raw = undefined;
         break;
       case "fail":
-        raw = await response.text();
+        body = await response.text();
+        raw = body;
         break;
       default:
         encoding satisfies never;
@@ -250,11 +255,11 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new GleanError(
-          "API error occurred",
+        error: new GleanError("API error occurred", {
+          request,
           response,
-          typeof raw === "string" ? raw : "",
-        ),
+          body,
+        }),
       }, raw];
     }
 
@@ -266,6 +271,9 @@ export function match<T, E>(
         ...options?.extraFields,
         ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
         ...(isPlainObject(raw) ? raw : null),
+        request$: request,
+        response$: response,
+        body$: body,
       };
     } else if (resultKey) {
       data = {
@@ -284,18 +292,20 @@ export function match<T, E>(
     }
 
     if ("err" in matcher) {
-      const result = safeParse(
+      const result = safeParseResponse(
         data,
         (v: unknown) => matcher.schema.parse(v),
         "Response validation failed",
+        { request, response, body },
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
       return [
-        safeParse(
+        safeParseResponse(
           data,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
+          { request, response, body },
         ),
         raw,
       ];
@@ -318,25 +328,22 @@ export function unpackHeaders(headers: Headers): Record<string, string[]> {
   return out;
 }
 
-/**
- * Discards the response body to free up resources.
- *
- * To learn why this is need, see the undici docs:
- * https://undici.nodejs.org/#/?id=garbage-collection
- */
-export async function discardResponseBody(res: Response) {
-  const reader = res.body?.getReader();
-  if (reader == null) {
-    return;
-  }
-
+function safeParseResponse<Inp, Out>(
+  rawValue: Inp,
+  fn: (value: Inp) => Out,
+  errorMessage: string,
+  httpMeta: { response: Response; request: Request; body: string },
+): Result<Out, ResponseValidationError> {
   try {
-    let done = false;
-    while (!done) {
-      const res = await reader.read();
-      done = res.done;
-    }
-  } finally {
-    reader.releaseLock();
+    return OK(fn(rawValue));
+  } catch (err) {
+    return ERR(
+      new ResponseValidationError(errorMessage, {
+        cause: err,
+        rawValue,
+        rawMessage: errorMessage,
+        ...httpMeta,
+      }),
+    );
   }
 }

package/src/lib/sdks.ts

@@ -65,6 +65,7 @@ type RequestConfig = {
   headers?: HeadersInit;
   security?: SecurityState | null;
   uaHeader?: string;
+  userAgent?: string | undefined;
   timeoutMs?: number;
 };
 
@@ -96,19 +97,21 @@ export class ClientSDK {
     } else {
       this.#hooks = new SDKHooks();
     }
-    this._options = { ...options, hooks: this.#hooks };
-
     const url = serverURLFromOptions(options);
     if (url) {
       url.pathname = url.pathname.replace(/\/+$/, "") + "/";
     }
+
     const { baseURL, client } = this.#hooks.sdkInit({
       baseURL: url,
       client: options.httpClient || new HTTPClient(),
     });
     this._baseURL = baseURL;
     this.#httpClient = client;
-    this.#logger = options.debugLogger;
+
+    this._options = { ...options, hooks: this.#hooks };
+
+    this.#logger = this._options.debugLogger;
     if (!this.#logger && env().GLEAN_DEBUG) {
       this.#logger = console;
     }
@@ -184,7 +187,10 @@ export class ClientSDK {
     // Only set user agent header in non-browser-like environments since CORS
     // policy disallows setting it in browsers e.g. Chrome throws an error.
     if (!isBrowserLike) {
-      headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent);
+      headers.set(
+        conf.uaHeader ?? "user-agent",
+        conf.userAgent ?? SDK_METADATA.userAgent,
+      );
     }
 
     const fetchOptions: Omit<RequestInit, "method" | "body"> = {

package/src/lib/security.ts

@@ -7,8 +7,8 @@ import { env } from "./env.js";
 
 type OAuth2PasswordFlow = {
   username: string;
-  password?: string | undefined;
-  clientID: string;
+  password: string;
+  clientID?: string | undefined;
   clientSecret?: string | undefined;
   tokenURL: string;
 };
@@ -84,7 +84,10 @@ type SecurityInputOAuth2 = {
 type SecurityInputOAuth2ClientCredentials = {
   type: "oauth2:client_credentials";
   value:
-    | { clientID?: string | undefined; clientSecret?: string | undefined }
+    | {
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
     | null
     | string
     | undefined;

package/src/lib/url.ts

@@ -10,7 +10,7 @@ export function pathToFunc(
   pathPattern: string,
   options?: { charEncoding?: "percent" | "none" },
 ): (params?: Params) => string {
-  const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
     return pathPattern.replace(paramRE, function (_, placeholder) {

package/src/models/components/agentsinsightsv2request.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Period,
+  Period$inboundSchema,
+  Period$Outbound,
+  Period$outboundSchema,
+} from "./period.js";
+
+export type AgentsInsightsV2Request = {
+  /**
+   * IDs of the Agents for which Insights should be returned. An empty array signifies all.
+   */
+  agentIds?: Array<string> | undefined;
+  /**
+   * Departments for which Insights are requested.
+   */
+  departments?: Array<string> | undefined;
+  dayRange?: Period | undefined;
+};
+
+/** @internal */
+export const AgentsInsightsV2Request$inboundSchema: z.ZodType<
+  AgentsInsightsV2Request,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agentIds: z.array(z.string()).optional(),
+  departments: z.array(z.string()).optional(),
+  dayRange: Period$inboundSchema.optional(),
+});
+
+/** @internal */
+export type AgentsInsightsV2Request$Outbound = {
+  agentIds?: Array<string> | undefined;
+  departments?: Array<string> | undefined;
+  dayRange?: Period$Outbound | undefined;
+};
+
+/** @internal */
+export const AgentsInsightsV2Request$outboundSchema: z.ZodType<
+  AgentsInsightsV2Request$Outbound,
+  z.ZodTypeDef,
+  AgentsInsightsV2Request
+> = z.object({
+  agentIds: z.array(z.string()).optional(),
+  departments: z.array(z.string()).optional(),
+  dayRange: Period$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentsInsightsV2Request$ {
+  /** @deprecated use `AgentsInsightsV2Request$inboundSchema` instead. */
+  export const inboundSchema = AgentsInsightsV2Request$inboundSchema;
+  /** @deprecated use `AgentsInsightsV2Request$outboundSchema` instead. */
+  export const outboundSchema = AgentsInsightsV2Request$outboundSchema;
+  /** @deprecated use `AgentsInsightsV2Request$Outbound` instead. */
+  export type Outbound = AgentsInsightsV2Request$Outbound;
+}
+
+export function agentsInsightsV2RequestToJSON(
+  agentsInsightsV2Request: AgentsInsightsV2Request,
+): string {
+  return JSON.stringify(
+    AgentsInsightsV2Request$outboundSchema.parse(agentsInsightsV2Request),
+  );
+}
+
+export function agentsInsightsV2RequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentsInsightsV2Request, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentsInsightsV2Request$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentsInsightsV2Request' from JSON`,
+  );
+}

package/src/models/components/customfieldvalue.ts

@@ -27,8 +27,8 @@ import {
 
 export type CustomFieldValue =
   | CustomFieldValueStr
-  | CustomFieldValuePerson
-  | CustomFieldValueHyperlink;
+  | CustomFieldValueHyperlink
+  | CustomFieldValuePerson;
 
 /** @internal */
 export const CustomFieldValue$inboundSchema: z.ZodType<
@@ -37,15 +37,15 @@ export const CustomFieldValue$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   CustomFieldValueStr$inboundSchema,
-  z.lazy(() => CustomFieldValuePerson$inboundSchema),
   CustomFieldValueHyperlink$inboundSchema,
+  z.lazy(() => CustomFieldValuePerson$inboundSchema),
 ]);
 
 /** @internal */
 export type CustomFieldValue$Outbound =
   | CustomFieldValueStr$Outbound
-  | CustomFieldValuePerson$Outbound
-  | CustomFieldValueHyperlink$Outbound;
+  | CustomFieldValueHyperlink$Outbound
+  | CustomFieldValuePerson$Outbound;
 
 /** @internal */
 export const CustomFieldValue$outboundSchema: z.ZodType<
@@ -54,8 +54,8 @@ export const CustomFieldValue$outboundSchema: z.ZodType<
   CustomFieldValue
 > = z.union([
   CustomFieldValueStr$outboundSchema,
-  z.lazy(() => CustomFieldValuePerson$outboundSchema),
   CustomFieldValueHyperlink$outboundSchema,
+  z.lazy(() => CustomFieldValuePerson$outboundSchema),
 ]);
 
 /**