feat(builder): Return type hint for return object

Author: Bastianowicz

src/builder.ts

@@ -741,6 +741,9 @@ export abstract class Builder
    * @param definition - definition of return object as key value pair whereas value can be
    * string selector or @see Selector
    *
+   * @typeParam N - (optional) new target type of this cypher to hint the keys that you want
+   * to be sure of
+   *
    * @example
    * ```typescript
    * // Selector Object:
@@ -752,7 +755,7 @@ export abstract class Builder
    *
    * ```typescript
    * // String selector
-   * q.returnObject({ user: 'person.name' });
+   * q.returnObject<{user: any}>({ user: 'person.name' });
    * ```
    *
    * ```typescript
@@ -763,10 +766,10 @@ export abstract class Builder
    * ])
    * ```
    */
-  returnObject(
-    definition: Many<Selectable<G>>,
+  returnObject<N = unknown>(
+    definition: Many<Selectable<G, StringKeyOf<N>>>,
   ) {
-    return this.continueChainClause(new ReturnObject(definition));
+    return this.continueChainClause(new ReturnObject(definition)) as any as Query<N>;
   }
 
   /**

src/clauses/returnObject.ts

@@ -2,7 +2,12 @@ import { Clause } from '../clause';
 import { Many, isArray } from 'lodash';
 import { Selector } from '../selector';
 
-export type Selectable<G> = Record<string, string | Selector<G> | Record<string, Selector<G>>>;
+/**
+ * @typeParam G - (optional) current graph model to gather data drom
+ * @typeParam T - (optional) Target type that defines the output
+ */
+export type Selectable<G, T extends string = string>
+    = Record<T, string | Selector<G> | Record<T, Selector<G>>>;
 
 /**
  * Clause to create an object formed RETURN