Development

Dub.co TypeScript SDK

Learn more about the Dub.co TypeScript SDK in the official documentation.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add dub

PNPM

pnpm add dub

Bun

bun add dub

Yarn

yarn add dub zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example 1

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create();

  // Handle the result
  console.log(result);
}

run();

Example 2

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.upsert();

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

analytics

retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.

domains

create - Create a domain
list - Retrieve a list of domains
update - Update a domain
delete - Delete a domain

events

list - Retrieve a list of events

metatags

get - Retrieve the metatags for a URL

qrCodes

get - Retrieve a QR code

track

lead - Track a lead
sale - Track a sale
customer - Track a customer

workspaces

get - Retrieve a workspace
update - Update a workspace

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the create method may throw the following errors:

Error Type	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4XX, 5XX	/

import { Dub } from "dub";
import {
  BadRequest,
  Conflict,
  Forbidden,
  InternalServerError,
  InviteExpired,
  NotFound,
  RateLimitExceeded,
  SDKValidationError,
  Unauthorized,
  UnprocessableEntity,
} from "dub/models/errors";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  let result;
  try {
    result = await dub.links.create();

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof BadRequest): {
        // Handle err.data$: BadRequestData
        console.error(err);
        return;
      }
      case (err instanceof Unauthorized): {
        // Handle err.data$: UnauthorizedData
        console.error(err);
        return;
      }
      case (err instanceof Forbidden): {
        // Handle err.data$: ForbiddenData
        console.error(err);
        return;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        console.error(err);
        return;
      }
      case (err instanceof Conflict): {
        // Handle err.data$: ConflictData
        console.error(err);
        return;
      }
      case (err instanceof InviteExpired): {
        // Handle err.data$: InviteExpiredData
        console.error(err);
        return;
      }
      case (err instanceof UnprocessableEntity): {
        // Handle err.data$: UnprocessableEntityData
        console.error(err);
        return;
      }
      case (err instanceof RateLimitExceeded): {
        // Handle err.data$: RateLimitExceededData
        console.error(err);
        return;
      }
      case (err instanceof InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	`https://api.dub.co`	None

import { Dub } from "dub";

const dub = new Dub({
  serverIdx: 0,
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create();

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { Dub } from "dub";

const dub = new Dub({
  serverURL: "https://api.dub.co",
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create();

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Dub } from "dub";
import { HTTPClient } from "dub/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Dub({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`token`	http	HTTP Bearer

To authenticate with the API the token parameter must be set when initializing the SDK client instance. For example:

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create();

  // Handle the result
  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Dub } from "dub";

const dub = new Dub({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.create();

  // Handle the result
  console.log(result);
}

run();

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.links.list();

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

analyticsRetrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
domainsCreate - Create a domain
domainsDelete - Delete a domain
domainsList - Retrieve a list of domains
domainsUpdate - Update a domain
eventsList - Retrieve a list of events
linksCount - Retrieve links count
linksCreate - Create a new link
linksCreateMany - Bulk create links
linksDelete - Delete a link
linksDeleteMany - Bulk delete links
linksGet - Retrieve a link
linksList - Retrieve a list of links
linksUpdate - Update a link
linksUpdateMany - Bulk update links
linksUpsert - Upsert a link
metatagsGet - Retrieve the metatags for a URL
qrCodesGet - Retrieve a QR code
tagsCreate - Create a new tag
tagsDelete - Delete a tag
tagsList - Retrieve a list of tags
tagsUpdate - Update a tag
trackCustomer - Track a customer
trackLead - Track a lead
trackSale - Track a sale
workspacesGet - Retrieve a workspace
workspacesUpdate - Update a workspace

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Dub } from "dub";

const sdk = new Dub({ debugLogger: console });

Summary

Dub.co API: Dub is link management infrastructure for companies to create marketing campaigns, link sharing features, and referral programs.

Development

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

Name		Name	Last commit message	Last commit date
Latest commit History 138 Commits
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
src		src
.eslintrc.cjs		.eslintrc.cjs
.genignore		.genignore
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
LICENSE		LICENSE
README.md		README.md
RELEASES.md		RELEASES.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
codeSamples.yaml		codeSamples.yaml
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

dubinc/dub-ts

Folders and files

Latest commit

History

Repository files navigation

Dub.co TypeScript SDK

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example 1

Example 2

Available Resources and Operations

Error Handling

Server Selection

Select Server by Index

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Retries

Pagination

Standalone functions

Debugging

Summary

Development

Contributions

SDK Created by Speakeasy

About

Topics

Resources

License

Stars

Watchers

Forks

Languages