Fix 750

Author: pluma

CHANGELOG.md

@@ -16,6 +16,13 @@ This driver uses semantic versioning:
 
 ## [unreleased]
 
+### Fixed
+
+- Changed all uses of `Record<string, unknown>` to `Record<string, any>` [#750](https://github.com/arangodb/arangojs/issues/750)
+
+  This should allow using more specific types without having to implement
+  index signatures.
+
 ## [7.6.0] - 2021-10-20
 
 ### Added

src/aql.ts

@@ -80,7 +80,7 @@ export type AqlValue =
   | boolean
   | null
   | undefined
-  | Record<string, unknown>
+  | Record<string, any>
   | any[];
 
 /**

src/collection.ts

@@ -1130,7 +1130,7 @@ export type CollectionImportResult = {
 /**
  * Result of retrieving edges in a collection.
  */
-export type CollectionEdgesResult<T extends Record<string, unknown> = any> = {
+export type CollectionEdgesResult<T extends Record<string, any> = any> = {
   edges: Edge<T>[];
   stats: {
     scannedIndex: number;
@@ -1192,7 +1192,7 @@ export type SimpleQueryUpdateByExampleResult = {
  * replaced with AQL queries.
  */
 export type SimpleQueryRemoveByKeysResult<
-  T extends Record<string, unknown> = any
+  T extends Record<string, any> = any
 > = {
   /**
    * Number of documents removed.
@@ -1230,7 +1230,7 @@ export type SimpleQueryRemoveByKeysResult<
  * const documents = db.collection("persons") as DocumentCollection<Person>;
  * ```
  */
-export interface DocumentCollection<T extends Record<string, unknown> = any>
+export interface DocumentCollection<T extends Record<string, any> = any>
   extends ArangoCollection {
   /**
    * Checks whether the collection exists.
@@ -2585,7 +2585,7 @@ export interface DocumentCollection<T extends Record<string, unknown> = any>
  * const edges = db.collection("friends") as EdgeCollection<Friend>;
  * ```
  */
-export interface EdgeCollection<T extends Record<string, unknown> = any>
+export interface EdgeCollection<T extends Record<string, any> = any>
   extends DocumentCollection<T> {
   /**
    * Retrieves the document matching the given key or id.
@@ -3320,7 +3320,7 @@ export interface EdgeCollection<T extends Record<string, unknown> = any>
  * @internal
  * @hidden
  */
-export class Collection<T extends Record<string, unknown> = any>
+export class Collection<T extends Record<string, any> = any>
   implements EdgeCollection<T>, DocumentCollection<T> {
   //#region attributes
   protected _name: string;
@@ -3337,14 +3337,14 @@ export class Collection<T extends Record<string, unknown> = any>
   }
 
   //#region internals
-  protected _get<T extends Record<string, unknown>>(path: string, qs?: any) {
+  protected _get<T extends Record<string, any>>(path: string, qs?: any) {
     return this._db.request(
       { path: `/_api/collection/${this._name}/${path}`, qs },
       (res) => res.body as ArangoResponseMetadata & T
     );
   }
 
-  protected _put<T extends Record<string, unknown>>(path: string, body?: any) {
+  protected _put<T extends Record<string, any>>(path: string, body?: any) {
     return this._db.request(
       {
         method: "PUT",

src/database.ts

@@ -1352,7 +1352,7 @@ export type CreateUserOptions = {
    *
    * Default: `{}`
    */
-  extra?: Record<string, unknown>;
+  extra?: Record<string, any>;
 };
 
 /**
@@ -1374,7 +1374,7 @@ export type UserOptions = {
    *
    * Default: `{}`
    */
-  extra?: Record<string, unknown>;
+  extra?: Record<string, any>;
 };
 
 /**
@@ -2029,7 +2029,7 @@ export class Database {
    * const edges = db.collection("friends") as EdgeCollection<Friend>;
    * ```
    */
-  collection<T extends Record<string, unknown> = any>(
+  collection<T extends Record<string, any> = any>(
     collectionName: string
   ): DocumentCollection<T> & EdgeCollection<T> {
     if (!this._collections.has(collectionName)) {
@@ -2064,7 +2064,7 @@ export class Database {
    * const documents = db.createCollection<Person>("persons");
    * ```
    */
-  async createCollection<T extends Record<string, unknown> = any>(
+  async createCollection<T extends Record<string, any> = any>(
     collectionName: string,
     options?: CreateCollectionOptions & {
       type?: CollectionType.DOCUMENT_COLLECTION;
@@ -2099,13 +2099,13 @@ export class Database {
    * });
    * ```
    */
-  async createCollection<T extends Record<string, unknown> = any>(
+  async createCollection<T extends Record<string, any> = any>(
     collectionName: string,
     options: CreateCollectionOptions & {
       type: CollectionType.EDGE_COLLECTION;
     }
   ): Promise<EdgeCollection<T>>;
-  async createCollection<T extends Record<string, unknown> = any>(
+  async createCollection<T extends Record<string, any> = any>(
     collectionName: string,
     options?: CreateCollectionOptions & { type?: CollectionType }
   ): Promise<DocumentCollection<T> & EdgeCollection<T>> {
@@ -2142,7 +2142,7 @@ export class Database {
    * const edges = db.createEdgeCollection<Friend>("friends");
    * ```
    */
-  async createEdgeCollection<T extends Record<string, unknown> = any>(
+  async createEdgeCollection<T extends Record<string, any> = any>(
     collectionName: string,
     options?: CreateCollectionOptions
   ): Promise<EdgeCollection<T>> {

src/documents.ts

@@ -45,28 +45,28 @@ export type EdgeMetadata = {
 /**
  * Type representing an object that can be stored in a collection.
  */
-export type DocumentData<T extends Record<string, unknown> = any> = T &
+export type DocumentData<T extends Record<string, any> = any> = T &
   Partial<DocumentMetadata> &
   Partial<EdgeMetadata>;
 
 /**
  * Type representing an object that can be stored in an edge collection.
  */
-export type EdgeData<T extends Record<string, unknown> = any> = T &
+export type EdgeData<T extends Record<string, any> = any> = T &
   Partial<DocumentMetadata> &
   EdgeMetadata;
 
 /**
  * Type representing a document stored in a collection.
  */
-export type Document<T extends Record<string, unknown> = any> = T &
+export type Document<T extends Record<string, any> = any> = T &
   DocumentMetadata &
   Partial<EdgeMetadata>;
 
 /**
  * Type representing an edge document stored in an edge collection.
  */
-export type Edge<T extends Record<string, unknown> = any> = T &
+export type Edge<T extends Record<string, any> = any> = T &
   DocumentMetadata &
   EdgeMetadata;
 
@@ -77,7 +77,7 @@ export type Edge<T extends Record<string, unknown> = any> = T &
  * This differs from `Partial` in that it also applies itself to any nested
  * objects recursively.
  */
-export type Patch<T = Record<string, unknown>> = {
+export type Patch<T = Record<string, any>> = {
   [K in keyof T]?: T[K] | Patch<T[K]>;
 };
 

src/graph.ts

@@ -380,7 +380,7 @@ export type GraphCreateOptions = {
  *
  * @param T - Type to use for document data. Defaults to `any`.
  */
-export class GraphVertexCollection<T extends Record<string, unknown> = any>
+export class GraphVertexCollection<T extends Record<string, any> = any>
   implements ArangoCollection {
   protected _db: Database;
   protected _name: string;
@@ -787,7 +787,7 @@ export class GraphVertexCollection<T extends Record<string, unknown> = any>
  *
  * @param T - Type to use for document data. Defaults to `any`.
  */
-export class GraphEdgeCollection<T extends Record<string, unknown> = any>
+export class GraphEdgeCollection<T extends Record<string, any> = any>
   implements ArangoCollection {
   protected _db: Database;
   protected _name: string;
@@ -1347,7 +1347,7 @@ export class Graph {
    * @param T - Type to use for document data. Defaults to `any`.
    * @param collection - Name of the vertex collection.
    */
-  vertexCollection<T extends Record<string, unknown> = any>(
+  vertexCollection<T extends Record<string, any> = any>(
     collection: string | ArangoCollection
   ): GraphVertexCollection<T> {
     if (isArangoCollection(collection)) {
@@ -1510,7 +1510,7 @@ export class Graph {
    * const edgeCollection = graphEdgeCollection.collection;
    * ```
    */
-  edgeCollection<T extends Record<string, unknown> = any>(
+  edgeCollection<T extends Record<string, any> = any>(
     collection: string | ArangoCollection
   ): GraphEdgeCollection<T> {
     if (isArangoCollection(collection)) {

src/test/14-document-collections.ts

@@ -56,11 +56,8 @@ describe("DocumentCollection API", function () {
     const data = { foo: "bar" };
     let meta: DocumentMetadata[];
     beforeEach(async () => {
-      meta = await Promise.all([
-        collection.save(data),
-        collection.save(data),
-        collection.save(data),
-      ]);
+      const c = collection as DocumentCollection<{ foo: string }>;
+      meta = await Promise.all([c.save(data), c.save(data), c.save(data)]);
     });
     it("returns multiple documents in the collection", async () => {
       const docs = await collection.documents(meta);

src/test/15-edge-collections.ts

@@ -176,7 +176,7 @@ describe("EdgeCollection API", function () {
     });
   });
   describe("edgeCollection.traversal", () => {
-    let knows: EdgeCollection<Record<string, unknown>>;
+    let knows: EdgeCollection<Record<string, any>>;
     beforeEach(async () => {
       let person;
       [knows, person] = await Promise.all<

src/view.ts

@@ -332,8 +332,8 @@ export type ArangoSearchViewPropertiesOptions = {
  * ArangoSearch View.
  */
 export class View<
-  PropertiesOptions extends Record<string, unknown> = any,
-  Properties extends Record<string, unknown> = any
+  PropertiesOptions extends Record<string, any> = any,
+  Properties extends Record<string, any> = any
 > {
   protected _name: string;
   protected _db: Database;

tsconfig.json

@@ -24,7 +24,11 @@
     "strict": true,
     "strictFunctionTypes": true,
     "strictNullChecks": true,
-    "target": "es2016"
+    "target": "es2016",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "declarationMap": true,
+    "resolveJsonModule": true
   },
   "exclude": ["node_modules", "build"]
 }