celitech-sdk 1.1.86 → 1.1.87

package/README.md

@@ -1,11 +1,11 @@
-# Celitech TypeScript SDK 1.1.86
+# Celitech TypeScript SDK 1.1.87
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
 ## Versions
 
 - API version: `1.1.0`
-- SDK version: `1.1.86`
+- SDK version: `1.1.87`
 
 ## About the API
 
@@ -18,6 +18,7 @@ Welcome to the CELITECH API documentation! Useful links: [Homepage](https://www.
   - [Installation](#installation)
   - [Environment Variables](#environment-variables)
 - [Setting a Custom Timeout](#setting-a-custom-timeout)
+- [Sample Usage](#sample-usage)
 - [Services](#services)
 - [Models](#models)
 - [License](#license)
@@ -57,6 +58,25 @@ You can set a custom timeout for the SDK's HTTP requests as follows:
 const celitech = new Celitech({ timeout: 10000 });
 ```
 
+# Sample Usage
+
+Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
+
+```ts
+import { Celitech } from 'celitech-sdk';
+
+(async () => {
+  const celitech = new Celitech({
+    clientId: 'client-id',
+    clientSecret: 'client-secret',
+  });
+
+  const { data } = await celitech.destinations.listDestinations();
+
+  console.log(data);
+})();
+```
+
 ## Services
 
 The SDK provides various services to interact with the API.

package/dist/index.d.ts

@@ -4,7 +4,7 @@ declare enum Environment {
     DEFAULT = "https://api.celitech.net/v1"
 }
 
-type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type HttpMethod$1 = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
 interface HttpRequest {
     baseUrl: string;
     method: HttpMethod$1;
@@ -97,7 +97,7 @@ declare class Request<T> {
     private constructPath;
 }
 
-type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
 interface SdkConfig {
     baseUrl?: string;
     environment?: Environment;
@@ -112,7 +112,7 @@ interface HttpMetadata {
     statusText: string;
     headers: Record<string, string>;
 }
-interface HttpResponse<T> {
+interface HttpResponse<T = unknown> {
     data?: T;
     metadata: HttpMetadata;
     raw: ArrayBuffer;

package/dist/index.js

@@ -451,53 +451,87 @@ var RequestValidationHandler = class {
   }
 };
 
-// src/http/transport/request-fetch-adapter.ts
-var RequestFetchAdapter = class {
+// src/http/transport/request-axios-adapter.ts
+var import_axios = __toESM(require("axios"));
+var RequestAxiosAdapter = class {
   constructor(request) {
     this.request = request;
-    this.requestInit = {};
-    this.setMethod(request.method);
-    this.setHeaders(request.getHeaders());
-    this.setBody(request.body);
-    this.setTimeout(request.config.timeout);
+    this.config = {
+      responseType: "arraybuffer"
+    };
+    this.setHeaders();
+    this.setTimeout();
   }
   async send() {
-    return fetch(this.request.constructFullUrl(), this.requestInit);
-  }
-  setMethod(method) {
-    if (!method) {
-      return;
+    const method = this.getMethod();
+    const { body } = this.request;
+    let axiosResponse;
+    try {
+      if (this.request.method === "POST" || this.request.method === "PUT" || this.request.method === "PATCH") {
+        axiosResponse = await method(this.request.constructFullUrl(), body, this.config);
+      } else {
+        axiosResponse = await method(this.request.constructFullUrl(), this.config);
+      }
+    } catch (err) {
+      if ((0, import_axios.isAxiosError)(err) && err.response) {
+        axiosResponse = err.response;
+      } else {
+        throw err;
+      }
     }
-    this.requestInit = {
-      ...this.requestInit,
-      method
+    const headerRecord = {};
+    Object.keys(axiosResponse.headers).forEach((key) => {
+      headerRecord[key] = axiosResponse.headers[key];
+    });
+    const metadata = {
+      status: axiosResponse.status,
+      statusText: axiosResponse.statusText || "",
+      headers: headerRecord
     };
-  }
-  setBody(body) {
-    if (!body) {
-      return;
+    if (metadata.status >= 400) {
+      throw new HttpError(metadata);
     }
-    this.requestInit = {
-      ...this.requestInit,
-      body
+    return {
+      metadata,
+      raw: axiosResponse.data.buffer.slice(
+        axiosResponse.data.byteOffset,
+        axiosResponse.data.byteOffset + axiosResponse.data.byteLength
+      )
     };
   }
-  setHeaders(headers) {
-    if (!headers) {
-      return;
+  getMethod() {
+    if (this.request.method === "POST") {
+      return import_axios.default.post;
+    } else if (this.request.method === "GET") {
+      return import_axios.default.get;
+    } else if (this.request.method === "PUT") {
+      return import_axios.default.put;
+    } else if (this.request.method === "DELETE") {
+      return import_axios.default.delete;
+    } else if (this.request.method === "PATCH") {
+      return import_axios.default.patch;
+    } else if (this.request.method === "HEAD") {
+      return import_axios.default.head;
     }
-    this.requestInit = {
-      ...this.requestInit,
-      headers
-    };
+    throw new Error("invalid method!!!!");
   }
-  setTimeout(timeout) {
-    if (!timeout) {
+  setHeaders() {
+    if (!this.request.headers) {
       return;
     }
-    this.requestInit = {
-      ...this.requestInit,
-      signal: AbortSignal.timeout(timeout)
+    const headersRecord = {};
+    new Headers(this.request.getHeaders()).forEach((value, key) => {
+      headersRecord[key] = value;
+    });
+    this.config = {
+      ...this.config,
+      headers: headersRecord
+    };
+  }
+  setTimeout() {
+    this.config = {
+      ...this.config,
+      timeout: this.request.config.timeout
     };
   }
 };
@@ -505,29 +539,7 @@ var RequestFetchAdapter = class {
 // src/http/handlers/terminating-handler.ts
 var TerminatingHandler = class {
   async handle(request) {
-    const response = await new RequestFetchAdapter(request).send();
-    const metadata = {
-      status: response.status,
-      statusText: response.statusText,
-      headers: this.getHeaders(response)
-    };
-    if (metadata.status >= 400) {
-      throw new HttpError(metadata);
-    }
-    return {
-      metadata,
-      raw: await response.clone().arrayBuffer()
-    };
-  }
-  getHeaders(response) {
-    const headers = {};
-    response.headers.forEach((value, key) => {
-      headers[key] = value;
-    });
-    return headers;
-  }
-  isErrorResponse(response) {
-    return response.metadata.status >= 400;
+    return new RequestAxiosAdapter(request).send();
   }
 };
 

package/dist/index.mjs

@@ -411,53 +411,87 @@ var RequestValidationHandler = class {
   }
 };
 
-// src/http/transport/request-fetch-adapter.ts
-var RequestFetchAdapter = class {
+// src/http/transport/request-axios-adapter.ts
+import axios, { isAxiosError } from "axios";
+var RequestAxiosAdapter = class {
   constructor(request) {
     this.request = request;
-    this.requestInit = {};
-    this.setMethod(request.method);
-    this.setHeaders(request.getHeaders());
-    this.setBody(request.body);
-    this.setTimeout(request.config.timeout);
+    this.config = {
+      responseType: "arraybuffer"
+    };
+    this.setHeaders();
+    this.setTimeout();
   }
   async send() {
-    return fetch(this.request.constructFullUrl(), this.requestInit);
-  }
-  setMethod(method) {
-    if (!method) {
-      return;
+    const method = this.getMethod();
+    const { body } = this.request;
+    let axiosResponse;
+    try {
+      if (this.request.method === "POST" || this.request.method === "PUT" || this.request.method === "PATCH") {
+        axiosResponse = await method(this.request.constructFullUrl(), body, this.config);
+      } else {
+        axiosResponse = await method(this.request.constructFullUrl(), this.config);
+      }
+    } catch (err) {
+      if (isAxiosError(err) && err.response) {
+        axiosResponse = err.response;
+      } else {
+        throw err;
+      }
     }
-    this.requestInit = {
-      ...this.requestInit,
-      method
+    const headerRecord = {};
+    Object.keys(axiosResponse.headers).forEach((key) => {
+      headerRecord[key] = axiosResponse.headers[key];
+    });
+    const metadata = {
+      status: axiosResponse.status,
+      statusText: axiosResponse.statusText || "",
+      headers: headerRecord
     };
-  }
-  setBody(body) {
-    if (!body) {
-      return;
+    if (metadata.status >= 400) {
+      throw new HttpError(metadata);
     }
-    this.requestInit = {
-      ...this.requestInit,
-      body
+    return {
+      metadata,
+      raw: axiosResponse.data.buffer.slice(
+        axiosResponse.data.byteOffset,
+        axiosResponse.data.byteOffset + axiosResponse.data.byteLength
+      )
     };
   }
-  setHeaders(headers) {
-    if (!headers) {
-      return;
+  getMethod() {
+    if (this.request.method === "POST") {
+      return axios.post;
+    } else if (this.request.method === "GET") {
+      return axios.get;
+    } else if (this.request.method === "PUT") {
+      return axios.put;
+    } else if (this.request.method === "DELETE") {
+      return axios.delete;
+    } else if (this.request.method === "PATCH") {
+      return axios.patch;
+    } else if (this.request.method === "HEAD") {
+      return axios.head;
     }
-    this.requestInit = {
-      ...this.requestInit,
-      headers
-    };
+    throw new Error("invalid method!!!!");
   }
-  setTimeout(timeout) {
-    if (!timeout) {
+  setHeaders() {
+    if (!this.request.headers) {
       return;
     }
-    this.requestInit = {
-      ...this.requestInit,
-      signal: AbortSignal.timeout(timeout)
+    const headersRecord = {};
+    new Headers(this.request.getHeaders()).forEach((value, key) => {
+      headersRecord[key] = value;
+    });
+    this.config = {
+      ...this.config,
+      headers: headersRecord
+    };
+  }
+  setTimeout() {
+    this.config = {
+      ...this.config,
+      timeout: this.request.config.timeout
     };
   }
 };
@@ -465,29 +499,7 @@ var RequestFetchAdapter = class {
 // src/http/handlers/terminating-handler.ts
 var TerminatingHandler = class {
   async handle(request) {
-    const response = await new RequestFetchAdapter(request).send();
-    const metadata = {
-      status: response.status,
-      statusText: response.statusText,
-      headers: this.getHeaders(response)
-    };
-    if (metadata.status >= 400) {
-      throw new HttpError(metadata);
-    }
-    return {
-      metadata,
-      raw: await response.clone().arrayBuffer()
-    };
-  }
-  getHeaders(response) {
-    const headers = {};
-    response.headers.forEach((value, key) => {
-      headers[key] = value;
-    });
-    return headers;
-  }
-  isErrorResponse(response) {
-    return response.metadata.status >= 400;
+    return new RequestAxiosAdapter(request).send();
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "celitech-sdk",
-  "version": "1.1.86",
+  "version": "1.1.87",
   "description": "Welcome to the CELITECH API documentation!  Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/) ",
   "source": "./src/index.ts",
   "main": "./dist/commonjs/index.js",
@@ -9,6 +9,7 @@
   "unpkg": "./dist/index.umd.js",
   "types": "./dist/commonjs/index.d.ts",
   "scripts": {
+    "test": "tsc --noEmit",
     "build": "tsup-node src/index.ts --format cjs,esm --dts --clean",
     "prepublishOnly": "npm run build"
   },
@@ -29,7 +30,8 @@
     "tsup": "^6.7.0"
   },
   "dependencies": {
-    "zod": "3.22.0"
+    "zod": "3.22.0",
+    "axios": "^1.7.4"
   },
   "exports": {
     ".": {