dub 0.44.0 → 0.45.0

package/src/funcs/workspacesGet.ts

@@ -80,12 +80,20 @@ export async function workspacesGet(
 
   const secConfig = await extractSecurity(client._options.token);
   const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     operationID: "getWorkspace",
     oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
   };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
@@ -115,9 +123,8 @@ export async function workspacesGet(
       "500",
       "5XX",
     ],
-    retryConfig: options?.retries
-      || client._options.retryConfig,
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
     return doResult;

package/src/funcs/workspacesUpdate.ts

@@ -87,12 +87,20 @@ export async function workspacesUpdate(
 
   const secConfig = await extractSecurity(client._options.token);
   const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     operationID: "updateWorkspace",
     oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
   };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
@@ -122,9 +130,8 @@ export async function workspacesUpdate(
       "500",
       "5XX",
     ],
-    retryConfig: options?.retries
-      || client._options.retryConfig,
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
     return doResult;

package/src/hooks/types.ts

@@ -3,11 +3,15 @@
  */
 
 import { HTTPClient, RequestInput } from "../lib/http.js";
+import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
 
 export type HookContext = {
   operationID: string;
   oAuth2Scopes?: string[];
   securitySource?: any | (() => Promise<any>);
+  retryConfig: RetryConfig;
+  resolvedSecurity: SecurityState | null;
 };
 
 export type Awaitable<T> = T | Promise<T>;

package/src/lib/config.ts

@@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.44.0",
-  genVersion: "2.442.11",
-  userAgent: "speakeasy-sdk/typescript 0.44.0 2.442.11 0.0.1 dub",
+  sdkVersion: "0.45.0",
+  genVersion: "2.457.2",
+  userAgent: "speakeasy-sdk/typescript 0.45.0 2.457.2 0.0.1 dub",
 } as const;

package/src/lib/primitives.ts

@@ -2,6 +2,26 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+class InvariantError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "InvariantError";
+  }
+}
+
+export function invariant(
+  condition: unknown,
+  message: string,
+): asserts condition {
+  if (!condition) {
+    throw new InvariantError(message);
+  }
+}
+
+export type ExactPartial<T> = {
+  [P in keyof T]?: T[P] | undefined;
+};
+
 export type Remap<Inp, Mapping extends { [k in keyof Inp]?: string | null }> = {
   [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */
     ? Mapping[k]

package/src/lib/retries.ts

@@ -26,23 +26,44 @@ export type RetryConfig =
       retryConnectionErrors?: boolean;
     };
 
-class PermanentError extends Error {
-  inner: unknown;
+/**
+ * PermanentError is an error that is not recoverable. Throwing this error will
+ * cause a retry loop to terminate.
+ */
+export class PermanentError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+
+  constructor(message: string, options?: { cause?: unknown }) {
+    let msg = message;
+    if (options?.cause) {
+      msg += `: ${options.cause}`;
+    }
 
-  constructor(inner: unknown) {
-    super("Permanent error");
-    this.inner = inner;
+    super(msg, options);
+    this.name = "PermanentError";
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = options?.cause;
+    }
 
     Object.setPrototypeOf(this, PermanentError.prototype);
   }
 }
 
-class TemporaryError extends Error {
-  res: Response;
+/**
+ * TemporaryError is an error is used to signal that an HTTP request can be
+ * retried as part of a retry loop. If retry attempts are exhausted and this
+ * error is thrown, the response will be returned to the caller.
+ */
+export class TemporaryError extends Error {
+  response: Response;
 
-  constructor(res: Response) {
-    super("Temporary error");
-    this.res = res;
+  constructor(message: string, response: Response) {
+    super(message);
+    this.response = response;
+    this.name = "TemporaryError";
 
     Object.setPrototypeOf(this, TemporaryError.prototype);
   }
@@ -80,11 +101,14 @@ function wrapFetcher(
     try {
       const res = await fn();
       if (isRetryableResponse(res, options.statusCodes)) {
-        throw new TemporaryError(res);
+        throw new TemporaryError(
+          "Response failed with retryable status code",
+          res,
+        );
       }
 
       return res;
-    } catch (err) {
+    } catch (err: unknown) {
       if (err instanceof TemporaryError) {
         throw err;
       }
@@ -96,7 +120,7 @@ function wrapFetcher(
         throw err;
       }
 
-      throw new PermanentError(err);
+      throw new PermanentError("Permanent error", { cause: err });
     }
   };
 }
@@ -139,37 +163,25 @@ async function retryBackoff(
     try {
       const res = await fn();
       return res;
-    } catch (err) {
+    } catch (err: unknown) {
       if (err instanceof PermanentError) {
-        throw err.inner;
+        throw err.cause;
       }
       const elapsed = Date.now() - start;
       if (elapsed > maxElapsedTime) {
         if (err instanceof TemporaryError) {
-          return err.res;
+          return err.response;
         }
 
         throw err;
       }
 
       let retryInterval = 0;
-      if (err instanceof TemporaryError && err.res && err.res.headers) {
-        const retryVal = err.res.headers.get("retry-after") || "";
-        if (retryVal != "") {
-          const parsedNumber = Number(retryVal);
-          if (!isNaN(parsedNumber) && Number.isInteger(parsedNumber)) {
-            retryInterval = parsedNumber * 1000;
-          } else {
-            const parsedDate = Date.parse(retryVal);
-            if (!isNaN(parsedDate)) {
-              const deltaMS = parsedDate - Date.now();
-              retryInterval = deltaMS > 0 ? Math.ceil(deltaMS) : 0;
-            }
-          }
-        }
+      if (err instanceof TemporaryError) {
+        retryInterval = retryIntervalFromResponse(err.response);
       }
 
-      if (retryInterval == 0) {
+      if (retryInterval <= 0) {
         retryInterval =
           initialInterval * Math.pow(x, exponent) + Math.random() * 1000;
       }
@@ -182,6 +194,26 @@ async function retryBackoff(
   }
 }
 
+function retryIntervalFromResponse(res: Response): number {
+  const retryVal = res.headers.get("retry-after") || "";
+  if (!retryVal) {
+    return 0;
+  }
+
+  const parsedNumber = Number(retryVal);
+  if (Number.isInteger(parsedNumber)) {
+    return parsedNumber * 1000;
+  }
+
+  const parsedDate = Date.parse(retryVal);
+  if (Number.isInteger(parsedDate)) {
+    const deltaMS = parsedDate - Date.now();
+    return deltaMS > 0 ? Math.ceil(deltaMS) : 0;
+  }
+
+  return 0;
+}
+
 async function delay(delay: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, delay));
 }

package/src/lib/sdks.ts

@@ -220,8 +220,8 @@ export class ClientSDK {
     options: {
       context: HookContext;
       errorCodes: number | string | (number | string)[];
-      retryConfig?: RetryConfig | undefined;
-      retryCodes?: string[] | undefined;
+      retryConfig: RetryConfig;
+      retryCodes: string[];
     },
   ): Promise<
     Result<
@@ -233,8 +233,6 @@ export class ClientSDK {
     >
   > {
     const { context, errorCodes } = options;
-    const retryConfig = options.retryConfig || { strategy: "none" };
-    const retryCodes = options.retryCodes || [];
 
     return retry(
       async () => {
@@ -245,22 +243,28 @@ export class ClientSDK {
 
         let response = await this.#httpClient.request(req);
 
-        if (matchStatusCode(response, errorCodes)) {
-          const result = await this.#hooks.afterError(context, response, null);
-          if (result.error) {
-            throw result.error;
+        try {
+          if (matchStatusCode(response, errorCodes)) {
+            const result = await this.#hooks.afterError(
+              context,
+              response,
+              null,
+            );
+            if (result.error) {
+              throw result.error;
+            }
+            response = result.response || response;
+          } else {
+            response = await this.#hooks.afterSuccess(context, response);
           }
-          response = result.response || response;
-        } else {
-          response = await this.#hooks.afterSuccess(context, response);
+        } finally {
+          await logResponse(this.#logger, response, req)
+            .catch(e => this.#logger?.log("Failed to log response:", e));
         }
 
-        await logResponse(this.#logger, response, req)
-          .catch(e => this.#logger?.log("Failed to log response:", e));
-
         return response;
       },
-      { config: retryConfig, statusCodes: retryCodes },
+      { config: options.retryConfig, statusCodes: options.retryCodes },
     ).then(
       (r) => OK(r),
       (err) => {

package/src/lib/security.ts

@@ -4,6 +4,14 @@
 
 import * as components from "../models/components/index.js";
 
+type OAuth2PasswordFlow = {
+  username: string;
+  password?: string | undefined;
+  clientID: string;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
 export enum SecurityErrorCode {
   Incomplete = "incomplete",
   UnrecognisedSecurityType = "unrecognized_security_type",
@@ -37,6 +45,7 @@ export type SecurityState = {
   headers: Record<string, string>;
   queryParams: Record<string, string>;
   cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
 };
 
 type SecurityInputBasic = {
@@ -73,7 +82,18 @@ type SecurityInputOAuth2 = {
 
 type SecurityInputOAuth2ClientCredentials = {
   type: "oauth2:client_credentials";
-  value: string | null | undefined;
+  value:
+    | { clientID?: string | undefined; clientSecret?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
   fieldName: string;
 };
 
@@ -89,6 +109,7 @@ export type SecurityInput =
   | SecurityInputAPIKey
   | SecurityInputOAuth2
   | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
   | SecurityInputOIDC
   | SecurityInputCustom;
 
@@ -100,6 +121,7 @@ export function resolveSecurity(
     headers: {},
     queryParams: {},
     cookies: {},
+    oauth2: { type: "none" },
   };
 
   const option = options.find((opts) => {
@@ -110,6 +132,12 @@ export function resolveSecurity(
         return o.value.username != null || o.value.password != null;
       } else if (o.type === "http:custom") {
         return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        return o.value.clientID != null || o.value.clientSecret != null;
       } else if (typeof o.value === "string") {
         return !!o.value;
       } else {
@@ -152,6 +180,9 @@ export function resolveSecurity(
       case "oauth2":
         applyBearer(state, spec);
         break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
       case "oauth2:client_credentials":
         break;
       case "openIdConnect":
@@ -179,9 +210,13 @@ function applyBasic(
 
 function applyBearer(
   state: SecurityState,
-  spec: SecurityInputBearer | SecurityInputOAuth2 | SecurityInputOIDC,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
 ) {
-  if (spec.value == null) {
+  if (typeof spec.value !== "string" || !spec.value) {
     return;
   }
 
@@ -192,6 +227,7 @@ function applyBearer(
 
   state.headers[spec.fieldName] = value;
 }
+
 export function resolveGlobalSecurity(
   security: Partial<components.Security> | null | undefined,
 ): SecurityState | null {

package/src/models/operations/getlinks.ts

@@ -36,7 +36,7 @@ export type GetLinksRequest = {
    */
   domain?: string | undefined;
   /**
-   * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
+   * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
    */
   tagId?: string | undefined;
   /**

package/src/models/operations/getlinkscount.ts

@@ -41,7 +41,7 @@ export type GetLinksCountRequest = {
    */
   domain?: string | undefined;
   /**
-   * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
+   * Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
    */
   tagId?: string | undefined;
   /**

package/src/models/operations/listevents.ts

@@ -48,6 +48,11 @@ export const QueryParamTrigger = {
  */
 export type QueryParamTrigger = ClosedEnum<typeof QueryParamTrigger>;
 
+/**
+ * The tag IDs to retrieve analytics for.
+ */
+export type ListEventsQueryParamTagIds = string | Array<string>;
+
 export const Order = {
   Asc: "asc",
   Desc: "desc",
@@ -137,9 +142,13 @@ export type ListEventsRequest = {
    */
   url?: string | undefined;
   /**
-   * The tag ID to retrieve analytics for.
+   * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
    */
   tagId?: string | undefined;
+  /**
+   * The tag IDs to retrieve analytics for.
+   */
+  tagIds?: string | Array<string> | undefined;
   /**
    * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
    */
@@ -225,6 +234,36 @@ export namespace QueryParamTrigger$ {
   export const outboundSchema = QueryParamTrigger$outboundSchema;
 }
 
+/** @internal */
+export const ListEventsQueryParamTagIds$inboundSchema: z.ZodType<
+  ListEventsQueryParamTagIds,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type ListEventsQueryParamTagIds$Outbound = string | Array<string>;
+
+/** @internal */
+export const ListEventsQueryParamTagIds$outboundSchema: z.ZodType<
+  ListEventsQueryParamTagIds$Outbound,
+  z.ZodTypeDef,
+  ListEventsQueryParamTagIds
+> = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListEventsQueryParamTagIds$ {
+  /** @deprecated use `ListEventsQueryParamTagIds$inboundSchema` instead. */
+  export const inboundSchema = ListEventsQueryParamTagIds$inboundSchema;
+  /** @deprecated use `ListEventsQueryParamTagIds$outboundSchema` instead. */
+  export const outboundSchema = ListEventsQueryParamTagIds$outboundSchema;
+  /** @deprecated use `ListEventsQueryParamTagIds$Outbound` instead. */
+  export type Outbound = ListEventsQueryParamTagIds$Outbound;
+}
+
 /** @internal */
 export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
   Order,
@@ -290,6 +329,7 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
   page: z.number().default(1),
@@ -320,6 +360,7 @@ export type ListEventsRequest$Outbound = {
   refererUrl?: string | undefined;
   url?: string | undefined;
   tagId?: string | undefined;
+  tagIds?: string | Array<string> | undefined;
   qr?: boolean | undefined;
   root?: boolean | undefined;
   page: number;
@@ -354,6 +395,7 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
   page: z.number().default(1),

package/src/models/operations/retrieveanalytics.ts

@@ -74,6 +74,11 @@ export const Trigger = {
  */
 export type Trigger = ClosedEnum<typeof Trigger>;
 
+/**
+ * The tag IDs to retrieve analytics for.
+ */
+export type RetrieveAnalyticsQueryParamTagIds = string | Array<string>;
+
 export type RetrieveAnalyticsRequest = {
   /**
    * The type of event to retrieve analytics for. Defaults to `clicks`.
@@ -156,9 +161,13 @@ export type RetrieveAnalyticsRequest = {
    */
   url?: string | undefined;
   /**
-   * The tag ID to retrieve analytics for.
+   * Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
    */
   tagId?: string | undefined;
+  /**
+   * The tag IDs to retrieve analytics for.
+   */
+  tagIds?: string | Array<string> | undefined;
   /**
    * Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
    */
@@ -266,6 +275,37 @@ export namespace Trigger$ {
   export const outboundSchema = Trigger$outboundSchema;
 }
 
+/** @internal */
+export const RetrieveAnalyticsQueryParamTagIds$inboundSchema: z.ZodType<
+  RetrieveAnalyticsQueryParamTagIds,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type RetrieveAnalyticsQueryParamTagIds$Outbound = string | Array<string>;
+
+/** @internal */
+export const RetrieveAnalyticsQueryParamTagIds$outboundSchema: z.ZodType<
+  RetrieveAnalyticsQueryParamTagIds$Outbound,
+  z.ZodTypeDef,
+  RetrieveAnalyticsQueryParamTagIds
+> = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RetrieveAnalyticsQueryParamTagIds$ {
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$inboundSchema` instead. */
+  export const inboundSchema = RetrieveAnalyticsQueryParamTagIds$inboundSchema;
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$outboundSchema` instead. */
+  export const outboundSchema =
+    RetrieveAnalyticsQueryParamTagIds$outboundSchema;
+  /** @deprecated use `RetrieveAnalyticsQueryParamTagIds$Outbound` instead. */
+  export type Outbound = RetrieveAnalyticsQueryParamTagIds$Outbound;
+}
+
 /** @internal */
 export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   RetrieveAnalyticsRequest,
@@ -293,6 +333,7 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
 });
@@ -320,6 +361,7 @@ export type RetrieveAnalyticsRequest$Outbound = {
   refererUrl?: string | undefined;
   url?: string | undefined;
   tagId?: string | undefined;
+  tagIds?: string | Array<string> | undefined;
   qr?: boolean | undefined;
   root?: boolean | undefined;
 };
@@ -351,6 +393,7 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
   refererUrl: z.string().optional(),
   url: z.string().optional(),
   tagId: z.string().optional(),
+  tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   qr: z.boolean().optional(),
   root: z.boolean().optional(),
 });