@sfcompute/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @sfcompute/sdk API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

SDK Installation

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

NPM

npm add @sfcompute/sdk

PNPM

pnpm add @sfcompute/sdk

Bun

bun add @sfcompute/sdk

Yarn

yarn add @sfcompute/sdk

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

import { Sfc } from "@sfcompute/sdk";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await sfc.capacities.list({
    startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
  });

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

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`bearerAuth`	http	HTTP Bearer	`SFC_BEARER_AUTH`

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

import { Sfc } from "@sfcompute/sdk";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await sfc.capacities.list({
    startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
  });

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

run();

Available Resources and Operations

Available methods

Capacities

list - List capacities
create - Create capacity
fetch - Get capacity
delete - Delete capacity
update - Update capacity

Images

list - List images
startUpload - Create image
fetch - Get image
delete - Delete image
completeUpload - Complete image upload
download - Download image
uploadPart - Create image upload part URL

NodeTemplates

list - List node templates
create - Create node template
fetch - Get node template
delete - Delete node template

Nodes

list - List nodes
fetch - Get node
getLogsForNode - Get node logs
replace - Replace node
getSSHInfoForNode - Get node SSH info

Orders

list - List orders
create - Create order
fetch - Get order
cancel - Cancel order

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

capacitiesCreate - Create capacity
capacitiesDelete - Delete capacity
capacitiesFetch - Get capacity
capacitiesList - List capacities
capacitiesUpdate - Update capacity
imagesCompleteUpload - Complete image upload
imagesDelete - Delete image
imagesDownload - Download image
imagesFetch - Get image
imagesList - List images
imagesStartUpload - Create image
imagesUploadPart - Create image upload part URL
nodesFetch - Get node
nodesGetLogsForNode - Get node logs
nodesGetSSHInfoForNode - Get node SSH info
nodesList - List nodes
nodesReplace - Replace node
nodeTemplatesCreate - Create node template
nodeTemplatesDelete - Delete node template
nodeTemplatesFetch - Get node template
nodeTemplatesList - List node templates
ordersCancel - Cancel order
ordersCreate - Create order
ordersFetch - Get order
ordersList - List orders

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 { Sfc } from "@sfcompute/sdk";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await sfc.capacities.list({
    startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
  });

  for await (const page of result) {
    console.log(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:

import { Sfc } from "@sfcompute/sdk";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await sfc.capacities.list({
    startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(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:

import { Sfc } from "@sfcompute/sdk";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await sfc.capacities.list({
    startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
  });

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

run();

Error Handling

SfcError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`error.message`	`string`	Error message
`error.statusCode`	`number`	HTTP response status code eg `404`
`error.headers`	`Headers`	HTTP response headers
`error.body`	`string`	HTTP body. Can be empty string if no body is returned.
`error.rawResponse`	`Response`	Raw HTTP response
`error.data$`		Optional. Some errors may contain structured data. See Error Classes.

Example

import { Sfc } from "@sfcompute/sdk";
import * as errors from "@sfcompute/sdk/models/errors";

const sfc = new Sfc({
  serverURL: "https://api.example.com",
  bearerAuth: process.env["SFC_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await sfc.capacities.list({
      startingAfter: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
      endingBefore: "capc_gqXR7s0Kj5mHvE2wNpLc4Q",
    });

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SfcError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.UnauthorizedError) {
        console.log(error.data$.error); // models.UnauthorizedErrorError
      }
    }
  }
}

run();

Error Classes

Primary errors:

SfcError: The base class for HTTP error responses.
- UnauthorizedError: Status code 401.
- InternalServerError: Status code 500.

Less common errors (12)

Network errors:

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

Inherit from SfcError:

NotFoundError: Status code 404. Applicable to 18 of 25 methods.*
UnprocessableEntityError: Status code 422. Applicable to 12 of 25 methods.*
ForbiddenError: Status code 403. Applicable to 10 of 25 methods.*
BadRequestError: Status code 400. Applicable to 4 of 25 methods.*
ConflictError: Status code 409. Applicable to 3 of 25 methods.*
PaymentRequiredError: Insufficient balance. Status code 402. Applicable to 1 of 25 methods.*
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

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:

route requests through a proxy server using undici's ProxyAgent
use the "beforeRequest" hook to add a custom header and a timeout to requests
use the "requestError" hook to log errors

import { Sfc } from "@sfcompute/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@sfcompute/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 Sfc({ httpClient: httpClient });

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 { Sfc } from "@sfcompute/sdk";

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

You can also enable a default debug logger by setting an environment variable SFC_DEBUG to true.

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.

Name		Name	Last commit message	Last commit date
Latest commit History 12 Commits
.agents/skills/speakeasy-context		.agents/skills/speakeasy-context
.devcontainer		.devcontainer
.github		.github
.speakeasy		.speakeasy
blueprint @ b634da3		blueprint @ b634da3
docs		docs
examples		examples
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
README.md		README.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

sfcompute/sfc-sdk-typescript

Folders and files

Latest commit

History

Repository files navigation

@sfcompute/sdk

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Standalone functions

Pagination

Retries

Error Handling

Example

Error Classes

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Uh oh!

Uh oh!

Languages