mirror of
https://github.com/tribufu/sdk-js
synced 2025-06-17 02:54:18 +00:00
Improve api
- TribufuApi - TribufuBot - TribufuClient - TribufuServer
This commit is contained in:
Guilherme Werner
443
src/api.ts
Normal file
443
src/api.ts
Normal file
@ -0,0 +1,443 @@
|
||||
// Copyright (c) Tribufu. All Rights Reserved.
|
||||
|
||||
import { HeaderMap } from "./http";
|
||||
import { JavaScriptRuntime } from "./node";
|
||||
import { TribufuApiOptions } from "./options";
|
||||
import { TribufuClient } from "./client";
|
||||
import { TribufuServer } from "./server";
|
||||
import axios, { AxiosInstance } from "axios";
|
||||
|
||||
export const TRIBUFU_VERSION = "0.0.0";
|
||||
export const TRIBUFU_API_URL = "https://api.tribufu.com";
|
||||
|
||||
/**
|
||||
* **Tribufu API**
|
||||
*
|
||||
* Use this class to interact with the Tribufu API.
|
||||
*
|
||||
* *There are three ways to use the Tribufu API:*
|
||||
* - A api key give you public read only access to the Tribufu API.
|
||||
* - A bot give you read and write access to the Tribufu API as a bot account.
|
||||
* - A client give you read and write access to the Tribufu API as a client application.
|
||||
*/
|
||||
export class TribufuApi {
|
||||
protected readonly http: AxiosInstance;
|
||||
protected readonly options: TribufuApiOptions;
|
||||
|
||||
constructor(options?: TribufuApiOptions | null) {
|
||||
this.options = options || {};
|
||||
|
||||
let http = axios.create({
|
||||
baseURL: TribufuApi.getBaseUrl(),
|
||||
headers: TribufuApi.defaultHeaders(),
|
||||
});
|
||||
|
||||
if (TribufuApi.debugEnabled()) {
|
||||
http.interceptors.request.use((req) => {
|
||||
console.log(`(TribufuApi) ${req.method?.toUpperCase()} ${req.baseURL}${req.url}`);
|
||||
return req;
|
||||
});
|
||||
}
|
||||
|
||||
this.http = http;
|
||||
}
|
||||
|
||||
public static default(): TribufuApi {
|
||||
return new TribufuApi({});
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a TribufuApi with the given api key.
|
||||
*
|
||||
* - A api key give you public read only access to the Tribufu API.
|
||||
*
|
||||
* @param apiKey
|
||||
* @returns TribufuApi
|
||||
*/
|
||||
public static withApiKey(apiKey: string): TribufuApi {
|
||||
return new TribufuApi({ apiKey });
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a TribufuBot with the given bot token.
|
||||
*
|
||||
* - A bot give you read and write access to the Tribufu API as a bot account.
|
||||
*
|
||||
* @param token
|
||||
* @returns TribufuBot
|
||||
*/
|
||||
public static withBot(token: string): TribufuBot {
|
||||
return new TribufuBot(token);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a TribufuClient with the given client id and client secret.
|
||||
*
|
||||
* @param clientId
|
||||
* @param clientSecret
|
||||
* @returns TribufuClient
|
||||
*/
|
||||
public static withClient(clientId: string, clientSecret: string): TribufuClient {
|
||||
return new TribufuClient(clientId, clientSecret);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a TribufuServer with the given server id, client id and client secret.
|
||||
* @param serverId
|
||||
* @param clientId
|
||||
* @param clientSecret
|
||||
* @returns TribufuServer
|
||||
*/
|
||||
public static withServer(serverId: string, clientId: string, clientSecret: string): TribufuServer {
|
||||
return new TribufuServer(serverId, clientId, clientSecret);
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to create a TribufuApi from environment variables.
|
||||
*
|
||||
* - This will only work if the environment variables are set.
|
||||
*
|
||||
* @param prefix A prefix for the environment variables.
|
||||
* @returns TribufuApi | null
|
||||
* @example
|
||||
* ```ts
|
||||
* // process.env.TRIBUFU_API_KEY
|
||||
* const api = TribufuApi.fromEnv("TRIBUFU_");
|
||||
* ```
|
||||
*/
|
||||
public static fromEnv(prefix: string = ""): TribufuApi | null {
|
||||
const apiKey = process.env[`${prefix}API_KEY`];
|
||||
|
||||
if (apiKey) {
|
||||
return TribufuApi.withApiKey(apiKey);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a TribufuApi from environment variables or the default api.
|
||||
*
|
||||
* - This will fallback to the default api if the environment variables are not set.
|
||||
*
|
||||
* @param prefix A prefix for the environment variables.
|
||||
* @returns TribufuApi | null
|
||||
* @example
|
||||
* ```ts
|
||||
* // process.env.TRIBUFU_API_KEY = null
|
||||
* const api = TribufuApi.fromEnvOrDefault("TRIBUFU_");
|
||||
* ```
|
||||
*/
|
||||
public static fromEnvOrDefault(prefix: string = ""): TribufuApi {
|
||||
return TribufuApi.fromEnv(prefix) || TribufuApi.default();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if debug mode is enabled.
|
||||
*
|
||||
* - Debug mode is enabled if the environment variable `NODE_ENV` is set to `development`.
|
||||
* - Debug mode is disabled by default.
|
||||
* - Debug mode is disabled in the browser.
|
||||
*
|
||||
* @returns boolean
|
||||
*/
|
||||
private static debugEnabled(): boolean {
|
||||
return process.env.NODE_ENV ? process.env.NODE_ENV === "development" : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the base url for the Tribufu API.
|
||||
*
|
||||
* - The base url can be set using the environment variable `TRIBUFU_API_URL`.
|
||||
* - The custom base url is only used if debug mode is enabled.
|
||||
* - The default base url is `https://api.tribufu.com`.
|
||||
*
|
||||
* @returns string
|
||||
*/
|
||||
private static getBaseUrl(): string {
|
||||
const baseUrl = process.env[`TRIBUFU_API_URL`] || null;
|
||||
return TribufuApi.debugEnabled() && baseUrl ? baseUrl : TRIBUFU_API_URL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the default headers for the Tribufu API.
|
||||
* @returns HeaderMap
|
||||
*/
|
||||
private static defaultHeaders(): HeaderMap {
|
||||
const headers = {
|
||||
"X-Tribufu-Language": "javascript",
|
||||
"X-Tribufu-Version": TRIBUFU_VERSION,
|
||||
};
|
||||
|
||||
return headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect the current JavaScript runtime.
|
||||
*
|
||||
* - This is used to determine if the code is running in a browser or in Node.js.
|
||||
*
|
||||
* @returns JavaScriptRuntime
|
||||
*/
|
||||
private static detectRuntime(): JavaScriptRuntime {
|
||||
if (typeof window !== "undefined") {
|
||||
return JavaScriptRuntime.Browser;
|
||||
}
|
||||
|
||||
if (typeof process !== "undefined" && process?.versions?.node) {
|
||||
return JavaScriptRuntime.Node;
|
||||
}
|
||||
|
||||
return JavaScriptRuntime.Other;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current JavaScript runtime is a browser.
|
||||
* @returns boolean
|
||||
*/
|
||||
public static isBrowser(): boolean {
|
||||
return TribufuApi.detectRuntime() === JavaScriptRuntime.Browser;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current JavaScript runtime is Node.js.
|
||||
* @returns boolean
|
||||
*/
|
||||
public static isNode(): boolean {
|
||||
return TribufuApi.detectRuntime() === JavaScriptRuntime.Node;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current headers with the api key or access token.
|
||||
* @returns HeaderMap
|
||||
*/
|
||||
protected getHeaders(): HeaderMap {
|
||||
let headers: HeaderMap = {};
|
||||
|
||||
if (this.options.apiKey) {
|
||||
headers["Authorization"] = `ApiKey ${this.options.apiKey}`;
|
||||
return headers;
|
||||
}
|
||||
|
||||
if (this.options.accessToken) {
|
||||
headers["Authorization"] = `Bearer ${this.options.accessToken}`;
|
||||
return headers;
|
||||
}
|
||||
|
||||
return headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a resource from the Tribufu API.
|
||||
* @returns T | null
|
||||
*/
|
||||
protected async get<T>(path: string, headers?: HeaderMap | null): Promise<T | null> {
|
||||
try {
|
||||
const requestHeaders = headers || this.getHeaders();
|
||||
const response = await this.http.get(path, { headers: requestHeaders });
|
||||
|
||||
if (response.status !== 200) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return response.data as T;
|
||||
} catch (error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a resource to the Tribufu API.
|
||||
* @param path
|
||||
* @param body
|
||||
* @param headers
|
||||
* @returns T | null
|
||||
*/
|
||||
protected async post<S, T>(path: string, body: S, headers?: HeaderMap | null): Promise<T | null> {
|
||||
try {
|
||||
const requestHeaders = headers || this.getHeaders();
|
||||
const response = await this.http.post(path, body, { headers: requestHeaders });
|
||||
|
||||
if (response.status !== 200) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return response.data as T;
|
||||
} catch (error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a resource on the Tribufu API.
|
||||
* @param path
|
||||
* @param body
|
||||
* @param headers
|
||||
* @returns T | null
|
||||
*/
|
||||
protected async put<S, T>(path: string, body: S, headers?: HeaderMap | null): Promise<T | null> {
|
||||
try {
|
||||
const requestHeaders = headers || this.getHeaders();
|
||||
const response = await this.http.put(path, body, { headers: requestHeaders });
|
||||
|
||||
if (response.status !== 200) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return response.data as T;
|
||||
} catch (error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a resource from the Tribufu API.
|
||||
* @param path
|
||||
* @param headers
|
||||
* @returns T | null
|
||||
*/
|
||||
protected async delete<T>(path: string, headers?: HeaderMap | null): Promise<T | null> {
|
||||
try {
|
||||
const requestHeaders = headers || this.getHeaders();
|
||||
const response = await this.http.delete(path, { headers: requestHeaders });
|
||||
|
||||
if (response.status !== 200) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return response.data as T;
|
||||
} catch (error) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get games from the Tribufu API.
|
||||
* @param page
|
||||
* @returns Game[]
|
||||
*/
|
||||
public async getGames(page: number = 1): Promise<any[]> {
|
||||
const headers = this.getHeaders();
|
||||
const responseBody = await this.get<any[]>(`/v1/packages?page=${page}`, headers);
|
||||
|
||||
if (!responseBody) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return responseBody;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a game from the Tribufu API.
|
||||
* @param id
|
||||
* @returns Game | null
|
||||
*/
|
||||
public async getGameyId(id: string): Promise<any | null> {
|
||||
const headers = this.getHeaders();
|
||||
const responseBody = await this.get<any>(`/v1/packages/${id}`, headers);
|
||||
|
||||
if (!responseBody) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return responseBody;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a game from the Tribufu API.
|
||||
* @param page
|
||||
* @returns Server[]
|
||||
*/
|
||||
public async getServers(page: number = 1): Promise<any[]> {
|
||||
const headers = this.getHeaders();
|
||||
const responseBody = await this.get<any[]>(`/v1/servers?page=${page}`, headers);
|
||||
|
||||
if (!responseBody) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return responseBody;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a server by id or address from the Tribufu API.
|
||||
* @param idOrAddress
|
||||
* @returns Server | null
|
||||
*/
|
||||
public async getServer(idOrAddress: string): Promise<any> {
|
||||
if (isNaN(idOrAddress as any)) {
|
||||
return await this.getServerByAddress(idOrAddress);
|
||||
}
|
||||
|
||||
return await this.getServerById(idOrAddress);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a server by id from the Tribufu API.
|
||||
* @param id
|
||||
* @returns Server | null
|
||||
*/
|
||||
public async getServerById(id: string): Promise<any> {
|
||||
const headers = this.getHeaders()
|
||||
const responseBody = await this.get<any>(`/v1/servers/${id}`, headers);
|
||||
|
||||
if (!responseBody) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return responseBody;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a server by address from the Tribufu API.
|
||||
* @param address
|
||||
* @returns Server | null
|
||||
*/
|
||||
public async getServerByAddress(address: string): Promise<any> {
|
||||
const headers = this.getHeaders();
|
||||
const responseBody = await this.get(`/v1/servers/address/${address}`, headers);
|
||||
|
||||
if (!responseBody) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return responseBody;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* **Tribufu Bot**
|
||||
*
|
||||
* To authenticate a bot you need to use the bot token obtained from the Tribufu Developer Portal.
|
||||
*
|
||||
* - A bot is a special type of user account.
|
||||
* - A bot give you read and write access to the Tribufu API.
|
||||
*/
|
||||
export class TribufuBot extends TribufuApi {
|
||||
constructor(token: string) {
|
||||
super({ accessToken: token });
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to create a TribufuBot from environment variables.
|
||||
*
|
||||
* - This will only work if the environment variables are set.
|
||||
*
|
||||
* @param prefix A prefix for the environment variables.
|
||||
* @returns TribufuBot | null
|
||||
* @example
|
||||
* ```ts
|
||||
* const bot = TribufuBot.fromEnv("TRIBUFU_"); // process.env.TRIBUFU_BOT_TOKEN
|
||||
* ```
|
||||
*/
|
||||
public static override fromEnv(prefix: string = ""): TribufuBot | null {
|
||||
const token = process.env[`${prefix}BOT_TOKEN`];
|
||||
|
||||
if (token) {
|
||||
return TribufuApi.withBot(token);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user