@simplesagar/vercel

v0.8.0

Published

2 months ago

<div align="center"> <img src="https://github.com/speakeasy-sdks/vercel-ts/assets/68016351/d64a32d7-acc1-497b-943f-caa3c994901e" width="500"> <p>Vercel is the Frontend Cloud</p> <a href="https://vercel.com/docs/rest-api"><img src="https://im

Downloads

0High
0Medium
0Low

simplesagar

[!NOTE] This SDK is an example and not yet ready for production usage.

Summary

Vercel API: Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

SDK Installation

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

NPM

npm add @simplesagar/vercel

PNPM

pnpm add @simplesagar/vercel

Bun

bun add @simplesagar/vercel

Yarn

yarn add @simplesagar/vercel zod

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

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@simplesagar/vercel") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel();

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>");

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

run();

Available Resources and Operations

accessGroups

read - Reads an access group
update - Update an access group
delete - Deletes an access group
listMembers - List members of an access group
list - List access groups for a team, project or member
create - Creates an access group
listProjects - List projects of an access group

aliases

list - List aliases
get - Get an Alias
delete - Delete an Alias
assign - Assign an Alias

artifacts

recordEvents - Record an artifacts cache usage event
status - Get status of Remote Caching for this principal
upload - Upload a cache artifact
download - Download a cache artifact
exists - Check if a cache artifact exists
query - Query information about an artifact

authentication

login - Login with email
verify - Verify a login request to get an authentication token

certs

getById - Get cert by id
remove - Remove cert
issue - Issue a new cert
upload - Upload a cert

checks

create - Creates a new Check
list - Retrieve a list of all checks
get - Get a single check
update - Update a check
rerequest - Rerequest a check

deployments

getEvents - Get deployment events
get - Get a deployment by ID or URL
create - Create a new deployment
cancel - Cancel a deployment
uploadFile - Upload Deployment Files
listAliases - List Deployment Aliases
listFiles - List Deployment Files
getFileContents - Get Deployment File Contents
list - List deployments
delete - Delete a Deployment

dns

listRecords - List existing DNS records
createRecord - Create a DNS record
updateRecord - Update an existing DNS record
removeRecord - Delete a DNS record

domains

buy - Purchase a domain
checkPrice - Check the price for a domain
checkStatus - Check a Domain Availability
getTransfer - Get domain transfer info.
getConfig - Get a Domain's configuration
get - Get Information for a Single Domain
list - List all the domains
createOrTransfer - Register or transfer-in a new Domain
update - Update or move apex domain
delete - Remove a domain by name
listByProject - Retrieve project domains by project by id or name
create - Add a domain to a project
verify - Verify project domain

edgeConfigs

list - Get Edge Configs
create - Create an Edge Config
get - Get an Edge Config
update - Update an Edge Config
delete - Delete an Edge Config
getItems - Get Edge Config items
getSchema - Get Edge Config schema
updateSchema - Update Edge Config schema
deleteSchema - Delete an Edge Config's schema
getItem - Get an Edge Config item
getTokens - Get all tokens of an Edge Config
deleteTokens - Delete one or more Edge Config tokens
getToken - Get Edge Config token meta data
createToken - Create an Edge Config token

envs

listByProject - Retrieve the environment variables of a project by id or name
get - Retrieve the decrypted value of an environment variable of a project by id
create - Create one or more environment variables
delete - Remove an environment variable
update - Edit an environment variable

events

list - List User Events

integrations

getConfigurations - Get configurations for the authenticated user or team
getConfiguration - Retrieve an integration configuration
deleteConfiguration - Delete an integration configuration
getGitNamespaces - List git namespaces by provider
searchRepos - List git repositories linked to namespace by provider

logDrains

list - Retrieves a list of Integration log drains
create - Creates a new Integration Log Drain
deleteIntegration - Deletes the Integration log drain with the provided id
getConfigurable - Retrieves a Configurable Log Drain
deleteConfigurable - Deletes a Configurable Log Drain
getAll - Retrieves a list of all the Log Drains
createConfigurable - Creates a Configurable Log Drain

projectDomains

get - Get a project domain
update - Update a project domain
delete - Remove a domain from a project

projectMembers

get - List project members
add - Adds a new member to a project.
remove - Remove a Project Member

projects

updateDataCache - Update the data cache feature
getAll - Retrieve a list of projects
create - Create a new project
update - Update an existing project
delete - Delete a Project
pause - Pause a project
unpause - Unpause a project

promotions

create - Points all production domains for a project to the given deploy
listAliases - Gets a list of aliases with status for the current promote

protectionBypass

update - Update Protection Bypass for Automation

secrets

list - List secrets
create - Create a new secret
rename - Change secret name
get - Get a single secret
delete - Delete a secret

teams

getMembers - List team members
inviteUser - Invite a user
requestAccess - Request access to a team
getAccessRequest - Get access request status
join - Join a team
updateMember - Update a Team Member
removeMember - Remove a Team Member
get - Get a Team
update - Update a Team
list - List all teams
create - Create a Team
delete - Delete a Team
deleteInviteCode - Delete a Team invite code

tokens

list - List Auth Tokens
create - Create an Auth Token
get - Get Auth Token Metadata
delete - Delete an authentication token

user

getAuthUser - Get the User
requestDelete - Delete User Account

Vercel SDK

listDeploymentBuilds - Retrieves the list of builds given their deployment's unique identifier. No longer listed as public API as of May 2023.
datacachePurgeall
dataCacheBillingSettings

webhooks

create - Creates a webhook
list - Get a list of webhooks
get - Get a webhook
delete - Deletes a webhook

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.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.artifacts.upload({
    contentLength: 4036.54,
    hash: "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
  });

  // 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 { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel();

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>", {
    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 { Vercel } from "@simplesagar/vercel";

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

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>");

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

run();

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 | | --------------- | --------------- | --------------- | | models.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.

import { Vercel } from "@simplesagar/vercel";
import { SDKValidationError } from "@simplesagar/vercel/models/sdkvalidationerror.js";

const vercel = new Vercel();

async function run() {
  let result;
  try {
    result = await vercel.listDeploymentBuilds("<value>");

    // 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;
      }
      default: {
        throw err;
      }
    }
  }
}

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.vercel.com | None |

import { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel({
  serverIdx: 0,
});

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>");

  // 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 { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel({
  serverURL: "https://api.vercel.com",
});

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>");

  // 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 { Vercel } from "@simplesagar/vercel";
import { HTTPClient } from "@simplesagar/vercel/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 Vercel({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------- | ------------- | ------------- | | bearerToken | http | HTTP Bearer |

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

import { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.listDeploymentBuilds("<value>");

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

run();

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 { Vercel } from "@simplesagar/vercel";

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

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 { Vercel } from "@simplesagar/vercel";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.projects.getAll({});

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

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.