waveshield

Developer-friendly & type-safe Typescript SDK specifically catered to leverage waveshield 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

WaveShield API: Official API documentation for the WaveShield Anti-Cheat System and its network tools.

Authentication

All API endpoints require authentication using API Keys. headers:

• x-api-key: Your public Access Key
• x-api-secret: Your private Secret Key

Rate Limiting & Cost

• Limits are applied per minute based on your API Key tier.
• Each endpoint has a cost associated with it. Your API Key tier determines your monthly quota.
• Response headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Cost included.

Table of Contents

• waveshield
  • Authentication
  • Rate Limiting & Cost
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

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

NPM

npm add waveshield

PNPM

pnpm add waveshield

Bun

bun add waveshield

Yarn

yarn add waveshield

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 { WaveShield } from "waveshield";

const waveShield = new WaveShield({
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  const result = await waveShield.auth.verify();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name	Type	Scheme	Environment Variable
apiKeyAuth	apiKey	API key	WAVESHIELD_API_KEY_AUTH
apiSecretAuth	apiKey	API key	WAVESHIELD_API_SECRET_AUTH

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { WaveShield } from "waveshield";

const waveShield = new WaveShield({
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  const result = await waveShield.auth.verify();

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Auth

• verify - Verify API Credentials

Bans

• getRecent - Recent Bans
• search - Search Bans
• getStats - Ban Stats
• getTrends - Ban Trends

Keys

• getUsage - Get Usage Stats

Player

• search - Search Players
• get - Player Profile
• getServers - Server History
• getBans - Player Active Bans
• getBansHistory - Player Ban History
• getThreatScore - Threat Score
• analyze - Player Analysis
• discordLookup - Discord Lookup

Server

• getInfo - Server Info
• getStats - Server Statistics
• getBans - Server Active Bans
• getBanHistory - Server Ban History
• getConfig - Server Config
• getPlayers - Online Players List
• getAdmins - Server Admins
• getLogs - Server Logs
• lookupPlayer - Lookup Player
• requestScreenshot - Request Screenshot
• kick - Kick Player
• getBan - Get Ban Info
• ban - Ban Player
• banOffline - Ban Player Offline
• unban - Unban Player
• unbanLast - Unban Last Players
• unbanAll - Unban All Players
• executeCommand - Execute Console Command
• addAdmin - Add Admin
• removeAdmin - Remove Admin

Stats

• get - Global System Stats

Webhooks

• list - List Active Webhooks
• create - Create Webhook
• delete - Delete 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.

Available standalone functions

• authVerify - Verify API Credentials
• bansGetRecent - Recent Bans
• bansGetStats - Ban Stats
• bansGetTrends - Ban Trends
• bansSearch - Search Bans
• keysGetUsage - Get Usage Stats
• playerAnalyze - Player Analysis
• playerDiscordLookup - Discord Lookup
• playerGet - Player Profile
• playerGetBans - Player Active Bans
• playerGetBansHistory - Player Ban History
• playerGetServers - Server History
• playerGetThreatScore - Threat Score
• playerSearch - Search Players
• serverAddAdmin - Add Admin
• serverBan - Ban Player
• serverBanOffline - Ban Player Offline
• serverExecuteCommand - Execute Console Command
• serverGetAdmins - Server Admins
• serverGetBan - Get Ban Info
• serverGetBanHistory - Server Ban History
• serverGetBans - Server Active Bans
• serverGetConfig - Server Config
• serverGetInfo - Server Info
• serverGetLogs - Server Logs
• serverGetPlayers - Online Players List
• serverGetStats - Server Statistics
• serverKick - Kick Player
• serverLookupPlayer - Lookup Player
• serverRemoveAdmin - Remove Admin
• serverRequestScreenshot - Request Screenshot
• serverUnban - Unban Player
• serverUnbanAll - Unban All Players
• serverUnbanLast - Unban Last Players
• statsGet - Global System Stats
• webhooksCreate - Create Webhook
• webhooksDelete - Delete Webhook
• webhooksList - List Active Webhooks

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 { WaveShield } from "waveshield";

const waveShield = new WaveShield({
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  const result = await waveShield.auth.verify({
    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 { WaveShield } from "waveshield";

const waveShield = new WaveShield({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  const result = await waveShield.auth.verify();

  console.log(result);
}

run();

Error Handling

WaveShieldError 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

Example

import { WaveShield } from "waveshield";
import * as errors from "waveshield/models/errors";

const waveShield = new WaveShield({
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  try {
    const result = await waveShield.auth.verify();

    console.log(result);
  } catch (error) {
    if (error instanceof errors.WaveShieldError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• WaveShieldError: The base class for HTTP error responses.

Less common errors (6)

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

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

Server Selection

Override Server URL Per-Client

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

import { WaveShield } from "waveshield";

const waveShield = new WaveShield({
  serverURL: "https://api.waveshield.xyz",
  security: {
    apiKeyAuth: process.env["WAVESHIELD_API_KEY_AUTH"] ?? "",
    apiSecretAuth: process.env["WAVESHIELD_API_SECRET_AUTH"] ?? "",
  },
});

async function run() {
  const result = await waveShield.auth.verify();

  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 { WaveShield } from "waveshield";
import { HTTPClient } from "waveshield/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 WaveShield({ 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 { WaveShield } from "waveshield";

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

You can also enable a default debug logger by setting an environment variable WAVESHIELD_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.

SDK Created by Speakeasy