Enhance library to fully support modular architecture release (#5)

* Enhance library to fully support modular architecture release

* 0.2.0

* 0.1.1

* Add global context to support constants

Author: lucferbux

.eslintignore

@@ -1,2 +1,3 @@
 package.json
-config
+config
+dist/

README.md

@@ -1,4 +1,4 @@
-# mod-arch-shared
+# Modular Architecture Shared Library
 
 ## Overview
 

__tests__/__mocks__/mockGenericResponse.ts

@@ -4,7 +4,6 @@ type MockGenericResponse = {
   description?: string;
 };
 
-
 export const mockGenericResponse = ({
   name = 'test',
   description = 'test',

__tests__/__mocks__/utils.ts

@@ -2,12 +2,14 @@ import { NotReadyError } from '~/utilities/useFetchState';
 import { APIError } from '~/api/types';
 import { handleRestFailures } from '~/api/errorUtils';
 import { mockGenericResponse } from '~/__tests__/__mocks__/mockGenericResponse';
-import { mockBFFResponse } from '~/__tests__/__mocks__/utils';
+import { mockModArchResponse } from '~/api/';
 
 describe('handleRestFailures', () => {
   it('should successfully return registered models', async () => {
     const modelRegistryMock = mockGenericResponse({});
-    const result = await handleRestFailures(Promise.resolve(mockBFFResponse(modelRegistryMock)));
+    const result = await handleRestFailures(
+      Promise.resolve(mockModArchResponse(modelRegistryMock)),
+    );
     expect(result.data).toStrictEqual(modelRegistryMock);
   });
 

api/__tests__/errorUtils.spec.ts

@@ -1,7 +1,6 @@
 import { APIOptions } from '~/api/types';
 import { EitherOrNone } from '~/types/typeHelpers';
-import { BFFBody } from '~/types';
-import { AUTH_HEADER, MOCK_AUTH } from '~/utilities/const';
+import { ModArchBody } from '~/types';
 
 export const mergeRequestInit = (
   opts: APIOptions = {},
@@ -65,14 +64,10 @@ const callRestJSON = <T>(
     requestData = JSON.stringify(data);
   }
 
-  // Workaround if we wanna force in a call to add the AUTH_HEADER
-  const authHeader = Object.keys(otherOptions.headers || {}).some((key) => key === AUTH_HEADER);
-
   return fetch(`${host}${path}${searchParams ? `?${searchParams}` : ''}`, {
     ...otherOptions,
     headers: {
       ...otherOptions.headers,
-      ...(MOCK_AUTH && !authHeader && { [AUTH_HEADER]: localStorage.getItem(AUTH_HEADER) }),
       ...(contentType && { 'Content-Type': contentType }),
     },
     method,
@@ -177,15 +172,15 @@ export const restDELETE = <T>(
     parseJSON: options?.parseJSON,
   });
 
-export const isModelRegistryResponse = <T>(response: unknown): response is BFFBody<T> => {
+export const isModArchResponse = <T>(response: unknown): response is ModArchBody<T> => {
   if (typeof response === 'object' && response !== null) {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const bffBody = response as { data?: T };
-    return bffBody.data !== undefined;
+    const modArchBody = response as { data?: T };
+    return modArchBody.data !== undefined;
   }
   return false;
 };
 
-export const assembleBFFBody = <T>(data: T): BFFBody<T> => ({
+export const assembleModArchBody = <T>(data: T): ModArchBody<T> => ({
   data,
 });

api/apiUtils.ts

@@ -0,0 +1,5 @@
+import { ModArchBody } from '~/types';
+
+export const mockModArchResponse = <T>(data: T): ModArchBody<T> => ({
+  data,
+});

api/const.ts

@@ -3,4 +3,5 @@ export * from './apiUtils';
 export * from './errorUtils';
 export * from './types';
 export * from './useAPIState';
-export * from './k8s';
+export * from './k8s';
+export * from './const';

api/index.ts

@@ -1,30 +1,34 @@
 import { APIOptions } from '~/api/types';
 import { handleRestFailures } from '~/api/errorUtils';
-import { isModelRegistryResponse, restGET } from '~/api/apiUtils';
-import { BFF_API_VERSION } from '~/utilities/const';
-import { URL_PREFIX } from '~/utilities/const';
+import { isModArchResponse, restGET } from '~/api/apiUtils';
 import { Namespace, UserSettings } from '~/types';
 
+// Define a type for the config needed by these functions
+type K8sApiConfig = {
+  BFF_API_VERSION: string;
+  URL_PREFIX: string;
+};
 
+// Functions now accept config object
 export const getUser =
-  (hostPath: string) =>
+  (hostPath: string, config: K8sApiConfig) =>
   (opts: APIOptions): Promise<UserSettings> =>
     handleRestFailures(
-      restGET(hostPath, `${URL_PREFIX}/api/${BFF_API_VERSION}/user`, {}, opts),
+      restGET(hostPath, `${config.URL_PREFIX}/api/${config.BFF_API_VERSION}/user`, {}, opts),
     ).then((response) => {
-      if (isModelRegistryResponse<UserSettings>(response)) {
+      if (isModArchResponse<UserSettings>(response)) {
         return response.data;
       }
       throw new Error('Invalid response format');
     });
 
 export const getNamespaces =
-  (hostPath: string) =>
+  (hostPath: string, config: K8sApiConfig) =>
   (opts: APIOptions): Promise<Namespace[]> =>
     handleRestFailures(
-      restGET(hostPath, `${URL_PREFIX}/api/${BFF_API_VERSION}/namespaces`, {}, opts),
+      restGET(hostPath, `${config.URL_PREFIX}/api/${config.BFF_API_VERSION}/namespaces`, {}, opts),
     ).then((response) => {
-      if (isModelRegistryResponse<Namespace[]>(response)) {
+      if (isModArchResponse<Namespace[]>(response)) {
         return response.data;
       }
       throw new Error('Invalid response format');

api/k8s.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { APIState } from '~/api/types';
 
-const useAPIState = <T>(
+export const useAPIState = <T>(
   hostPath: string | null,
   createAPI: (path: string) => T,
 ): [apiState: APIState<T>, refreshAPIState: () => void] => {
@@ -28,5 +28,3 @@ const useAPIState = <T>(
 
   return [apiState, refreshAPIState];
 };
-
-export default useAPIState;