mirror of
https://github.com/tribufu/sdk-js
synced 2025-06-17 02:54:18 +00:00
Compare commits
1 Commits
Author | SHA1 | Date | |
---|---|---|---|
e04fa03af8 |
@ -1,17 +1,15 @@
|
|||||||
root = true
|
root = true
|
||||||
|
|
||||||
[*]
|
[*]
|
||||||
charset = utf-8
|
|
||||||
end_of_line = lf
|
end_of_line = lf
|
||||||
indent_size = 4
|
|
||||||
indent_style = space
|
indent_style = space
|
||||||
insert_final_newline = true
|
indent_size = 4
|
||||||
max_line_length = 120
|
charset = utf-8
|
||||||
trim_trailing_whitespace = true
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
[*.md]
|
[*.md]
|
||||||
indent_size = 1
|
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
[.env*]
|
[*.env*]
|
||||||
insert_final_newline = false
|
insert_final_newline = false
|
||||||
|
@ -7,8 +7,8 @@ import { TribufuApi } from "../build/index.mjs";
|
|||||||
dotenv.config();
|
dotenv.config();
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const tribufu = TribufuApi.fromEnv();
|
const api = TribufuApi.fromEnv("TRIBUFU");
|
||||||
console.log(await tribufu.getUserInfo());
|
console.log(await api.authGetUserInfo());
|
||||||
}
|
}
|
||||||
|
|
||||||
main();
|
main();
|
||||||
|
19
package.json
19
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "tribufu",
|
"name": "tribufu",
|
||||||
"version": "1.0.2",
|
"version": "0.1.20",
|
||||||
"description": "Tribufu JS SDK",
|
"description": "Tribufu JS SDK",
|
||||||
"repository": "https://github.com/Tribufu/TribufuJs",
|
"repository": "https://github.com/Tribufu/TribufuJs",
|
||||||
"author": "Tribufu <contact@Tribufu.com>",
|
"author": "Tribufu <contact@Tribufu.com>",
|
||||||
@ -9,26 +9,21 @@
|
|||||||
"types": "./build/index.d.ts",
|
"types": "./build/index.d.ts",
|
||||||
"exports": {
|
"exports": {
|
||||||
"import": "./build/index.mjs",
|
"import": "./build/index.mjs",
|
||||||
"require": "./build/index.cjs",
|
"require": "./build/index.cjs"
|
||||||
"types": "./build/index.d.ts"
|
|
||||||
},
|
|
||||||
"typesVersions": {
|
|
||||||
"*": {
|
|
||||||
"*": [
|
|
||||||
"./build/*"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"clean": "rimraf build",
|
"clean": "rimraf build",
|
||||||
"build": "npm run clean && tsc && node scripts/esbuild.js"
|
"build": "npm run clean && tsc && node scripts/esbuild.js"
|
||||||
},
|
},
|
||||||
"dependencies": {},
|
"peerDependencies": {
|
||||||
|
"@tauri-apps/plugin-http": "^2.0.0"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@tauri-apps/plugin-http": "^2.0.0",
|
||||||
"@types/node": "^20.10.6",
|
"@types/node": "^20.10.6",
|
||||||
"dotenv": "^16.3.1",
|
"dotenv": "^16.3.1",
|
||||||
"esbuild": "^0.19.10",
|
|
||||||
"esbuild-node-externals": "^1.12.0",
|
"esbuild-node-externals": "^1.12.0",
|
||||||
|
"esbuild": "^0.19.10",
|
||||||
"eslint": "9.11.1",
|
"eslint": "9.11.1",
|
||||||
"prettier": "3.3.3",
|
"prettier": "3.3.3",
|
||||||
"rimraf": "^5.0.5",
|
"rimraf": "^5.0.5",
|
||||||
|
1348
pnpm-lock.yaml
generated
1348
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -22,26 +22,12 @@ const moduleConfig = {
|
|||||||
format: "esm",
|
format: "esm",
|
||||||
};
|
};
|
||||||
|
|
||||||
const moduleMinConfig = {
|
|
||||||
...moduleConfig,
|
|
||||||
outfile: "build/index.min.mjs",
|
|
||||||
minify: true,
|
|
||||||
sourcemap: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
const legacyConfig = {
|
const legacyConfig = {
|
||||||
...baseConfig,
|
...baseConfig,
|
||||||
outfile: "build/index.cjs",
|
outfile: "build/index.cjs",
|
||||||
format: "cjs",
|
format: "cjs",
|
||||||
};
|
};
|
||||||
|
|
||||||
const legacyMinConfig = {
|
|
||||||
...legacyConfig,
|
|
||||||
outfile: "build/index.min.cjs",
|
|
||||||
minify: true,
|
|
||||||
sourcemap: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
async function addCopyrightHeader(filename) {
|
async function addCopyrightHeader(filename) {
|
||||||
const header = `// Copyright (c) Tribufu. All Rights Reserved.\n// SPDX-License-Identifier: MIT\n\n`;
|
const header = `// Copyright (c) Tribufu. All Rights Reserved.\n// SPDX-License-Identifier: MIT\n\n`;
|
||||||
const content = await fs.readFile(filename, 'utf-8');
|
const content = await fs.readFile(filename, 'utf-8');
|
||||||
@ -58,8 +44,5 @@ async function buildAndAddHeader(config) {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
await buildAndAddHeader(legacyConfig);
|
|
||||||
await buildAndAddHeader(moduleConfig);
|
await buildAndAddHeader(moduleConfig);
|
||||||
|
await buildAndAddHeader(legacyConfig);
|
||||||
//await buildAndAddHeader(legacyMinConfig);
|
|
||||||
//await buildAndAddHeader(moduleMinConfig);
|
|
||||||
|
@ -18,11 +18,11 @@ export abstract class TribufuApiBase {
|
|||||||
* @returns boolean
|
* @returns boolean
|
||||||
*/
|
*/
|
||||||
public static debugEnabled(): boolean {
|
public static debugEnabled(): boolean {
|
||||||
if (typeof process !== "undefined") {
|
if (!process) {
|
||||||
return process.env.NODE_ENV === "development";
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return process.env.NODE_ENV === "development";
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -66,7 +66,7 @@ export abstract class TribufuApiBase {
|
|||||||
*/
|
*/
|
||||||
protected static defaultHeaders(): HttpHeaders {
|
protected static defaultHeaders(): HttpHeaders {
|
||||||
const headers = {};
|
const headers = {};
|
||||||
headers["X-Tribufu-Library"] = "javascript";
|
headers["X-Tribufu-Language"] = "javascript";
|
||||||
headers["X-Tribufu-Version"] = TRIBUFU_VERSION;
|
headers["X-Tribufu-Version"] = TRIBUFU_VERSION;
|
||||||
return headers;
|
return headers;
|
||||||
}
|
}
|
||||||
@ -92,10 +92,12 @@ export abstract class TribufuApiBase {
|
|||||||
* @returns
|
* @returns
|
||||||
*/
|
*/
|
||||||
protected transformOptions(options: RequestInit) {
|
protected transformOptions(options: RequestInit) {
|
||||||
options.headers = {
|
if (this.apiKey) {
|
||||||
...options.headers,
|
options.headers = {
|
||||||
...this.getHeaders(),
|
...options.headers,
|
||||||
};
|
...this.getHeaders(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
return Promise.resolve(options);
|
return Promise.resolve(options);
|
||||||
}
|
}
|
File diff suppressed because it is too large
Load Diff
1
src/api/api.include.ts
Normal file
1
src/api/api.include.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
import { TribufuApiBase } from "./api.base";
|
@ -4,7 +4,7 @@
|
|||||||
"documentGenerator": {
|
"documentGenerator": {
|
||||||
"fromDocument": {
|
"fromDocument": {
|
||||||
"json": "",
|
"json": "",
|
||||||
"url": "http://localhost:5000/openapi.json",
|
"url": "http://localhost:5000/v1/openapi.json",
|
||||||
"output": null,
|
"output": null,
|
||||||
"newLineBehavior": "Auto"
|
"newLineBehavior": "Auto"
|
||||||
}
|
}
|
||||||
@ -26,7 +26,7 @@
|
|||||||
"nullValue": "Null",
|
"nullValue": "Null",
|
||||||
"generateClientClasses": true,
|
"generateClientClasses": true,
|
||||||
"generateClientInterfaces": false,
|
"generateClientInterfaces": false,
|
||||||
"generateOptionalParameters": true,
|
"generateOptionalParameters": false,
|
||||||
"exportTypes": true,
|
"exportTypes": true,
|
||||||
"wrapDtoExceptions": false,
|
"wrapDtoExceptions": false,
|
||||||
"exceptionClass": "TribufuApiError",
|
"exceptionClass": "TribufuApiError",
|
||||||
@ -41,14 +41,14 @@
|
|||||||
"useTransformResultMethod": false,
|
"useTransformResultMethod": false,
|
||||||
"generateDtoTypes": true,
|
"generateDtoTypes": true,
|
||||||
"operationGenerationMode": "SingleClientFromOperationId",
|
"operationGenerationMode": "SingleClientFromOperationId",
|
||||||
"markOptionalProperties": false,
|
"markOptionalProperties": true,
|
||||||
"generateCloneMethod": false,
|
"generateCloneMethod": false,
|
||||||
"typeStyle": "Interface",
|
"typeStyle": "Interface",
|
||||||
"enumStyle": "Enum",
|
"enumStyle": "Enum",
|
||||||
"useLeafType": false,
|
"useLeafType": false,
|
||||||
"classTypes": [],
|
"classTypes": [],
|
||||||
"extendedClasses": [],
|
"extendedClasses": [],
|
||||||
"extensionCode": "include.ts",
|
"extensionCode": "api.include.ts",
|
||||||
"generateDefaultValues": true,
|
"generateDefaultValues": true,
|
||||||
"excludedTypeNames": [],
|
"excludedTypeNames": [],
|
||||||
"excludedParameterNames": [],
|
"excludedParameterNames": [],
|
||||||
@ -67,7 +67,7 @@
|
|||||||
"templateDirectory": null,
|
"templateDirectory": null,
|
||||||
"serviceHost": null,
|
"serviceHost": null,
|
||||||
"serviceSchemes": null,
|
"serviceSchemes": null,
|
||||||
"output": "generated.ts",
|
"output": "api.generated.ts",
|
||||||
"newLineBehavior": "LF"
|
"newLineBehavior": "LF"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1 +0,0 @@
|
|||||||
import { TribufuApiBase } from "./base";
|
|
@ -2,8 +2,8 @@
|
|||||||
// SPDX-License-Identifier: MIT
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
import { TRIBUFU_API_URL } from "..";
|
import { TRIBUFU_API_URL } from "..";
|
||||||
import { TribufuApiBase } from "./base";
|
import { TribufuApiBase } from "./api.base";
|
||||||
import { TribufuApiGenerated } from "./generated";
|
import { TribufuApiGenerated } from "./api.generated";
|
||||||
import { TribufuApiOptions } from "../options";
|
import { TribufuApiOptions } from "../options";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -44,20 +44,22 @@ export class TribufuApi extends TribufuApiGenerated {
|
|||||||
*
|
*
|
||||||
* - This will only work if the environment variables are set.
|
* - 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
|
* @returns TribufuApi | null
|
||||||
* @example
|
* @example
|
||||||
* ```ts
|
* ```ts
|
||||||
* // process.env.TRIBUFU_API_KEY
|
* // process.env.TRIBUFU_API_KEY
|
||||||
* const api = TribufuApi.fromEnv();
|
* const api = TribufuApi.fromEnv("TRIBUFU");
|
||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
public static fromEnv(prefix?: string | null): TribufuApi | null {
|
public static fromEnv(prefix?: string | null): TribufuApi | null {
|
||||||
if (typeof process === "undefined") {
|
const envPrefix = prefix ? `${prefix}_` : "";
|
||||||
|
|
||||||
|
if (!process) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
const apiKey = process.env[`${prefix || "TRIBUFU"}_API_KEY`];
|
const apiKey = process.env[`${envPrefix}API_KEY`];
|
||||||
|
|
||||||
if (apiKey) {
|
if (apiKey) {
|
||||||
return TribufuApi.withApiKey(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.
|
* - 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
|
* @returns TribufuApi | null
|
||||||
* @example
|
* @example
|
||||||
* ```ts
|
* ```ts
|
||||||
* // process.env.TRIBUFU_API_KEY = null
|
* // process.env.TRIBUFU_API_KEY = null
|
||||||
* const api = TribufuApi.fromEnvOrDefault();
|
* const api = TribufuApi.fromEnvOrDefault("TRIBUFU_");
|
||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
public static fromEnvOrDefault(prefix: string = ""): TribufuApi {
|
public static fromEnvOrDefault(prefix: string = ""): TribufuApi {
|
||||||
@ -93,11 +95,13 @@ export class TribufuApi extends TribufuApiGenerated {
|
|||||||
* @returns string
|
* @returns string
|
||||||
*/
|
*/
|
||||||
protected static getBaseUrl(): string {
|
protected static getBaseUrl(): string {
|
||||||
if (typeof process === "undefined") {
|
if (!process) {
|
||||||
return TRIBUFU_API_URL;
|
return TRIBUFU_API_URL;
|
||||||
}
|
}
|
||||||
|
|
||||||
const baseUrl = process.env[`TRIBUFU_API_URL`] || null;
|
const baseUrl = process.env[`TRIBUFU_API_URL`] || null;
|
||||||
return TribufuApiBase.debugEnabled() && baseUrl ? baseUrl : TRIBUFU_API_URL;
|
return TribufuApiBase.debugEnabled() && baseUrl
|
||||||
|
? baseUrl
|
||||||
|
: TRIBUFU_API_URL;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -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;
|
|
||||||
}
|
|
||||||
}
|
|
21
src/index.ts
21
src/index.ts
@ -8,24 +8,9 @@ import {
|
|||||||
TRIBUFU_WEB_URL,
|
TRIBUFU_WEB_URL,
|
||||||
} from "./constants";
|
} from "./constants";
|
||||||
|
|
||||||
|
export { TRIBUFU_API_URL, TRIBUFU_CDN_URL, TRIBUFU_VERSION, TRIBUFU_WEB_URL };
|
||||||
|
|
||||||
import { TribufuApi } from "./api";
|
import { TribufuApi } from "./api";
|
||||||
import { TribufuApiOptions } from "./options";
|
import { TribufuApiOptions } from "./options";
|
||||||
import { TribufuApiSingleton } from "./api/singletion";
|
|
||||||
|
|
||||||
export {
|
export { TribufuApi, TribufuApiOptions };
|
||||||
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";
|
|
||||||
|
24
src/tauri/api.ts
Normal file
24
src/tauri/api.ts
Normal 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 });
|
||||||
|
}
|
||||||
|
}
|
@ -1,13 +1,12 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"target": "esnext",
|
"target": "ESNext",
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"emitDeclarationOnly": true,
|
"emitDeclarationOnly": true,
|
||||||
"noImplicitAny": false,
|
"noImplicitAny": false,
|
||||||
"moduleResolution": "Node",
|
"moduleResolution": "Node",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"module": "esnext",
|
|
||||||
"allowImportingTsExtensions": true,
|
"allowImportingTsExtensions": true,
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"rootDir": "src",
|
"rootDir": "src",
|
||||||
|
Reference in New Issue
Block a user