feat: add additional headers to config and pass them through the request

Author: tharropoulos

src/typesense/configuration.py

@@ -74,6 +74,8 @@ class ConfigDict(typing.TypedDict):
         master_node (typing.Union[str, NodeConfigDict], deprecated): A dictionary or
             URL that represents the master node.
 
+        additional_headers (dict): Additional headers to include in the request.
+
         read_replica_nodes (list[typing.Union[str, NodeConfigDict]], deprecated): A list of
             dictionaries or URLs that represent the read replica nodes.
     """
@@ -87,6 +89,7 @@ class ConfigDict(typing.TypedDict):
     verify: typing.NotRequired[bool]
     timeout_seconds: typing.NotRequired[int]  # deprecated
     master_node: typing.NotRequired[typing.Union[str, NodeConfigDict]]  # deprecated
+    additional_headers: typing.NotRequired[typing.Dict[str, str]]
     read_replica_nodes: typing.NotRequired[
         typing.List[typing.Union[str, NodeConfigDict]]
     ]  # deprecated
@@ -213,6 +216,7 @@ def __init__(
             60,
         )
         self.verify = config_dict.get("verify", True)
+        self.additional_headers = config_dict.get("additional_headers", {})
 
     def _handle_nearest_node(
         self,

src/typesense/request_handler.py

@@ -204,7 +204,11 @@ def make_request(
         Raises:
             TypesenseClientError: If the API returns an error response.
         """
-        headers = {self.api_key_header_name: self.config.api_key}
+        headers = {
+            self.api_key_header_name: self.config.api_key,
+        }
+        headers.update(self.config.additional_headers)
+
         kwargs.setdefault("headers", {}).update(headers)
         kwargs.setdefault("timeout", self.config.connection_timeout_seconds)
         kwargs.setdefault("verify", self.config.verify)