@reyaxyz/api-sdk 0.9.0 → 0.10.0

package/dist/clients/modules/markets.js

@@ -83,7 +83,7 @@ var MarketsClient = /** @class */ (function (_super) {
             var uri;
             return __generator(this, function (_a) {
                 uri = '/api/markets';
-                return [2 /*return*/, this.get(uri, { id: params.id })];
+                return [2 /*return*/, this.get(uri, { id: params === null || params === void 0 ? void 0 : params.id })];
             });
         });
     };

package/dist/clients/modules/markets.js.map

@@ -1 +1 @@
-{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAoEA,CAAC;IAnEC;;;;;;;;;;;;;;;;;OAiBG;IAEG,kCAAU,GAAhB,UAAiB,MAAwB;;;;gBACjC,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,EAAC;;;KACzC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,wCAAgB,GAAtB,UACE,QAA4B,EAC5B,UAA6B,EAC7B,OAAuB,EACvB,KAAqB,EACrB,KAAqB;;;;gBAEf,GAAG,GAAG,+BAAwB,QAAQ,CAAE,CAAC;gBAC/C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,UAAU,YAAA;wBACV,OAAO,SAAA;wBACP,KAAK,OAAA;wBACL,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IAEK,gDAAwB,GAA9B,UACE,QAAgB,EAChB,KAAqB;;;;gBAEf,GAAG,GAAG,sBAAe,QAAQ,CAAE,CAAC;gBACtC,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IACH,oBAAC;AAAD,CAAC,AApED,CAA2C,cAAU,GAoEpD","sourcesContent":["import {\n  CandlesResolution,\n  GetMarketsParams,\n  MarketCandlesResponse,\n  MarketEntity,\n  TradesResponse,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class MarketsClient extends RestClient {\n  /**\n   * Asynchronously retrieves market data from the API.\n   *\n   * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,\n   * it fetches data for that particular market; otherwise, it fetches data for all available markets.\n   *\n   * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.\n   * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * // Fetch data for all markets\n   * const allMarketsData = await market.getMarkets();\n   *\n   * @example\n   * // Fetch data for a specific market\n   * const specificMarketData = await market.getMarkets('ETH-USDC');\n   */\n\n  async getMarkets(params: GetMarketsParams): Promise<MarketEntity[]> {\n    const uri = '/api/markets';\n    return this.get(uri, { id: params.id });\n  }\n\n  /**\n   * Retrieves candlestick data for a specified market.\n   *\n   * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.\n   * The data can be filtered by time range (fromISO and toISO) and resolution.\n   *\n   * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.\n   * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').\n   * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.\n   * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');\n   */\n\n  async getMarketCandles(\n    marketId: MarketEntity['id'],\n    resolution: CandlesResolution,\n    fromISO?: string | null,\n    toISO?: string | null,\n    limit?: number | null,\n  ): Promise<MarketCandlesResponse> {\n    const uri = `/api/markets/candles/${marketId}`;\n    return this.get(uri, {\n      resolution,\n      fromISO,\n      toISO,\n      limit,\n    });\n  }\n\n  async getPerpetualMarketTrades(\n    marketId: number,\n    limit?: number | null,\n  ): Promise<TradesResponse> {\n    const uri = `/api/trades/${marketId}`;\n    return this.get(uri, {\n      limit,\n    });\n  }\n}\n"]}
+{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAoEA,CAAC;IAnEC;;;;;;;;;;;;;;;;;OAiBG;IAEG,kCAAU,GAAhB,UAAiB,MAAyB;;;;gBAClC,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,EAAE,CAAC,EAAC;;;KAC1C;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,wCAAgB,GAAtB,UACE,QAA4B,EAC5B,UAA6B,EAC7B,OAAuB,EACvB,KAAqB,EACrB,KAAqB;;;;gBAEf,GAAG,GAAG,+BAAwB,QAAQ,CAAE,CAAC;gBAC/C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,UAAU,YAAA;wBACV,OAAO,SAAA;wBACP,KAAK,OAAA;wBACL,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IAEK,gDAAwB,GAA9B,UACE,QAAgB,EAChB,KAAqB;;;;gBAEf,GAAG,GAAG,sBAAe,QAAQ,CAAE,CAAC;gBACtC,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IACH,oBAAC;AAAD,CAAC,AApED,CAA2C,cAAU,GAoEpD","sourcesContent":["import {\n  CandlesResolution,\n  GetMarketsParams,\n  MarketCandlesResponse,\n  MarketEntity,\n  TradesResponse,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class MarketsClient extends RestClient {\n  /**\n   * Asynchronously retrieves market data from the API.\n   *\n   * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,\n   * it fetches data for that particular market; otherwise, it fetches data for all available markets.\n   *\n   * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.\n   * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * // Fetch data for all markets\n   * const allMarketsData = await market.getMarkets();\n   *\n   * @example\n   * // Fetch data for a specific market\n   * const specificMarketData = await market.getMarkets('ETH-USDC');\n   */\n\n  async getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]> {\n    const uri = '/api/markets';\n    return this.get(uri, { id: params?.id });\n  }\n\n  /**\n   * Retrieves candlestick data for a specified market.\n   *\n   * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.\n   * The data can be filtered by time range (fromISO and toISO) and resolution.\n   *\n   * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.\n   * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').\n   * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.\n   * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');\n   */\n\n  async getMarketCandles(\n    marketId: MarketEntity['id'],\n    resolution: CandlesResolution,\n    fromISO?: string | null,\n    toISO?: string | null,\n    limit?: number | null,\n  ): Promise<MarketCandlesResponse> {\n    const uri = `/api/markets/candles/${marketId}`;\n    return this.get(uri, {\n      resolution,\n      fromISO,\n      toISO,\n      limit,\n    });\n  }\n\n  async getPerpetualMarketTrades(\n    marketId: number,\n    limit?: number | null,\n  ): Promise<TradesResponse> {\n    const uri = `/api/trades/${marketId}`;\n    return this.get(uri, {\n      limit,\n    });\n  }\n}\n"]}

package/dist/index.js

@@ -1,6 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClient = void 0;
 var api_client_1 = require("./clients/api-client");
 Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
+__exportStar(require("./clients/types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mDAAiD;AAAxC,uGAAA,SAAS,OAAA","sourcesContent":["export { ApiClient } from './clients/api-client';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mDAAiD;AAAxC,uGAAA,SAAS,OAAA;AAClB,kDAAgC","sourcesContent":["export { ApiClient } from './clients/api-client';\nexport * from './clients/types';\n"]}

package/dist/types/clients/modules/markets.d.ts

@@ -19,7 +19,7 @@ export default class MarketsClient extends RestClient {
      * // Fetch data for a specific market
      * const specificMarketData = await market.getMarkets('ETH-USDC');
      */
-    getMarkets(params: GetMarketsParams): Promise<MarketEntity[]>;
+    getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]>;
     /**
      * Retrieves candlestick data for a specified market.
      *

package/dist/types/clients/modules/markets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markets.d.ts","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,cAAc,EACf,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;;OAiBG;IAEG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAKnE;;;;;;;;;;;;;;;;OAgBG;IAEG,gBAAgB,CACpB,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,EAC5B,UAAU,EAAE,iBAAiB,EAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,qBAAqB,CAAC;IAU3B,wBAAwB,CAC5B,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,cAAc,CAAC;CAM3B"}
+{"version":3,"file":"markets.d.ts","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,cAAc,EACf,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;;OAiBG;IAEG,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAKpE;;;;;;;;;;;;;;;;OAgBG;IAEG,gBAAgB,CACpB,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,EAC5B,UAAU,EAAE,iBAAiB,EAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,qBAAqB,CAAC;IAU3B,wBAAwB,CAC5B,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,cAAc,CAAC;CAM3B"}

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { ApiClient } from './clients/api-client';
+export * from './clients/types';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,cAAc,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reyaxyz/api-sdk",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -36,5 +36,5 @@
     "axios": "^1.6.2"
   },
   "packageManager": "pnpm@8.10.4",
-  "gitHead": "21e2e1bd85d1a87ed212743419f0f3e8785be09a"
+  "gitHead": "faa38b7af7e74b04a98215efadbef38fab902665"
 }

package/src/clients/modules/markets.ts

@@ -27,9 +27,9 @@ export default class MarketsClient extends RestClient {
    * const specificMarketData = await market.getMarkets('ETH-USDC');
    */
 
-  async getMarkets(params: GetMarketsParams): Promise<MarketEntity[]> {
+  async getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]> {
     const uri = '/api/markets';
-    return this.get(uri, { id: params.id });
+    return this.get(uri, { id: params?.id });
   }
 
   /**

package/src/index.ts

@@ -1 +1,2 @@
 export { ApiClient } from './clients/api-client';
+export * from './clients/types';