@gen3/core 0.10.47 → 0.10.49

package/dist/cjs/index.js

@@ -2,21 +2,39 @@
 
 var toolkit = require('@reduxjs/toolkit');
 var react = require('@reduxjs/toolkit/query/react');
-var React = require('react');
-var reactRedux = require('react-redux');
-var react$1 = require('@reduxjs/toolkit/dist/query/react');
 var cookiesNext = require('cookies-next');
 var query = require('@reduxjs/toolkit/query');
+var React = require('react');
+var reactRedux = require('react-redux');
 var lodash = require('lodash');
 var Queue = require('queue');
 var jsonpathPlus = require('jsonpath-plus');
 var uuid = require('uuid');
-require('redux-persist');
+var reduxPersist = require('redux-persist');
 var reactCookie = require('react-cookie');
 var useSWR = require('swr');
 var flat = require('flat');
 var Papa = require('papaparse');
 
+function _interopNamespaceDefault(e) {
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
+
 const GEN3_COMMONS_NAME = process.env.GEN3_COMMONS_NAME || 'gen3';
 const GEN3_API = process.env.NEXT_PUBLIC_GEN3_API || '';
 const GEN3_DOMAIN = process.env.NEXT_PUBLIC_GEN3_DOMAIN || '';
@@ -44,30 +62,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 = reactRedux.createSelectorHook(CoreContext);
-const useCoreDispatch = reactRedux.createDispatchHook(CoreContext);
-const useCoreStore = reactRedux.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 = react.buildCreateApi(react.coreModule(), react.reactHooksModule({
-    useSelector: useCoreSelector,
-    useStore: useCoreStore,
-    useDispatch: useCoreDispatch
-}));
-
 /**
  * Template for fence error response dict
  * @returns: An error dict response from a RESTFUL API request
@@ -101,7 +95,7 @@ const useCoreStore = reactRedux.createStoreHook(CoreContext);
     });
 };
 
-const userAuthApi = coreCreateApi({
+const userAuthApi = react.createApi({
     reducerPath: 'userAuthApi',
     refetchOnMountOrArgChange: 1800,
     refetchOnReconnect: true,
@@ -198,9 +192,9 @@ const selectHeadersWithCSRFToken = toolkit.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 = react.createApi({
     reducerPath: 'gen3Services',
-    baseQuery: react$1.fetchBaseQuery({
+    baseQuery: react.fetchBaseQuery({
         baseUrl: `${GEN3_API}`,
         prepareHeaders: (headers, { getState })=>{
             const csrfToken = selectCSRFToken(getState());
@@ -338,6 +332,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 = reactRedux.useSelector.withTypes();
+const useCoreDispatch = reactRedux.useDispatch.withTypes();
+
 const usePrevious = (value)=>{
     const ref = React.useRef();
     React.useEffect(()=>{
@@ -592,8 +598,8 @@ const slice$2 = toolkit.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: [
@@ -605,8 +611,8 @@ const slice$2 = toolkit.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
@@ -733,8 +739,7 @@ const cohortsAdapter = createEntityAdapter<Cohort>({
                 }
             };
         }
-    },
-    extraReducers: {}
+    }
 });
 // Filter actions: addFilter, removeFilter, updateFilter
 const { updateCohortFilter, removeCohortFilter, clearCohortFilters } = cohortSlice.actions;
@@ -768,7 +773,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 = react.createApi({
     reducerPath: 'guppy',
     // TODO: refactor to use fetchBaseQuery
     baseQuery: async (query, api)=>{
@@ -833,8 +838,7 @@ query.setupListeners(coreStore.dispatch);
 
 const CoreProvider = ({ children })=>{
     return /*#__PURE__*/ React.createElement(reactRedux.Provider, {
-        store: coreStore,
-        context: CoreContext
+        store: coreStore
     }, children);
 };
 
@@ -999,12 +1003,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 uuid.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}`;
@@ -1016,20 +1021,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)=>{
+        React.useEffect(()=>{
+            document.title = `GEN3 - ${name}`;
+        });
+        return /*#__PURE__*/ React.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 = uuid.v5(nameVersion, GEN3_APP_NAMESPACE);
     const store = toolkit.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: [
+                        reduxPersist.FLUSH,
+                        reduxPersist.REHYDRATE,
+                        reduxPersist.PAUSE,
+                        reduxPersist.PERSIST,
+                        reduxPersist.PURGE,
+                        reduxPersist.REGISTER
+                    ]
+                }
+            }).concat(middleware) : getDefaultMiddleware({
+                serializableCheck: {
+                    ignoredActions: [
+                        reduxPersist.FLUSH,
+                        reduxPersist.REHYDRATE,
+                        reduxPersist.PAUSE,
+                        reduxPersist.PERSIST,
+                        reduxPersist.PURGE,
+                        reduxPersist.REGISTER
+                    ]
+                }
+            })
     });
-    const Gen3AppWrapper = ()=>{
+    const context = /*#__PURE__*/ React.createContext(null);
+    const useAppSelector = reactRedux.createSelectorHook(context);
+    const useAppDispatch = reactRedux.createDispatchHook(context);
+    const useAppStore = reactRedux.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)=>{
         React.useEffect(()=>{
             document.title = `GEN3 - ${name}`;
         });
         return /*#__PURE__*/ React.createElement(reactRedux.Provider, {
-            store: store
-        }, /*#__PURE__*/ React.createElement(reactCookie.CookiesProvider, null, /*#__PURE__*/ React.createElement(App, null)));
+            store: store,
+            context: context
+        }, /*#__PURE__*/ React.createElement(reactCookie.CookiesProvider, null, /*#__PURE__*/ React.createElement(App, props)));
     };
     // add the app to the store
     coreStore.dispatch(addGen3AppMetadata({
@@ -1038,10 +1118,69 @@ const getGen3AppId = (name, version)=>{
         version,
         requiredEntityTypes
     }));
-    registerGen3App(id, Gen3AppWrapper);
+    registerGen3App(name, Gen3AppWrapper);
     return Gen3AppWrapper;
 };
 
+const createAppApiForRTKQ = (reducerPath, baseQuery)=>{
+    const appContext = React__namespace.createContext(null);
+    const useAppSelector = reactRedux.useSelector.withTypes();
+    const useAppDispatch = reactRedux.createDispatchHook(appContext);
+    const useAppStore = reactRedux.createStoreHook(appContext);
+    const appCreateApi = react.buildCreateApi(react.coreModule(), react.reactHooksModule({
+        hooks: {
+            useDispatch: useAppDispatch,
+            useSelector: useAppSelector,
+            useStore: useAppStore
+        }
+    }));
+    const appRTKQApi = appCreateApi({
+        reducerPath: reducerPath,
+        baseQuery: baseQuery ?? react.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 = cookiesNext.getCookie('credentials_token');
+                }
+                if (accessToken) headers.set('Authorization', `Bearer ${accessToken}`);
+                return headers;
+            }
+        }),
+        endpoints: ()=>({})
+    });
+    const appMiddleware = appRTKQApi.middleware;
+    const appStore = toolkit.configureStore({
+        reducer: {
+            [appRTKQApi.reducerPath]: appRTKQApi.reducer
+        },
+        middleware: (getDefaultMiddleware)=>getDefaultMiddleware({
+                serializableCheck: {
+                    ignoredActions: [
+                        reduxPersist.FLUSH,
+                        reduxPersist.REHYDRATE,
+                        reduxPersist.PAUSE,
+                        reduxPersist.PERSIST,
+                        reduxPersist.PURGE,
+                        reduxPersist.REGISTER
+                    ]
+                }
+            }).concat(appMiddleware)
+    });
+    return {
+        useAppSelector: useAppSelector,
+        useAppDispatch: useAppDispatch,
+        useAppStore: useAppStore,
+        AppContext: appContext,
+        appApi: appRTKQApi,
+        appContext: appContext,
+        appStore: appStore
+    };
+};
+
 const graphQLWithTags = gen3Api.enhanceEndpoints({
     addTagTypes: [
         'graphQL'
@@ -1498,14 +1637,14 @@ const useGetStatus = ()=>{
                 }
             }),
             getFieldCountSummary: builder.query({
-                query: ({ type, field, filters })=>{
+                query: ({ type, field, filters, accessibility = exports.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,
               }
             }
           }
@@ -1603,12 +1742,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
@@ -2081,7 +2215,6 @@ const SubmissionGraphqlQuery = `query transactionList {
 });
 const { useGetProjectsQuery, useGetSubmissionGraphQLQuery, useGetProjectsDetailsQuery, useLazyGetProjectsQuery, useLazyGetSubmissionGraphQLQuery, useGetSubmissionsQuery, useGetDictionaryQuery } = submissionApi;
 
-exports.CoreContext = CoreContext;
 exports.CoreProvider = CoreProvider;
 exports.GEN3_API = GEN3_API;
 exports.GEN3_AUTHZ_API = GEN3_AUTHZ_API;
@@ -2099,7 +2232,10 @@ exports.clearCohortFilters = clearCohortFilters;
 exports.cohortReducer = cohortReducer;
 exports.convertFilterSetToGqlFilter = convertFilterSetToGqlFilter;
 exports.coreStore = coreStore;
+exports.createAppApiForRTKQ = createAppApiForRTKQ;
+exports.createAppStore = createAppStore;
 exports.createGen3App = createGen3App;
+exports.createGen3AppWithOwnStore = createGen3AppWithOwnStore;
 exports.createUseCoreDataHook = createUseCoreDataHook;
 exports.downloadFromGuppyToBlob = downloadFromGuppyToBlob;
 exports.downloadJSONDataFromGuppy = downloadJSONDataFromGuppy;
@@ -2152,7 +2288,6 @@ exports.rawDataQueryStrForEachField = rawDataQueryStrForEachField;
 exports.removeCohortFilter = removeCohortFilter;
 exports.resetUserState = resetUserState;
 exports.resourcePathFromProjectID = resourcePathFromProjectID;
-exports.selectAggDataForIndex = selectAggDataForIndex;
 exports.selectAuthzMappingData = selectAuthzMappingData;
 exports.selectCSRFToken = selectCSRFToken;
 exports.selectCSRFTokenData = selectCSRFTokenData;
@@ -2162,8 +2297,8 @@ exports.selectCurrentCohortId = selectCurrentCohortId;
 exports.selectCurrentCohortName = selectCurrentCohortName;
 exports.selectCurrentMessage = selectCurrentMessage;
 exports.selectCurrentModal = selectCurrentModal;
-exports.selectGen3AppById = selectGen3AppById;
-exports.selectGen3AppMetadataById = selectGen3AppMetadataById;
+exports.selectGen3AppByName = selectGen3AppByName;
+exports.selectGen3AppMetadataByName = selectGen3AppMetadataByName;
 exports.selectHeadersWithCSRFToken = selectHeadersWithCSRFToken;
 exports.selectIndexFilters = selectIndexFilters;
 exports.selectIndexedFilterByName = selectIndexedFilterByName;
@@ -2182,7 +2317,6 @@ exports.useAskQuestionMutation = useAskQuestionMutation;
 exports.useAuthorizeFromCredentialsMutation = useAuthorizeFromCredentialsMutation;
 exports.useCoreDispatch = useCoreDispatch;
 exports.useCoreSelector = useCoreSelector;
-exports.useCoreStore = useCoreStore;
 exports.useDownloadFromGuppyMutation = useDownloadFromGuppyMutation;
 exports.useFetchUserDetailsQuery = useFetchUserDetailsQuery;
 exports.useGeneralGQLQuery = useGeneralGQLQuery;
@@ -2224,6 +2358,7 @@ exports.useIsExternalConnectedQuery = useIsExternalConnectedQuery;
 exports.useIsUserLoggedIn = useIsUserLoggedIn;
 exports.useLazyFetchUserDetailsQuery = useLazyFetchUserDetailsQuery;
 exports.useLazyGeneralGQLQuery = useLazyGeneralGQLQuery;
+exports.useLazyGetAggsQuery = useLazyGetAggsQuery;
 exports.useLazyGetCrosswalkDataQuery = useLazyGetCrosswalkDataQuery;
 exports.useLazyGetExternalLoginsQuery = useLazyGetExternalLoginsQuery;
 exports.useLazyGetProjectsQuery = useLazyGetProjectsQuery;