Inline util modules

Author: pluma

CHANGELOG.md

@@ -47,6 +47,16 @@ This driver uses semantic versioning:
   This brings these methods behavior in line with that of the `beginTransaction`
   and `executeTransaction` methods of `Database` objects.
 
+- Moved `collectionToString` helper into `collection` module
+
+- Moved `Dict` type into `connection` module
+
+- Moved `Patch` type into `documents` module
+
+- Moved `Errback` type into library internals
+
+- Renamed `util/foxx-manifest` module to `foxx-manifest`
+
 ### Added
 
 - Added `precaptureStackTraces` configuration option ([#599](https://github.com/arangodb/arangojs/issues/599))

src/aql.ts

@@ -11,7 +11,7 @@
  * @packageDocumentation
  */
 import { ArangoCollection, isArangoCollection } from "./collection";
-import { Dict } from "./util/types";
+import { Dict } from "./connection";
 import { isArangoView, View } from "./view";
 
 /**

src/collection.ts

@@ -21,6 +21,7 @@ import {
   DocumentSelector,
   Edge,
   EdgeData,
+  Patch,
   _documentHandle,
 } from "./documents";
 import { isArangoError } from "./error";
@@ -43,7 +44,6 @@ import {
 } from "./indexes";
 import { Blob } from "./lib/blob";
 import { COLLECTION_NOT_FOUND, DOCUMENT_NOT_FOUND } from "./lib/codes";
-import { Patch } from "./util/types";
 
 /**
  * Indicates whether the given value represents an {@link ArangoCollection}.
@@ -56,6 +56,20 @@ export function isArangoCollection(
   return Boolean(collection && collection.isArangoCollection);
 }
 
+/**
+ * Coerces the given collection name or {@link ArangoCollection} object to
+ * a string representing the collection name.
+ *
+ * @param collection - Collection name or {@link ArangoCollection} object.
+ */
+export function collectionToString(
+  collection: string | ArangoCollection
+): string {
+  if (isArangoCollection(collection)) {
+    return String(collection.name);
+  } else return String(collection);
+}
+
 /**
  * A marker interface identifying objects that can be used in AQL template
  * strings to create references to ArangoDB collections.

src/connection.ts

@@ -33,6 +33,13 @@ import {
 const MIME_JSON = /\/(json|javascript)(\W|$)/;
 const LEADER_ENDPOINT_HEADER = "x-arango-endpoint";
 
+/**
+ * Generic type representing an object with values of a given value type.
+ *
+ * @param T - Type of the object's property values.
+ */
+export type Dict<T> = { [key: string]: T };
+
 /**
  * Determines the behavior when multiple URLs are used:
  *
@@ -53,17 +60,13 @@ export type LoadBalancingStrategy = "NONE" | "ROUND_ROBIN" | "ONE_RANDOM";
  *
  * Header names should always be lowercase.
  */
-export type Headers = {
-  [key: string]: string;
-};
+export type Headers = Dict<string>;
 
 /**
  * An arbitrary object with scalar values representing query string parameters
  * and their values.
  */
-export type Params = {
-  [key: string]: any;
-};
+export type Params = Dict<any>;
 
 /**
  * Generic properties shared by all ArangoDB HTTP API responses.

src/cursor.ts

@@ -8,8 +8,8 @@
  * @packageDocumentation
  */
 import { LinkedList } from "x3-linkedlist";
+import { Dict } from "./connection";
 import { Database } from "./database";
-import { Dict } from "./util/types";
 
 /**
  * Additional information about the cursor.

src/database.ts

@@ -21,6 +21,7 @@ import {
   ArangoCollection,
   Collection,
   CollectionMetadata,
+  collectionToString,
   CollectionType,
   CreateCollectionOptions,
   DocumentCollection,
@@ -31,11 +32,13 @@ import {
   ArangoResponseMetadata,
   Config,
   Connection,
+  Dict,
   Headers,
   RequestOptions,
 } from "./connection";
 import { ArrayCursor, BatchedArrayCursor } from "./cursor";
 import { isArangoError } from "./error";
+import { FoxxManifest } from "./foxx-manifest";
 import {
   EdgeDefinitionOptions,
   Graph,
@@ -48,9 +51,6 @@ import { toForm } from "./lib/multipart";
 import { ArangojsResponse } from "./lib/request";
 import { Route } from "./route";
 import { Transaction } from "./transaction";
-import { collectionToString } from "./util/collectionToString";
-import { FoxxManifest } from "./util/foxx-manifest";
-import { Dict } from "./util/types";
 import {
   ArangoSearchView,
   ArangoSearchViewPropertiesOptions,

src/documents.ts

@@ -68,6 +68,15 @@ export type Document<T extends object = any> = T &
  */
 export type Edge<T extends object = any> = T & DocumentMetadata & EdgeMetadata;
 
+/**
+ * Type representing patch data for a given object type to represent a payload
+ * ArangoDB can apply in a document PATCH request (i.e. a partial update).
+ *
+ * This differs from `Partial` in that it also applies itself to any nested
+ * objects recursively.
+ */
+export type Patch<T = object> = { [K in keyof T]?: T[K] | Patch<T[K]> };
+
 /**
  * An object with an ArangoDB document `_id` property.
  *

src/util/foxx-manifest.ts renamed to src/foxx-manifest.ts

@@ -1,18 +1,17 @@
 /**
  * ```ts
- * import type { FoxxManifest } from "arangojs/util/foxx-manifest";
+ * import type { FoxxManifest } from "arangojs/foxx-manifest";
  * ```
  *
- * The "util/foxx-manifest" module provides the Foxx manifest type for
- * TypeScript.
+ * The "foxx-manifest" module provides the Foxx manifest type for TypeScript.
  *
  * Generated from {@link http://json.schemastore.org/foxx-manifest | JSON Schema}
  * using `json-schema-to-typescript`.
  *
  * @packageDocumentation
  */
 
-import { Dict } from "./types";
+import { Dict } from "./connection";
 
 /**
  * Schema for ArangoDB Foxx service manifests.

src/graph.ts

@@ -14,6 +14,7 @@
  */
 import {
   ArangoCollection,
+  collectionToString,
   DocumentCollection,
   EdgeCollection,
   isArangoCollection,
@@ -28,12 +29,11 @@ import {
   DocumentSelector,
   Edge,
   EdgeData,
+  Patch,
   _documentHandle,
 } from "./documents";
 import { isArangoError } from "./error";
 import { DOCUMENT_NOT_FOUND, GRAPH_NOT_FOUND } from "./lib/codes";
-import { collectionToString } from "./util/collectionToString";
-import { Patch } from "./util/types";
 
 /**
  * @internal