Remove Params/Headers types

CHANGELOG.md

@@ -30,6 +30,12 @@ for upgrading your code to arangojs v9.
 
   For more information, see [the Node.js release schedule](https://nodejs.dev/en/about/releases/).
 
+- Removed `Params` and `Headers` types
+
+  These can mostly be replaced with the native `URLSearchParams` and `Headers`
+  types but most public methods still accept the equivalent `Record` types for
+  convenience.
+
 ### Changed
 
 - Replaced request logic with native `fetch` API

src/connection.ts

@@ -30,6 +30,7 @@ import {
   RequestFunction,
 } from "./lib/request";
 import { joinPath } from "./lib/joinPath";
+import { mergeHeaders } from "./lib/mergeHeaders";
 
 const MIME_JSON = /\/(json|javascript)(\W|$)/;
 const LEADER_ENDPOINT_HEADER = "x-arango-endpoint";
@@ -48,20 +49,6 @@ const LEADER_ENDPOINT_HEADER = "x-arango-endpoint";
  */
 export type LoadBalancingStrategy = "NONE" | "ROUND_ROBIN" | "ONE_RANDOM";
 
-/**
- * An arbitrary object with string values representing HTTP headers and their
- * values.
- *
- * Header names should always be lowercase.
- */
-export type Headers = Record<string, string>;
-
-/**
- * An arbitrary object with scalar values representing query string parameters
- * and their values.
- */
-export type Params = Record<string, any>;
-
 /**
  * Generic properties shared by all ArangoDB HTTP API responses.
  */
@@ -177,7 +164,7 @@ export type RequestOptions = {
    * HTTP headers to pass along with this request in addition to the default
    * headers generated by arangojs.
    */
-  headers?: Headers | globalThis.Headers;
+  headers?: Headers | Record<string, string>;
   /**
    * Time in milliseconds after which arangojs will abort the request if the
    * socket has not already timed out.
@@ -196,7 +183,7 @@ export type RequestOptions = {
   /**
    * URL parameters to pass as part of the query string.
    */
-  qs?: Params | URLSearchParams;
+  qs?: URLSearchParams | Record<string, any>;
 };
 
 /**
@@ -217,7 +204,7 @@ type Task = {
     timeout?: number;
     pathname: string;
     qs?: URLSearchParams;
-    headers: globalThis.Headers;
+    headers: Headers;
     body: any;
   };
 };
@@ -391,7 +378,7 @@ export type Config = {
    * using {@link database.Database#useBasicAuth}, {@link database.Database#useBearerAuth} or
    * the `auth` configuration option.
    */
-  headers?: Headers | globalThis.Headers;
+  headers?: Headers | Record<string, string>;
   /**
    * If set to `true`, arangojs will generate stack traces every time a request
    * is initiated and augment the stack traces of any errors it generates.
@@ -431,7 +418,7 @@ export function isArangoConnection(connection: any): connection is Connection {
 export class Connection {
   protected _activeTasks: number = 0;
   protected _arangoVersion: number = 31100;
-  protected _headers: globalThis.Headers;
+  protected _headers: Headers;
   protected _loadBalancingStrategy: LoadBalancingStrategy;
   protected _maxRetries: number | false;
   protected _taskPoolSize: number;
@@ -475,7 +462,7 @@ export class Connection {
       beforeRequest: config.beforeRequest,
       afterResponse: config.afterResponse,
     };
-    this._headers = new globalThis.Headers(config.headers);
+    this._headers = new Headers(config.headers);
     this._headers.set("x-arango-version", String(this._arangoVersion));
     this._headers.set(
       "x-arango-driver",
@@ -898,10 +885,7 @@ export class Connection {
     transform?: (res: ArangojsResponse) => T
   ): Promise<T> {
     return new Promise((resolve, reject) => {
-      const headers = new globalThis.Headers([
-        ...this._headers.entries(),
-        ...(requestHeaders ? Object.entries(requestHeaders) : []),
-      ]);
+      const headers = mergeHeaders(this._headers, requestHeaders ?? {});
 
       if (body && !(body instanceof FormData)) {
         let contentType;
@@ -935,7 +919,7 @@ export class Connection {
             (params instanceof URLSearchParams
               ? params
               : new URLSearchParams(params)),
-          headers: headers,
+          headers,
           timeout,
           method,
           expectBinary,

src/database.ts

@@ -31,7 +31,6 @@ import {
   ArangoApiResponse,
   Config,
   Connection,
-  Headers,
   RequestOptions,
 } from "./connection";
 import { ArrayCursor, BatchedArrayCursor } from "./cursor";
@@ -1910,7 +1909,7 @@ export class Database {
    * // with JSON request body '{"username": "admin", "password": "hunter2"}'
    * ```
    */
-  route(path?: string, headers?: Headers): Route {
+  route(path?: string, headers?: Headers | Record<string, string>): Route {
     return new Route(this, path, headers);
   }
 
@@ -2006,7 +2005,8 @@ export class Database {
       this._trapRequest = undefined;
       return new Promise<T>(async (resolveRequest, rejectRequest) => {
         const options = { ...opts };
-        options.headers = { ...options.headers, "x-arango-async": "store" };
+        options.headers = new Headers(options.headers);
+        options.headers.set("x-arango-async", "store");
         let jobRes: ArangojsResponse;
         try {
           jobRes = await this._connection.request({ basePath, ...options });

src/graph.ts

@@ -19,7 +19,6 @@ import {
   EdgeCollection,
   TraversalOptions,
 } from "./collection";
-import { Headers } from "./connection";
 import { Database } from "./database";
 import {
   Document,
@@ -567,7 +566,7 @@ export class GraphVertexCollection<T extends Record<string, any> = any>
       rev,
       ...qs
     } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     const result = this._db.request(
       {
@@ -664,7 +663,7 @@ export class GraphVertexCollection<T extends Record<string, any> = any>
       options = { rev: options };
     }
     const { rev, ...qs } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     return this._db.request(
       {
@@ -717,7 +716,7 @@ export class GraphVertexCollection<T extends Record<string, any> = any>
     if (typeof options === "string") {
       options = { rev: options };
     }
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     const { rev, ...qs } = options;
     if (rev) headers["if-match"] = rev;
     return this._db.request(
@@ -772,7 +771,7 @@ export class GraphVertexCollection<T extends Record<string, any> = any>
     if (typeof options === "string") {
       options = { rev: options };
     }
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     const { rev, ...qs } = options;
     if (rev) headers["if-match"] = rev;
     return this._db.request(
@@ -968,7 +967,7 @@ export class GraphEdgeCollection<T extends Record<string, any> = any>
       rev,
       ...qs
     } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     const result = this._db.request(
       {
@@ -1071,7 +1070,7 @@ export class GraphEdgeCollection<T extends Record<string, any> = any>
       options = { rev: options };
     }
     const { rev, ...qs } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     return this._db.request(
       {
@@ -1133,7 +1132,7 @@ export class GraphEdgeCollection<T extends Record<string, any> = any>
       options = { rev: options };
     }
     const { rev, ...qs } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     return this._db.request(
       {
@@ -1180,7 +1179,7 @@ export class GraphEdgeCollection<T extends Record<string, any> = any>
       options = { rev: options };
     }
     const { rev, ...qs } = options;
-    const headers: Headers = {};
+    const headers: Record<string, string> = {};
     if (rev) headers["if-match"] = rev;
     return this._db.request(
       {

src/lib/mergeHeaders.ts

@@ -0,0 +1,20 @@
+/**
+ * Utility function for merging headers.
+ *
+ * @packageDocumentation
+ * @internal
+ */
+
+/**
+ * @internal
+ */
+export function mergeHeaders(
+  base: Headers,
+  extra: Headers | Record<string, string> | undefined
+) {
+  if (!extra) return base;
+  return new Headers([
+    ...base,
+    ...(extra instanceof Headers ? extra : Object.entries(extra)),
+  ]);
+}