Merge pull request #2432 from ChristianMurphy/refactor/move-transform…

…er-out-of-axios refactor: move transformer out of and after validation
openequella · Nov 20, 2020 · f9585ef · f9585ef
2 parents 28420ae + 77c3d8d
commit f9585ef
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 25 deletions.
diff --git a/oeq-ts-rest-api/src/AxiosInstance.ts b/oeq-ts-rest-api/src/AxiosInstance.ts
@@ -42,16 +42,14 @@ const catchHandler = (error: AxiosError | Error): never => {
 export const GET = <T>(
   path: string,
   validator: (data: unknown) => data is T,
-  queryParams?: Parameters<typeof stringify>[0], // eslint-disable-line @typescript-eslint/ban-types
-  transformer?: (data: unknown) => T
+  queryParams?: Parameters<typeof stringify>[0] // eslint-disable-line @typescript-eslint/ban-types
 ): Promise<T> =>
   axios
     .get(path, {
       params: queryParams,
       paramsSerializer: (params) => stringify(params),
     })
-    .then(({ data: rawData }: AxiosResponse<unknown>) => {
-      const data = transformer ? transformer(rawData) : rawData;
+    .then(({ data }: AxiosResponse<unknown>) => {
       if (!validator(data)) {
         throw new TypeError(
           `Data format mismatch with data received from server, on request to: "${path}"`
@@ -82,8 +80,7 @@ export const POST = <T, R>(
 ): Promise<R> =>
   axios
     .post(path, data)
-    .then((response: AxiosResponse<unknown>) => {
-      const data = response.data;
+    .then(({ data }: AxiosResponse<unknown>) => {
       if (!validator(data)) {
         throw new TypeError(
           `Data format mismatch with data received from server, on request to: "${path}"`

diff --git a/oeq-ts-rest-api/src/Search.ts b/oeq-ts-rest-api/src/Search.ts
@@ -170,9 +170,9 @@ export interface Attachment {
 }
 
 /**
- * Type of search result item.
+ * Shared properties or raw and transformed search result item
  */
-export interface SearchResultItem {
+interface SearchResultItemBase {
   /**
    * Item's unique ID.
    */
@@ -193,14 +193,6 @@ export interface SearchResultItem {
    * Item's status
    */
   status: string;
-  /**
-   * The date when item is created.
-   */
-  createdDate: Date;
-  /**
-   * The last date when item is modified.
-   */
-  modifiedDate: Date;
   /**
    * The ID of item's collection.
    */
@@ -248,6 +240,34 @@ export interface SearchResultItem {
   };
 }
 
+/**
+ * Search result item as it is returned by the API
+ */
+interface SearchResultItemRaw extends SearchResultItemBase {
+  /**
+   * The date when item is created.
+   */
+  createdDate: string;
+  /**
+   * The last date when item is modified.
+   */
+  modifiedDate: string;
+}
+
+/**
+ * Type of search result item.
+ */
+export interface SearchResultItem extends SearchResultItemBase {
+  /**
+   * The date when item is created.
+   */
+  createdDate: Date;
+  /**
+   * The last date when item is modified.
+   */
+  modifiedDate: Date;
+}
+
 /**
  * Represents the results for a search query.
  */
@@ -286,15 +306,15 @@ export const search = (
   apiBasePath: string,
   params?: SearchParams
 ): Promise<SearchResult<SearchResultItem>> => {
-  return GET<SearchResult<SearchResultItem>>(
+  return GET<SearchResult<SearchResultItemRaw>>(
     apiBasePath + SEARCH2_API_PATH,
-    (data): data is SearchResult<SearchResultItem> =>
-      is<SearchResult<SearchResultItem>>(data),
-    params,
-    (data) =>
-      Utils.convertDateFields<SearchResult<SearchResultItem>>(data, [
-        'createdDate',
-        'modifiedDate',
-      ])
+    (data): data is SearchResult<SearchResultItemRaw> =>
+      is<SearchResult<SearchResultItemRaw>>(data),
+    params
+  ).then((data) =>
+    Utils.convertDateFields<SearchResult<SearchResultItem>>(data, [
+      'createdDate',
+      'modifiedDate',
+    ])
   );
 };