@dogabot/sdk 0.0.0-stage → 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,31 @@
+/** JSON-compatible values. */
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export interface ClientOptions {
+    /** API key (`dbk_live_…`). Defaults to `process.env.DOGABOT_API_KEY`. */
+    apiKey?: string;
+    /** Defaults to `https://api.dogabot.com`. */
+    baseUrl?: string;
+    /** Optional fetch implementation (tests). */
+    fetch?: typeof fetch;
+    /** Max retries for 429/5xx (default 2). */
+    maxRetries?: number;
+    /** User-Agent override. */
+    userAgent?: string;
+}
+export interface RequestOptions {
+    query?: Record<string, string | number | boolean | undefined | null>;
+    body?: JsonValue;
+    headers?: Record<string, string>;
+    /** Required for write mutations; preferred when retrying the same intent. */
+    idempotencyKey?: string;
+    /** Internal: marks allowlist write routes. */
+    write?: boolean;
+    signal?: AbortSignal;
+}
+export interface APIErrorBody {
+    error?: string;
+    [key: string]: JsonValue | undefined;
+}

package/dist/types.js

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

package/examples/README.md

@@ -0,0 +1,15 @@
+# @dogabot/sdk examples (Node)
+
+```bash
+export DOGABOT_API_KEY=dbk_live_...
+# from sdk/js:
+pnpm install && pnpm run build
+node examples/get-me.mjs
+node examples/get-ticker.mjs
+node examples/list-markets.mjs
+CONFIRM_PLACE=1 node examples/place-paper-order.mjs
+```
+
+Local imports resolve via `file:..` in each example’s comment — after publish, `npm i @dogabot/sdk` and run the same scripts from any project.
+
+Docs: https://docs.dogabot.com/sdk/

package/examples/get-me.mjs

@@ -0,0 +1,18 @@
+/**
+ * Print the authenticated account (GET /api/v1/me).
+ * From sdk/js after `pnpm run build`: node examples/get-me.mjs
+ */
+import { dirname, join } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { fileURLToPath } from 'node:url'
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..')
+const { Client } = await import(pathToFileURL(join(root, 'dist/index.js')).href)
+
+if (!process.env.DOGABOT_API_KEY) {
+  console.error('Set DOGABOT_API_KEY=dbk_live_...')
+  process.exit(1)
+}
+
+const client = new Client()
+console.log(JSON.stringify(await client.getMe(), null, 2))

package/examples/get-ticker.mjs

@@ -0,0 +1,23 @@
+/**
+ * Fetch a ticker with query params (GET /api/v1/ticker).
+ * From sdk/js after `pnpm run build`: node examples/get-ticker.mjs
+ */
+import { dirname, join } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { fileURLToPath } from 'node:url'
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..')
+const { Client } = await import(pathToFileURL(join(root, 'dist/index.js')).href)
+
+if (!process.env.DOGABOT_API_KEY) {
+  console.error('Set DOGABOT_API_KEY=dbk_live_...')
+  process.exit(1)
+}
+
+const exchange = process.env.DOGABOT_EXCHANGE ?? 'hyperliquid'
+const symbol = process.env.DOGABOT_SYMBOL ?? 'BTC'
+const client = new Client()
+const ticker = await client.resources.getTicker({
+  query: { exchange, symbol },
+})
+console.log(JSON.stringify(ticker, null, 2))

package/examples/list-markets.mjs

@@ -0,0 +1,21 @@
+/**
+ * List markets with optional filters (GET /api/v1/markets).
+ * From sdk/js after `pnpm run build`: node examples/list-markets.mjs
+ */
+import { dirname, join } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { fileURLToPath } from 'node:url'
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..')
+const { Client } = await import(pathToFileURL(join(root, 'dist/index.js')).href)
+
+if (!process.env.DOGABOT_API_KEY) {
+  console.error('Set DOGABOT_API_KEY=dbk_live_...')
+  process.exit(1)
+}
+
+const client = new Client()
+const markets = await client.resources.getMarkets({
+  query: { limit: 5, is_tradable: true },
+})
+console.log(JSON.stringify(markets, null, 2))

package/examples/place-paper-order.mjs

@@ -0,0 +1,39 @@
+/**
+ * Place a tiny paper market order (Idempotency-Key required).
+ * Dry-run unless CONFIRM_PLACE=1. trading_mode stays paper.
+ * From sdk/js after `pnpm run build`: CONFIRM_PLACE=1 node examples/place-paper-order.mjs
+ */
+import { randomUUID } from 'node:crypto'
+import { dirname, join } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { fileURLToPath } from 'node:url'
+
+const root = join(dirname(fileURLToPath(import.meta.url)), '..')
+const { Client } = await import(pathToFileURL(join(root, 'dist/index.js')).href)
+
+if (!process.env.DOGABOT_API_KEY) {
+  console.error('Set DOGABOT_API_KEY=dbk_live_...')
+  process.exit(1)
+}
+
+const body = {
+  exchange: process.env.DOGABOT_EXCHANGE ?? 'hyperliquid',
+  symbol: process.env.DOGABOT_SYMBOL ?? 'BTC',
+  side: 'buy',
+  quantity: 0.001,
+  order_type: 'market',
+  trading_mode: 'paper',
+  broadcast_mode: 'personal',
+}
+const idempotencyKey = process.env.DOGABOT_IDEMPOTENCY_KEY ?? `example-paper-${randomUUID()}`
+
+if (process.env.CONFIRM_PLACE !== '1') {
+  console.log('Dry-run only. Would POST placeorder with:')
+  console.log(JSON.stringify({ body, idempotencyKey }, null, 2))
+  console.log('Re-run with CONFIRM_PLACE=1 to submit (still paper).')
+  process.exit(0)
+}
+
+const client = new Client()
+const out = await client.resources.postTerminalPlaceorder(body, { idempotencyKey })
+console.log(JSON.stringify(out, null, 2))

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@dogabot/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Official dogabot REST API SDK for JavaScript/TypeScript (backend-first)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "examples",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dogabot/dogabot-sdk-js.git"
+  },
+  "license": "MIT",
+  "keywords": [
+    "dogabot",
+    "trading",
+    "sdk",
+    "api"
+  ]
+}