Merge branch 'feature/1-retrieve-jsonapi-body-meta'

Close #1

Author: stantanasi

src/lib/query.ts

@@ -2,6 +2,11 @@ import { JsonApiBody, JsonApiResource } from "../types/jsonapi.type";
 import { fromJsonApi, Model, ModelConstructor, ModelInstance } from "./model";
 import Schema from "./schema";
 
+type RawResultType<T> = {
+  result: T;
+  body: JsonApiBody<T extends ModelInstance<unknown>[] ? JsonApiResource[] : JsonApiResource>;
+}
+
 type ExtractDocType<T> =
   T extends Model<infer U> ? U :
   T extends Model<infer U>[] ? U :
@@ -37,6 +42,7 @@ interface QueryOptions<DocType> {
   sort?: SortQuery<DocType>;
   limit?: number;
   offset?: number;
+  raw?: boolean;
 }
 
 
@@ -99,6 +105,10 @@ class Query<ResultType, DocType> {
 
   options!: QueryOptions<DocType>;
 
+  raw!: () => this extends Query<infer ResultType, infer ResultDocType>
+    ? ResultType extends RawResultType<any> ? this : Query<RawResultType<ResultType>, ResultDocType>
+    : never;
+
   schema!: Schema<DocType>;
 
   setOptions!: (options: QueryOptions<DocType>, overwrite?: boolean) => this;
@@ -172,8 +182,14 @@ Query.prototype.exec = async function exec() {
       }
     );
 
-    return this.model.fromJsonApi(response.data);
+    if (options.raw) {
+      return {
+        result: this.model.fromJsonApi(response.data),
+        body: response.data,
+      } as RawResultType<ModelInstance<unknown>[]>;
+    }
 
+    return this.model.fromJsonApi(response.data);
   } else if (options.op === 'findById') {
     const response = await client.client.get<JsonApiBody<JsonApiResource | null>>(
       `/${this.model.type}/${options.id}`,
@@ -182,6 +198,13 @@ Query.prototype.exec = async function exec() {
       }
     );
 
+    if (options.raw) {
+      return {
+        result: this.model.fromJsonApi(response.data),
+        body: response.data,
+      } as RawResultType<ModelInstance<unknown>>;
+    }
+
     return this.model.fromJsonApi(response.data);
   } else if (options.op === 'findRelationship') {
     const response = await client.client.get<JsonApiBody<JsonApiResource | null>>(
@@ -191,7 +214,14 @@ Query.prototype.exec = async function exec() {
       }
     );
 
-    return fromJsonApi(response.data)
+    if (options.raw) {
+      return {
+        result: fromJsonApi(response.data),
+        body: response.data,
+      } as RawResultType<ModelInstance<unknown> | ModelInstance<unknown>[]>;
+    }
+
+    return fromJsonApi(response.data);
   }
 
   return;
@@ -266,6 +296,13 @@ Query.prototype.offset = function (offset) {
   return this;
 };
 
+Query.prototype.raw = function () {
+  this.setOptions({
+    raw: true,
+  });
+  return this;
+};
+
 Query.prototype.setOptions = function (options, overwrite) {
   if (overwrite) {
     this.options = options;