celitech-sdk 1.3.18 → 1.3.23

package/README.md

@@ -1,11 +1,13 @@
-# Celitech TypeScript SDK 1.3.18
+# Celitech TypeScript SDK 1.3.23
 
 Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
 
+[![This SDK was generated by liblab](https://public-liblab-readme-assets.s3.us-east-1.amazonaws.com/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
+
 ## Versions
 
 - API version: `1.1.0`
-- SDK version: `1.3.18`
+- SDK version: `1.3.23`
 
 ## About the API
 

package/dist/index.d.ts

@@ -155,7 +155,8 @@ declare enum ContentType {
     Binary = "binary",
     FormUrlEncoded = "form",
     Text = "text",
-    MultipartFormData = "multipartFormData"
+    MultipartFormData = "multipartFormData",
+    EventStream = "eventStream"
 }
 interface RequestConfig {
     retry?: RetryOptions;
@@ -187,6 +188,7 @@ declare class HttpClient {
     private readonly requestHandlerChain;
     constructor(config: SdkConfig, hook?: CustomHook);
     call<T>(request: Request<T>): Promise<HttpResponse<T>>;
+    stream<T>(request: Request<T>): AsyncGenerator<HttpResponse<T>>;
     callPaginated<FullResponse, Page>(request: Request<FullResponse, Page>): Promise<HttpResponse<Page>>;
     setBaseUrl(url: string): void;
     setConfig(config: SdkConfig): void;

package/dist/index.js

@@ -58,6 +58,12 @@ var RequestHandlerChain = class {
     }
     return this.handlers[0].handle(request);
   }
+  async *streamChain(request) {
+    if (!this.handlers.length) {
+      throw new Error("No handlers added to the chain");
+    }
+    yield* this.handlers[0].stream(request);
+  }
 };
 
 // src/http/error.ts
@@ -256,6 +262,22 @@ var HookHandler = class {
     }
     throw await hook.onError(nextRequest, response, hookParams);
   }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in hook handler.");
+    }
+    const hook = new TransportHookAdapter();
+    const hookParams = this.getHookParams(request);
+    const nextRequest = await hook.beforeRequest(request, hookParams);
+    const stream = this.next.stream(nextRequest);
+    for await (const response of stream) {
+      if (response.metadata.status < 400) {
+        yield await hook.afterResponse(nextRequest, response, hookParams);
+      } else {
+        throw await hook.onError(nextRequest, response, hookParams);
+      }
+    }
+  }
   getHookParams(_request) {
     const hookParams = /* @__PURE__ */ new Map();
     return hookParams;
@@ -267,47 +289,95 @@ var import_zod = require("zod");
 var ResponseValidationHandler = class {
   async handle(request) {
     const response = await this.next.handle(request);
+    return this.decodeBody(request, response);
+  }
+  async *stream(request) {
+    const stream = this.next.stream(request);
+    for await (const response of stream) {
+      const responseChunks = this.splitByDataChunks(response);
+      for (const chunk of responseChunks) {
+        yield this.decodeBody(request, chunk);
+      }
+    }
+  }
+  splitByDataChunks(response) {
+    if (!response.metadata.headers["content-type"].includes("text/event-stream")) {
+      return [response];
+    }
+    const text = new TextDecoder().decode(response.raw);
+    const encoder = new TextEncoder();
+    return text.split("\n").filter((line) => line.startsWith("data: ")).map((part) => ({
+      ...response,
+      raw: encoder.encode(part)
+    }));
+  }
+  decodeBody(request, response) {
     if (!this.hasContent(request, response)) {
       return response;
     }
-    if (request.responseContentType === "json" /* Json */) {
-      const decodedBody = new TextDecoder().decode(response.raw);
-      const json = JSON.parse(decodedBody);
-      return {
-        ...response,
-        data: this.validate(request, json)
-      };
-    } else if (request.responseContentType === "binary" /* Binary */ || request.responseContentType === "image" /* Image */) {
-      return {
-        ...response,
-        data: this.validate(request, response.raw)
-      };
-    } else if (request.responseContentType === "text" /* Text */ || request.responseContentType === "xml" /* Xml */) {
-      const text = new TextDecoder().decode(response.raw);
-      return {
-        ...response,
-        data: this.validate(request, text)
-      };
-    } else if (request.responseContentType === "form" /* FormUrlEncoded */) {
-      const urlEncoded = this.fromUrlEncoded(new TextDecoder().decode(response.raw));
-      return {
-        ...response,
-        data: this.validate(request, urlEncoded)
-      };
-    } else if (request.responseContentType === "multipartFormData" /* MultipartFormData */) {
-      const formData = this.fromFormData(response.raw);
-      return {
-        ...response,
-        data: this.validate(request, formData)
-      };
-    } else {
-      const decodedBody = new TextDecoder().decode(response.raw);
-      const json = JSON.parse(decodedBody);
-      return {
-        ...response,
-        data: this.validate(request, json)
-      };
+    if (request.responseContentType === "binary" /* Binary */ || request.responseContentType === "image" /* Image */) {
+      return this.decodeFile(request, response);
+    }
+    if (request.responseContentType === "multipartFormData" /* MultipartFormData */) {
+      return this.decodeMultipartFormData(request, response);
+    }
+    if (request.responseContentType === "text" /* Text */ || request.responseContentType === "xml" /* Xml */) {
+      return this.decodeText(request, response);
+    }
+    if (request.responseContentType === "form" /* FormUrlEncoded */) {
+      return this.decodeFormUrlEncoded(request, response);
+    }
+    if (request.responseContentType === "eventStream" /* EventStream */ || response.metadata.headers["content-type"].includes("text/event-stream")) {
+      return this.decodeEventStream(request, response);
+    }
+    return this.decodeJson(request, response);
+  }
+  decodeFile(request, response) {
+    return {
+      ...response,
+      data: this.validate(request, response.raw)
+    };
+  }
+  decodeMultipartFormData(request, response) {
+    const formData = this.fromFormData(response.raw);
+    return {
+      ...response,
+      data: this.validate(request, formData)
+    };
+  }
+  decodeText(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    return {
+      ...response,
+      data: this.validate(request, decodedBody)
+    };
+  }
+  decodeFormUrlEncoded(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    const urlEncoded = this.fromUrlEncoded(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, urlEncoded)
+    };
+  }
+  decodeEventStream(request, response) {
+    let decodedBody = new TextDecoder().decode(response.raw);
+    if (decodedBody.startsWith("data: ")) {
+      decodedBody = decodedBody.substring(6);
     }
+    const json = JSON.parse(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, json)
+    };
+  }
+  decodeJson(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    const json = JSON.parse(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, json)
+    };
   }
   validate(request, data) {
     var _a;
@@ -351,10 +421,21 @@ var ResponseValidationHandler = class {
 // src/http/handlers/request-validation-handler.ts
 var RequestValidationHandler = class {
   async handle(request) {
-    var _a, _b;
     if (!this.next) {
       throw new Error("No next handler set in ContentTypeHandler.");
     }
+    this.validateRequest(request);
+    return this.next.handle(request);
+  }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in ContentTypeHandler.");
+    }
+    this.validateRequest(request);
+    yield* this.next.stream(request);
+  }
+  validateRequest(request) {
+    var _a, _b;
     if (request.requestContentType === "json" /* Json */) {
       request.body = JSON.stringify((_a = request.requestSchema) == null ? void 0 : _a.parse(request.body));
     } else if (request.requestContentType === "xml" /* Xml */ || request.requestContentType === "binary" /* Binary */ || request.requestContentType === "text" /* Text */) {
@@ -366,7 +447,6 @@ var RequestValidationHandler = class {
     } else {
       request.body = JSON.stringify((_b = request.requestSchema) == null ? void 0 : _b.parse(request.body));
     }
-    return await this.next.handle(request);
   }
   toFormUrlEncoded(request) {
     var _a;
@@ -434,6 +514,34 @@ var RequestFetchAdapter = class {
       raw: await response.clone().arrayBuffer()
     };
   }
+  async *stream() {
+    const response = await fetch(this.request.constructFullUrl(), this.requestInit);
+    const metadata = {
+      status: response.status,
+      statusText: response.statusText || "",
+      headers: this.getHeaders(response)
+    };
+    if (response.status >= 400) {
+      throw new HttpError(metadata, await response.clone().arrayBuffer());
+    }
+    if (!response.body) {
+      return yield {
+        metadata,
+        raw: await response.clone().arrayBuffer()
+      };
+    }
+    const reader = response.body.getReader();
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) {
+        break;
+      }
+      yield {
+        metadata,
+        raw: value
+      };
+    }
+  }
   setMethod(method) {
     if (!method) {
       return;
@@ -484,6 +592,9 @@ var TerminatingHandler = class {
   async handle(request) {
     return new RequestFetchAdapter(request).send();
   }
+  async *stream(request) {
+    yield* new RequestFetchAdapter(request).stream();
+  }
 };
 
 // src/http/handlers/retry-handler.ts
@@ -504,6 +615,23 @@ var RetryHandler = class {
     }
     throw new Error("Error retrying request.");
   }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in retry handler.");
+    }
+    for (let attempt = 1; attempt <= request.retry.attempts; attempt++) {
+      try {
+        yield* this.next.stream(request);
+        return;
+      } catch (error) {
+        if (!this.shouldRetry(error) || attempt === request.retry.attempts) {
+          throw error;
+        }
+        await this.delay(request.retry.delayMs);
+      }
+    }
+    throw new Error("Error retrying request.");
+  }
   shouldRetry(error) {
     return error instanceof HttpError && (error.metadata.status >= 500 || error.metadata.status === 408);
   }
@@ -520,12 +648,22 @@ var RetryHandler = class {
 // src/http/handlers/oauth-handler.ts
 var OAuthHandler = class {
   async handle(request) {
-    var _a;
     if (!this.next) {
       throw new Error(`No next handler set in OAuthHandler`);
     }
+    await this.addToken(request);
+    return this.next.handle(request);
+  }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error(`No next handler set in OAuthHandler`);
+    }
+    await this.addToken(request);
+    yield* this.next.stream(request);
+  }
+  async addToken(request) {
     if (!request.scopes) {
-      return (_a = this.next) == null ? void 0 : _a.handle(request);
+      return;
     }
     const token = await request.tokenManager.getToken(request.scopes, request.config);
     if (token.accessToken) {
@@ -539,7 +677,6 @@ var OAuthHandler = class {
         isOffset: false
       });
     }
-    return this.next.handle(request);
   }
 };
 
@@ -558,6 +695,9 @@ var HttpClient = class {
   call(request) {
     return this.requestHandlerChain.callChain(request);
   }
+  async *stream(request) {
+    yield* this.requestHandlerChain.streamChain(request);
+  }
   async callPaginated(request) {
     const response = await this.call(request);
     if (!response.data) {

package/dist/index.mjs

@@ -16,6 +16,12 @@ var RequestHandlerChain = class {
     }
     return this.handlers[0].handle(request);
   }
+  async *streamChain(request) {
+    if (!this.handlers.length) {
+      throw new Error("No handlers added to the chain");
+    }
+    yield* this.handlers[0].stream(request);
+  }
 };
 
 // src/http/error.ts
@@ -214,6 +220,22 @@ var HookHandler = class {
     }
     throw await hook.onError(nextRequest, response, hookParams);
   }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in hook handler.");
+    }
+    const hook = new TransportHookAdapter();
+    const hookParams = this.getHookParams(request);
+    const nextRequest = await hook.beforeRequest(request, hookParams);
+    const stream = this.next.stream(nextRequest);
+    for await (const response of stream) {
+      if (response.metadata.status < 400) {
+        yield await hook.afterResponse(nextRequest, response, hookParams);
+      } else {
+        throw await hook.onError(nextRequest, response, hookParams);
+      }
+    }
+  }
   getHookParams(_request) {
     const hookParams = /* @__PURE__ */ new Map();
     return hookParams;
@@ -225,47 +247,95 @@ import { ZodUndefined } from "zod";
 var ResponseValidationHandler = class {
   async handle(request) {
     const response = await this.next.handle(request);
+    return this.decodeBody(request, response);
+  }
+  async *stream(request) {
+    const stream = this.next.stream(request);
+    for await (const response of stream) {
+      const responseChunks = this.splitByDataChunks(response);
+      for (const chunk of responseChunks) {
+        yield this.decodeBody(request, chunk);
+      }
+    }
+  }
+  splitByDataChunks(response) {
+    if (!response.metadata.headers["content-type"].includes("text/event-stream")) {
+      return [response];
+    }
+    const text = new TextDecoder().decode(response.raw);
+    const encoder = new TextEncoder();
+    return text.split("\n").filter((line) => line.startsWith("data: ")).map((part) => ({
+      ...response,
+      raw: encoder.encode(part)
+    }));
+  }
+  decodeBody(request, response) {
     if (!this.hasContent(request, response)) {
       return response;
     }
-    if (request.responseContentType === "json" /* Json */) {
-      const decodedBody = new TextDecoder().decode(response.raw);
-      const json = JSON.parse(decodedBody);
-      return {
-        ...response,
-        data: this.validate(request, json)
-      };
-    } else if (request.responseContentType === "binary" /* Binary */ || request.responseContentType === "image" /* Image */) {
-      return {
-        ...response,
-        data: this.validate(request, response.raw)
-      };
-    } else if (request.responseContentType === "text" /* Text */ || request.responseContentType === "xml" /* Xml */) {
-      const text = new TextDecoder().decode(response.raw);
-      return {
-        ...response,
-        data: this.validate(request, text)
-      };
-    } else if (request.responseContentType === "form" /* FormUrlEncoded */) {
-      const urlEncoded = this.fromUrlEncoded(new TextDecoder().decode(response.raw));
-      return {
-        ...response,
-        data: this.validate(request, urlEncoded)
-      };
-    } else if (request.responseContentType === "multipartFormData" /* MultipartFormData */) {
-      const formData = this.fromFormData(response.raw);
-      return {
-        ...response,
-        data: this.validate(request, formData)
-      };
-    } else {
-      const decodedBody = new TextDecoder().decode(response.raw);
-      const json = JSON.parse(decodedBody);
-      return {
-        ...response,
-        data: this.validate(request, json)
-      };
+    if (request.responseContentType === "binary" /* Binary */ || request.responseContentType === "image" /* Image */) {
+      return this.decodeFile(request, response);
+    }
+    if (request.responseContentType === "multipartFormData" /* MultipartFormData */) {
+      return this.decodeMultipartFormData(request, response);
+    }
+    if (request.responseContentType === "text" /* Text */ || request.responseContentType === "xml" /* Xml */) {
+      return this.decodeText(request, response);
+    }
+    if (request.responseContentType === "form" /* FormUrlEncoded */) {
+      return this.decodeFormUrlEncoded(request, response);
+    }
+    if (request.responseContentType === "eventStream" /* EventStream */ || response.metadata.headers["content-type"].includes("text/event-stream")) {
+      return this.decodeEventStream(request, response);
+    }
+    return this.decodeJson(request, response);
+  }
+  decodeFile(request, response) {
+    return {
+      ...response,
+      data: this.validate(request, response.raw)
+    };
+  }
+  decodeMultipartFormData(request, response) {
+    const formData = this.fromFormData(response.raw);
+    return {
+      ...response,
+      data: this.validate(request, formData)
+    };
+  }
+  decodeText(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    return {
+      ...response,
+      data: this.validate(request, decodedBody)
+    };
+  }
+  decodeFormUrlEncoded(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    const urlEncoded = this.fromUrlEncoded(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, urlEncoded)
+    };
+  }
+  decodeEventStream(request, response) {
+    let decodedBody = new TextDecoder().decode(response.raw);
+    if (decodedBody.startsWith("data: ")) {
+      decodedBody = decodedBody.substring(6);
     }
+    const json = JSON.parse(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, json)
+    };
+  }
+  decodeJson(request, response) {
+    const decodedBody = new TextDecoder().decode(response.raw);
+    const json = JSON.parse(decodedBody);
+    return {
+      ...response,
+      data: this.validate(request, json)
+    };
   }
   validate(request, data) {
     var _a;
@@ -309,10 +379,21 @@ var ResponseValidationHandler = class {
 // src/http/handlers/request-validation-handler.ts
 var RequestValidationHandler = class {
   async handle(request) {
-    var _a, _b;
     if (!this.next) {
       throw new Error("No next handler set in ContentTypeHandler.");
     }
+    this.validateRequest(request);
+    return this.next.handle(request);
+  }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in ContentTypeHandler.");
+    }
+    this.validateRequest(request);
+    yield* this.next.stream(request);
+  }
+  validateRequest(request) {
+    var _a, _b;
     if (request.requestContentType === "json" /* Json */) {
       request.body = JSON.stringify((_a = request.requestSchema) == null ? void 0 : _a.parse(request.body));
     } else if (request.requestContentType === "xml" /* Xml */ || request.requestContentType === "binary" /* Binary */ || request.requestContentType === "text" /* Text */) {
@@ -324,7 +405,6 @@ var RequestValidationHandler = class {
     } else {
       request.body = JSON.stringify((_b = request.requestSchema) == null ? void 0 : _b.parse(request.body));
     }
-    return await this.next.handle(request);
   }
   toFormUrlEncoded(request) {
     var _a;
@@ -392,6 +472,34 @@ var RequestFetchAdapter = class {
       raw: await response.clone().arrayBuffer()
     };
   }
+  async *stream() {
+    const response = await fetch(this.request.constructFullUrl(), this.requestInit);
+    const metadata = {
+      status: response.status,
+      statusText: response.statusText || "",
+      headers: this.getHeaders(response)
+    };
+    if (response.status >= 400) {
+      throw new HttpError(metadata, await response.clone().arrayBuffer());
+    }
+    if (!response.body) {
+      return yield {
+        metadata,
+        raw: await response.clone().arrayBuffer()
+      };
+    }
+    const reader = response.body.getReader();
+    while (true) {
+      const { done, value } = await reader.read();
+      if (done) {
+        break;
+      }
+      yield {
+        metadata,
+        raw: value
+      };
+    }
+  }
   setMethod(method) {
     if (!method) {
       return;
@@ -442,6 +550,9 @@ var TerminatingHandler = class {
   async handle(request) {
     return new RequestFetchAdapter(request).send();
   }
+  async *stream(request) {
+    yield* new RequestFetchAdapter(request).stream();
+  }
 };
 
 // src/http/handlers/retry-handler.ts
@@ -462,6 +573,23 @@ var RetryHandler = class {
     }
     throw new Error("Error retrying request.");
   }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error("No next handler set in retry handler.");
+    }
+    for (let attempt = 1; attempt <= request.retry.attempts; attempt++) {
+      try {
+        yield* this.next.stream(request);
+        return;
+      } catch (error) {
+        if (!this.shouldRetry(error) || attempt === request.retry.attempts) {
+          throw error;
+        }
+        await this.delay(request.retry.delayMs);
+      }
+    }
+    throw new Error("Error retrying request.");
+  }
   shouldRetry(error) {
     return error instanceof HttpError && (error.metadata.status >= 500 || error.metadata.status === 408);
   }
@@ -478,12 +606,22 @@ var RetryHandler = class {
 // src/http/handlers/oauth-handler.ts
 var OAuthHandler = class {
   async handle(request) {
-    var _a;
     if (!this.next) {
       throw new Error(`No next handler set in OAuthHandler`);
     }
+    await this.addToken(request);
+    return this.next.handle(request);
+  }
+  async *stream(request) {
+    if (!this.next) {
+      throw new Error(`No next handler set in OAuthHandler`);
+    }
+    await this.addToken(request);
+    yield* this.next.stream(request);
+  }
+  async addToken(request) {
     if (!request.scopes) {
-      return (_a = this.next) == null ? void 0 : _a.handle(request);
+      return;
     }
     const token = await request.tokenManager.getToken(request.scopes, request.config);
     if (token.accessToken) {
@@ -497,7 +635,6 @@ var OAuthHandler = class {
         isOffset: false
       });
     }
-    return this.next.handle(request);
   }
 };
 
@@ -516,6 +653,9 @@ var HttpClient = class {
   call(request) {
     return this.requestHandlerChain.callChain(request);
   }
+  async *stream(request) {
+    yield* this.requestHandlerChain.streamChain(request);
+  }
   async callPaginated(request) {
     const response = await this.call(request);
     if (!response.data) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "celitech-sdk",
-  "version": "1.3.18",
+  "version": "1.3.23",
   "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/index.js",