npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@steamsets/client-ts

v0.34.8

Published

<div align="left"> <a href="https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=go"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454"

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

flo4604flo4604zwolofzwolof

Keywords

Readme

openapi

SDK Installation

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

NPM

npm add @steamsets/client-ts

PNPM

pnpm add @steamsets/client-ts

Bun

bun add @steamsets/client-ts

Yarn

yarn add @steamsets/client-ts zod

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

SDK Example Usage

Example

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  });

  console.log(result);
}

run();

Available Resources and Operations

Account

Activity

Admin

  • cmsArchive - Archive a CMS document so it stops appearing in public reads (versions retained)
  • cmsCreate - Create a new CMS document with an initial draft version
  • cmsDelete - Permanently delete a CMS document and all its versions
  • cmsList - List CMS documents (drafts + published) for editor
  • cmsListAssets - List recently uploaded CMS images
  • cmsPreviewToken - Issue a short-lived preview token for a specific document version
  • cmsPublish - Publish a CMS document version (also used for rollback by passing an older version_id)
  • cmsReorder - Batch-update parent_id / sort_order for CMS documents (used after drag-drop)
  • cmsUpdateDraft - Append a new draft version to an existing CMS document
  • cmsUploadImage - Upload a CMS image (partner logos, page hero, etc.) to S3/MinIO
  • cmsVersions - List the version history of a CMS document (newest first)
  • getAccount - Get account for admin
  • removeVanity - Remove vanity URL
  • updateResources - Update account resources
  • adminUpdateRoleOverride - Set or remove a tier role override for an account
  • updateRoles - Update account roles

Admin.Donations

  • createCurrency - Add a currency to the donation whitelist
  • deleteCurrency - Soft-delete a donation currency (sets active=0)
  • listCurrencies - List every donation currency (active + soft-deleted) for admin management
  • updateCurrency - Update a donation currency (treasury, decimals, etc.); chain+contract are immutable

Admin.Maintenance

  • create - Create a maintenance event
  • delete - Hard-delete a maintenance event
  • list - Admin: list every maintenance event including disabled and scheduled
  • update - Update a maintenance event (any subset of fields)

Analytics

  • getBivariate - Bucket by X, aggregate Y, within a scope
  • getDistribution - Histogram + summary stats for a metric in a scope
  • getInequality - Lorenz curve + Gini + top-X%-own-Y% headlines for one metric in a scope
  • getMetricByScope - One metric aggregated per country (or region) — worldmap source
  • getMyPercentiles - Per-metric percentile rank for the logged-in user in the chosen scope
  • getTrend - Daily quantiles over a window for a metric in a scope
  • listMetrics - List every analytics domain, metric, and scope the data-library can serve
  • trackEvent - Track a frontend-only analytics event (profile view, search). Frontend API key + logged-in users only.

Apps

Badge

  • streamPricing - Server-sent-events stream of badge pricing ticks. Forwards every tick — filter client-side.
  • search - Search badges
  • suggestTags - Suggest badge tag

Badges

Cms

  • list - List published CMS documents of a given type

Donations

  • claim - Claim a crypto donation by tx hash + signed message
  • getAddresses - Get the treasury addresses to send crypto donations to
  • listSupportedCurrencies - List cryptocurrencies accepted for donations (DB-backed; admin-managed)

Item

  • findOwners - Find owners of one or more trading cards or booster packs. Friend paths from the requester are included for logged-in callers.

Leaderboard

Leaderboards

  • list - List leaderboard badges

Location

  • get - List available locations

Maintenance

  • list - List currently active maintenance events

Search

Site

  • subscribe - Server-sent-events stream of site-wide broadcasts (maintenance, announcements, etc).

Staff

  • list - List staff members

Stats

  • get - Get platform statistics
  • subscribe - Server-sent-events stream of platform stats. Emits a snapshot, then deltas as the queues commit them.

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as an async iterable that can be consumed using a for await...of loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.subscribe({
    accountId: 442779,
  });

  if (result.serverSentEvents == null) {
    throw new Error("failed to create stream: received null value");
  }
  for await (const event of result.serverSentEvents) {
    console.log(event);
  }
}

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 { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.admin.cmsListAssets({});

  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 { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  }, {
    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 { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  });

  console.log(result);
}

run();

Error Handling

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

| Property | Type | Description | | ------------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.httpMeta.response | Response | HTTP response. Access to headers and more. | | error.httpMeta.request | Request | HTTP request. Access to headers and more. | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { SteamSets } from "@steamsets/client-ts";
import * as errors from "@steamsets/client-ts/models/errors";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  try {
    const result = await steamSets.account.bookmarkBadge({
      badgeId: "bdg_123",
      bookmark: true,
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SteamSetsError) {
      console.log(error.message);
      console.log(error.httpMeta.response.status);
      console.log(error.httpMeta.response.headers);
      console.log(error.httpMeta.request);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorModel) {
        console.log(error.data$.dollarSchema); // string
        console.log(error.data$.detail); // string
        console.log(error.data$.errors); // ErrorDetail[]
        console.log(error.data$.instance); // string
        console.log(error.data$.status); // number
      }
    }
  }
}

run();

Error Classes

Primary errors:

Network errors:

Inherit from SteamSetsError:

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

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://api.steamsets.com | | | 1 | http://localhost:7388 | |

Example

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  serverIdx: 0,
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  });

  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 { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  serverURL: "http://localhost:7388",
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  });

  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:

  • 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 { SteamSets } from "@steamsets/client-ts";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@steamsets/client-ts/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 SteamSets({ httpClient: 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 { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.account.bookmarkBadge({
    badgeId: "bdg_123",
    bookmark: true,
  });

  console.log(result);
}

run();

Special Types

SDK Installation

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

NPM

npm add @steamsets/client-ts

PNPM

pnpm add @steamsets/client-ts

Bun

bun add @steamsets/client-ts

Yarn

yarn add @steamsets/client-ts

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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.

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 { SteamSets } from "@steamsets/client-ts";

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

Summary

Table of Contents

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](https://www.speakeasy.com/?utm_source=&utm_campaign=go)