Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dubinc/dub-ts
Official Dub Typescript SDK
https://github.com/dubinc/dub-ts
api dub node npm sdk speakeasy speakeasyapi typescript
Last synced: about 2 months ago
JSON representation
Official Dub Typescript SDK
- Host: GitHub
- URL: https://github.com/dubinc/dub-ts
- Owner: dubinc
- License: mit
- Created: 2024-01-09T17:53:29.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-08T22:32:48.000Z (3 months ago)
- Last Synced: 2024-07-09T03:21:26.908Z (3 months ago)
- Topics: api, dub, node, npm, sdk, speakeasy, speakeasyapi, typescript
- Language: TypeScript
- Homepage: https://d.to/sdk
- Size: 1.12 MB
- Stars: 38
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dub.co TypeScript SDK
Learn more about the Dub.co TypeScript SDK in the [official documentation](https://dub.co/docs/sdks/typescript/overview).
## SDK Installation
### NPM
```bash
npm add dub
```
### PNPM
```bash
pnpm add dub
```
### Bun
```bash
bun add dub
```
### Yarn
```bash
yarn add dub zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
```
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Example Usage
### Example 1
```typescript
import { Dub } from "dub";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.links.create({
url: "https://google.com",
});
// Handle the result
console.log(result);
}
run();
```
### Example 2
```typescript
import { Dub } from "dub";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.links.upsert({
url: "https://google.com",
});
// Handle the result
console.log(result);
}
run();
```
## Available Resources and Operations
### [links](docs/sdks/links/README.md)
* [list](docs/sdks/links/README.md#list) - Retrieve a list of links
* [create](docs/sdks/links/README.md#create) - Create a new link
* [count](docs/sdks/links/README.md#count) - Retrieve links count
* [get](docs/sdks/links/README.md#get) - Retrieve a link
* [delete](docs/sdks/links/README.md#delete) - Delete a link
* [update](docs/sdks/links/README.md#update) - Update a link
* [createMany](docs/sdks/links/README.md#createmany) - Bulk create links
* [updateMany](docs/sdks/links/README.md#updatemany) - Bulk update links
* [upsert](docs/sdks/links/README.md#upsert) - Upsert a link
### [qrCodes](docs/sdks/qrcodes/README.md)
* [get](docs/sdks/qrcodes/README.md#get) - Retrieve a QR code
### [analytics](docs/sdks/analytics/README.md)
* [retrieve](docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
### [workspaces](docs/sdks/workspaces/README.md)
* [get](docs/sdks/workspaces/README.md#get) - Retrieve a workspace
* [update](docs/sdks/workspaces/README.md#update) - Update a workspace
### [tags](docs/sdks/tags/README.md)
* [list](docs/sdks/tags/README.md#list) - Retrieve a list of tags
* [create](docs/sdks/tags/README.md#create) - Create a new tag
* [update](docs/sdks/tags/README.md#update) - Update a tag
### [domains](docs/sdks/domains/README.md)
* [list](docs/sdks/domains/README.md#list) - Retrieve a list of domains
* [create](docs/sdks/domains/README.md#create) - Create a domain
* [delete](docs/sdks/domains/README.md#delete) - Delete a domain
* [update](docs/sdks/domains/README.md#update) - Update a domain
### [track](docs/sdks/track/README.md)
* [lead](docs/sdks/track/README.md#lead) - Track a lead
* [sale](docs/sdks/track/README.md#sale) - Track a sale
* [customer](docs/sdks/track/README.md#customer) - Track a customer
### [metatags](docs/sdks/metatags/README.md)
* [get](docs/sdks/metatags/README.md#get) - Retrieve the metatags for a URL
## Error Handling
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | 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 | */* |
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.
```typescript
import { Dub } from "dub";
import { SDKValidationError } from "dub/models/errors";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
let result;
try {
result = await dub.links.list({});
} 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 errors.BadRequest: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Unauthorized: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Forbidden: {
console.error(err); // handle exception
return;
}
case err instanceof errors.NotFound: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Conflict: {
console.error(err); // handle exception
return;
}
case err instanceof errors.InviteExpired: {
console.error(err); // handle exception
return;
}
case err instanceof errors.UnprocessableEntity: {
console.error(err); // handle exception
return;
}
case err instanceof errors.RateLimitExceeded: {
console.error(err); // handle exception
return;
}
case err instanceof errors.InternalServerError: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
for await (const page of result) {
// handle page
}
}
run();
```
## 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 |
```typescript
import { Dub } from "dub";
const dub = new Dub({
serverIdx: 0,
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.links.list({});
for await (const page of result) {
// handle page
}
}
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:
```typescript
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.list({});
for await (const page of result) {
// handle page
}
}
run();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:
```typescript
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:
```typescript
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 page
}
}
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:
```typescript
import { Dub } from "dub";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.links.list(
{},
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
}
);
for await (const page of result) {
// handle page
}
}
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:
```typescript
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.list({});
for await (const page of result) {
// handle page
}
}
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`][for-await-of]
syntax.
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
Here's an example of one such pagination call:
```typescript
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 page
}
}
run();
```
# 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!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)