@trytestify/sdk

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

<div align="left"> <a href="https://www.speakeasy.com/?utm_source=@trytestify/sdk&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" /> </a> </div> <!-- Start Summary [summary] -->

Summary

Testify API: API for managing Testify spaces and testimonials.

<!-- End Summary [summary] --> <!-- Start Table of Contents [toc] -->

Table of Contents

<!-- $toc-max-depth=2 -->

• @trytestify/sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

<!-- End Table of Contents [toc] --> <!-- Start SDK Installation [installation] -->

SDK Installation

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

NPM

npm add @trytestify/sdk

PNPM

pnpm add @trytestify/sdk

Bun

bun add @trytestify/sdk

Yarn

yarn add @trytestify/sdk 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.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

<details> <summary>Claude installation steps</summary>

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Testify": {
      "command": "npx",
      "args": [
        "-y", "--package", "@trytestify/sdk",
        "--",
        "mcp", "start"
      ]
    }
  }
}

</details> <details> <summary>Cursor installation steps</summary>

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Testify": {
      "command": "npx",
      "args": [
        "-y", "--package", "@trytestify/sdk",
        "--",
        "mcp", "start"
      ]
    }
  }
}

</details>

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @trytestify/sdk -- mcp start --help

<!-- End SDK Installation [installation] --> <!-- Start Requirements [requirements] -->

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

<!-- End Requirements [requirements] --> <!-- Start SDK Example Usage [usage] -->

SDK Example Usage

Example

import { Testify } from "@trytestify/sdk";

const testify = new Testify();

async function run() {
  const result = await testify.testimonials.get({
    spaceId: "<id>",
  });

  console.log(result);
}

run();

<!-- End SDK Example Usage [usage] --> <!-- Start Available Resources and Operations [operations] -->

Available Resources and Operations

<details open> <summary>Available methods</summary>

testimonials

• get
• create

</details> <!-- End Available Resources and Operations [operations] --> <!-- Start Standalone functions [standalone-funcs] -->

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.

<details> <summary>Available standalone functions</summary>

• testimonialsCreate
• testimonialsGet

</details> <!-- End Standalone functions [standalone-funcs] --> <!-- Start Retries [retries] -->

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

const testify = new Testify();

async function run() {
  const result = await testify.testimonials.get({
    spaceId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

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

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

async function run() {
  const result = await testify.testimonials.get({
    spaceId: "<id>",
  });

  console.log(result);
}

run();

<!-- End Retries [retries] --> <!-- Start Error Handling [errors] -->

Error Handling

TestifyError 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 { Testify } from "@trytestify/sdk";
import * as errors from "@trytestify/sdk/models/errors";

const testify = new Testify();

async function run() {
  try {
    const result = await testify.testimonials.get({
      spaceId: "<id>",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.TestifyError) {
      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.StandardError) {
        console.log(error.data$.message); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• TestifyError: The base class for HTTP error responses.
  • StandardError: Generic error.

<details><summary>Less common errors (7)</summary> <br />

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 TestifyError:

• RateLimitError: Too Many Requests. Status code 429. Applicable to 1 of 2 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.

</details>

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

<!-- End Error Handling [errors] --> <!-- Start Server Selection [server] -->

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number 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 | Description | | --- | ------------------------ | ---------------------- | | 0 | https://usetestify.xyz | Production environment | | 1 | http://localhost:3000 | Local environment |

Example

import { Testify } from "@trytestify/sdk";

const testify = new Testify({
  serverIdx: 1,
});

async function run() {
  const result = await testify.testimonials.get({
    spaceId: "<id>",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

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

import { Testify } from "@trytestify/sdk";

const testify = new Testify({
  serverURL: "http://localhost:3000",
});

async function run() {
  const result = await testify.testimonials.get({
    spaceId: "<id>",
  });

  console.log(result);
}

run();

<!-- End Server Selection [server] --> <!-- Start Custom HTTP Client [http-client] -->

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 { Testify } from "@trytestify/sdk";
import { HTTPClient } from "@trytestify/sdk/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 Testify({ httpClient });

<!-- End Custom HTTP Client [http-client] --> <!-- Start Debugging [debug] -->

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

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

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

<!-- End Debugging [debug] --> <!-- Placeholder for Future Speakeasy SDK Sections -->

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.

SDK Created by Speakeasy