1 Commits
1.0.1 ... dev2

Author SHA1 Message Date
e04fa03af8 Add tauri extension 2024-10-04 18:49:13 -03:00
15 changed files with 1144 additions and 2135 deletions

View File

@ -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

View File

@ -7,10 +7,8 @@ import { TribufuApi } from "../build/index.mjs";
dotenv.config();
async function main() {
const tribufu = TribufuApi.fromEnv();
console.log(
await tribufu.getServerByAddressAndQueryPort("mine.tribufu.com", 25565),
);
const api = TribufuApi.fromEnv("TRIBUFU");
console.log(await api.authGetUserInfo());
}
main();

View File

@ -1,6 +1,6 @@
{
"name": "tribufu",
"version": "1.0.1",
"version": "0.1.20",
"description": "Tribufu JS SDK",
"repository": "https://github.com/Tribufu/TribufuJs",
"author": "Tribufu <contact@Tribufu.com>",
@ -9,26 +9,21 @@
"types": "./build/index.d.ts",
"exports": {
"import": "./build/index.mjs",
"require": "./build/index.cjs",
"types": "./build/index.d.ts"
},
"typesVersions": {
"*": {
"*": [
"./build/*"
]
}
"require": "./build/index.cjs"
},
"scripts": {
"clean": "rimraf build",
"build": "npm run clean && tsc && node scripts/esbuild.js"
},
"dependencies": {},
"peerDependencies": {
"@tauri-apps/plugin-http": "^2.0.0"
},
"devDependencies": {
"@tauri-apps/plugin-http": "^2.0.0",
"@types/node": "^20.10.6",
"dotenv": "^16.3.1",
"esbuild": "^0.19.10",
"esbuild-node-externals": "^1.12.0",
"esbuild": "^0.19.10",
"eslint": "9.11.1",
"prettier": "3.3.3",
"rimraf": "^5.0.5",

1348
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -22,26 +22,12 @@ const moduleConfig = {
format: "esm",
};
const moduleMinConfig = {
...moduleConfig,
outfile: "build/index.min.mjs",
minify: true,
sourcemap: true,
};
const legacyConfig = {
...baseConfig,
outfile: "build/index.cjs",
format: "cjs",
};
const legacyMinConfig = {
...legacyConfig,
outfile: "build/index.min.cjs",
minify: true,
sourcemap: true,
};
async function addCopyrightHeader(filename) {
const header = `// Copyright (c) Tribufu. All Rights Reserved.\n// SPDX-License-Identifier: MIT\n\n`;
const content = await fs.readFile(filename, 'utf-8');
@ -58,8 +44,5 @@ async function buildAndAddHeader(config) {
}
};
await buildAndAddHeader(legacyConfig);
await buildAndAddHeader(moduleConfig);
//await buildAndAddHeader(legacyMinConfig);
//await buildAndAddHeader(moduleMinConfig);
await buildAndAddHeader(legacyConfig);

View File

@ -18,11 +18,11 @@ export abstract class TribufuApiBase {
* @returns boolean
*/
public static debugEnabled(): boolean {
if (typeof process !== "undefined") {
return process.env.NODE_ENV === "development";
if (!process) {
return false;
}
return false;
return process.env.NODE_ENV === "development";
}
/**
@ -66,7 +66,7 @@ export abstract class TribufuApiBase {
*/
protected static defaultHeaders(): HttpHeaders {
const headers = {};
headers["X-Tribufu-Library"] = "javascript";
headers["X-Tribufu-Language"] = "javascript";
headers["X-Tribufu-Version"] = TRIBUFU_VERSION;
return headers;
}
@ -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);
}

File diff suppressed because it is too large Load Diff

1
src/api/api.include.ts Normal file
View File

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

View File

@ -4,7 +4,7 @@
"documentGenerator": {
"fromDocument": {
"json": "",
"url": "https://api.tribufu.com/v1/openapi.json",
"url": "http://localhost:5000/v1/openapi.json",
"output": null,
"newLineBehavior": "Auto"
}
@ -26,7 +26,7 @@
"nullValue": "Null",
"generateClientClasses": true,
"generateClientInterfaces": false,
"generateOptionalParameters": true,
"generateOptionalParameters": false,
"exportTypes": true,
"wrapDtoExceptions": false,
"exceptionClass": "TribufuApiError",
@ -41,14 +41,14 @@
"useTransformResultMethod": false,
"generateDtoTypes": true,
"operationGenerationMode": "SingleClientFromOperationId",
"markOptionalProperties": false,
"markOptionalProperties": true,
"generateCloneMethod": false,
"typeStyle": "Interface",
"enumStyle": "Enum",
"useLeafType": false,
"classTypes": [],
"extendedClasses": [],
"extensionCode": "include.ts",
"extensionCode": "api.include.ts",
"generateDefaultValues": true,
"excludedTypeNames": [],
"excludedParameterNames": [],
@ -67,7 +67,7 @@
"templateDirectory": null,
"serviceHost": null,
"serviceSchemes": null,
"output": "generated.ts",
"output": "api.generated.ts",
"newLineBehavior": "LF"
}
}

View File

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

View File

@ -2,8 +2,8 @@
// SPDX-License-Identifier: MIT
import { TRIBUFU_API_URL } from "..";
import { TribufuApiBase } from "./base";
import { TribufuApiGenerated } from "./generated";
import { TribufuApiBase } from "./api.base";
import { TribufuApiGenerated } from "./api.generated";
import { TribufuApiOptions } from "../options";
/**
@ -44,20 +44,22 @@ export class TribufuApi extends TribufuApiGenerated {
*
* - This will only work if the environment variables are set.
*
* @param prefix A prefix for the environment variables. Default is `TRIBUFU`.
* @param prefix A prefix for the environment variables.
* @returns TribufuApi | null
* @example
* ```ts
* // process.env.TRIBUFU_API_KEY
* const api = TribufuApi.fromEnv();
* const api = TribufuApi.fromEnv("TRIBUFU");
* ```
*/
public static fromEnv(prefix?: string | null): TribufuApi | null {
if (typeof process === "undefined") {
const envPrefix = prefix ? `${prefix}_` : "";
if (!process) {
return null;
}
const apiKey = process.env[`${prefix || "TRIBUFU"}_API_KEY`];
const apiKey = process.env[`${envPrefix}API_KEY`];
if (apiKey) {
return TribufuApi.withApiKey(apiKey);
@ -71,12 +73,12 @@ export class TribufuApi extends TribufuApiGenerated {
*
* - This will fallback to the default api if the environment variables are not set.
*
* @param prefix A prefix for the environment variables. Default is `TRIBUFU`.
* @param prefix A prefix for the environment variables.
* @returns TribufuApi | null
* @example
* ```ts
* // process.env.TRIBUFU_API_KEY = null
* const api = TribufuApi.fromEnvOrDefault();
* const api = TribufuApi.fromEnvOrDefault("TRIBUFU_");
* ```
*/
public static fromEnvOrDefault(prefix: string = ""): TribufuApi {
@ -93,11 +95,13 @@ export class TribufuApi extends TribufuApiGenerated {
* @returns string
*/
protected static getBaseUrl(): string {
if (typeof process === "undefined") {
if (!process) {
return TRIBUFU_API_URL;
}
const baseUrl = process.env[`TRIBUFU_API_URL`] || null;
return TribufuApiBase.debugEnabled() && baseUrl ? baseUrl : TRIBUFU_API_URL;
return TribufuApiBase.debugEnabled() && baseUrl
? baseUrl
: TRIBUFU_API_URL;
}
}

View File

@ -1,23 +0,0 @@
// Copyright (c) Tribufu. All Rights Reserved.
// SPDX-License-Identifier: MIT
import { TribufuApi } from "./index";
/**
* **Tribufu API**
*
* Helper class to get a singleton instance of the Tribufu API.
*/
export class TribufuApiSingleton {
private static INSTANCE: TribufuApi | null = null;
private constructor() {}
public static getInstance(): TribufuApi {
if (!TribufuApiSingleton.INSTANCE) {
TribufuApiSingleton.INSTANCE = TribufuApi.fromEnvOrDefault();
}
return TribufuApiSingleton.INSTANCE;
}
}

View File

@ -8,24 +8,9 @@ import {
TRIBUFU_WEB_URL,
} from "./constants";
export { TRIBUFU_API_URL, TRIBUFU_CDN_URL, TRIBUFU_VERSION, TRIBUFU_WEB_URL };
import { TribufuApi } from "./api";
import { TribufuApiOptions } from "./options";
import { TribufuApiSingleton } from "./api/singletion";
export {
TRIBUFU_API_URL,
TRIBUFU_CDN_URL,
TRIBUFU_VERSION,
TRIBUFU_WEB_URL,
TribufuApi,
TribufuApiOptions,
TribufuApiSingleton,
};
export * from "./api/base";
export * from "./api/generated";
export * from "./api/include";
export * from "./api/index";
export * from "./api/singletion";
export * from "./http/headers";
export * from "./node";
export { TribufuApi, TribufuApiOptions };

24
src/tauri/api.ts Normal file
View File

@ -0,0 +1,24 @@
// Copyright (c) Tribufu. All Rights Reserved.
// SPDX-License-Identifier: MIT
import { TribufuApi } from "../api";
import { TribufuApiOptions } from "../options";
let fetchFn: typeof fetch | undefined;
if (window && (window as any).__TAURI__) {
fetchFn = (await import("@tauri-apps/plugin-http")).fetch;
}
export type TribufuTauriApiOptions = Omit<TribufuApiOptions, "fetch">;
/**
* **Tribufu Tauri API**
*
* Use this class to interact with the Tribufu API in a Tauri application.
*/
export class TribufuTauriApi extends TribufuApi {
constructor(options?: TribufuTauriApiOptions | null) {
super({ ...options, fetch: fetchFn });
}
}

View File

@ -1,13 +1,12 @@
{
"compilerOptions": {
"strict": true,
"target": "esnext",
"target": "ESNext",
"declaration": true,
"emitDeclarationOnly": true,
"noImplicitAny": false,
"moduleResolution": "Node",
"esModuleInterop": true,
"module": "esnext",
"allowImportingTsExtensions": true,
"resolveJsonModule": true,
"rootDir": "src",