Merge pull request #190 from pneumaticapp/frontend/templates/45407__datasets

45407 frontend [ templates ] Datasets

Author: pneumojoseph

frontend/.storybook/initData.ts

@@ -144,6 +144,8 @@ window['__pneumaticConfig'] = {
         tenantsCount: '/tenants/count',
         tenants: '/tenants',
         tenantToken: '/tenants/:id/token',
+        datasets: '/datasets',
+        dataset: '/datasets/:id',
         getFaq: '/faq',
         wsNotifications: '/ws/notifications',
         wsNewTask: '/ws/workflows/new-task',

frontend/config/common.json

@@ -150,6 +150,8 @@
       "tenantsCount": "/tenants/count",
       "tenants": "/tenants",
       "tenantToken": "/tenants/:id/token",
+      "datasets": "/datasets",
+      "dataset": "/datasets/:id",
       "getFaq": "/faq",
       "wsNotifications": "/ws/notifications",
       "wsNewTask": "/ws/workflows/new-task",

frontend/package-lock.json

@@ -163,7 +163,7 @@
     "@types/react-input-autosize": "^2.2.1",
     "@types/react-redux": "^7.1.2",
     "@types/react-responsive": "^8.0.2",
-    "@types/react-router-dom": "^4.3.5",
+    "@types/react-router-dom": "^5.3.3",
     "@types/react-table": "^7.7.14",
     "@types/react-transition-group": "^4.2.2",
     "@types/react-visibility-sensor": "^5.0.1",

frontend/package.json

@@ -93,11 +93,23 @@ axiosInstance.interceptors.response.use(
   },
 );
 
+export async function commonRequest(
+  rawUrl: string,
+  params: Partial<AxiosRequestConfig>,
+  options: Partial<ICommonRequestOptions> & { responseType: 'empty' },
+): Promise<void>;
+export async function commonRequest<T>(
+  rawUrl: string,
+  params?: Partial<AxiosRequestConfig>,
+  options?: Partial<ICommonRequestOptions>,
+): Promise<T>;
+
+/* eslint-disable consistent-return */
 export async function commonRequest<T>(
   rawUrl: string,
   params: Partial<AxiosRequestConfig> = {},
   options: Partial<ICommonRequestOptions> = {},
-): Promise<T> {
+): Promise<T | void> {
   const {
     api: { publicUrl, urls },
   } = getBrowserConfigEnv();
@@ -114,14 +126,14 @@ export async function commonRequest<T>(
     const config: AxiosRequestConfig = {
       ...params,
       timeout: timeOut,
-      responseType: options.responseType === 'text' ? 'text' : 'json',
+      responseType: options.responseType === 'text' || options.responseType === 'empty' ? 'text' : 'json',
       validateStatus: (status) => successStatusCodes.includes(status),
     };
 
     const response = await axiosInstance(fullUrl, config);
 
-    if (options.responseType === 'text') {
-      return response.data as T;
+    if (options.responseType === 'empty') {
+      return;
     }
 
     return response.data as T;
@@ -130,6 +142,7 @@ export async function commonRequest<T>(
       throw error;
     }
     logger.error(error);
-    return undefined as unknown as T;
+    
   }
 }
+/* eslint-enable consistent-return */

frontend/src/public/api/commonRequest.ts

@@ -0,0 +1,21 @@
+import { commonRequest } from '../commonRequest';
+import { IDataset, ICreateDatasetParams } from '../../types/dataset';
+import { getBrowserConfigEnv } from '../../utils/getConfig';
+import { mapRequestBody } from '../../utils/mappers';
+
+export function createDataset({ name, description, items }: ICreateDatasetParams) {
+  const {
+    api: { urls },
+  } = getBrowserConfigEnv();
+
+  return commonRequest<IDataset>(
+    urls.datasets,
+    {
+      method: 'POST',
+      data: mapRequestBody({ name, description, items }),
+    },
+    {
+      shouldThrow: true,
+    },
+  );
+}

frontend/src/public/api/datasets/createDataset.ts

@@ -0,0 +1,22 @@
+import { commonRequest } from '../commonRequest';
+import { IDeleteDatasetParams } from '../../types/dataset';
+import { getBrowserConfigEnv } from '../../utils/getConfig';
+
+export function deleteDataset({ id }: IDeleteDatasetParams) {
+  const {
+    api: { urls },
+  } = getBrowserConfigEnv();
+
+  const url = urls.dataset.replace(':id', String(id));
+
+  return commonRequest<void>(
+    url,
+    {
+      method: 'DELETE',
+    },
+    {
+      shouldThrow: true,
+      responseType: 'empty',
+    },
+  );
+}

frontend/src/public/api/datasets/deleteDataset.ts

@@ -0,0 +1,22 @@
+import { commonRequest } from '../commonRequest';
+import { IDataset, IGetDatasetParams } from '../../types/dataset';
+import { getBrowserConfigEnv } from '../../utils/getConfig';
+
+export function getDataset({ id, signal }: IGetDatasetParams) {
+  const {
+    api: { urls },
+  } = getBrowserConfigEnv();
+
+  const url = urls.dataset.replace(':id', String(id));
+
+  return commonRequest<IDataset>(
+    url,
+    {
+      method: 'GET',
+      signal,
+    },
+    {
+      shouldThrow: true,
+    },
+  );
+}

frontend/src/public/api/datasets/getDataset.ts

@@ -0,0 +1,35 @@
+import { commonRequest } from '../commonRequest';
+import { IGetDatasetsResponse, IGetDatasetsParams } from '../../types/dataset';
+import { datasetsOrderingMap } from '../../constants/sortings';
+import { getBrowserConfigEnv } from '../../utils/getConfig';
+
+export function getDatasets(config: IGetDatasetsParams = {}) {
+  const {
+    api: { urls },
+  } = getBrowserConfigEnv();
+
+  const { signal } = config;
+  const queryString = getDatasetsQueryString(config);
+  const url = queryString ? `${urls.datasets}?${queryString}` : urls.datasets;
+
+  return commonRequest<IGetDatasetsResponse>(
+    url,
+    {
+      method: 'GET',
+      signal,
+    },
+    {
+      shouldThrow: true,
+    },
+  );
+}
+
+function getDatasetsQueryString({ ordering, limit, offset }: IGetDatasetsParams): string {
+  const backendOrdering = ordering ? datasetsOrderingMap[ordering] || ordering : undefined;
+
+  return [
+    backendOrdering && `ordering=${backendOrdering}`,
+    limit !== undefined && `limit=${limit}`,
+    offset !== undefined && `offset=${offset}`,
+  ].filter(Boolean).join('&');
+}

frontend/src/public/api/datasets/getDatasets.ts

@@ -0,0 +1,24 @@
+import { commonRequest } from '../commonRequest';
+import { IDataset, IUpdateDatasetParams } from '../../types/dataset';
+import { getBrowserConfigEnv } from '../../utils/getConfig';
+import { mapRequestBody } from '../../utils/mappers';
+
+export function updateDataset({ id, signal, ...data }: IUpdateDatasetParams) {
+  const {
+    api: { urls },
+  } = getBrowserConfigEnv();
+
+  const url = urls.dataset.replace(':id', String(id));
+
+  return commonRequest<IDataset>(
+    url,
+    {
+      method: 'PATCH',
+      data: mapRequestBody(data),
+      signal,
+    },
+    {
+      shouldThrow: true,
+    },
+  );
+}