cloreai 0.1.0

package/build/CloreAI.d.ts

@@ -0,0 +1,26 @@
+import { type AxiosInstance } from 'axios';
+import { type CancelOrderBody, type CancelOrderOutput } from './types/cloreai/cancelOrder.js';
+import { type CreateOrderBody, type CreateOrderOutput } from './types/cloreai/createOrder.js';
+import { type MarketplaceOutput } from './types/cloreai/marketplace.js';
+import { type MyOrdersOutput, type MyOrdersParams } from './types/cloreai/myOrders.js';
+import { type MyServersOutput } from './types/cloreai/myServers.js';
+import { type ServerConfigBody, type ServerConfigOutput } from './types/cloreai/serverConfig.js';
+import { type SetServerSettingsBody, type SetServerSettingsOutput } from './types/cloreai/setServerSettings.js';
+import { type SetSpotPriceBody, type SetSpotPriceOutput } from './types/cloreai/setSpotPrice.js';
+import { type SpotMarketplaceOutput, type SpotMarketplaceParams } from './types/cloreai/spotMarketplace.js';
+import { type WalletsOutput } from './types/cloreai/wallets.js';
+import { type Options } from './types/options.js';
+export declare class CloreAI {
+    readonly api: AxiosInstance;
+    constructor(options: Options);
+    wallets(): Promise<WalletsOutput>;
+    myServers(): Promise<MyServersOutput>;
+    serverConfig(body: ServerConfigBody): Promise<ServerConfigOutput>;
+    marketplace(): Promise<MarketplaceOutput>;
+    myOrders(params?: MyOrdersParams): Promise<MyOrdersOutput>;
+    spotMarketplace(params: SpotMarketplaceParams): Promise<SpotMarketplaceOutput>;
+    setServerSettings(body: SetServerSettingsBody): Promise<SetServerSettingsOutput>;
+    setSpotPrice(body: SetSpotPriceBody): Promise<SetSpotPriceOutput>;
+    cancelOrder(body: CancelOrderBody): Promise<CancelOrderOutput>;
+    createOrder(body: CreateOrderBody): Promise<CreateOrderOutput>;
+}

package/build/CloreAI.js

@@ -0,0 +1,84 @@
+import axios from 'axios';
+import { statusCodes } from './constants.js';
+import { CustomError, DatabaseError, ExceededError, InvalidApiTokenError, InvalidEndpointError, InvalidInputDataError, UnknownError } from './errors.js';
+export class CloreAI {
+    api;
+    constructor(options) {
+        const { apiKey, axiosConfig = {} } = options;
+        this.api = axios.create({
+            ...axiosConfig,
+            baseURL: 'https://api.clore.ai/v1',
+            headers: {
+                ...axiosConfig.headers,
+                auth: apiKey,
+            },
+        });
+        this.api.interceptors.response.use((response) => {
+            if (response.data.code === statusCodes['NORMAL']) {
+                return response;
+            }
+            const statusCodeMessage = response.data.code != null ? `Status code "${response.data.code}".` : null;
+            const errorFieldMessage = response.data.error != null ? `Error field "${response.data.error}".` : null;
+            const errorMessageArray = [statusCodeMessage, errorFieldMessage].filter((message) => {
+                return message != null;
+            });
+            const errorMessage = errorMessageArray.join(' ');
+            switch (response.data.code) {
+                case statusCodes['DATABASE_ERROR']:
+                    throw new DatabaseError(errorMessage, undefined, response.config, response.request, response);
+                case statusCodes['INVALID_INPUT_DATA']:
+                    throw new InvalidInputDataError(errorMessage, undefined, response.config, response.request, response);
+                case statusCodes['INVALID_API_TOKEN']:
+                    throw new InvalidApiTokenError(errorMessage, undefined, response.config, response.request, response);
+                case statusCodes['INVALID_ENDPOINT']:
+                    throw new InvalidEndpointError(errorMessage, undefined, response.config, response.request, response);
+                case statusCodes['EXCEEDED']:
+                    throw new ExceededError(errorMessage, undefined, response.config, response.request, response);
+                case statusCodes['ERROR']:
+                    throw new CustomError(errorMessage, undefined, response.config, response.request, response);
+                default:
+                    throw new UnknownError(errorMessage, undefined, response.config, response.request, response);
+            }
+        });
+    }
+    async wallets() {
+        const response = await this.api.get('/wallets');
+        return response.data;
+    }
+    async myServers() {
+        const response = await this.api.get('/my_servers');
+        return response.data;
+    }
+    async serverConfig(body) {
+        const response = await this.api.get('/server_config', { data: body });
+        return response.data;
+    }
+    async marketplace() {
+        const response = await this.api.get('/marketplace');
+        return response.data;
+    }
+    async myOrders(params) {
+        const response = await this.api.get('/my_orders', { params });
+        return response.data;
+    }
+    async spotMarketplace(params) {
+        const response = await this.api.get('/spot_marketplace', { params });
+        return response.data;
+    }
+    async setServerSettings(body) {
+        const response = await this.api.post('/set_server_settings', body);
+        return response.data;
+    }
+    async setSpotPrice(body) {
+        const response = await this.api.post('/set_spot_price', body);
+        return response.data;
+    }
+    async cancelOrder(body) {
+        const response = await this.api.post('/cancel_order', body);
+        return response.data;
+    }
+    async createOrder(body) {
+        const response = await this.api.post('/create_order', body);
+        return response.data;
+    }
+}

package/build/WebAPI.d.ts

@@ -0,0 +1,10 @@
+import { type AxiosInstance } from 'axios';
+import { type WebOptions } from './types/options.js';
+import { type WebCreateOrderBody, type WebCreateOrderOutput } from './types/webapi/createOrder.js';
+import { type WebMarketplaceServersOutput } from './types/webapi/marketplaceServers.js';
+export declare class WebAPI {
+    readonly api: AxiosInstance;
+    constructor(options: WebOptions);
+    marketplaceServers(): Promise<WebMarketplaceServersOutput>;
+    createOrder(body: WebCreateOrderBody): Promise<WebCreateOrderOutput>;
+}

package/build/WebAPI.js

@@ -0,0 +1,40 @@
+import axios from 'axios';
+import { webStatusCodes } from './constants.js';
+import { UnknownError } from './errors.js';
+export class WebAPI {
+    api;
+    constructor(options) {
+        const { token, axiosConfig = {} } = options;
+        this.api = axios.create({
+            ...axiosConfig,
+            baseURL: 'https://clore.ai/webapi',
+        });
+        this.api.interceptors.request.use((request) => {
+            request.data = {
+                ...request.data,
+                token,
+            };
+            return request;
+        });
+        this.api.interceptors.response.use((response) => {
+            if (response.data.status === webStatusCodes['NORMAL']) {
+                return response;
+            }
+            const statusCodeMessage = response.data.status != null ? `Status code "${response.data.status}".` : null;
+            const errorFieldMessage = response.data.error != null ? `Error field "${response.data.error}".` : null;
+            const errorMessageArray = [statusCodeMessage, errorFieldMessage].filter((message) => {
+                return message != null;
+            });
+            const errorMessage = errorMessageArray.join(' ');
+            throw new UnknownError(errorMessage, undefined, response.config, response.request, response);
+        });
+    }
+    async marketplaceServers() {
+        const response = await this.api.post('/marketplace/servers');
+        return response.data;
+    }
+    async createOrder(body) {
+        const response = await this.api.post('/create_order', body);
+        return response.data;
+    }
+}

package/build/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const GLOBAL_RATE_LIMIT = 1000;
+export declare const CREATE_ORDER_RATE_LIMIT = 5000;
+export declare const statusCodes: Record<string, number>;
+export declare const webStatusCodes: Record<string, string>;

package/build/constants.js

@@ -0,0 +1,14 @@
+export const GLOBAL_RATE_LIMIT = 1_000;
+export const CREATE_ORDER_RATE_LIMIT = 5_000;
+export const statusCodes = {
+    NORMAL: 0,
+    DATABASE_ERROR: 1,
+    INVALID_INPUT_DATA: 2,
+    INVALID_API_TOKEN: 3,
+    INVALID_ENDPOINT: 4,
+    EXCEEDED: 5,
+    ERROR: 6,
+};
+export const webStatusCodes = {
+    NORMAL: 'ok',
+};

package/build/errors.d.ts

@@ -0,0 +1,23 @@
+import { AxiosError } from 'axios';
+export type AxiosErrorParameters = ConstructorParameters<typeof AxiosError>;
+export declare class DatabaseError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class InvalidInputDataError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class InvalidApiTokenError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class InvalidEndpointError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class ExceededError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class CustomError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}
+export declare class UnknownError extends AxiosError {
+    constructor(...args: AxiosErrorParameters);
+}

package/build/errors.js

@@ -0,0 +1,43 @@
+import { AxiosError } from 'axios';
+export class DatabaseError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'DatabaseError';
+    }
+}
+export class InvalidInputDataError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'InvalidInputDataError';
+    }
+}
+export class InvalidApiTokenError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'InvalidApiTokenError';
+    }
+}
+export class InvalidEndpointError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'InvalidEndpointError';
+    }
+}
+export class ExceededError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'ExceededError';
+    }
+}
+export class CustomError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'CustomError';
+    }
+}
+export class UnknownError extends AxiosError {
+    constructor(...args) {
+        super(...args);
+        this.name = 'UnknownError';
+    }
+}

package/build/index.d.ts

@@ -0,0 +1,19 @@
+export { CloreAI as default } from './CloreAI.js';
+export * from './constants.js';
+export * from './errors.js';
+export * from './types/cloreai/cancelOrder.js';
+export * from './types/cloreai/createOrder.js';
+export * from './types/cloreai/marketplace.js';
+export * from './types/cloreai/myOrders.js';
+export * from './types/cloreai/myServers.js';
+export * from './types/cloreai/serverConfig.js';
+export * from './types/cloreai/setServerSettings.js';
+export * from './types/cloreai/setSpotPrice.js';
+export * from './types/cloreai/spotMarketplace.js';
+export * from './types/cloreai/wallets.js';
+export * from './types/common.js';
+export * from './types/options.js';
+export * from './types/output.js';
+export * from './types/webapi/createOrder.js';
+export * from './types/webapi/marketplaceServers.js';
+export * from './WebAPI.js';

package/build/index.js

@@ -0,0 +1,19 @@
+export { CloreAI as default } from './CloreAI.js';
+export * from './constants.js';
+export * from './errors.js';
+export * from './types/cloreai/cancelOrder.js';
+export * from './types/cloreai/createOrder.js';
+export * from './types/cloreai/marketplace.js';
+export * from './types/cloreai/myOrders.js';
+export * from './types/cloreai/myServers.js';
+export * from './types/cloreai/serverConfig.js';
+export * from './types/cloreai/setServerSettings.js';
+export * from './types/cloreai/setSpotPrice.js';
+export * from './types/cloreai/spotMarketplace.js';
+export * from './types/cloreai/wallets.js';
+export * from './types/common.js';
+export * from './types/options.js';
+export * from './types/output.js';
+export * from './types/webapi/createOrder.js';
+export * from './types/webapi/marketplaceServers.js';
+export * from './WebAPI.js';

package/build/types/cloreai/cancelOrder.d.ts

@@ -0,0 +1,7 @@
+import { type Output } from '../output.js';
+export interface CancelOrderBody {
+    id: number;
+    issue?: string;
+}
+export interface CancelOrderOutput extends Output {
+}

package/build/types/cloreai/cancelOrder.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/createOrder.d.ts

@@ -0,0 +1,25 @@
+import { type Currency } from '../common.js';
+import { type Output } from '../output.js';
+export interface CreateOrderCommon {
+    currency: Currency;
+    image: string;
+    renting_server: number;
+    ports?: Record<string, string>;
+    env?: Record<string, string>;
+    jupyter_token?: string;
+    ssh_key?: string;
+    ssh_password?: string;
+    command?: string;
+    required_price?: number;
+    autossh_entrypoint?: boolean;
+}
+export interface CreateOrderOnDemand extends CreateOrderCommon {
+    type: 'on-demand';
+}
+export interface CreateOrderSpot extends CreateOrderCommon {
+    type: 'spot';
+    spotprice: number;
+}
+export type CreateOrderBody = CreateOrderOnDemand | CreateOrderSpot;
+export interface CreateOrderOutput extends Output {
+}

package/build/types/cloreai/createOrder.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/marketplace.d.ts

@@ -0,0 +1,14 @@
+import { type Price, type Specs } from '../common.js';
+import { type Output } from '../output.js';
+export interface MarketplaceServer {
+    id: number;
+    owner: number;
+    mrl: number;
+    price: Price;
+    rented: boolean;
+    specs: Specs;
+}
+export interface MarketplaceOutput extends Output {
+    servers: MarketplaceServer[];
+    my_servers: number[];
+}

package/build/types/cloreai/marketplace.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/myOrders.d.ts

@@ -0,0 +1,28 @@
+import { type Currency, type Specs } from '../common.js';
+import { type Output } from '../output.js';
+export interface MyOrdersParams {
+    return_completed?: boolean;
+}
+export interface MyOrdersOrder {
+    id: number;
+    fee: number;
+    creation_fee: number;
+    price: number;
+    mrl: number;
+    image: string;
+    currency: Currency;
+    spend: number;
+    ct: number;
+    p: number;
+    specs: Specs;
+    si: number;
+    pub_cluster: string[];
+    tcp_ports: string[];
+    http_port: string;
+    spot: boolean;
+    expired: boolean;
+}
+export interface MyOrdersOutput extends Output {
+    orders: MyOrdersOrder[];
+    limit: number;
+}

package/build/types/cloreai/myOrders.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/myServers.d.ts

@@ -0,0 +1,16 @@
+import { type Pricing, type Specs, type Visibility } from '../common.js';
+import { type Output } from '../output.js';
+export interface MyServersServer {
+    name: string;
+    connected: boolean;
+    visibility: Visibility;
+    pricing: Pricing;
+    online: boolean;
+    min_spot_pricing: Pricing;
+    init_token: string;
+    specs: Specs;
+}
+export interface MyServersOutput extends Output {
+    servers: MyServersServer[];
+    limit: number;
+}

package/build/types/cloreai/myServers.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/serverConfig.d.ts

@@ -0,0 +1,29 @@
+import { type Pricing, type Specs, type Visibility } from '../common.js';
+import { type Output } from '../output.js';
+export interface ServerConfigBody {
+    server_name: string;
+}
+export interface ServerConfigConfigBackgroundJob {
+    times_updated: number;
+    image: string;
+    command: string;
+    env: Record<string, string>;
+}
+export interface ServerConfigConfig {
+    name: string;
+    connected: boolean;
+    visibility: Visibility;
+    pricing: Pricing;
+    spot_pricing: Pricing;
+    mrl: number;
+    online: boolean;
+    initialized: boolean;
+    id: number;
+    rental_status: number;
+    specs: Specs;
+    background_job: ServerConfigConfigBackgroundJob;
+}
+export interface ServerConfigOutput extends Output {
+    config: ServerConfigConfig;
+    creation_completed: boolean;
+}

package/build/types/cloreai/serverConfig.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/setServerSettings.d.ts

@@ -0,0 +1,10 @@
+import { type Output } from '../output.js';
+export interface SetServerSettingsBody {
+    name: string;
+    availability: boolean;
+    mrl: number;
+    on_demand: number;
+    spot: number;
+}
+export interface SetServerSettingsOutput extends Output {
+}

package/build/types/cloreai/setServerSettings.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/setSpotPrice.d.ts

@@ -0,0 +1,17 @@
+import { type Output } from '../output.js';
+export interface SetSpotPriceBody {
+    order_id: number;
+    desired_price: number;
+}
+export interface SetSpotPriceMaxStep extends Output {
+    error: 'exceeded_max_step';
+    max_step: number;
+}
+export interface SetSpotPriceTimeToLowering extends Output {
+    error: 'can_lower_every_600_seconds';
+    time_to_lowering: number;
+}
+export interface SetSpotPriceSuccess extends Output {
+    error: undefined;
+}
+export type SetSpotPriceOutput = SetSpotPriceMaxStep | SetSpotPriceTimeToLowering | SetSpotPriceSuccess;

package/build/types/cloreai/setSpotPrice.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/spotMarketplace.d.ts

@@ -0,0 +1,25 @@
+import { type Pricing, type Visibility } from '../common.js';
+import { type Output } from '../output.js';
+export interface SpotMarketplaceParams {
+    market: number;
+}
+export interface SpotMarketplaceMarketOffer {
+    offer_id: number;
+    bid: number;
+    active: boolean;
+    my: boolean;
+}
+export interface SpotMarketplaceMarketServer {
+    min_pricing: Pricing;
+    mrl: number;
+    visibility: Visibility;
+    online: boolean;
+}
+export interface SpotMarketplaceMarket {
+    offers: SpotMarketplaceMarketOffer[];
+    server: SpotMarketplaceMarketServer;
+}
+export interface SpotMarketplaceOutput extends Output {
+    market: SpotMarketplaceMarket;
+    exists: boolean;
+}

package/build/types/cloreai/spotMarketplace.js

@@ -0,0 +1 @@
+export {};

package/build/types/cloreai/wallets.d.ts

@@ -0,0 +1,11 @@
+import { type Currency } from '../common.js';
+import { type Output } from '../output.js';
+export interface WalletsWallet {
+    name: Currency;
+    deposit: string;
+    balance: number;
+    withdrawal_fee: number;
+}
+export interface WalletsOutput extends Output {
+    wallets: WalletsWallet[];
+}

package/build/types/cloreai/wallets.js

@@ -0,0 +1 @@
+export {};

package/build/types/common.d.ts

@@ -0,0 +1,30 @@
+export type OrderType = 'on-demand' | 'spot';
+export type Visibility = 'public' | 'hidden';
+export type Currency = 'CLORE-Blockchain' | 'bitcoin';
+export type Pricing = Record<Currency, number>;
+export interface Price {
+    on_demand: Pricing;
+    spot: Pricing;
+}
+export interface Net {
+    cc: string;
+    down: number;
+    up: number;
+}
+export interface Specs {
+    mb: string;
+    cpu: string;
+    cpus: string;
+    ram: number;
+    disk: string;
+    disk_speed: number;
+    gpu: string;
+    gpuram: number;
+    net: Net;
+    backend_version: number;
+    pcie_rev: number;
+    pcie_width: number;
+    pl: number[];
+    stock_oc_override: boolean;
+    stock_pl: number[];
+}

package/build/types/common.js

@@ -0,0 +1 @@
+export {};

package/build/types/options.d.ts

@@ -0,0 +1,10 @@
+import { type CreateAxiosDefaults } from 'axios';
+export interface CommonOptions {
+    axiosConfig?: CreateAxiosDefaults;
+}
+export interface Options extends CommonOptions {
+    apiKey: string;
+}
+export interface WebOptions extends CommonOptions {
+    token: string;
+}

package/build/types/options.js

@@ -0,0 +1 @@
+export {};

package/build/types/output.d.ts

@@ -0,0 +1,9 @@
+export interface CommonOutput<T = string> {
+    error?: T | undefined;
+}
+export interface Output<T = string> extends CommonOutput<T> {
+    code: number;
+}
+export interface WebOutput<T = string> extends CommonOutput<T> {
+    status: string;
+}

package/build/types/output.js

@@ -0,0 +1 @@
+export {};

package/build/types/webapi/createOrder.d.ts

@@ -0,0 +1,5 @@
+import { type CreateOrderBody } from '../cloreai/createOrder.js';
+import { type WebOutput } from '../output.js';
+export type WebCreateOrderBody = CreateOrderBody;
+export interface WebCreateOrderOutput extends WebOutput {
+}

package/build/types/webapi/createOrder.js

@@ -0,0 +1 @@
+export {};

package/build/types/webapi/marketplaceServers.d.ts

@@ -0,0 +1,25 @@
+import { type Currency, type Price, type Specs } from '../common.js';
+import { type WebOutput } from '../output.js';
+export interface WebMarketplaceServersServerRating {
+    avg: number;
+    cnt: number;
+}
+export interface WebMarketplaceServersServer {
+    id: number;
+    owner: number;
+    mrl: number;
+    price: Price;
+    rented: boolean;
+    specs: Specs;
+    reliability: number;
+    allowed_coins: Currency[];
+    rating: WebMarketplaceServersServerRating;
+    cuda_version: string;
+}
+export interface WebMarketplaceServersOutput extends WebOutput {
+    all_servers: WebMarketplaceServersServer[];
+    creation_fees: number;
+    disable_usd: number;
+    my_servers: number;
+    not_rented_available_servers: number;
+}

package/build/types/webapi/marketplaceServers.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "cloreai",
+  "version": "0.1.0",
+  "description": "CLORE.AI API client",
+  "keywords": [
+    "cloreai",
+    "clore",
+    "api"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vladpuz/cloreai.git"
+  },
+  "license": "MIT",
+  "author": "Vladislav Puzyrev",
+  "type": "module",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "check": "npm run typecheck && npm run lint && npm run format",
+    "clean": "rimraf build",
+    "format": "prettier --check .",
+    "lint": "eslint .",
+    "prepack": "npm run clean && npm run build && npm run check",
+    "prepare": "husky",
+    "start-playground": "node playground/main.js",
+    "typecheck": "tsc --noEmit",
+    "update-check": "npm-check-updates --peer",
+    "update-latest": "npm-check-updates --peer --upgrade --target latest",
+    "update-minor": "npm-check-updates --peer --upgrade --target minor"
+  },
+  "dependencies": {
+    "axios": "^1.7.2"
+  },
+  "devDependencies": {
+    "@tsconfig/strictest": "^2.0.5",
+    "eslint": "^8.57.0",
+    "eslint-config-vladpuz": "^0.7.0",
+    "husky": "^9.0.11",
+    "npm-check-updates": "^16.14.20",
+    "prettier": "^3.3.3",
+    "prettier-config-vladpuz": "^0.3.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.5.3"
+  }
+}