@thegamefatherco/warera-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @thegamefatherco/warera-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

WarEra API: WarEra tRPC API endpoints. ⚠️ Please notice that every call is in GET and not POST.

Table of Contents

• @thegamefatherco/warera-sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • 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 @thegamefatherco/warera-sdk

PNPM

pnpm add @thegamefatherco/warera-sdk

Bun

bun add @thegamefatherco/warera-sdk

Yarn

yarn add @thegamefatherco/warera-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 { Warera } from "@thegamefatherco/warera-sdk";

const warera = new Warera({
  serverURL: "https://api.example.com",
});

async function run() {
  await warera.companies.getById({
    input: {
      companyId: "<id>",
    },
  });
}

run();

Available Resources and Operations

Articles

• getById - Get article by ID
• listPaginated - Get paginated articles

BattleRankings

• get - Get battle rankings

Battles

• getById - Get battle by ID
• getLiveData - Get live battle data
• list - Get battles

Companies

• getById - Get company by ID
• list - Get companies with pagination

Countries

• getById - Get country by ID
• getAll - Get all countries

Events

• getPaginated - Get paginated events

GameConfig

• getDates - Get game dates
• get - Get game configuration

Governments

• getByCountryId - Get government by country ID

ItemOffers

• getById - Get item offer by ID

ItemTradings

• getPrices - Get item prices

MilitaryUnits

• getPaginated - Get military units (paginated)

Mus

• getById - Get military unit by ID

Rankings

• get - Get ranking data

Regions

• getById - Get region by ID
• list - Get all regions

Round

• getLastHits - Get last hits in round

Rounds

• getById - Get round by ID

Search

• global - Global search

TradingOrders

• getTop - Get best orders for an item

Transactions

• listPaginated - Get paginated transactions

Upgrades

• getByTypeAndEntity - Get upgrade by type and entity

Users

• getLite - Get user profile (lite)
• listByCountry - Get users by country

WorkOffers

• getById - Get work offer by ID
• getByCompanyId - Get work offer by company ID
• getPaginated - Get paginated work offers

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.

• articlesGetById - Get article by ID
• articlesListPaginated - Get paginated articles
• battleRankingsGet - Get battle rankings
• battlesGetById - Get battle by ID
• battlesGetLiveData - Get live battle data
• battlesList - Get battles
• companiesGetById - Get company by ID
• companiesList - Get companies with pagination
• countriesGetAll - Get all countries
• countriesGetById - Get country by ID
• eventsGetPaginated - Get paginated events
• gameConfigGet - Get game configuration
• gameConfigGetDates - Get game dates
• governmentsGetByCountryId - Get government by country ID
• itemOffersGetById - Get item offer by ID
• itemTradingsGetPrices - Get item prices
• militaryUnitsGetPaginated - Get military units (paginated)
• musGetById - Get military unit by ID
• rankingsGet - Get ranking data
• regionsGetById - Get region by ID
• regionsList - Get all regions
• roundGetLastHits - Get last hits in round
• roundsGetById - Get round by ID
• searchGlobal - Global search
• tradingOrdersGetTop - Get best orders for an item
• transactionsListPaginated - Get paginated transactions
• upgradesGetByTypeAndEntity - Get upgrade by type and entity
• usersGetLite - Get user profile (lite)
• usersListByCountry - Get users by country
• workOffersGetByCompanyId - Get work offer by company ID
• workOffersGetById - Get work offer by ID
• workOffersGetPaginated - Get paginated work offers

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 { Warera } from "@thegamefatherco/warera-sdk";

const warera = new Warera({
  serverURL: "https://api.example.com",
});

async function run() {
  await warera.companies.getById({
    input: {
      companyId: "<id>",
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });
}

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 { Warera } from "@thegamefatherco/warera-sdk";

const warera = new Warera({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  await warera.companies.getById({
    input: {
      companyId: "<id>",
    },
  });
}

run();

Error Handling

WarEraError 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 { Warera } from "@thegamefatherco/warera-sdk";
import * as errors from "@thegamefatherco/warera-sdk/models/errors";

const warera = new Warera({
  serverURL: "https://api.example.com",
});

async function run() {
  try {
    await warera.companies.getById({
      input: {
        companyId: "<id>",
      },
    });
  } catch (error) {
    if (error instanceof errors.WarEraError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• WarEraError: The base class for HTTP error responses.

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

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

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 { Warera } from "@thegamefatherco/warera-sdk";
import { HTTPClient } from "@thegamefatherco/warera-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 Warera({ 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 { Warera } from "@thegamefatherco/warera-sdk";

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

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