@dogabot/sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) dogabot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @dogabot/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Official REST client for the [dogabot public API](https://docs.dogabot.com/).
+
+```bash
+npm i @dogabot/sdk
+# If the npm package is not visible yet: npm i github:dogabot/dogabot-sdk-js
+```
+
+```ts
+import { Client } from '@dogabot/sdk'
+
+const client = new Client({ apiKey: process.env.DOGABOT_API_KEY })
+const me = await client.getMe()
+```
+
+Writes require `idempotencyKey`:
+
+```ts
+await client.resources.postTerminalPlaceorder(
+  {
+    exchange: 'hyperliquid',
+    symbol: 'BTC',
+    side: 'buy',
+    quantity: 0.001,
+    order_type: 'market',
+    trading_mode: 'paper',
+    broadcast_mode: 'personal',
+  },
+  { idempotencyKey: 'place-paper-btc-1' },
+)
+```
+
+**Backend-first** (Node 20+). Do not put API keys in browser bundles — call dogabot from your server/BFF.
+
+Runnable samples: [`examples/`](./examples/).
+
+Public repo: https://github.com/dogabot/dogabot-sdk-js · Docs: https://docs.dogabot.com/sdk/

package/dist/client.d.ts

@@ -0,0 +1,18 @@
+import { Resources } from './resources.generated.js';
+import type { ClientOptions, HttpMethod, JsonValue, RequestOptions } from './types.js';
+export declare class Client {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    readonly maxRetries: number;
+    readonly userAgent: string;
+    readonly resources: Resources;
+    private readonly fetchImpl;
+    constructor(options?: ClientOptions);
+    /** Convenience: GET /api/v1/me */
+    getMe(options?: RequestOptions): Promise<JsonValue>;
+    request(input: {
+        method: HttpMethod;
+        path: string;
+    } & RequestOptions): Promise<JsonValue>;
+}
+export declare function createClient(options?: ClientOptions): Client;

package/dist/client.js

@@ -0,0 +1,100 @@
+import { createRequire } from 'node:module';
+import { APIError } from './error.js';
+import { Resources } from './resources.generated.js';
+const require = createRequire(import.meta.url);
+const { version: pkgVersion } = require('../package.json');
+const DEFAULT_BASE = 'https://api.dogabot.com';
+export class Client {
+    apiKey;
+    baseUrl;
+    maxRetries;
+    userAgent;
+    resources;
+    fetchImpl;
+    constructor(options = {}) {
+        const apiKey = options.apiKey ?? process.env.DOGABOT_API_KEY;
+        if (!apiKey) {
+            throw new Error('apiKey is required (pass options.apiKey or set DOGABOT_API_KEY)');
+        }
+        this.apiKey = apiKey;
+        this.baseUrl = (options.baseUrl ?? DEFAULT_BASE).replace(/\/$/, '');
+        this.maxRetries = options.maxRetries ?? 2;
+        this.userAgent = options.userAgent ?? `dogabot-sdk-js/${pkgVersion}`;
+        this.fetchImpl = options.fetch ?? fetch;
+        this.resources = new Resources(this);
+    }
+    /** Convenience: GET /api/v1/me */
+    getMe(options) {
+        return this.resources.getMe(options);
+    }
+    async request(input) {
+        const { method, path, query, body, headers, idempotencyKey, write, signal } = input;
+        if (write && !idempotencyKey) {
+            throw new Error(`Idempotency-Key is required for write operation ${method} ${path}`);
+        }
+        const url = new URL(path.startsWith('http') ? path : `${this.baseUrl}${path}`);
+        if (query) {
+            for (const [k, v] of Object.entries(query)) {
+                if (v === undefined || v === null)
+                    continue;
+                url.searchParams.set(k, String(v));
+            }
+        }
+        let attempt = 0;
+        for (;;) {
+            const reqHeaders = {
+                Authorization: `Bearer ${this.apiKey}`,
+                Accept: 'application/json',
+                'User-Agent': this.userAgent,
+                ...headers,
+            };
+            if (idempotencyKey) {
+                reqHeaders['Idempotency-Key'] = idempotencyKey;
+            }
+            let payload;
+            if (body !== undefined) {
+                reqHeaders['Content-Type'] = 'application/json';
+                payload = JSON.stringify(body);
+            }
+            const res = await this.fetchImpl(url.toString(), {
+                method,
+                headers: reqHeaders,
+                body: payload,
+                signal,
+            });
+            const text = await res.text();
+            let parsed = null;
+            if (text) {
+                try {
+                    parsed = JSON.parse(text);
+                }
+                catch {
+                    parsed = text;
+                }
+            }
+            if (res.ok) {
+                return parsed;
+            }
+            const retryable = res.status === 429 || res.status >= 500;
+            if (retryable && attempt < this.maxRetries) {
+                attempt += 1;
+                const retryAfter = res.headers.get('Retry-After');
+                const waitMs = retryAfter ? Number(retryAfter) * 1000 : Math.min(1000 * 2 ** attempt, 8000);
+                await sleep(Number.isFinite(waitMs) ? waitMs : 1000);
+                continue;
+            }
+            const errBody = parsed && typeof parsed === 'object' && !Array.isArray(parsed)
+                ? parsed
+                : null;
+            const msg = (errBody && typeof errBody.error === 'string' && errBody.error) ||
+                `HTTP ${res.status} ${method} ${path}`;
+            throw new APIError(msg, res.status, errBody, res.headers);
+        }
+    }
+}
+function sleep(ms) {
+    return new Promise((r) => setTimeout(r, ms));
+}
+export function createClient(options) {
+    return new Client(options);
+}

package/dist/error.d.ts

@@ -0,0 +1,7 @@
+import type { APIErrorBody } from './types.js';
+export declare class APIError extends Error {
+    readonly status: number;
+    readonly body: APIErrorBody | null;
+    readonly headers: Headers;
+    constructor(message: string, status: number, body: APIErrorBody | null, headers: Headers);
+}

package/dist/error.js

@@ -0,0 +1,12 @@
+export class APIError extends Error {
+    status;
+    body;
+    headers;
+    constructor(message, status, body, headers) {
+        super(message);
+        this.name = 'APIError';
+        this.status = status;
+        this.body = body;
+        this.headers = headers;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { Client, createClient } from './client.js';
+export { APIError } from './error.js';
+export { Resources, OPERATION_IDS } from './resources.generated.js';
+export type { ClientOptions, RequestOptions, JsonValue, HttpMethod, APIErrorBody } from './types.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { Client, createClient } from './client.js';
+export { APIError } from './error.js';
+export { Resources, OPERATION_IDS } from './resources.generated.js';

package/dist/resources.generated.d.ts

@@ -0,0 +1,129 @@
+import type { Client } from './client.js';
+import type { JsonValue, RequestOptions } from './types.js';
+export type PathParams = Record<string, string | number>;
+/** All OpenAPI operationIds as client methods. */
+export declare class Resources {
+    private readonly client;
+    constructor(client: Client);
+    getMe(options?: RequestOptions): Promise<JsonValue>;
+    getMeStatistics(options?: RequestOptions): Promise<JsonValue>;
+    getMePositions(options?: RequestOptions): Promise<JsonValue>;
+    getMePositionlegs(options?: RequestOptions): Promise<JsonValue>;
+    getMeOrders(options?: RequestOptions): Promise<JsonValue>;
+    getMeSignals(options?: RequestOptions): Promise<JsonValue>;
+    getMeEmitters(options?: RequestOptions): Promise<JsonValue>;
+    postMeEmittersSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postAutomationsSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getFollowers(options?: RequestOptions): Promise<JsonValue>;
+    postFollowers(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getFollowersById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    patchFollowersById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deleteFollowersById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postFollowersSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getFollowersSummaryById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getFollowersPnlseriesById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getFollowersPositionById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getBots(options?: RequestOptions): Promise<JsonValue>;
+    postBots(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getBotsById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    patchBotsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deleteBotsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postBotsSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getBotsPnlseriesById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getBotsPositionById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getEmitters(options?: RequestOptions): Promise<JsonValue>;
+    postEmitters(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getEmittersById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    patchEmittersById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deleteEmittersById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postEmittersSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getEmittersSummaryById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getEmittersCurated(options?: RequestOptions): Promise<JsonValue>;
+    getEmittersPnlseriesById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getEmittersPositionById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getPortfolios(options?: RequestOptions): Promise<JsonValue>;
+    postPortfolios(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getPortfoliosById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    patchPortfoliosById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deletePortfoliosById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postPortfoliosSummary(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getPortfoliosPnlseriesById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getPortfoliosPositionsById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getOrders(options?: RequestOptions): Promise<JsonValue>;
+    getSignals(options?: RequestOptions): Promise<JsonValue>;
+    getBacktestQuota(options?: RequestOptions): Promise<JsonValue>;
+    getBacktests(options?: RequestOptions): Promise<JsonValue>;
+    getBacktestsSummary(options?: RequestOptions): Promise<JsonValue>;
+    getBacktestByJob_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getBacktestSignalsByJob_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getBacktestBulkSeed(options?: RequestOptions): Promise<JsonValue>;
+    getBacktestBulkBatches(options?: RequestOptions): Promise<JsonValue>;
+    getBacktestBulkBatchesByBatch_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getTicker(options?: RequestOptions): Promise<JsonValue>;
+    getFundingrate(options?: RequestOptions): Promise<JsonValue>;
+    getMarketOrderbook(options?: RequestOptions): Promise<JsonValue>;
+    getMarketTrades(options?: RequestOptions): Promise<JsonValue>;
+    getMarkets(options?: RequestOptions): Promise<JsonValue>;
+    getMarketsAssetprofile(options?: RequestOptions): Promise<JsonValue>;
+    getExchanges(options?: RequestOptions): Promise<JsonValue>;
+    getMarkettypes(options?: RequestOptions): Promise<JsonValue>;
+    getMarketplaceSearch(options?: RequestOptions): Promise<JsonValue>;
+    getMarketplaceSellersByHandle(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getDatafeedHistory(options?: RequestOptions): Promise<JsonValue>;
+    postMarketsSymbolcorrelation(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postMarketsSymbolvolatility(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postMarketsSymbolfeebreakeven(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getTerminalOrders(options?: RequestOptions): Promise<JsonValue>;
+    getTerminalOrdersByclientorderidByClient_order_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    getTerminalPositions(options?: RequestOptions): Promise<JsonValue>;
+    getTerminalSymbolrules(options?: RequestOptions): Promise<JsonValue>;
+    getTerminalOrdercapabilities(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeBalances(options?: RequestOptions): Promise<JsonValue>;
+    getExchangePositions(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeMarginsummary(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeOrders(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeTrades(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeIncome(options?: RequestOptions): Promise<JsonValue>;
+    getExchangeOpenablenotional(options?: RequestOptions): Promise<JsonValue>;
+    postExchangeLeverage(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postExchangeCancelorder(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postExchangeCancelorders(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getCredentials(options?: RequestOptions): Promise<JsonValue>;
+    postCredentials(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getTags(options?: RequestOptions): Promise<JsonValue>;
+    postTags(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getMeStatisticsBytag(options?: RequestOptions): Promise<JsonValue>;
+    postFollowersStartById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postFollowersStopById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBotsStartById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBotsStopById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBotsBooksById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postFollowersBooksById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postEmittersStartById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postEmittersStopById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postPortfoliosStartById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postPortfoliosStopById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    putFollowersTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    putBotsTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    putEmittersTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    putPortfoliosTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    patchTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deleteTagsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    putCredentialsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    deleteCredentialsById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postCredentialsDefaultById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBacktest(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postBacktestBulk(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postBacktestBulkBatchesRerunByBatch_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBacktestBulkBatchesCancelByBatch_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postBacktestCancelByJob_id(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postTerminalPlaceorder(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postTerminalCancelorder(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getAiChatQuota(options?: RequestOptions): Promise<JsonValue>;
+    getAiChatConversations(options?: RequestOptions): Promise<JsonValue>;
+    postAiChatConversations(body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    getAiChatConversationsById(pathParams: PathParams, options?: RequestOptions): Promise<JsonValue>;
+    postAiChatConversationsMessagesById(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+    postAiChatConversationsToolsConfirmByIdCall_id(pathParams: PathParams, body?: JsonValue, options?: RequestOptions): Promise<JsonValue>;
+}
+export declare const OPERATION_IDS: readonly ["getMe", "getMeStatistics", "getMePositions", "getMePositionlegs", "getMeOrders", "getMeSignals", "getMeEmitters", "postMeEmittersSummary", "postAutomationsSummary", "getFollowers", "postFollowers", "getFollowersById", "patchFollowersById", "deleteFollowersById", "postFollowersSummary", "getFollowersSummaryById", "getFollowersPnlseriesById", "getFollowersPositionById", "getBots", "postBots", "getBotsById", "patchBotsById", "deleteBotsById", "postBotsSummary", "getBotsPnlseriesById", "getBotsPositionById", "getEmitters", "postEmitters", "getEmittersById", "patchEmittersById", "deleteEmittersById", "postEmittersSummary", "getEmittersSummaryById", "getEmittersCurated", "getEmittersPnlseriesById", "getEmittersPositionById", "getPortfolios", "postPortfolios", "getPortfoliosById", "patchPortfoliosById", "deletePortfoliosById", "postPortfoliosSummary", "getPortfoliosPnlseriesById", "getPortfoliosPositionsById", "getOrders", "getSignals", "getBacktestQuota", "getBacktests", "getBacktestsSummary", "getBacktestByJob_id", "getBacktestSignalsByJob_id", "getBacktestBulkSeed", "getBacktestBulkBatches", "getBacktestBulkBatchesByBatch_id", "getTicker", "getFundingrate", "getMarketOrderbook", "getMarketTrades", "getMarkets", "getMarketsAssetprofile", "getExchanges", "getMarkettypes", "getMarketplaceSearch", "getMarketplaceSellersByHandle", "getDatafeedHistory", "postMarketsSymbolcorrelation", "postMarketsSymbolvolatility", "postMarketsSymbolfeebreakeven", "getTerminalOrders", "getTerminalOrdersByclientorderidByClient_order_id", "getTerminalPositions", "getTerminalSymbolrules", "getTerminalOrdercapabilities", "getExchangeBalances", "getExchangePositions", "getExchangeMarginsummary", "getExchangeOrders", "getExchangeTrades", "getExchangeIncome", "getExchangeOpenablenotional", "postExchangeLeverage", "postExchangeCancelorder", "postExchangeCancelorders", "getCredentials", "postCredentials", "getTags", "postTags", "getMeStatisticsBytag", "postFollowersStartById", "postFollowersStopById", "postBotsStartById", "postBotsStopById", "postBotsBooksById", "postFollowersBooksById", "postEmittersStartById", "postEmittersStopById", "postPortfoliosStartById", "postPortfoliosStopById", "putFollowersTagsById", "putBotsTagsById", "putEmittersTagsById", "putPortfoliosTagsById", "patchTagsById", "deleteTagsById", "putCredentialsById", "deleteCredentialsById", "postCredentialsDefaultById", "postBacktest", "postBacktestBulk", "postBacktestBulkBatchesRerunByBatch_id", "postBacktestBulkBatchesCancelByBatch_id", "postBacktestCancelByJob_id", "postTerminalPlaceorder", "postTerminalCancelorder", "getAiChatQuota", "getAiChatConversations", "postAiChatConversations", "getAiChatConversationsById", "postAiChatConversationsMessagesById", "postAiChatConversationsToolsConfirmByIdCall_id"];