Add translate api client

.editorconfig

@@ -1,17 +1,15 @@
 root = true
 
 [*]
-charset = utf-8
 end_of_line = lf
-indent_size = 4
 indent_style = space
-insert_final_newline = true
-max_line_length = 120
+indent_size = 4
+charset = utf-8
 trim_trailing_whitespace = true
+insert_final_newline = true
 
 [*.md]
-indent_size = 1
 trim_trailing_whitespace = false
 
-[.env*]
+[*.env*]
 insert_final_newline = false

examples/api.js

@@ -8,7 +8,9 @@ dotenv.config();
 
 async function main() {
     const tribufu = TribufuApi.fromEnv();
-    console.log(await tribufu.getUserInfo());
+    console.log(
+        await tribufu.getServerByAddressAndQueryPort("mine.tribufu.com", 25565),
+    );
 }
 
 main();

package.json

@@ -1,6 +1,6 @@
 {
     "name": "tribufu",
-    "version": "1.0.2",
+    "version": "1.0.0",
     "description": "Tribufu JS SDK",
     "repository": "https://github.com/Tribufu/TribufuJs",
     "author": "Tribufu <contact@Tribufu.com>",

scripts/nswag.ps1

@@ -1,3 +1,4 @@
 #!/usr/bin/env sh
 
 nswag run ./src/api/api.nswag
+nswag run ./src/translate/translate.nswag

src/api/api.nswag

@@ -48,7 +48,7 @@
             "useLeafType": false,
             "classTypes": [],
             "extendedClasses": [],
-            "extensionCode": "include.ts",
+            "extensionCode": "../core/include.ts",
             "generateDefaultValues": true,
             "excludedTypeNames": [],
             "excludedParameterNames": [],

src/api/generated.ts

@@ -8,7 +8,7 @@
 /* eslint-disable */
 // ReSharper disable InconsistentNaming
 
-import { TribufuApiBase } from "./base";
+import { TribufuApiBase } from "../core/base";
 
 export class TribufuApiGenerated extends TribufuApiBase {
     private http: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> };
@@ -62,7 +62,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Login with name or email and password.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     login(body?: LoginRequest | undefined): Promise<LoginResponse> {
@@ -106,7 +106,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Create a new user.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     register(body?: RegisterRequest | undefined): Promise<LoginResponse> {
@@ -150,7 +150,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Refresh credentials.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     refresh(body?: RefreshRequest | undefined): Promise<LoginResponse> {
@@ -230,8 +230,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of game server clusters.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getClusters(page?: number | undefined, limit?: number | undefined): Promise<GameServerCluster[]> {
@@ -279,7 +279,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Create a new game server cluster.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     createCluster(body?: any | undefined): Promise<void> {
@@ -362,7 +362,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Update a game server cluster.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     updateCluster(id: string, body?: any | undefined): Promise<void> {
@@ -447,7 +447,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
      * Get a list of games.
      * @return OK
      */
-    getGames(): Promise<Game[]> {
+    getGames(): Promise<Application[]> {
         let url_ = this.baseUrl + "/v1/games";
         url_ = url_.replace(/[?&]$/, "");
 
@@ -465,13 +465,13 @@ export class TribufuApiGenerated extends TribufuApiBase {
         });
     }
 
-    protected processGetGames(response: Response): Promise<Game[]> {
+    protected processGetGames(response: Response): Promise<Application[]> {
         const status = response.status;
         let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
         if (status === 200) {
             return response.text().then((_responseText) => {
             let result200: any = null;
-            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as Game[];
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as Application[];
             return result200;
             });
         } else if (status !== 200 && status !== 204) {
@@ -479,14 +479,14 @@ export class TribufuApiGenerated extends TribufuApiBase {
             return throwException("An unexpected server error occurred.", status, _responseText, _headers);
             });
         }
-        return Promise.resolve<Game[]>(null as any);
+        return Promise.resolve<Application[]>(null as any);
     }
 
     /**
      * Get a game by id.
      * @return OK
      */
-    getGameById(id: string): Promise<Game> {
+    getGameById(id: string): Promise<Application> {
         let url_ = this.baseUrl + "/v1/games/{id}";
         if (id === undefined || id === null)
             throw new Error("The parameter 'id' must be defined.");
@@ -507,13 +507,13 @@ export class TribufuApiGenerated extends TribufuApiBase {
         });
     }
 
-    protected processGetGameById(response: Response): Promise<Game> {
+    protected processGetGameById(response: Response): Promise<Application> {
         const status = response.status;
         let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
         if (status === 200) {
             return response.text().then((_responseText) => {
             let result200: any = null;
-            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as Game;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as Application;
             return result200;
             });
         } else if (status !== 200 && status !== 204) {
@@ -521,13 +521,13 @@ export class TribufuApiGenerated extends TribufuApiBase {
             return throwException("An unexpected server error occurred.", status, _responseText, _headers);
             });
         }
-        return Promise.resolve<Game>(null as any);
+        return Promise.resolve<Application>(null as any);
     }
 
     /**
      * Get a list of game servers of a game.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getGameServers(id: string, page?: number | undefined, limit?: number | undefined): Promise<GameServer[]> {
@@ -578,8 +578,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of game server clusters of a game.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getGameClusters(id: string, page?: number | undefined, limit?: number | undefined): Promise<GameServerCluster[]> {
@@ -630,8 +630,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of game items.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getGameItems(id: string, page?: number | undefined, limit?: number | undefined): Promise<any[]> {
@@ -682,8 +682,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of groups.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getGroups(page?: number | undefined, limit?: number | undefined): Promise<Group[]> {
@@ -731,7 +731,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Create a new group.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     createGroup(body?: any | undefined): Promise<void> {
@@ -814,7 +814,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Update a group.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     updateGroup(id: string, body?: any | undefined): Promise<void> {
@@ -1065,7 +1065,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get the top 20 leaderboard users.
-     * @param order (optional) 
+     * @param order (optional)
      * @return OK
      */
     getLeaderboard(order?: LeaderboardOrder | undefined): Promise<LeaderboardItem[]> {
@@ -1109,8 +1109,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of packages.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getPackages(page?: number | undefined, limit?: number | undefined): Promise<Package[]> {
@@ -1200,7 +1200,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Advanced search for servers or players.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     search(body?: SearchRequest | undefined): Promise<any[]> {
@@ -1244,8 +1244,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of game servers.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getServers(page?: number | undefined, limit?: number | undefined): Promise<GameServer[]> {
@@ -1293,7 +1293,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Create a new game server.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     createServer(body?: any | undefined): Promise<void> {
@@ -1376,7 +1376,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Update a game server.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     updateServer(id: string, body?: any | undefined): Promise<void> {
@@ -1504,8 +1504,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of game servers from a country.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getServersByCountry(country: string, page?: number | undefined, limit?: number | undefined): Promise<GameServer[]> {
@@ -1556,7 +1556,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Claim a game server.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     claimServer(id: string, body?: any | undefined): Promise<void> {
@@ -1678,8 +1678,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of subscriptions.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getSubscriptions(page?: number | undefined, limit?: number | undefined): Promise<Subscription[]> {
@@ -1769,8 +1769,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of user profiles.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getUsers(page?: number | undefined, limit?: number | undefined): Promise<Profile[]> {
@@ -2070,8 +2070,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Get a list of servers the user is owner of.
-     * @param page (optional) 
-     * @param limit (optional) 
+     * @param page (optional)
+     * @param limit (optional)
      * @return OK
      */
     getUserServers(id: string, page?: number | undefined, limit?: number | undefined): Promise<GameServer[]> {
@@ -2206,7 +2206,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Update a user profile.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     updateUserProfile(id: string, body?: UpdateProfile | undefined): Promise<Profile> {
@@ -2253,7 +2253,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Change the email of a user.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     changeEmail(id: string, body?: any | undefined): Promise<void> {
@@ -2297,7 +2297,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Change the password of a user.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     changePassword(id: string, body?: any | undefined): Promise<void> {
@@ -2341,8 +2341,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Generate a random password.
-     * @param length (optional) 
-     * @param symbols (optional) 
+     * @param length (optional)
+     * @param symbols (optional)
      * @return OK
      */
     generatePassword(length?: number | undefined, symbols?: boolean | undefined): Promise<HashViewModel> {
@@ -2390,7 +2390,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Generate one or more flake ids.
-     * @param amount (optional) 
+     * @param amount (optional)
      * @return OK
      */
     generateFlakeId(amount?: number | undefined): Promise<string[]> {
@@ -2434,8 +2434,8 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Generate one or more uuids with a specific version.
-     * @param version (optional) 
-     * @param amount (optional) 
+     * @param version (optional)
+     * @param amount (optional)
      * @return OK
      */
     generateUuid(version?: number | undefined, amount?: number | undefined): Promise<string[]> {
@@ -2483,7 +2483,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Convert a string to base64 or vice versa.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     convertBase64(body?: CryptoViewModel | undefined): Promise<CryptoViewModel> {
@@ -2527,7 +2527,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Hash a string using md5.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     hashMd5(body?: HashViewModel | undefined): Promise<HashViewModel> {
@@ -2571,7 +2571,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Hash a string using sha256.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     hashSha256(body?: HashViewModel | undefined): Promise<HashViewModel> {
@@ -2615,7 +2615,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Hash a string using bcrypt.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     hashBcrypt(body?: HashViewModel | undefined): Promise<HashViewModel> {
@@ -2659,7 +2659,7 @@ export class TribufuApiGenerated extends TribufuApiBase {
 
     /**
      * Hash a string using argon2.
-     * @param body (optional) 
+     * @param body (optional)
      * @return OK
      */
     hashArgon2(body?: HashViewModel | undefined): Promise<HashViewModel> {
@@ -2746,40 +2746,6 @@ export interface CryptoViewModel {
     decoded: string | null;
 }
 
-export interface Game {
-    game_port: number | null;
-    query_port: number | null;
-    rcon_port: number | null;
-    server_count: number;
-    steam_app_id: number | null;
-    steam_server_app_id: number | null;
-    enable_servers: boolean;
-    rust_gamedig_id: string | null;
-    node_gamedig_id: string | null;
-    server_connect_url: string | null;
-    server_tags: string | null;
-    id: string;
-    name: string | null;
-    description: string | null;
-    type: ApplicationType;
-    organization_id: string | null;
-    icon_url: string | null;
-    banner_url: string | null;
-    capsule_image_url: string | null;
-    library_image_url: string | null;
-    parent_id: string | null;
-    slug: string | null;
-    visibility: number;
-    password: string | null;
-    primary: number;
-    user_count: number;
-    achievement_count: number;
-    badge_count: number | null;
-    download_count: number;
-    created: string;
-    updated: string | null;
-}
-
 export interface GameServer {
     id: string;
     name: string | null;
@@ -2853,7 +2819,6 @@ export interface Group {
 export interface GroupGame {
     group_id: string;
     application_id: string;
-    application: Application;
     stats: any | null;
     acquired: string;
     last_used: string | null;
@@ -3096,4 +3061,4 @@ function throwException(message: string, status: number, response: string, heade
         throw result;
     else
         throw new TribufuApiError(message, status, response, headers, null);
-}
+}

src/api/include.ts

@@ -1 +0,0 @@
-import { TribufuApiBase } from "./base";

src/api/index.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 
 import { TRIBUFU_API_URL } from "..";
-import { TribufuApiBase } from "./base";
+import { TribufuApiBase } from "../core/base";
 import { TribufuApiGenerated } from "./generated";
 import { TribufuApiOptions } from "../options";
 
@@ -98,6 +98,8 @@ export class TribufuApi extends TribufuApiGenerated {
         }
 
         const baseUrl = process.env[`TRIBUFU_API_URL`] || null;
-        return TribufuApiBase.debugEnabled() && baseUrl ? baseUrl : TRIBUFU_API_URL;
+        return TribufuApiBase.debugEnabled() && baseUrl
+            ? baseUrl
+            : TRIBUFU_API_URL;
     }
 }

src/core/base.ts

@@ -92,10 +92,12 @@ export abstract class TribufuApiBase {
      * @returns
      */
     protected transformOptions(options: RequestInit) {
-        options.headers = {
-            ...options.headers,
-            ...this.getHeaders(),
-        };
+        if (this.apiKey) {
+            options.headers = {
+                ...options.headers,
+                ...this.getHeaders(),
+            };
+        }
 
         return Promise.resolve(options);
     }

src/core/include.ts

@@ -0,0 +1 @@
+import { TribufuApiBase } from "../core/base";

src/index.ts

@@ -22,9 +22,9 @@ export {
     TribufuApiSingleton,
 };
 
-export * from "./api/base";
-export * from "./api/generated";
-export * from "./api/include";
+export * from "./api/api.base";
+export * from "./api/api.generated";
+export * from "./api/api.include";
 export * from "./api/index";
 export * from "./api/singletion";
 export * from "./http/headers";

src/translate/generated.ts

@@ -0,0 +1,84 @@
+//----------------------
+// <auto-generated>
+//     Generated using the NSwag toolchain v14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org)
+// </auto-generated>
+//----------------------
+
+/* tslint:disable */
+/* eslint-disable */
+// ReSharper disable InconsistentNaming
+
+import { TribufuApiBase } from "../core/base";
+
+export class TribufuTranslateGenerated extends TribufuApiBase {
+    private http: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> };
+    private baseUrl: string;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined = undefined;
+
+    constructor(baseUrl?: string, http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> }) {
+        super();
+        this.http = http ? http : window as any;
+        this.baseUrl = baseUrl ?? "";
+    }
+
+    /**
+     * Translate a given text.
+     */
+    translate(): Promise<void> {
+        let url_ = this.baseUrl + "/translate";
+        url_ = url_.replace(/[?&]$/, "");
+
+        let options_: RequestInit = {
+            method: "POST",
+            headers: {
+            }
+        };
+
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response: Response) => {
+            return this.processTranslate(_response);
+        });
+    }
+
+    protected processTranslate(response: Response): Promise<void> {
+        const status = response.status;
+        let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
+        {
+            return response.text().then((_responseText) => {
+            return;
+            });
+        }
+    }
+}
+
+export class TribufuTranslateError extends Error {
+    override message: string;
+    status: number;
+    response: string;
+    headers: { [key: string]: any; };
+    result: any;
+
+    constructor(message: string, status: number, response: string, headers: { [key: string]: any; }, result: any) {
+        super();
+
+        this.message = message;
+        this.status = status;
+        this.response = response;
+        this.headers = headers;
+        this.result = result;
+    }
+
+    protected isTribufuTranslateError = true;
+
+    static isTribufuTranslateError(obj: any): obj is TribufuTranslateError {
+        return obj.isTribufuTranslateError === true;
+    }
+}
+
+function throwException(message: string, status: number, response: string, headers: { [key: string]: any; }, result?: any): any {
+    if (result !== null && result !== undefined)
+        throw result;
+    else
+        throw new TribufuTranslateError(message, status, response, headers, null);
+}

src/translate/translate.nswag

@@ -0,0 +1,74 @@
+{
+    "runtime": "Default",
+    "defaultVariables": null,
+    "documentGenerator": {
+        "fromDocument": {
+            "json": "",
+            "url": "http://localhost:5578/openapi.json",
+            "output": null,
+            "newLineBehavior": "Auto"
+        }
+    },
+    "codeGenerators": {
+        "openApiToTypeScriptClient": {
+            "className": "TribufuTranslateGenerated",
+            "moduleName": "",
+            "namespace": "",
+            "typeScriptVersion": 4.3,
+            "template": "Fetch",
+            "promiseType": "Promise",
+            "httpClass": "HttpClient",
+            "withCredentials": false,
+            "useSingletonProvider": false,
+            "injectionTokenType": "OpaqueToken",
+            "rxJsVersion": 6,
+            "dateTimeType": "String",
+            "nullValue": "Null",
+            "generateClientClasses": true,
+            "generateClientInterfaces": false,
+            "generateOptionalParameters": true,
+            "exportTypes": true,
+            "wrapDtoExceptions": false,
+            "exceptionClass": "TribufuTranslateError",
+            "clientBaseClass": "TribufuApiBase",
+            "wrapResponses": false,
+            "wrapResponseMethods": [],
+            "generateResponseClasses": true,
+            "responseClass": "SwaggerResponse",
+            "protectedMethods": [],
+            "configurationClass": null,
+            "useTransformOptionsMethod": true,
+            "useTransformResultMethod": false,
+            "generateDtoTypes": true,
+            "operationGenerationMode": "SingleClientFromOperationId",
+            "markOptionalProperties": false,
+            "generateCloneMethod": false,
+            "typeStyle": "Interface",
+            "enumStyle": "Enum",
+            "useLeafType": false,
+            "classTypes": [],
+            "extendedClasses": [],
+            "extensionCode": "../core/include.ts",
+            "generateDefaultValues": true,
+            "excludedTypeNames": [],
+            "excludedParameterNames": [],
+            "handleReferences": false,
+            "generateTypeCheckFunctions": false,
+            "generateConstructorInterface": true,
+            "convertConstructorInterfaceData": false,
+            "importRequiredTypes": true,
+            "useGetBaseUrlMethod": false,
+            "baseUrlTokenName": "API_BASE_URL",
+            "queryNullValue": "",
+            "useAbortSignal": false,
+            "inlineNamedDictionaries": false,
+            "inlineNamedAny": false,
+            "includeHttpContext": false,
+            "templateDirectory": null,
+            "serviceHost": null,
+            "serviceSchemes": null,
+            "output": "generated.ts",
+            "newLineBehavior": "LF"
+        }
+    }
+}