@gen3/core 0.10.47 → 0.10.49

package/dist/esm/index.js

@@ -1,15 +1,15 @@
 import { createSelector, createAsyncThunk, createSlice, combineReducers, configureStore } from '@reduxjs/toolkit';
-import { buildCreateApi, coreModule, reactHooksModule } from '@reduxjs/toolkit/query/react';
-import React, { useRef, useEffect } from 'react';
-import { createSelectorHook, createDispatchHook, createStoreHook, Provider } from 'react-redux';
-import { fetchBaseQuery } from '@reduxjs/toolkit/dist/query/react';
+import { createApi, fetchBaseQuery, buildCreateApi, coreModule, reactHooksModule } from '@reduxjs/toolkit/query/react';
 import { getCookie } from 'cookies-next';
 import { QueryStatus, setupListeners } from '@reduxjs/toolkit/query';
+import * as React from 'react';
+import React__default, { useRef, useEffect } from 'react';
+import { useSelector, useDispatch, Provider, createSelectorHook, createDispatchHook, createStoreHook } from 'react-redux';
 import { isEqual } from 'lodash';
 import Queue from 'queue';
 import { JSONPath } from 'jsonpath-plus';
 import { v5 } from 'uuid';
-import 'redux-persist';
+import { FLUSH, REHYDRATE, PAUSE, PERSIST, PURGE, REGISTER } from 'redux-persist';
 import { CookiesProvider } from 'react-cookie';
 import useSWR from 'swr';
 import { flatten } from 'flat';
@@ -42,30 +42,6 @@ const FILE_DELIMITERS = {
     csv: ','
 };
 
-// From here down is react-related code. If we wanted to create a UI-agnotic core,
-// we could need to move the following code and the provider into a new workspace,
-// such as core-react.
-/**
- * The initial context is never used in practice. A little casting voodoo to satisfy TS.
- *
- * Note: Should the action type be AnyAction (from redux) or PayloadAction (from redux-toolkit)?
- * If we are creating all of our actions through RTK, then PayloadAction might be the
- * correct opinionated type.
- */ const CoreContext = React.createContext(undefined);
-const useCoreSelector = createSelectorHook(CoreContext);
-const useCoreDispatch = createDispatchHook(CoreContext);
-const useCoreStore = createStoreHook(CoreContext);
-
-/**
- * Creates a custom Redux Toolkit core API
- * See: https://redux-toolkit.js.org/rtk-query/usage/customizing-create-api
- * @returns: created core API.
- */ const coreCreateApi = buildCreateApi(coreModule(), reactHooksModule({
-    useSelector: useCoreSelector,
-    useStore: useCoreStore,
-    useDispatch: useCoreDispatch
-}));
-
 /**
  * Template for fence error response dict
  * @returns: An error dict response from a RESTFUL API request
@@ -99,7 +75,7 @@ const useCoreStore = createStoreHook(CoreContext);
     });
 };
 
-const userAuthApi = coreCreateApi({
+const userAuthApi = createApi({
     reducerPath: 'userAuthApi',
     refetchOnMountOrArgChange: 1800,
     refetchOnReconnect: true,
@@ -196,7 +172,7 @@ const selectHeadersWithCSRFToken = createSelector([
  * @param baseQuery: - The template query which the slices will addon to
  * @param endpoints - Base API endpoints that should exist in every slice
  * @returns: The generated base API
- */ const gen3Api = coreCreateApi({
+ */ const gen3Api = createApi({
     reducerPath: 'gen3Services',
     baseQuery: fetchBaseQuery({
         baseUrl: `${GEN3_API}`,
@@ -336,6 +312,18 @@ const credentialsWithTags = gen3Api.enhanceEndpoints({
 });
 const { useGetJWKKeysQuery } = jwtApi;
 
+// From here down is react-related code. If we wanted to create a UI-agnotic core,
+// we could need to move the following code and the provider into a new workspace,
+// such as core-react.
+/**
+ * The initial context is never used in practice. A little casting voodoo to satisfy TS.
+ *
+ * Note: Should the action type be AnyAction (from redux) or PayloadAction (from redux-toolkit)?
+ * If we are creating all of our actions through RTK, then PayloadAction might be the
+ * correct opinionated type.
+ */ const useCoreSelector = useSelector.withTypes();
+const useCoreDispatch = useDispatch.withTypes();
+
 const usePrevious = (value)=>{
     const ref = useRef();
     useEffect(()=>{
@@ -590,8 +578,8 @@ const slice$2 = createSlice({
     initialState: initialState$2,
     reducers: {
         addGen3AppMetadata: (state, action)=>{
-            const { id, requiredEntityTypes } = action.payload;
-            state.gen3Apps[id] = {
+            const { name, requiredEntityTypes } = action.payload;
+            state.gen3Apps[name] = {
                 ...action.payload,
                 // need to turn a ReadonlyArray into a mutable array for immer's WritableDraft
                 requiredEntityTypes: [
@@ -603,8 +591,8 @@ const slice$2 = createSlice({
 });
 const gen3AppReducer = slice$2.reducer;
 const { addGen3AppMetadata } = slice$2.actions;
-const selectGen3AppMetadataById = (state, appId)=>state.gen3Apps.gen3Apps[appId];
-const selectGen3AppById = (appId)=>lookupGen3App(appId); // TODO: memoize this selector
+const selectGen3AppMetadataByName = (state, appName)=>state.gen3Apps.gen3Apps[appName];
+const selectGen3AppByName = (appName)=>lookupGen3App(appName); // TODO: memoize this selector
 
 const initialState$1 = {};
 // TODO: document what this does
@@ -731,8 +719,7 @@ const cohortsAdapter = createEntityAdapter<Cohort>({
                 }
             };
         }
-    },
-    extraReducers: {}
+    }
 });
 // Filter actions: addFilter, removeFilter, updateFilter
 const { updateCohortFilter, removeCohortFilter, clearCohortFilters } = cohortSlice.actions;
@@ -766,7 +753,7 @@ const cohortReducer = cohortSlice.reducer;
 /**
  * Creates a base class core API for guppy API calls.
  * @returns: guppy core API with guppyAPIFetch base query
- */ const guppyApi = coreCreateApi({
+ */ const guppyApi = createApi({
     reducerPath: 'guppy',
     // TODO: refactor to use fetchBaseQuery
     baseQuery: async (query, api)=>{
@@ -830,9 +817,8 @@ const coreStore = configureStore({
 setupListeners(coreStore.dispatch);
 
 const CoreProvider = ({ children })=>{
-    return /*#__PURE__*/ React.createElement(Provider, {
-        store: coreStore,
-        context: CoreContext
+    return /*#__PURE__*/ React__default.createElement(Provider, {
+        store: coreStore
     }, children);
 };
 
@@ -997,12 +983,13 @@ const { useGetAggMDSQuery, useGetMDSQuery, useGetTagsQuery, useGetDataQuery, use
 
 // using a random uuid v4 as the namespace
 const GEN3_APP_NAMESPACE = '7bfaa818-c69c-457e-8d87-413cf60c25f0';
+
 const getGen3AppId = (name, version)=>{
     const nameVersion = `${name}::${version}`;
     return v5(nameVersion, GEN3_APP_NAMESPACE);
 };
 /**
- *  TODO: can't tell what anything in this directory is doing.
+ *  Creates a Gen3App that is dynamically loaded
  */ const createGen3App = ({ App, name, version, requiredEntityTypes })=>{
     // create a stable id for this app
     const nameVersion = `${name}::${version}`;
@@ -1014,20 +1001,95 @@ const getGen3AppId = (name, version)=>{
     // need to register its name, category, path, data requirements
     // this will be used to build page3
     // click app link
+    // const store = configureStore({
+    //   // TODO allow user to pass in a reducer in CreateGen3AppOptions?
+    //   reducer: (state) => state,
+    //   devTools: {
+    //     name: `${nameVersion}::${id}`,
+    //   },
+    // });
+    const Gen3AppWrapper = (props)=>{
+        useEffect(()=>{
+            document.title = `GEN3 - ${name}`;
+        });
+        return /*#__PURE__*/ React__default.createElement(App, props);
+    };
+    // add the app to the store
+    coreStore.dispatch(addGen3AppMetadata({
+        id,
+        name,
+        version,
+        requiredEntityTypes
+    }));
+    registerGen3App(name, Gen3AppWrapper);
+    return Gen3AppWrapper;
+};
+// ----------------------------------------------------------------------------------------
+// Apps with Local Storage
+//
+const createAppStore = (options)=>{
+    const { name, version, reducers, middleware } = options;
+    const nameVersion = `${name}::${version}`;
+    const id = v5(nameVersion, GEN3_APP_NAMESPACE);
     const store = configureStore({
-        // TODO allow user to pass in a reducer in CreateGen3AppOptions?
-        reducer: (state)=>state,
+        reducer: reducers,
         devTools: {
             name: `${nameVersion}::${id}`
-        }
+        },
+        middleware: (getDefaultMiddleware)=>middleware ? getDefaultMiddleware({
+                serializableCheck: {
+                    ignoredActions: [
+                        FLUSH,
+                        REHYDRATE,
+                        PAUSE,
+                        PERSIST,
+                        PURGE,
+                        REGISTER
+                    ]
+                }
+            }).concat(middleware) : getDefaultMiddleware({
+                serializableCheck: {
+                    ignoredActions: [
+                        FLUSH,
+                        REHYDRATE,
+                        PAUSE,
+                        PERSIST,
+                        PURGE,
+                        REGISTER
+                    ]
+                }
+            })
     });
-    const Gen3AppWrapper = ()=>{
+    const context = /*#__PURE__*/ React__default.createContext(null);
+    const useAppSelector = createSelectorHook(context);
+    const useAppDispatch = createDispatchHook(context);
+    const useAppStore = createStoreHook(context);
+    return {
+        id: id,
+        AppStore: store,
+        AppContext: context,
+        useAppSelector: useAppSelector,
+        useAppDispatch: useAppDispatch,
+        useAppStore: useAppStore
+    };
+};
+const createGen3AppWithOwnStore = (options)=>{
+    const { App, id, name, version, requiredEntityTypes, store, context } = options;
+    // need to create store and provider.
+    // return a component representing this app
+    // if component gets added to a list, then the list can be iterated in index.js and each provider component can be added
+    // a route can be setup for the app
+    // need to register its name, category, path, data requirements
+    // this will be used to build page3
+    // click app link
+    const Gen3AppWrapper = (props)=>{
         useEffect(()=>{
             document.title = `GEN3 - ${name}`;
         });
-        return /*#__PURE__*/ React.createElement(Provider, {
-            store: store
-        }, /*#__PURE__*/ React.createElement(CookiesProvider, null, /*#__PURE__*/ React.createElement(App, null)));
+        return /*#__PURE__*/ React__default.createElement(Provider, {
+            store: store,
+            context: context
+        }, /*#__PURE__*/ React__default.createElement(CookiesProvider, null, /*#__PURE__*/ React__default.createElement(App, props)));
     };
     // add the app to the store
     coreStore.dispatch(addGen3AppMetadata({
@@ -1036,10 +1098,69 @@ const getGen3AppId = (name, version)=>{
         version,
         requiredEntityTypes
     }));
-    registerGen3App(id, Gen3AppWrapper);
+    registerGen3App(name, Gen3AppWrapper);
     return Gen3AppWrapper;
 };
 
+const createAppApiForRTKQ = (reducerPath, baseQuery)=>{
+    const appContext = React.createContext(null);
+    const useAppSelector = useSelector.withTypes();
+    const useAppDispatch = createDispatchHook(appContext);
+    const useAppStore = createStoreHook(appContext);
+    const appCreateApi = buildCreateApi(coreModule(), reactHooksModule({
+        hooks: {
+            useDispatch: useAppDispatch,
+            useSelector: useAppSelector,
+            useStore: useAppStore
+        }
+    }));
+    const appRTKQApi = appCreateApi({
+        reducerPath: reducerPath,
+        baseQuery: baseQuery ?? fetchBaseQuery({
+            baseUrl: `${GEN3_API}`,
+            prepareHeaders: (headers)=>{
+                headers.set('Content-Type', 'application/json');
+                let accessToken = undefined;
+                if (process.env.NODE_ENV === 'development') {
+                    // NOTE: This cookie can only be accessed from the client side
+                    // in development mode. Otherwise, the cookie is set as httpOnly
+                    accessToken = getCookie('credentials_token');
+                }
+                if (accessToken) headers.set('Authorization', `Bearer ${accessToken}`);
+                return headers;
+            }
+        }),
+        endpoints: ()=>({})
+    });
+    const appMiddleware = appRTKQApi.middleware;
+    const appStore = configureStore({
+        reducer: {
+            [appRTKQApi.reducerPath]: appRTKQApi.reducer
+        },
+        middleware: (getDefaultMiddleware)=>getDefaultMiddleware({
+                serializableCheck: {
+                    ignoredActions: [
+                        FLUSH,
+                        REHYDRATE,
+                        PAUSE,
+                        PERSIST,
+                        PURGE,
+                        REGISTER
+                    ]
+                }
+            }).concat(appMiddleware)
+    });
+    return {
+        useAppSelector: useAppSelector,
+        useAppDispatch: useAppDispatch,
+        useAppStore: useAppStore,
+        AppContext: appContext,
+        appApi: appRTKQApi,
+        appContext: appContext,
+        appStore: appStore
+    };
+};
+
 const graphQLWithTags = gen3Api.enhanceEndpoints({
     addTagTypes: [
         'graphQL'
@@ -1496,14 +1617,14 @@ const useGetStatus = ()=>{
                 }
             }),
             getFieldCountSummary: builder.query({
-                query: ({ type, field, filters })=>{
+                query: ({ type, field, filters, accessibility = Accessibility.ALL })=>{
                     const gqlFilters = convertFilterSetToGqlFilter(filters);
-                    const query = `query ($filter: JSON) {
+                    const query = `query summary ($filter: JSON) {
         _aggregation {
-          ${type} (filter: $filter) {
+          ${type} (filter: $filter, accessibility: ${accessibility}) {
             ${field} {
               histogram {
-                sum
+                sum,
               }
             }
           }
@@ -1601,12 +1722,7 @@ const useGetArrayTypes = ()=>{
         return data ? data['indices'] : {};
     }
 };
-const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useGetSubAggsQuery, useGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
-const EmptyAggData = {};
-const selectAggDataForIndex = (state, index, field)=>{
-    const data = state.guppyApi.aggs[index]?.[field]?.histogram;
-    return data ?? EmptyAggData;
-};
+const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useLazyGetAggsQuery, useGetSubAggsQuery, useGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
 
 /**
  * Flattens a deep nested JSON object skipping
@@ -2079,5 +2195,5 @@ const SubmissionGraphqlQuery = `query transactionList {
 });
 const { useGetProjectsQuery, useGetSubmissionGraphQLQuery, useGetProjectsDetailsQuery, useLazyGetProjectsQuery, useLazyGetSubmissionGraphQLQuery, useGetSubmissionsQuery, useGetDictionaryQuery } = submissionApi;
 
-export { Accessibility, CoreContext, CoreProvider, GEN3_API, GEN3_AUTHZ_API, GEN3_COMMONS_NAME, GEN3_CROSSWALK_API, GEN3_DOMAIN, GEN3_DOWNLOADS_ENDPOINT, GEN3_FENCE_API, GEN3_GUPPY_API, GEN3_MDS_API, GEN3_REDIRECT_URL, GEN3_SUBMISSION_API, GEN3_WORKSPACE_STATUS_API, Modals, clearCohortFilters, cohortReducer, convertFilterSetToGqlFilter, coreStore, createGen3App, createUseCoreDataHook, downloadFromGuppyToBlob, downloadJSONDataFromGuppy, drsHostnamesReducer, extractEnumFilterValue, extractFieldNameFromFullFieldName, extractFilterValue, extractIndexAndFieldNameFromFullFieldName, extractIndexFromFullFieldName, fetchFence, fetchJson, fetchUserState, fieldNameToTitle, gen3Api, getGen3AppId, graphQLAPI, graphQLWithTags, guppyAPISliceMiddleware, guppyApi, guppyApiReducer, guppyApiSliceReducerPath, handleOperation, hideModal, isAuthenticated, isErrorWithMessage, isFetchBaseQueryError, isFetchParseError, isFilterEmpty, isGuppyAggregationData, isHistogramData, isHistogramDataAArray, isHistogramDataAnEnum, isHistogramDataArray, isHistogramDataArrayARange, isHistogramDataArrayAnEnum, isHistogramDataCollection, isHistogramRangeData, isJSONObject, isJSONValue, isJSONValueArray, isOperationWithField, isPending, isProgramUrl, isRootUrl, listifyMethodsFromMapping, logoutFence, prependIndexToFieldName, projectCodeFromResourcePath, rawDataQueryStrForEachField, removeCohortFilter, resetUserState, resourcePathFromProjectID, selectAggDataForIndex, selectAuthzMappingData, selectCSRFToken, selectCSRFTokenData, selectCohortFilters, selectCurrentCohort, selectCurrentCohortId, selectCurrentCohortName, selectCurrentMessage, selectCurrentModal, selectGen3AppById, selectGen3AppMetadataById, selectHeadersWithCSRFToken, selectIndexFilters, selectIndexedFilterByName, selectUser, selectUserAuthStatus, selectUserData, selectUserDetails, selectUserLoginStatus, setDRSHostnames, showModal, submissionApi, trimFirstFieldNameToTitle, updateCohortFilter, useAddNewCredentialMutation, useAskQuestionMutation, useAuthorizeFromCredentialsMutation, useCoreDispatch, useCoreSelector, useCoreStore, useDownloadFromGuppyMutation, useFetchUserDetailsQuery, useGeneralGQLQuery, useGetAISearchStatusQuery, useGetAISearchVersionQuery, useGetAccessibleDataQuery, useGetAggMDSQuery, useGetAggsQuery, useGetAllFieldsForTypeQuery, useGetArrayTypes, useGetAuthzMappingsQuery, useGetCSRFQuery, useGetCountsQuery, useGetCredentialsQuery, useGetCrosswalkDataQuery, useGetDataQuery, useGetDictionaryQuery, useGetExternalLoginsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetIndexAggMDSQuery, useGetIndexFields, useGetJWKKeysQuery, useGetLoginProvidersQuery, useGetMDSQuery, useGetProjectsDetailsQuery, useGetProjectsQuery, useGetRawDataAndTotalCountsQuery, useGetStatus, useGetSubAggsQuery, useGetSubmissionGraphQLQuery, useGetSubmissionsQuery, useGetTagsQuery, useGetWorkspaceOptionsQuery, useGetWorkspacePayModelsQuery, useGetWorkspaceStatusQuery, useGraphQLQuery, useIsExternalConnectedQuery, useIsUserLoggedIn, useLazyFetchUserDetailsQuery, useLazyGeneralGQLQuery, useLazyGetCrosswalkDataQuery, useLazyGetExternalLoginsQuery, useLazyGetProjectsQuery, useLazyGetSubmissionGraphQLQuery, useLazyIsExternalConnectedQuery, usePrevious, useRemoveCredentialMutation, useUser, useUserAuth, userHasCreateOrUpdateOnAnyProject, userHasDataUpload, userHasMethodForServiceOnProject, userHasMethodForServiceOnResource, userHasMethodOnAnyProject, userHasSheepdogProgramAdmin, userHasSheepdogProjectAdmin };
+export { Accessibility, CoreProvider, GEN3_API, GEN3_AUTHZ_API, GEN3_COMMONS_NAME, GEN3_CROSSWALK_API, GEN3_DOMAIN, GEN3_DOWNLOADS_ENDPOINT, GEN3_FENCE_API, GEN3_GUPPY_API, GEN3_MDS_API, GEN3_REDIRECT_URL, GEN3_SUBMISSION_API, GEN3_WORKSPACE_STATUS_API, Modals, clearCohortFilters, cohortReducer, convertFilterSetToGqlFilter, coreStore, createAppApiForRTKQ, createAppStore, createGen3App, createGen3AppWithOwnStore, createUseCoreDataHook, downloadFromGuppyToBlob, downloadJSONDataFromGuppy, drsHostnamesReducer, extractEnumFilterValue, extractFieldNameFromFullFieldName, extractFilterValue, extractIndexAndFieldNameFromFullFieldName, extractIndexFromFullFieldName, fetchFence, fetchJson, fetchUserState, fieldNameToTitle, gen3Api, getGen3AppId, graphQLAPI, graphQLWithTags, guppyAPISliceMiddleware, guppyApi, guppyApiReducer, guppyApiSliceReducerPath, handleOperation, hideModal, isAuthenticated, isErrorWithMessage, isFetchBaseQueryError, isFetchParseError, isFilterEmpty, isGuppyAggregationData, isHistogramData, isHistogramDataAArray, isHistogramDataAnEnum, isHistogramDataArray, isHistogramDataArrayARange, isHistogramDataArrayAnEnum, isHistogramDataCollection, isHistogramRangeData, isJSONObject, isJSONValue, isJSONValueArray, isOperationWithField, isPending, isProgramUrl, isRootUrl, listifyMethodsFromMapping, logoutFence, prependIndexToFieldName, projectCodeFromResourcePath, rawDataQueryStrForEachField, removeCohortFilter, resetUserState, resourcePathFromProjectID, selectAuthzMappingData, selectCSRFToken, selectCSRFTokenData, selectCohortFilters, selectCurrentCohort, selectCurrentCohortId, selectCurrentCohortName, selectCurrentMessage, selectCurrentModal, selectGen3AppByName, selectGen3AppMetadataByName, selectHeadersWithCSRFToken, selectIndexFilters, selectIndexedFilterByName, selectUser, selectUserAuthStatus, selectUserData, selectUserDetails, selectUserLoginStatus, setDRSHostnames, showModal, submissionApi, trimFirstFieldNameToTitle, updateCohortFilter, useAddNewCredentialMutation, useAskQuestionMutation, useAuthorizeFromCredentialsMutation, useCoreDispatch, useCoreSelector, useDownloadFromGuppyMutation, useFetchUserDetailsQuery, useGeneralGQLQuery, useGetAISearchStatusQuery, useGetAISearchVersionQuery, useGetAccessibleDataQuery, useGetAggMDSQuery, useGetAggsQuery, useGetAllFieldsForTypeQuery, useGetArrayTypes, useGetAuthzMappingsQuery, useGetCSRFQuery, useGetCountsQuery, useGetCredentialsQuery, useGetCrosswalkDataQuery, useGetDataQuery, useGetDictionaryQuery, useGetExternalLoginsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetIndexAggMDSQuery, useGetIndexFields, useGetJWKKeysQuery, useGetLoginProvidersQuery, useGetMDSQuery, useGetProjectsDetailsQuery, useGetProjectsQuery, useGetRawDataAndTotalCountsQuery, useGetStatus, useGetSubAggsQuery, useGetSubmissionGraphQLQuery, useGetSubmissionsQuery, useGetTagsQuery, useGetWorkspaceOptionsQuery, useGetWorkspacePayModelsQuery, useGetWorkspaceStatusQuery, useGraphQLQuery, useIsExternalConnectedQuery, useIsUserLoggedIn, useLazyFetchUserDetailsQuery, useLazyGeneralGQLQuery, useLazyGetAggsQuery, useLazyGetCrosswalkDataQuery, useLazyGetExternalLoginsQuery, useLazyGetProjectsQuery, useLazyGetSubmissionGraphQLQuery, useLazyIsExternalConnectedQuery, usePrevious, useRemoveCredentialMutation, useUser, useUserAuth, userHasCreateOrUpdateOnAnyProject, userHasDataUpload, userHasMethodForServiceOnProject, userHasMethodForServiceOnResource, userHasMethodOnAnyProject, userHasSheepdogProgramAdmin, userHasSheepdogProjectAdmin };
 //# sourceMappingURL=index.js.map