cloreai 1.0.1 → 2.0.0

package/README.md

@@ -2,37 +2,37 @@
 
 > CLORE.AI API client
 
-Особенности:
+Features:
 
-- Базируется на [axios](https://github.com/axios/axios)
-- Защищает от превышения rate limit (ошибки 429) через
+- Based on [axios](https://github.com/axios/axios)
+- Protects from rate limit exceeded (429 errors) via
   [p-queue](https://github.com/sindresorhus/p-queue)
-- Поддерживает GigaSPOT
+- Error handling via try...catch and instanceof
+- Supports GigaSPOT
 
-Официальная документация: [clore.ai/api-docs](https://clore.ai/api-docs)
+Official documentation: [clore.ai/api-docs](https://clore.ai/api-docs)
 
-Официальная документация GigaSPOT:
+Official GigaSPOT documentation:
 [gigaspot-api-docs.clore.ai](https://gigaspot-api-docs.clore.ai)
 
-## Установка
+## Installation
 
 ```shell
 npm install cloreai
 ```
 
-## Использование
+## Usage
 
-### Создание экземпляра
+### Creating an instance
 
 ```typescript
 import CloreAI from 'cloreai'
 
-const cloreai = new CloreAI({
-  apiKey: '<API_KEY>', // (required)
+const cloreai = new CloreAI('<API_KEY>', {
   axiosOptions: {}, // (optional) Axios instance options https://github.com/axios/axios
   queueOptions: {}, // (optional) Queue instance options https://github.com/sindresorhus/p-queue
   queueOptionsCreateOrder: {}, // (optional) Create order queue instance options https://github.com/sindresorhus/p-queue
-  queueOptionsGigaspot: {}, //  (optional) Gigaspot queue instance options https://github.com/sindresorhus/p-queue
+  queueOptionsGigaspot: {}, // (optional) Gigaspot queue instance options https://github.com/sindresorhus/p-queue
 })
 ```
 
@@ -184,10 +184,10 @@ await cloreai.gigaspot.cancelOrders({
 })
 ```
 
-### Конфигурация запросов
+### Request Configuration
 
-Каждый метод принимает опциональную конфигурацию запроса для axios последним
-параметром, например:
+All methods accept an optional request configuration for axios as the last
+parameter, for example:
 
 ```typescript
 const marketplace = await cloreai.marketplace({
@@ -195,25 +195,25 @@ const marketplace = await cloreai.marketplace({
 })
 ```
 
-### Доступ к экземпляру axios
+### Access to axios instance
 
-Используйте поле `cloreai.axios`.
+Use the field `cloreai.axios`.
 
-Обратитесь к документации [axios](https://github.com/axios/axios).
+Refer to the documentation [axios](https://github.com/axios/axios).
 
-### Доступ к экземплярам p-queue
+### Access to p-queue instances
 
-Используйте поля:
+Use the fields:
 
-- `cloreai.queue` - для основной очереди запросов
-- `cloreai.queueCreateOrder` - для очереди запросов createOrder
-- `cloreai.gigaspot.queue` - для очереди запросов gigaspot
+- `cloreai.queue` - for main request queue
+- `cloreai.queueCreateOrder` - for createOrder request queue
+- `cloreai.gigaspot.queue` - for gigaspot request queue
 
-Обратитесь к документации [p-queue](https://github.com/sindresorhus/p-queue).
+Refer to the documentation [p-queue](https://github.com/sindresorhus/p-queue).
 
-### Обработка ошибок
+### Error Handling
 
-Библиотека экспортирует следующие виды ошибок:
+The library exports the following error types:
 
 - `DatabaseError`
 - `InvalidInputDataError`
@@ -223,9 +223,9 @@ const marketplace = await cloreai.marketplace({
 - `OtherError`
 - `UnknownError`
 
-Все эти ошибки наследуются от `AxiosError`.
+All these errors inherit from `AxiosError`.
 
-Проверяйте тип ошибки через оператор `instanceof`:
+Check the error type via the `instanceof` operator:
 
 ```typescript
 import { AxiosError } from 'axios'
@@ -236,23 +236,23 @@ try {
 } catch (error) {
   if (error instanceof AxiosError) {
     console.log('AxiosError')
+  }
 
-    if (error instanceof ExceededError) {
-      console.log('ExceededError')
-    }
-  } else {
-    throw error
+  if (error instanceof ExceededError) {
+    console.log('ExceededError')
   }
+
+  throw error
 }
 ```
 
 ### Rate limit
 
-Все методы защищены от превышения rate limit через
-[p-queue](https://github.com/sindresorhus/p-queue), они автоматически
-задерживаются на нужное время, чтобы избежать превышения лимита.
+All methods are protected from rate limit exceeded via
+[p-queue](https://github.com/sindresorhus/p-queue), they automatically pause for
+the required time to avoid exceeding the limit.
 
-Значения rate limit по умолчанию доступны как константы:
+Default rate limit values are available as constants:
 
 ```typescript
 import {
@@ -266,21 +266,20 @@ console.log(RATE_LIMIT_CREATE_ORDER)
 console.log(RATE_LIMIT_GIGASPOT)
 ```
 
-Можно задать собственные значение rate limit для каждой очереди запросов:
+You can set your own rate limit values for each request queue:
 
 ```typescript
 import CloreAI from 'cloreai'
 
-const cloreai = new CloreAI({
-  apiKey: '<API_KEY>',
+const cloreai = new CloreAI('<API_KEY>', {
   queueOptions: {
-    interval: 10000, // 10 seconds
+    interval: 2000, // For example 2 seconds
   },
   queueOptionsCreateOrder: {
-    interval: 10000, // 10 seconds
+    interval: 6000, // For example 6 seconds
   },
   queueOptionsGigaspot: {
-    interval: 10000, // 10 seconds
+    interval: 2000, // For example 2 seconds
   },
 })
 ```

package/build/CloreAI.d.ts

@@ -1,24 +1,24 @@
 import { type AxiosInstance, type AxiosRequestConfig } from 'axios';
 import PQueue from 'p-queue';
-import type { CancelOrderRequestData, CancelOrderResponseData } from './endpoints/cancelOrder.js';
-import type { CreateOrderRequestData, CreateOrderResponseData } from './endpoints/createOrder.js';
-import type { MarketplaceResponseData } from './endpoints/marketplace.js';
-import type { MyOrdersRequestParams, MyOrdersResponseData } from './endpoints/myOrders.js';
-import type { MyServersResponseData } from './endpoints/myServers.js';
-import type { PohBalanceResponseData } from './endpoints/pohBalance.js';
-import type { ServerConfigRequestData, ServerConfigResponseData } from './endpoints/serverConfig.js';
-import type { SetServerSettingsRequestData, SetServerSettingsResponseData } from './endpoints/setServerSettings.js';
-import type { SetSpotPriceRequestData, SetSpotPriceResponseData } from './endpoints/setSpotPrice.js';
-import type { SpotMarketplaceRequestParams, SpotMarketplaceResponseData } from './endpoints/spotMarketplace.js';
-import type { WalletsResponseData } from './endpoints/wallets.js';
-import type { Config } from './types.js';
+import type { CancelOrderRequestData, CancelOrderResponseData } from './resources/cancelOrder.js';
+import type { CreateOrderRequestData, CreateOrderResponseData } from './resources/createOrder.js';
+import type { MarketplaceResponseData } from './resources/marketplace.js';
+import type { MyOrdersRequestParams, MyOrdersResponseData } from './resources/myOrders.js';
+import type { MyServersResponseData } from './resources/myServers.js';
+import type { PohBalanceResponseData } from './resources/pohBalance.js';
+import type { ServerConfigRequestData, ServerConfigResponseData } from './resources/serverConfig.js';
+import type { SetServerSettingsRequestData, SetServerSettingsResponseData } from './resources/setServerSettings.js';
+import type { SetSpotPriceRequestData, SetSpotPriceResponseData } from './resources/setSpotPrice.js';
+import type { SpotMarketplaceRequestParams, SpotMarketplaceResponseData } from './resources/spotMarketplace.js';
+import type { WalletsResponseData } from './resources/wallets.js';
+import type { Options } from './types.js';
 import Gigaspot from './Gigaspot.js';
 declare class CloreAI {
     axios: AxiosInstance;
     queue: PQueue;
     queueCreateOrder: PQueue;
     gigaspot: Gigaspot;
-    constructor(config: Config);
+    constructor(apiKey: string, options?: Options);
     wallets(config?: AxiosRequestConfig): Promise<WalletsResponseData>;
     myServers(config?: AxiosRequestConfig): Promise<MyServersResponseData>;
     serverConfig(data: ServerConfigRequestData, config?: AxiosRequestConfig): Promise<ServerConfigResponseData>;

package/build/CloreAI.js

@@ -1,33 +1,33 @@
 import axios from 'axios';
 import PQueue from 'p-queue';
-import { RATE_LIMIT, RATE_LIMIT_CREATE_ORDER } from './constants.js';
+import { priorityLevels, RATE_LIMIT, RATE_LIMIT_CREATE_ORDER, statusCodes } from './constants.js';
 import { DatabaseError, ExceededError, InvalidApiTokenError, InvalidEndpointError, InvalidInputDataError, OtherError, UnknownError } from './errors.js';
+import { getQueueOptions } from './getQueueOptions.js';
 import Gigaspot from './Gigaspot.js';
-import { getQueueOptions, priorityLevels, statusCodes } from './helpers.js';
 class CloreAI {
     axios;
     queue;
     queueCreateOrder;
     gigaspot;
-    constructor(config) {
+    constructor(apiKey, options = {}) {
         this.queue = new PQueue({
             interval: RATE_LIMIT,
             intervalCap: 1,
             concurrency: 1,
-            ...config.queueOptions,
+            ...options.queueOptions,
         });
         this.queueCreateOrder = new PQueue({
             interval: RATE_LIMIT_CREATE_ORDER,
             intervalCap: 1,
             concurrency: 1,
-            ...config.queueOptionsCreateOrder,
+            ...options.queueOptionsCreateOrder,
         });
         this.axios = axios.create({
-            ...config.axiosOptions,
+            ...options.axiosOptions,
             baseURL: 'https://api.clore.ai/v1',
         });
         this.axios.interceptors.request.use((request) => {
-            request.headers.set('auth', config.apiKey);
+            request.headers.set('auth', apiKey);
             return request;
         });
         this.axios.interceptors.response.use((response) => {
@@ -61,7 +61,7 @@ class CloreAI {
                     throw new UnknownError(...axiosErrorParameters);
             }
         });
-        this.gigaspot = new Gigaspot(config, this.axios);
+        this.gigaspot = new Gigaspot(options, this.axios);
     }
     async wallets(config) {
         const response = await this.queue.add(async () => {

package/build/Gigaspot.d.ts

@@ -1,14 +1,14 @@
 import { type AxiosInstance, type AxiosRequestConfig } from 'axios';
 import PQueue from 'p-queue';
-import type { CancelOrdersRequestData, CancelOrdersResponseData } from './endpoints/cancelOrders.js';
-import type { CreateGigaspotOrdersRequestData, CreateGigaspotOrdersResponseData } from './endpoints/createGigaspotOrders.js';
-import type { EditGigaspotOrdersRequestData, EditGigaspotOrdersResponseData } from './endpoints/editGigaspotOrders.js';
-import type { GetGigaspotResponseData } from './endpoints/getGigaspot.js';
-import type { Config } from './types.js';
+import type { CancelOrdersRequestData, CancelOrdersResponseData } from './resources/cancelOrders.js';
+import type { CreateGigaspotOrdersRequestData, CreateGigaspotOrdersResponseData } from './resources/createGigaspotOrders.js';
+import type { EditGigaspotOrdersRequestData, EditGigaspotOrdersResponseData } from './resources/editGigaspotOrders.js';
+import type { GetGigaspotResponseData } from './resources/getGigaspot.js';
+import type { Options } from './types.js';
 declare class Gigaspot {
     queue: PQueue;
-    private readonly axios;
-    constructor(config: Config, axios: AxiosInstance);
+    private axios;
+    constructor(options: Options, axios: AxiosInstance);
     getGigaspot(config?: AxiosRequestConfig): Promise<GetGigaspotResponseData>;
     createGigaspotOrders(data: CreateGigaspotOrdersRequestData, config?: AxiosRequestConfig): Promise<CreateGigaspotOrdersResponseData>;
     editGigaspotOrders(data: EditGigaspotOrdersRequestData, config?: AxiosRequestConfig): Promise<EditGigaspotOrdersResponseData>;

package/build/Gigaspot.js

@@ -1,16 +1,16 @@
 import axios from 'axios';
 import PQueue from 'p-queue';
-import { RATE_LIMIT_GIGASPOT } from './constants.js';
-import { getQueueOptions, priorityLevels } from './helpers.js';
+import { priorityLevels, RATE_LIMIT_GIGASPOT } from './constants.js';
+import { getQueueOptions } from './getQueueOptions.js';
 class Gigaspot {
     queue;
     axios;
-    constructor(config, axios) {
+    constructor(options, axios) {
         this.queue = new PQueue({
             interval: RATE_LIMIT_GIGASPOT,
             intervalCap: 1,
             concurrency: 1,
-            ...config.queueOptionsGigaspot,
+            ...options.queueOptionsGigaspot,
         });
         this.axios = axios;
     }

package/build/constants.d.ts

@@ -5,3 +5,17 @@ export declare const gigaspotBaseImages: {
     UBUNTU: string;
     HIVEOS: string;
 };
+export declare const statusCodes: {
+    NORMAL: number;
+    DATABASE_ERROR: number;
+    INVALID_INPUT_DATA: number;
+    INVALID_API_TOKEN: number;
+    INVALID_ENDPOINT: number;
+    EXCEEDED: number;
+    OTHER: number;
+};
+export declare const priorityLevels: {
+    NORMAL: number;
+    HIGH: number;
+    HIGHEST: number;
+};

package/build/constants.js

@@ -5,3 +5,17 @@ export const gigaspotBaseImages = {
     UBUNTU: 'a3f9c4d7e5b088d8a0bff880',
     HIVEOS: 'c9a4e2f6b7d488d8f0bab0ff',
 };
+export const statusCodes = {
+    NORMAL: 0,
+    DATABASE_ERROR: 1,
+    INVALID_INPUT_DATA: 2,
+    INVALID_API_TOKEN: 3,
+    INVALID_ENDPOINT: 4,
+    EXCEEDED: 5,
+    OTHER: 6,
+};
+export const priorityLevels = {
+    NORMAL: 0,
+    HIGH: 1,
+    HIGHEST: 2,
+};

package/build/getQueueOptions.d.ts

@@ -0,0 +1,5 @@
+import type { AxiosRequestConfig } from 'axios';
+import type { QueueAddOptions } from 'p-queue';
+export declare function getQueueOptions(priority: number, config?: AxiosRequestConfig): QueueAddOptions & {
+    throwOnTimeout: true;
+};

package/build/{helpers.js → getQueueOptions.js}

@@ -1,17 +1,3 @@
-export const statusCodes = {
-    NORMAL: 0,
-    DATABASE_ERROR: 1,
-    INVALID_INPUT_DATA: 2,
-    INVALID_API_TOKEN: 3,
-    INVALID_ENDPOINT: 4,
-    EXCEEDED: 5,
-    OTHER: 6,
-};
-export const priorityLevels = {
-    NORMAL: 0,
-    HIGH: 1,
-    HIGHEST: 2,
-};
 export function getQueueOptions(priority, config) {
     const defaultQueueOptions = {
         throwOnTimeout: true,

package/build/index.d.ts

@@ -1,20 +1,20 @@
 import CloreAI from './CloreAI.js';
 export * from './constants.js';
-export type * from './endpoints/cancelOrder.js';
-export type * from './endpoints/cancelOrders.js';
-export type * from './endpoints/createGigaspotOrders.js';
-export type * from './endpoints/createOrder.js';
-export type * from './endpoints/editGigaspotOrders.js';
-export type * from './endpoints/getGigaspot.js';
-export type * from './endpoints/marketplace.js';
-export type * from './endpoints/myOrders.js';
-export type * from './endpoints/myServers.js';
-export type * from './endpoints/pohBalance.js';
-export type * from './endpoints/serverConfig.js';
-export type * from './endpoints/setServerSettings.js';
-export type * from './endpoints/setSpotPrice.js';
-export type * from './endpoints/spotMarketplace.js';
-export type * from './endpoints/wallets.js';
 export * from './errors.js';
+export type * from './resources/cancelOrder.js';
+export type * from './resources/cancelOrders.js';
+export type * from './resources/createGigaspotOrders.js';
+export type * from './resources/createOrder.js';
+export type * from './resources/editGigaspotOrders.js';
+export type * from './resources/getGigaspot.js';
+export type * from './resources/marketplace.js';
+export type * from './resources/myOrders.js';
+export type * from './resources/myServers.js';
+export type * from './resources/pohBalance.js';
+export type * from './resources/serverConfig.js';
+export type * from './resources/setServerSettings.js';
+export type * from './resources/setSpotPrice.js';
+export type * from './resources/spotMarketplace.js';
+export type * from './resources/wallets.js';
 export type * from './types.js';
 export default CloreAI;

package/build/{endpoints → resources}/marketplace.d.ts

@@ -11,7 +11,7 @@ export interface MarketplaceResponseDataServer {
     allowed_coins: Currency[];
     rating: Rating;
     gpu_array: string[];
-    gigaspot: boolean;
+    gigaspot?: boolean;
     oc?: boolean;
     cuda_version: string;
 }

package/build/{endpoints → resources}/myOrders.d.ts

@@ -26,10 +26,10 @@ export interface MyOrdersResponseDataOrder {
     rating: Rating;
     reliability: number;
     owner: number;
-    cuda_version: number;
+    cuda_version: string;
     gpu_array: string[];
-    spot: boolean;
-    expired: boolean;
+    spot?: boolean;
+    expired?: boolean;
 }
 export interface MyOrdersResponseData extends ResponseData {
     orders: MyOrdersResponseDataOrder[];

package/build/types.d.ts

@@ -1,12 +1,11 @@
 import type { CreateAxiosDefaults } from 'axios';
-import type { Options, Queue, QueueAddOptions } from 'p-queue';
-export type PQueueOptions = Options<Queue<() => Promise<unknown>, QueueAddOptions>, QueueAddOptions>;
-export interface Config {
-    apiKey: string;
+import type { Options as PQueueOptions, Queue, QueueAddOptions } from 'p-queue';
+export type QueueOptions = PQueueOptions<Queue<() => Promise<unknown>, QueueAddOptions>, QueueAddOptions>;
+export interface Options {
     axiosOptions?: CreateAxiosDefaults;
-    queueOptions?: PQueueOptions;
-    queueOptionsCreateOrder?: PQueueOptions;
-    queueOptionsGigaspot?: PQueueOptions;
+    queueOptions?: QueueOptions;
+    queueOptionsCreateOrder?: QueueOptions;
+    queueOptionsGigaspot?: QueueOptions;
 }
 export interface ResponseData {
     code: number;
@@ -20,20 +19,20 @@ export interface Pricing {
     'bitcoin': number;
     'usd'?: number;
 }
-export interface PricingInUSD {
+export interface PricingInUsd {
     on_demand_btc: number;
     on_demand_clore: number;
     spot: number;
 }
-export interface PricingInOriginalUSD {
+export interface PricingInOriginalUsd {
     on_demand: number;
     spot: number;
 }
 export interface Price {
     on_demand: Pricing;
     spot: Pricing;
-    usd?: PricingInUSD;
-    original_usd?: PricingInOriginalUSD;
+    usd?: PricingInUsd;
+    original_usd?: PricingInOriginalUsd;
 }
 export interface Net {
     cc: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloreai",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "type": "module",
   "description": "CLORE.AI API client",
   "repository": {
@@ -27,19 +27,18 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "axios": "^1.8.4",
+    "axios": "^1.10.0",
     "p-queue": "^8.1.0"
   },
   "devDependencies": {
-    "@tsconfig/node-lts": "^22.0.1",
+    "@tsconfig/node-lts": "^22.0.2",
     "@tsconfig/strictest": "^2.0.5",
-    "@types/node": "^22.14.1",
-    "eslint": "^9.25.0",
-    "eslint-config-vladpuz": "^1.1.0",
+    "@types/node": "^24.0.12",
+    "eslint": "^9.30.1",
+    "eslint-config-vladpuz": "^2.0.2",
     "husky": "^9.1.7",
-    "jiti": "^2.4.2",
-    "prettier": "^3.5.3",
-    "prettier-config-vladpuz": "^1.0.0",
+    "prettier": "^3.6.2",
+    "prettier-config-vladpuz": "^1.0.2",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3"
   }

package/build/helpers.d.ts

@@ -1,19 +0,0 @@
-import type { AxiosRequestConfig } from 'axios';
-import type { QueueAddOptions } from 'p-queue';
-export declare const statusCodes: {
-    NORMAL: number;
-    DATABASE_ERROR: number;
-    INVALID_INPUT_DATA: number;
-    INVALID_API_TOKEN: number;
-    INVALID_ENDPOINT: number;
-    EXCEEDED: number;
-    OTHER: number;
-};
-export declare const priorityLevels: {
-    NORMAL: number;
-    HIGH: number;
-    HIGHEST: number;
-};
-export declare function getQueueOptions(priority: number, config?: AxiosRequestConfig): QueueAddOptions & {
-    throwOnTimeout: true;
-};

package/build/{endpoints → resources}/createGigaspotOrders.d.ts

@@ -1,10 +1,10 @@
 import type { Currency, ResponseData } from '../types.js';
 export interface CreateGigaspotOrdersRequestDataOrderOverclock {
     pl: number;
+    core_offset?: number;
+    mem_offset?: number;
     core_lock?: number;
     mem_lock?: number;
-    mem_offset?: number;
-    core_offset?: number;
 }
 export interface CreateGigaspotOrdersRequestDataOrder {
     currency: Currency;

package/build/{endpoints → resources}/editGigaspotOrders.d.ts

@@ -1,10 +1,10 @@
 import type { ResponseData } from '../types.js';
 export interface EditGigaspotOrdersRequestDataOrderOverclock {
     pl: number;
+    core_offset?: number;
+    mem_offset?: number;
     core_lock?: number;
     mem_lock?: number;
-    mem_offset?: number;
-    core_offset?: number;
 }
 export interface EditGigaspotOrdersRequestDataOrder {
     order_id: number;