chore(release): 1.8.0 [skip ci]

## [1.8.0](v1.7.0...v1.8.0) (2024-12-17) ### 🚀 Features * add header and connect timeouts ([6183474](6183474)) * undici v7 ([4c5f2de](4c5f2de)) ### 📔 Docs * fix badge ([e6b831a](e6b831a))
SkeLLLa · Dec 17, 2024 · 4190a51 · 4190a51
1 parent 4c5f2de
commit 4190a51
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 11 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,3 +1,14 @@
+## [1.8.0](https://github.com/SkeLLLa/pinot-noir/compare/v1.7.0...v1.8.0) (2024-12-17)
+
+### 🚀 Features
+
+* add header and connect timeouts ([6183474](https://github.com/SkeLLLa/pinot-noir/commit/6183474786c3c516651f176392725c9462b8bbe9))
+* undici v7 ([4c5f2de](https://github.com/SkeLLLa/pinot-noir/commit/4c5f2dee72e714c0a224564a8f687cafef439520))
+
+### 📔 Docs
+
+* fix badge ([e6b831a](https://github.com/SkeLLLa/pinot-noir/commit/e6b831ac76d692143b0808a0c944fad0b59b2840))
+
 ## [1.7.0](https://github.com/SkeLLLa/pinot-noir/compare/v1.6.0...v1.7.0) (2024-09-17)
 
 ### 🛠 Fixes

diff --git a/docs/api/pinot-noir.ebrokertransporterrorcode.md b/docs/api/pinot-noir.ebrokertransporterrorcode.md
@@ -42,6 +42,19 @@ Invalid response from pinot
 </td></tr>
 <tr><td>
 
+TIMEOUT
+
+</td><td>
+
+`2`
+
+</td><td>
+
+Timeout
+
+</td></tr>
+<tr><td>
+
 UNKNOWN
 
 </td><td>

diff --git a/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.bodytimeout.md
@@ -4,7 +4,7 @@
 
 ## IBrokerTransportConfig.bodyTimeout property
 
-The timeout after which a request will time out, in milliseconds
+The timeout after which a request will time out (in ms)
 
 **Signature:**
 

diff --git a/docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.connecttimeout.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerTransportConfig](./pinot-noir.ibrokertransportconfig.md) &gt; [connectTimeout](./pinot-noir.ibrokertransportconfig.connecttimeout.md)
+
+## IBrokerTransportConfig.connectTimeout property
+
+TCP connect timeout (in ms)
+
+**Signature:**
+
+```typescript
+connectTimeout?: number;
+```
diff --git a/docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.headerstimeout.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IBrokerTransportConfig](./pinot-noir.ibrokertransportconfig.md) &gt; [headersTimeout](./pinot-noir.ibrokertransportconfig.headerstimeout.md)
+
+## IBrokerTransportConfig.headersTimeout property
+
+Headers timeout (in ms)
+
+**Signature:**
+
+```typescript
+headersTimeout?: number;
+```
diff --git a/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md b/docs/api/pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md
@@ -4,7 +4,7 @@
 
 ## IBrokerTransportConfig.keepAliveMaxTimeout property
 
-The maximum allowed `keepAliveTimeout`
+The maximum allowed `keepAliveTimeout` (in ms)
 
 **Signature:**
 

diff --git a/docs/api/pinot-noir.ibrokertransportconfig.md b/docs/api/pinot-noir.ibrokertransportconfig.md
@@ -43,7 +43,7 @@ number
 
 </td><td>
 
-_(Optional)_ The timeout after which a request will time out, in milliseconds
+_(Optional)_ The timeout after which a request will time out (in ms)
 
 </td></tr>
 <tr><td>
@@ -78,6 +78,36 @@ _(Optional)_ Max pool connections. `undefined` = unlimited.
 </td></tr>
 <tr><td>
 
+[connectTimeout?](./pinot-noir.ibrokertransportconfig.connecttimeout.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ TCP connect timeout (in ms)
+
+</td></tr>
+<tr><td>
+
+[headersTimeout?](./pinot-noir.ibrokertransportconfig.headerstimeout.md)
+
+</td><td>
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Headers timeout (in ms)
+
+</td></tr>
+<tr><td>
+
 [keepAliveMaxTimeout?](./pinot-noir.ibrokertransportconfig.keepalivemaxtimeout.md)
 
 </td><td>
@@ -88,7 +118,7 @@ number
 
 </td><td>
 
-_(Optional)_ The maximum allowed `keepAliveTimeout`
+_(Optional)_ The maximum allowed `keepAliveTimeout` (in ms)
 
 </td></tr>
 <tr><td>

diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md b/docs/api/pinot-noir.pinotbrokerjsontransport._constructor_.md
@@ -9,7 +9,7 @@ Constructs a new instance of the `PinotBrokerJSONTransport` class
 **Signature:**
 
 ```typescript
-constructor({ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, }: IBrokerTransportConfig);
+constructor({ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, }: IBrokerTransportConfig);
 ```
 
 ## Parameters
@@ -29,7 +29,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-{ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, }
+{ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, }
 
 </td><td>
 

diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport.md b/docs/api/pinot-noir.pinotbrokerjsontransport.md
@@ -31,7 +31,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)({ brokerUrl, token, bodyTimeout, connections, keepAliveMaxTimeout, })](./pinot-noir.pinotbrokerjsontransport._constructor_.md)
+[(constructor)({ bodyTimeout, brokerUrl, connections, connectTimeout, headersTimeout, keepAliveMaxTimeout, token, })](./pinot-noir.pinotbrokerjsontransport._constructor_.md)
 
 </td><td>
 
@@ -142,7 +142,7 @@ Closes connection to pinot broker
 </td></tr>
 <tr><td>
 
-[request({ method, headers, path, body, query, })](./pinot-noir.pinotbrokerjsontransport.request.md)
+[request({ body, headers, method, path, query, })](./pinot-noir.pinotbrokerjsontransport.request.md)
 
 </td><td>
 

diff --git a/docs/api/pinot-noir.pinotbrokerjsontransport.request.md b/docs/api/pinot-noir.pinotbrokerjsontransport.request.md
@@ -9,7 +9,7 @@ Perform HTTP request to pinot
 **Signature:**
 
 ```typescript
-request<TResponse = unknown>({ method, headers, path, body, query, }: IBrokerTransportRequestOptions): Promise<TResponse>;
+request<TResponse = unknown>({ body, headers, method, path, query, }: IBrokerTransportRequestOptions): Promise<TResponse>;
 ```
 
 ## Parameters
@@ -29,7 +29,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-{ method, headers, path, body, query, }
+{ body, headers, method, path, query, }
 
 </td><td>
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "pinot-noir",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Unofficial client for Apache Pinot.",
   "keywords": [
     "pinot",