dub 0.10.0 → 0.20.2

package/src/hooks/types.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { HTTPClient } from "../lib/http";
+
+export type HookContext = {
+    operationID: string;
+    oAuth2Scopes?: string[];
+    securitySource?: any | (() => Promise<any>);
+};
+
+export type Awaitable<T> = T | Promise<T>;
+
+export type SDKInitOptions = {
+    baseURL: URL | null;
+    client: HTTPClient;
+};
+export type BeforeRequestContext = HookContext & {};
+export type AfterSuccessContext = HookContext & {};
+export type AfterErrorContext = HookContext & {};
+
+/**
+ * SDKInitHook is called when the SDK is initializing. The
+ * hook can return a new baseURL and HTTP client to be used by the SDK.
+ */
+export interface SDKInitHook {
+    sdkInit: (opts: SDKInitOptions) => SDKInitOptions;
+}
+
+/**
+ * BeforeRequestHook is called before the SDK sends a request. The hook can
+ * modify the request before it is sent or throw an error to stop the request
+ * from being sent.
+ */
+export interface BeforeRequestHook {
+    beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable<Request>;
+}
+
+/**
+ * AfterSuccessHook is called after the SDK receives a response. The hook can
+ * modify the response before it is handled or throw an error to stop the
+ * response from being handled.
+ */
+export interface AfterSuccessHook {
+    afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable<Response>;
+}
+
+/**
+ * AfterErrorHook is called after the SDK encounters an error, or a
+ * non-successful response. The hook can modify the response if available
+ * otherwise modify the error.
+ */
+export interface AfterErrorHook {
+    afterError: (
+        hookCtx: AfterErrorContext,
+        response: Response | null,
+        error: unknown
+    ) => Awaitable<{
+        response: Response | null;
+        error: unknown;
+    }>;
+}
+
+export interface Hooks {
+    /** Registers a hook to be used by the SDK for initialization event. */
+    registerSDKInitHook(hook: SDKInitHook): void;
+    /** Registers a hook to be used by the SDK for the before request event. */
+    registerBeforeRequestHook(hook: BeforeRequestHook): void;
+    /** Registers a hook to be used by the SDK for the after success event. */
+    registerAfterSuccessHook(hook: AfterSuccessHook): void;
+    /** Registers a hook to be used by the SDK for the after error event. */
+    registerAfterErrorHook(hook: AfterErrorHook): void;
+}

package/src/index.ts

@@ -1,212 +1,11 @@
-// File generated from our OpenAPI spec by Stainless.
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
 
-import * as Core from './core';
-import * as Errors from './error';
-import { type Agent } from './_shims/index';
-import * as Uploads from './uploads';
-import * as qs from 'qs';
-import * as API from "./resources/index";
+export * from "./sdk";
+export * from "./lib/config";
 
-export interface ClientOptions {
-  /**
-   * Defaults to process.env['DUB_API_KEY'].
-   */
-  token?: string | undefined;
+import { Dub } from './sdk'
 
-  projectSlug?: string | null | undefined;
-
-  /**
-   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
-   *
-   * Defaults to process.env['DUB_BASE_URL'].
-   */
-  baseURL?: string | null | undefined;
-
-  /**
-   * The maximum amount of time (in milliseconds) that the client should wait for a response
-   * from the server before timing out a single request.
-   *
-   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
-   * much longer than this timeout before the promise succeeds or fails.
-   */
-  timeout?: number;
-
-  /**
-   * An HTTP agent used to manage HTTP(S) connections.
-   *
-   * If not provided, an agent will be constructed by default in the Node.js environment,
-   * otherwise no agent is used.
-   */
-  httpAgent?: Agent;
-
-  /**
-   * Specify a custom `fetch` function implementation.
-   *
-   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
-   * defined globally.
-   */
-  fetch?: Core.Fetch | undefined;
-
-  /**
-   * The maximum number of times that the client will retry a request in case of a
-   * temporary failure, like a network error or a 5XX error from the server.
-   *
-   * @default 2
-   */
-  maxRetries?: number;
-
-  /**
-   * Default headers to include with every request to the API.
-   *
-   * These can be removed in individual requests by explicitly setting the
-   * header to `undefined` or `null` in request options.
-   */
-  defaultHeaders?: Core.Headers;
-
-  /**
-   * Default query parameters to include with every request to the API.
-   *
-   * These can be removed in individual requests by explicitly setting the
-   * param to `undefined` in request options.
-   */
-  defaultQuery?: Core.DefaultQuery;
-}
-
-/** API Client for interfacing with the Dub API. */
-export class Dub extends Core.APIClient {
-  token: string;
-  projectSlug: string | null;
-
-  private _options: ClientOptions;
-
-  /**
-   * API Client for interfacing with the Dub API.
-   *
-   * @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
-   * @param {string | null | undefined} [opts.projectSlug]
-   * @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
-   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
-   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
-   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
-   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
-   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
-   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-   */
-  constructor({
-    baseURL = Core.readEnv('DUB_BASE_URL'),
-    token = Core.readEnv('DUB_API_KEY'),
-    projectSlug = null,
-    ...opts
-  }: ClientOptions = {}) {
-    if (token === undefined) {
-      throw new Errors.DubError(
-        "The DUB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Dub client with an token option, like new Dub({ token: 'My Token' }).",
-      );
-    }
-
-    const options: ClientOptions = {
-      token,
-      projectSlug,
-      ...opts,
-      baseURL: baseURL || `https://api.dub.co`,
-    };
-
-    super({
-      baseURL: options.baseURL!,
-      timeout: options.timeout ?? 60000 /* 1 minute */,
-      httpAgent: options.httpAgent,
-      maxRetries: options.maxRetries,
-      fetch: options.fetch,
-    });
-    this._options = options;
-
-    this.token = token;
-    this.projectSlug = projectSlug;
-  }
-
-  links: API.Links = new API.Links(this);
-  qr: API.Qr = new API.Qr(this);
-  projects: API.Projects = new API.Projects(this);
-
-  protected override defaultQuery(): Core.DefaultQuery | undefined {
-    return this._options.defaultQuery;
-  }
-
-  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    return {
-      ...super.defaultHeaders(opts),
-      ...this._options.defaultHeaders,
-    };
-  }
-
-  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
-    return { Authorization: `Bearer ${this.token}` };
-  }
-
-  protected override stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'comma' });
-  }
-
-  static Dub = this;
-
-  static DubError = Errors.DubError;
-  static APIError = Errors.APIError;
-  static APIConnectionError = Errors.APIConnectionError;
-  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
-  static APIUserAbortError = Errors.APIUserAbortError;
-  static NotFoundError = Errors.NotFoundError;
-  static ConflictError = Errors.ConflictError;
-  static RateLimitError = Errors.RateLimitError;
-  static BadRequestError = Errors.BadRequestError;
-  static AuthenticationError = Errors.AuthenticationError;
-  static InternalServerError = Errors.InternalServerError;
-  static PermissionDeniedError = Errors.PermissionDeniedError;
-  static UnprocessableEntityError = Errors.UnprocessableEntityError;
-}
-
-export const {
-  DubError,
-  APIError,
-  APIConnectionError,
-  APIConnectionTimeoutError,
-  APIUserAbortError,
-  NotFoundError,
-  ConflictError,
-  RateLimitError,
-  BadRequestError,
-  AuthenticationError,
-  InternalServerError,
-  PermissionDeniedError,
-  UnprocessableEntityError,
-} = Errors;
-
-export import toFile = Uploads.toFile;
-export import fileFromPath = Uploads.fileFromPath;
-
-export namespace Dub {
-  // Helper functions
-  export import toFile = Uploads.toFile;
-  export import fileFromPath = Uploads.fileFromPath;
-
-  export import RequestOptions = Core.RequestOptions;
-
-  export import Links = API.Links;
-  export import LinkCreateResponse = API.LinkCreateResponse;
-  export import LinkUpdateResponse = API.LinkUpdateResponse;
-  export import LinkListResponse = API.LinkListResponse;
-  export import LinkDeleteLinkResponse = API.LinkDeleteLinkResponse;
-  export import LinkCreateParams = API.LinkCreateParams;
-  export import LinkUpdateParams = API.LinkUpdateParams;
-  export import LinkListParams = API.LinkListParams;
-  export import LinkDeleteLinkParams = API.LinkDeleteLinkParams;
-
-  export import Qr = API.Qr;
-  export import QrRetrieveParams = API.QrRetrieveParams;
-
-  export import Projects = API.Projects;
-  export import ProjectRetrieveResponse = API.ProjectRetrieveResponse;
-  export import ProjectListResponse = API.ProjectListResponse;
-  export import ProjectRetrieveParams = API.ProjectRetrieveParams;
-}
-
-export default Dub;
+/** @deprecated Use named export instead: `import { Dub } from "dub";` */
+export default Dub; // eslint-disable-line import/no-default-export

package/src/lib/base64.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function bytesToBase64(u8arr: Uint8Array): string {
+  return btoa(String.fromCodePoint(...u8arr));
+}
+
+export function bytesFromBase64(encoded: string): Uint8Array {
+  return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+}
+
+export function stringToBytes(str: string): Uint8Array {
+  return new TextEncoder().encode(str);
+}
+
+export function stringFromBytes(u8arr: Uint8Array): string {
+  return new TextDecoder().decode(u8arr);
+}
+
+export function stringToBase64(str: string): string {
+  return bytesToBase64(stringToBytes(str));
+}
+
+export function stringFromBase64(b64str: string): string {
+  return stringFromBytes(bytesFromBase64(b64str));
+}
+
+export const zodOutbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(stringToBytes));
+
+export const zodInbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(bytesFromBase64));

package/src/lib/config.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { HTTPClient } from "./http";
+import { RetryConfig } from "./retries";
+import { pathToFunc } from "./url";
+
+/**
+ * Contains the list of servers available to the SDK
+ */
+export const ServerList = [
+    /**
+     * Production API
+     */
+    "https://api.dub.co",
+] as const;
+
+export type SDKOptions = {
+    token?: string | (() => Promise<string>);
+
+    /**
+     * Allows setting the workspaceId parameter for all supported operations
+     */
+    workspaceId?: string;
+
+    /**
+     * Allows setting the projectSlug parameter for all supported operations
+     */
+    projectSlug?: string | undefined;
+
+    httpClient?: HTTPClient;
+    /**
+     * Allows overriding the default server used by the SDK
+     */
+    serverIdx?: number;
+    /**
+     * Allows overriding the default server URL used by the SDK
+     */
+    serverURL?: string;
+    /**
+     * Allows overriding the default retry config used by the SDK
+     */
+    retryConfig?: RetryConfig;
+};
+
+export function serverURLFromOptions(options: SDKOptions): URL | null {
+    let serverURL = options.serverURL;
+
+    const params: Record<string, string> = {};
+
+    if (!serverURL) {
+        const serverIdx = options.serverIdx ?? 0;
+        if (serverIdx < 0 || serverIdx >= ServerList.length) {
+            throw new Error(`Invalid server index ${serverIdx}`);
+        }
+        serverURL = ServerList[serverIdx] || "";
+    }
+
+    const u = pathToFunc(serverURL)(params);
+    return new URL(u);
+}
+
+export const SDK_METADATA = Object.freeze({
+    language: "typescript",
+    openapiDocVersion: "0.0.1",
+    sdkVersion: "0.20.2",
+    genVersion: "2.302.0",
+    userAgent: "speakeasy-sdk/typescript 0.20.2 2.302.0 0.0.1 dub",
+});