@swapkit/api-sdk-typescript 1.0.3 → 1.1.0-nightly.20260701161042

package/README.md

@@ -10,6 +10,12 @@ npm install @swapkit/api-sdk-typescript
 bun add @swapkit/api-sdk-typescript
 ```
 
+For the bleeding-edge build tracking the API's `develop` branch, install the `nightly` tag:
+
+```bash
+npm install @swapkit/api-sdk-typescript@nightly
+```
+
 ## Quick Start
 
 ```typescript

package/dist/index.cjs

@@ -31,18 +31,18 @@ __export(index_exports, {
   TrackService: () => TrackService,
   client: () => client,
   configureSwapKit: () => configureSwapKit,
-  getGas: () => getGas,
+  createBrokerChannel: () => createBrokerChannel,
+  executeSwap: () => executeSwap,
+  getCachedPrice: () => getCachedPrice,
   getGasHistory: () => getGasHistory,
+  getGasPrices: () => getGasPrices,
   getProviders: () => getProviders,
-  getSwapFrom: () => getSwapFrom,
-  getSwapTo: () => getSwapTo,
+  getQuote: () => getQuote,
+  getSwapFromAssets: () => getSwapFromAssets,
+  getSwapToAssets: () => getSwapToAssets,
   getTokens: () => getTokens,
-  postChainflipBrokerChannel: () => postChainflipBrokerChannel,
-  postPriceCachedPrice: () => postPriceCachedPrice,
-  postScreen: () => postScreen,
-  postTrack: () => postTrack,
-  postV3Quote: () => postV3Quote,
-  postV3Swap: () => postV3Swap
+  screenAddress: () => screenAddress,
+  trackTransaction: () => trackTransaction
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -61,7 +61,7 @@ var extraPrefixesMap = {
 var extraPrefixes = Object.entries(extraPrefixesMap);
 
 // src/core/serverSentEvents.ts
-var createSseClient = ({
+function createSseClient({
   onRequest,
   onSseError,
   onSseEvent,
@@ -73,7 +73,7 @@ var createSseClient = ({
   sseSleepFn,
   url,
   ...options
-}) => {
+}) {
   let lastEventId;
   const sleep = sseSleepFn ?? ((ms) => new Promise((resolve) => setTimeout(resolve, ms)));
   const createStream = async function* () {
@@ -117,7 +117,7 @@ var createSseClient = ({
             const { done, value } = await reader.read();
             if (done) break;
             buffer += value;
-            buffer = buffer.replace(/\r\n/g, "\n").replace(/\r/g, "\n");
+            buffer = buffer.replace(/\r\n?/g, "\n");
             const chunks = buffer.split("\n\n");
             buffer = chunks.pop() ?? "";
             for (const chunk of chunks) {
@@ -185,7 +185,7 @@ var createSseClient = ({
   };
   const stream = createStream();
   return { stream };
-};
+}
 
 // src/core/pathSerializer.ts
 var separatorArrayExplode = (style) => {
@@ -502,11 +502,8 @@ var checkForExistence = (options, name) => {
   }
   return false;
 };
-var setAuthParams = async ({
-  security,
-  ...options
-}) => {
-  for (const auth of security) {
+async function setAuthParams(options) {
+  for (const auth of options.security ?? []) {
     if (checkForExistence(options, auth.name)) {
       continue;
     }
@@ -531,7 +528,7 @@ var setAuthParams = async ({
         break;
     }
   }
-};
+}
 var buildUrl = (options) => getUrl({
   baseUrl: options.baseUrl,
   path: options.path,
@@ -659,10 +656,7 @@ var createClient = (config = {}) => {
       serializedBody: void 0
     };
     if (opts.security) {
-      await setAuthParams({
-        ...opts,
-        security: opts.security
-      });
+      await setAuthParams(opts);
     }
     if (opts.requestValidator) {
       await opts.requestValidator(opts);
@@ -673,131 +667,121 @@ var createClient = (config = {}) => {
     if (opts.body === void 0 || opts.serializedBody === "") {
       opts.headers.delete("Content-Type");
     }
-    const url = buildUrl(opts);
-    return { opts, url };
+    const resolvedOpts = opts;
+    const url = buildUrl(resolvedOpts);
+    return { opts: resolvedOpts, url };
   };
   const request = async (options) => {
-    const { opts, url } = await beforeRequest(options);
-    const requestInit = {
-      redirect: "follow",
-      ...opts,
-      body: getValidRequestBody(opts)
-    };
-    let request2 = new Request(url, requestInit);
-    for (const fn of interceptors.request.fns) {
-      if (fn) {
-        request2 = await fn(request2, opts);
-      }
-    }
-    const _fetch = opts.fetch;
+    const throwOnError = options.throwOnError ?? _config.throwOnError;
+    const responseStyle = options.responseStyle ?? _config.responseStyle;
+    let request2;
     let response;
     try {
-      response = await _fetch(request2);
-    } catch (error2) {
-      let finalError2 = error2;
-      for (const fn of interceptors.error.fns) {
+      const { opts, url } = await beforeRequest(options);
+      const requestInit = {
+        redirect: "follow",
+        ...opts,
+        body: getValidRequestBody(opts)
+      };
+      request2 = new Request(url, requestInit);
+      for (const fn of interceptors.request.fns) {
         if (fn) {
-          finalError2 = await fn(error2, void 0, request2, opts);
+          request2 = await fn(request2, opts);
         }
       }
-      finalError2 = finalError2 || {};
-      if (opts.throwOnError) {
-        throw finalError2;
+      const _fetch = opts.fetch;
+      response = await _fetch(request2);
+      for (const fn of interceptors.response.fns) {
+        if (fn) {
+          response = await fn(response, request2, opts);
+        }
       }
-      return opts.responseStyle === "data" ? void 0 : {
-        error: finalError2,
+      const result = {
         request: request2,
-        response: void 0
+        response
       };
-    }
-    for (const fn of interceptors.response.fns) {
-      if (fn) {
-        response = await fn(response, request2, opts);
-      }
-    }
-    const result = {
-      request: request2,
-      response
-    };
-    if (response.ok) {
-      const parseAs = (opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json";
-      if (response.status === 204 || response.headers.get("Content-Length") === "0") {
-        let emptyData;
+      if (response.ok) {
+        const parseAs = (opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json";
+        if (response.status === 204 || response.headers.get("Content-Length") === "0") {
+          let emptyData;
+          switch (parseAs) {
+            case "arrayBuffer":
+            case "blob":
+            case "text":
+              emptyData = await response[parseAs]();
+              break;
+            case "formData":
+              emptyData = new FormData();
+              break;
+            case "stream":
+              emptyData = response.body;
+              break;
+            case "json":
+            default:
+              emptyData = {};
+              break;
+          }
+          return opts.responseStyle === "data" ? emptyData : {
+            data: emptyData,
+            ...result
+          };
+        }
+        let data;
         switch (parseAs) {
           case "arrayBuffer":
           case "blob":
+          case "formData":
           case "text":
-            emptyData = await response[parseAs]();
+            data = await response[parseAs]();
             break;
-          case "formData":
-            emptyData = new FormData();
+          case "json": {
+            const text = await response.text();
+            data = text ? JSON.parse(text) : {};
             break;
+          }
           case "stream":
-            emptyData = response.body;
-            break;
-          case "json":
-          default:
-            emptyData = {};
-            break;
+            return opts.responseStyle === "data" ? response.body : {
+              data: response.body,
+              ...result
+            };
+        }
+        if (parseAs === "json") {
+          if (opts.responseValidator) {
+            await opts.responseValidator(data);
+          }
+          if (opts.responseTransformer) {
+            data = await opts.responseTransformer(data);
+          }
         }
-        return opts.responseStyle === "data" ? emptyData : {
-          data: emptyData,
+        return opts.responseStyle === "data" ? data : {
+          data,
           ...result
         };
       }
-      let data;
-      switch (parseAs) {
-        case "arrayBuffer":
-        case "blob":
-        case "formData":
-        case "text":
-          data = await response[parseAs]();
-          break;
-        case "json": {
-          const text = await response.text();
-          data = text ? JSON.parse(text) : {};
-          break;
-        }
-        case "stream":
-          return opts.responseStyle === "data" ? response.body : {
-            data: response.body,
-            ...result
-          };
+      const textError = await response.text();
+      let jsonError;
+      try {
+        jsonError = JSON.parse(textError);
+      } catch {
       }
-      if (parseAs === "json") {
-        if (opts.responseValidator) {
-          await opts.responseValidator(data);
-        }
-        if (opts.responseTransformer) {
-          data = await opts.responseTransformer(data);
+      throw jsonError ?? textError;
+    } catch (error) {
+      let finalError = error;
+      for (const fn of interceptors.error.fns) {
+        if (fn) {
+          finalError = await fn(finalError, response, request2, options);
         }
       }
-      return opts.responseStyle === "data" ? data : {
-        data,
-        ...result
-      };
-    }
-    const textError = await response.text();
-    let jsonError;
-    try {
-      jsonError = JSON.parse(textError);
-    } catch {
-    }
-    const error = jsonError ?? textError;
-    let finalError = error;
-    for (const fn of interceptors.error.fns) {
-      if (fn) {
-        finalError = await fn(error, response, request2, opts);
+      finalError = finalError || {};
+      if (throwOnError) {
+        throw finalError;
       }
+      return responseStyle === "data" ? void 0 : {
+        error: finalError,
+        request: request2,
+        response
+      };
     }
-    finalError = finalError || {};
-    if (opts.throwOnError) {
-      throw finalError;
-    }
-    return opts.responseStyle === "data" ? void 0 : {
-      error: finalError,
-      ...result
-    };
   };
   const makeMethodFn = (method) => (options) => request({ ...options, method });
   const makeSseFn = (method) => async (options) => {
@@ -805,7 +789,6 @@ var createClient = (config = {}) => {
     return createSseClient({
       ...opts,
       body: opts.body,
-      headers: opts.headers,
       method,
       onRequest: async (url2, init) => {
         let request2 = new Request(url2, init);
@@ -820,8 +803,9 @@ var createClient = (config = {}) => {
       url
     });
   };
+  const _buildUrl = (options) => buildUrl({ ..._config, ...options });
   return {
-    buildUrl,
+    buildUrl: _buildUrl,
     connect: makeMethodFn("CONNECT"),
     delete: makeMethodFn("DELETE"),
     get: makeMethodFn("GET"),
@@ -850,7 +834,7 @@ var createClient = (config = {}) => {
 };
 
 // src/client.ts
-var client = createClient(createConfig({ baseUrl: "http://localhost:8080" }));
+var client = createClient(createConfig({ baseUrl: "http://localhost:0" }));
 
 // src/config.ts
 function configureSwapKit(options) {
@@ -872,17 +856,17 @@ var getTokens = (options) => (options?.client ?? client).get({
   url: "/tokens",
   ...options
 });
-var getSwapTo = (options) => (options.client ?? client).get({
+var getSwapToAssets = (options) => (options.client ?? client).get({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/swapTo",
   ...options
 });
-var getSwapFrom = (options) => (options.client ?? client).get({
+var getSwapFromAssets = (options) => (options.client ?? client).get({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/swapFrom",
   ...options
 });
-var postChainflipBrokerChannel = (options) => (options.client ?? client).post({
+var createBrokerChannel = (options) => (options.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/chainflip/broker/channel",
   ...options,
@@ -891,7 +875,7 @@ var postChainflipBrokerChannel = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
-var postTrack = (options) => (options?.client ?? client).post({
+var trackTransaction = (options) => (options?.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/track",
   ...options,
@@ -900,7 +884,7 @@ var postTrack = (options) => (options?.client ?? client).post({
     ...options?.headers
   }
 });
-var postScreen = (options) => (options.client ?? client).post({
+var screenAddress = (options) => (options.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/screen",
   ...options,
@@ -909,17 +893,17 @@ var postScreen = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
-var getGasHistory = (options) => (options?.client ?? client).get({
+var getGasPrices = (options) => (options?.client ?? client).get({
   security: [{ name: "x-api-key", type: "apiKey" }],
-  url: "/gas/history",
+  url: "/gas",
   ...options
 });
-var getGas = (options) => (options?.client ?? client).get({
+var getGasHistory = (options) => (options?.client ?? client).get({
   security: [{ name: "x-api-key", type: "apiKey" }],
-  url: "/gas",
+  url: "/gas/history",
   ...options
 });
-var postPriceCachedPrice = (options) => (options.client ?? client).post({
+var getCachedPrice = (options) => (options.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/price/cached-price",
   ...options,
@@ -928,7 +912,7 @@ var postPriceCachedPrice = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
-var postV3Quote = (options) => (options.client ?? client).post({
+var getQuote = (options) => (options.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/v3/quote",
   ...options,
@@ -937,7 +921,7 @@ var postV3Quote = (options) => (options.client ?? client).post({
     ...options.headers
   }
 });
-var postV3Swap = (options) => (options.client ?? client).post({
+var executeSwap = (options) => (options.client ?? client).post({
   security: [{ name: "x-api-key", type: "apiKey" }],
   url: "/v3/swap",
   ...options,
@@ -952,43 +936,43 @@ var SwapKitService = class {
 };
 SwapKitService.getProviders = getProviders;
 SwapKitService.getTokens = getTokens;
-SwapKitService.getSwapTo = getSwapTo;
-SwapKitService.getSwapFrom = getSwapFrom;
-SwapKitService.getQuote = postV3Quote;
-SwapKitService.getSwap = postV3Swap;
-SwapKitService.trackTransaction = postTrack;
-SwapKitService.screenAddress = postScreen;
-SwapKitService.getGasPrices = getGas;
+SwapKitService.getSwapTo = getSwapToAssets;
+SwapKitService.getSwapFrom = getSwapFromAssets;
+SwapKitService.getQuote = getQuote;
+SwapKitService.getSwap = executeSwap;
+SwapKitService.trackTransaction = trackTransaction;
+SwapKitService.screenAddress = screenAddress;
+SwapKitService.getGasPrices = getGasPrices;
 SwapKitService.getGasHistory = getGasHistory;
-SwapKitService.getCachedPrice = postPriceCachedPrice;
-SwapKitService.createBrokerChannel = postChainflipBrokerChannel;
+SwapKitService.getCachedPrice = getCachedPrice;
+SwapKitService.createBrokerChannel = createBrokerChannel;
 var TokenlistService = {
   getProviders,
   getTokens,
-  getSwapTo,
-  getSwapFrom
+  getSwapTo: getSwapToAssets,
+  getSwapFrom: getSwapFromAssets
 };
 var QuoteService = {
-  getQuote: postV3Quote
+  getQuote
 };
 var SwapService = {
-  getSwap: postV3Swap
+  getSwap: executeSwap
 };
 var TrackService = {
-  trackTransaction: postTrack
+  trackTransaction
 };
 var ScreenService = {
-  screenAddress: postScreen
+  screenAddress
 };
 var GasService = {
-  getGasPrices: getGas,
+  getGasPrices,
   getGasHistory
 };
 var PriceService = {
-  getCachedPrice: postPriceCachedPrice
+  getCachedPrice
 };
 var ChainflipService = {
-  createBrokerChannel: postChainflipBrokerChannel
+  createBrokerChannel
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -1003,16 +987,16 @@ var ChainflipService = {
   TrackService,
   client,
   configureSwapKit,
-  getGas,
+  createBrokerChannel,
+  executeSwap,
+  getCachedPrice,
   getGasHistory,
+  getGasPrices,
   getProviders,
-  getSwapFrom,
-  getSwapTo,
+  getQuote,
+  getSwapFromAssets,
+  getSwapToAssets,
   getTokens,
-  postChainflipBrokerChannel,
-  postPriceCachedPrice,
-  postScreen,
-  postTrack,
-  postV3Quote,
-  postV3Swap
+  screenAddress,
+  trackTransaction
 });