@gen3/core 0.11.29 → 0.11.31

package/dist/cjs/index.js

@@ -6,8 +6,9 @@ var cookiesNext = require('cookies-next');
 var query = require('@reduxjs/toolkit/query');
 var reactRedux = require('react-redux');
 var React = require('react');
-var lodash = require('lodash');
+var nanoid$1 = require('nanoid');
 var useSWR = require('swr');
+var lodash = require('lodash');
 var flat = require('flat');
 var Papa = require('papaparse');
 var jsonpathPlus = require('jsonpath-plus');
@@ -864,7 +865,8 @@ const newCohort = ({ filters = {}, customName })=>{
         counts: {}
     };
 };
-const createCohortId = ()=>toolkit.nanoid();
+const nanoid = nanoid$1.customAlphabet('1234567890abcdef', 16);
+const createCohortId = ()=>nanoid();
 const cohortsAdapter = toolkit.createEntityAdapter({
     sortComparer: (a, b)=>{
         if (a.modifiedDatetime <= b.modifiedDatetime) return 1;
@@ -1087,6 +1089,21 @@ const getCurrentCohortId = (state)=>state.currentCohortId;
                 }
             });
         },
+        updateCohortIndexCountById: (state, action)=>{
+            const { index, cohortId, counts } = action.payload;
+            const cohort = state.entities[cohortId];
+            cohortsAdapter.updateOne(state, {
+                id: cohortId,
+                changes: {
+                    counts: {
+                        ...cohort.counts,
+                        ...{
+                            [index]: counts
+                        }
+                    }
+                }
+            });
+        },
         setCurrentCohortId: (state, action)=>{
             state.currentCohortId = action.payload;
         },
@@ -1108,7 +1125,7 @@ const getCurrentCohortId = (state)=>state.currentCohortId;
  * @hidden
  */ const cohortSelectors = cohortsAdapter.getSelectors((state)=>state.cohorts.cohortManager);
 // Filter actions: addFilter, removeFilter, updateFilter
-const { createNewCohort, updateCohortFilter, setCohortFilter, setCohortIndexFilters, duplicateCohort, removeCohortFilter, clearCohortFilters, removeCohort, setCurrentCohortId, updateCohortName, updateCohortCounts, setCohortList } = cohortManagerSlice.actions;
+const { createNewCohort, updateCohortFilter, setCohortFilter, setCohortIndexFilters, duplicateCohort, removeCohortFilter, clearCohortFilters, removeCohort, setCurrentCohortId, updateCohortName, updateCohortCounts, updateCohortIndexCountById, setCohortList } = cohortManagerSlice.actions;
 const cohortReducer = cohortManagerSlice.reducer;
 
 const initialState$2 = {};
@@ -1693,81 +1710,6 @@ const trimFirstFieldNameToTitle = (fieldName, trim = false)=>{
     ];
 };
 
-const { selectAll: selectAllCohorts, selectTotal: selectTotalCohorts, selectById: selectCohortById, selectIds: selectCohortIds } = cohortsAdapter.getSelectors((state)=>state.cohorts.cohortManager);
-/**
- * Internally used selector for the exported selectora
- * @param state
- */ const getCurrentCohortFromCoreState = (state)=>{
-    return state.cohorts.cohortManager.currentCohortId;
-};
-const selectCohortFilters = (state)=>{
-    const currentCohortId = getCurrentCohortFromCoreState(state);
-    return state.cohorts.cohortManager.entities[currentCohortId]?.filters;
-};
-const selectCurrentCohortFilters = (state)=>{
-    const currentCohortId = getCurrentCohortFromCoreState(state);
-    return state.cohorts.cohortManager.entities[currentCohortId]?.filters;
-};
-const selectCurrentCohortId = (state)=>{
-    return state.cohorts.cohortManager.currentCohortId;
-};
-const selectCurrentCohort = (state)=>cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
-const selectCurrentCohortName = (state)=>cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state)).name;
-/**
- * Select a filter by its name from the current cohort. If the filter is not found
- * returns undefined.
- * @param state - Core
- * @param index which cohort index to select from
- * @param name name of the filter to select
- */ const selectIndexedFilterByName = (state, index, name)=>{
-    return cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state)).filters[index]?.root[name];
-};
-/**
- * Returns all the cohorts in the state
- * @param state - the CoreState
- *
- * @category Cohort
- * @category Selectors
- */ const selectAvailableCohorts = (state)=>cohortSelectors.selectAll(state);
-/**
- * Returns if the current cohort is modified
- * @param state - the CoreState
- * @category Cohort
- * @category Selectors
- * @hidden
- */ const selectCurrentCohortModified = (state)=>{
-    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
-    return cohort?.modified;
-};
-/**
- * Returns if the current cohort has been saved
- * @param state - the CoreState
- * @category Cohort
- * @category Selectors
- * @hidden
- */ const selectCurrentCohortSaved = (state)=>{
-    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
-    return cohort?.saved;
-};
-/**
- * Select a filter by its name from the current cohort. If the filter is not found
- * returns undefined.
- * @param state - Core
- * @param name name of the filter to select
- */ const selectAvailableCohortByName = (state, name)=>cohortSelectors.selectAll(state).find((cohort)=>cohort.name === name);
-/**
- * Select a filter from the index.
- * returns undefined.
- * @param state - Core
- * @param index which cohort index to select from
- */ const selectIndexFilters = (state, index)=>{
-    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
-    if (!cohort) {
-        console.error('No Cohort Defined');
-    }
-    return cohort?.filters?.[index] ?? EmptyFilterSet;
-};
-
 /**
  * Flattens a deep nested JSON object skipping
  * the first level to avoid potentially flattening
@@ -2135,6 +2077,15 @@ const useGetStatus = ()=>{
     const fetcher = ()=>fetchJson(`${GEN3_GUPPY_API}${statusEndpoint}`);
     return useSWR('explorerStatus', fetcher);
 };
+const explorerTags = guppyApi.enhanceEndpoints({
+    addTagTypes: [
+        'AGGS',
+        'COUNTS',
+        'STATS',
+        'TABLE_DATA',
+        'RAW_DATA'
+    ]
+});
 /**
  * The main endpoint used in templating Exploration page queries.
  * Includes table, filter and aggregation query types and leverages guppyApi defined in ./gupplApi.ts
@@ -2152,7 +2103,7 @@ const useGetStatus = ()=>{
  * @param getSubAggs - TODO: not sure what this one does. Looks like nested aggregation
  * @param getCounts - Returns total counts of a vertex type
  * @returns: A guppy API endpoint for templating queryable data displayed on the exploration page
- */ const explorerApi = guppyApi.injectEndpoints({
+ */ const explorerApi = explorerTags.injectEndpoints({
     endpoints: (builder)=>({
             getAllFieldsForType: builder.query({
                 query: (type)=>({
@@ -2163,11 +2114,11 @@ const useGetStatus = ()=>{
                 }
             }),
             getAccessibleData: builder.query({
-                query: ({ type, fields, accessType })=>{
+                query: ({ type, fields, accessibility })=>{
                     const fieldParts = fields.map((field)=>`${field} { histogram { key count } }`);
                     return {
                         query: `_aggregation {
-              ${type} (accessibility: ${accessType}) {
+              ${type} (accessibility: ${accessibility}) {
                 ${fieldParts.join(',')}
               }
             }`
@@ -2229,11 +2180,15 @@ const useGetStatus = ()=>{
                         query,
                         variables
                     };
-                }
+                },
+                providesTags: [
+                    'RAW_DATA',
+                    'TABLE_DATA'
+                ]
             }),
             getAggs: builder.query({
-                query: ({ type, fields, filters, accessibility = Accessibility.ALL })=>{
-                    return buildGetAggregationQuery(type, fields, filters, accessibility, false);
+                query: ({ type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false })=>{
+                    return buildGetAggregationQuery(type, fields, filters, accessibility, filterSelf);
                 },
                 transformResponse: (response, _meta, args)=>{
                     const buckets = processHistogramResponse(response?.data?._aggregation[args.type] ?? {});
@@ -2248,41 +2203,39 @@ const useGetStatus = ()=>{
                         ],
                         ...buckets
                     };
-                }
-            }),
-            getAggsNoFilterSelf: builder.query({
-                query: ({ type, fields, filters, accessibility = Accessibility.ALL })=>{
-                    return buildGetAggregationQuery(type, fields, filters, accessibility, true);
                 },
-                transformResponse: (response, _meta, args)=>{
-                    return processHistogramResponse(response?.data?._aggregation[args.type] ?? {});
-                }
+                providesTags: [
+                    'AGGS'
+                ]
             }),
             getStatsAggregations: builder.query({
-                query: ({ type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false })=>{
-                    return buildGetStatsAggregationQuery(type, fields, filters, accessibility, filterSelf);
+                query: ({ type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false, queryId = undefined })=>{
+                    return buildGetStatsAggregationQuery(type, fields, filters, accessibility, filterSelf, queryId);
                 },
                 transformResponse: (response, _meta, args)=>{
                     return processHistogramResponse(response?.data?._aggregation[args.type] ?? {});
-                }
+                },
+                providesTags: [
+                    'STATS'
+                ]
             }),
             getSubAggs: builder.query({
-                query: ({ type, mainField, termsFields = undefined, missingFields = undefined, numericAggAsText = false, gqlFilter = undefined, accessibility = Accessibility.ALL })=>{
+                query: ({ type, mainField, termsFields = undefined, missingFields = undefined, numericAggAsText = false, filters = undefined, accessibility = Accessibility.ALL })=>{
                     const nestedAggFields = {
                         termsFields: termsFields,
                         missingFields: missingFields
                     };
-                    const query = `query getSubAggs ( ${gqlFilter ?? '$filter: JSON,'} $nestedAggFields: JSON) {
+                    const query = `query getSubAggs ( ${filters ?? '$filter: JSON,'} $nestedAggFields: JSON) {
     _aggregation {
-      ${type} ( ${gqlFilter ?? 'filter: $filter, filterSelf: false,'} nestedAggFields: $nestedAggFields, accessibility: ${accessibility}) {
+      ${type} ( ${filters ?? 'filter: $filter, filterSelf: false,'} nestedAggFields: $nestedAggFields, accessibility: ${accessibility}) {
       _totalCounts
         ${nestedHistogramQueryStrForEachField(mainField, numericAggAsText)}
       }`;
                     return {
                         query: query,
                         variables: {
-                            ...gqlFilter && {
-                                filter: convertFilterSetToGqlFilter(gqlFilter)
+                            ...filters && {
+                                filter: convertFilterSetToGqlFilter(filters)
                             },
                             nestedAggFields: nestedAggFields
                         }
@@ -2290,12 +2243,15 @@ const useGetStatus = ()=>{
                 },
                 transformResponse: (response, _meta, args)=>{
                     return processHistogramResponse(response?.data?._aggregation[args.type] ?? {});
-                }
+                },
+                providesTags: [
+                    'AGGS'
+                ]
             }),
             getCounts: builder.query({
-                query: ({ type, filters, accessibility = Accessibility.ALL })=>{
+                query: ({ type, filters, accessibility = Accessibility.ALL, queryId = undefined })=>{
                     const gqlFilters = convertFilterSetToGqlFilter(filters);
-                    const queryLine = `query totalCounts ${gqlFilters ? '($filter: JSON)' : ''}{`;
+                    const queryLine = `query totalCounts${queryId ? `_${queryId}` : ''} ${gqlFilters ? '($filter: JSON)' : ''}{`;
                     const typeAggsLine = `${type} ${gqlFilters ? '(filter: $filter, ' : '('} accessibility: ${accessibility}) {`;
                     const query = `${queryLine} _aggregation {
           ${typeAggsLine}
@@ -2320,7 +2276,10 @@ const useGetStatus = ()=>{
                         throw new Error(`Invalid response: Missing expected key '${args.type}' in _aggregation`);
                     }
                     return response.data._aggregation[args.type]._totalCount ?? 0;
-                }
+                },
+                providesTags: [
+                    'COUNTS'
+                ]
             }),
             getFieldCountSummary: builder.query({
                 query: ({ type, field, filters, accessibility = Accessibility.ALL })=>{
@@ -2383,8 +2342,6 @@ const useGetStatus = ()=>{
             })
         })
 });
-// query for aggregate data
-// convert the function below to typescript
 const histogramQueryStrForEachField = (field)=>{
     const splittedFieldArray = field.split('.');
     const splittedField = splittedFieldArray.shift();
@@ -2467,9 +2424,9 @@ const useGetIndexFields = (index)=>{
     const { data } = useGetFieldsForIndexQuery(index);
     return data ?? [];
 };
-const buildGetAggregationQuery = (type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false)=>{
+const buildGetAggregationQuery = (type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false, queryId = undefined)=>{
     const queryStart = isFilterEmpty(filters) ? `
-              query getAggs {
+              query getAggs${queryId ? `_${queryId}` : ''} {
               _aggregation {
               ${type} (accessibility: ${accessibility}) {` : `query getAggs ($filter: JSON) {
                _aggregation {
@@ -2488,11 +2445,11 @@ const buildGetAggregationQuery = (type, fields, filters, accessibility = Accessi
     };
     return queryBody;
 };
-const buildGetStatsAggregationQuery = (type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false)=>{
+const buildGetStatsAggregationQuery = (type, fields, filters, accessibility = Accessibility.ALL, filterSelf = false, queryId = undefined)=>{
     const queryStart = isFilterEmpty(filters) ? `
-              query getAggs {
+              query getStatsAggs${queryId ? `_${queryId}` : ''} {
               _aggregation {
-              ${type} (accessibility: ${accessibility}) {` : `query getAggs ($filter: JSON) {
+              ${type} (accessibility: ${accessibility}) {` : `query getStatsAggs${queryId ? `_${queryId}` : ''} ($filter: JSON) {
                _aggregation {
                       ${type} (filter: $filter, filterSelf: ${filterSelf ? 'true' : 'false'}, accessibility: ${accessibility}) { _totalCount`;
     const query = `${queryStart}
@@ -2508,49 +2465,29 @@ const buildGetStatsAggregationQuery = (type, fields, filters, accessibility = Ac
     };
     return queryBody;
 };
-const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useGetAggsNoFilterSelfQuery, useLazyGetAggsQuery, useLazyGetAggsNoFilterSelfQuery, useGetStatsAggregationsQuery, useLazyGetStatsAggregationsQuery, useGetSubAggsQuery, useGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetSharedFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
+const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useLazyGetAggsQuery, useGetStatsAggregationsQuery, useLazyGetStatsAggregationsQuery, useGetSubAggsQuery, useGetCountsQuery, useLazyGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetSharedFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
 
-const isPayloadActionWithObject = (action)=>{
-    return typeof action === 'object' && action !== null && 'type' in action && 'payload' in action && typeof action.payload === 'object';
-};
 /**
  * Defines coreListeners for adding middleware.
  * used to update the current Cohort Case count
  */ const coreStoreListenerMiddleware = toolkit.createListenerMiddleware();
 const startCoreListening = coreStoreListenerMiddleware.startListening;
-startCoreListening({
-    matcher: toolkit.isAnyOf(updateCohortFilter, removeCohortFilter, clearCohortFilters),
-    effect: async (_, listenerApi)=>{
-        const currentCohortId = selectCurrentCohortId(listenerApi.getState());
-        // need to pass the current cohort id to the case count fetcher because it is possible that
-        // the current cohort will be different when the fetch is fulfilled
-        if (currentCohortId) console.log('currentCohortId', currentCohortId);
-    }
-});
-startCoreListening({
-    matcher: toolkit.isAnyOf(explorerApi.endpoints.getAggs.matchFulfilled),
-    effect: async (action, listenerApi)=>{
-        if (isPayloadActionWithObject(action)) {
-            const root = action.payload;
-            const counts = root?._totalCount.reduce((acc, curr)=>{
-                const { key, count } = curr;
-                acc[key] = count;
-                return acc;
-            }, {});
-            if (counts) {
-                listenerApi.dispatch(updateCohortCounts(counts ?? {}));
-            }
-        }
-    }
-});
-startCoreListening({
+/**
+ * When a getCounts is requested, it might be for a cohort.
+ * If so, then update the cohort's counts for that index
+ */ startCoreListening({
     matcher: toolkit.isAnyOf(explorerApi.endpoints.getCounts.matchFulfilled),
     effect: async (action, listenerApi)=>{
         const counts = action.payload;
-        const index = action?.meta?.arg?.originalArgs?.index;
-        if (index) listenerApi.dispatch(updateCohortCounts({
-            [index]: counts
-        }));
+        const index = action?.meta?.arg?.originalArgs?.type; // note this is the guppy index name
+        const cohortId = action?.meta?.arg?.originalArgs?.queryId;
+        if (cohortId && index) {
+            listenerApi.dispatch(updateCohortIndexCountById({
+                index,
+                cohortId,
+                counts
+            }));
+        }
     }
 });
 
@@ -3459,6 +3396,81 @@ class CohortStorage {
     }
 }
 
+const { selectAll: selectAllCohorts, selectTotal: selectTotalCohorts, selectById: selectCohortById, selectIds: selectCohortIds } = cohortsAdapter.getSelectors((state)=>state.cohorts.cohortManager);
+/**
+ * Internally used selector for the exported selectora
+ * @param state
+ */ const getCurrentCohortFromCoreState = (state)=>{
+    return state.cohorts.cohortManager.currentCohortId;
+};
+const selectCohortFilters = (state)=>{
+    const currentCohortId = getCurrentCohortFromCoreState(state);
+    return state.cohorts.cohortManager.entities[currentCohortId]?.filters;
+};
+const selectCurrentCohortFilters = (state)=>{
+    const currentCohortId = getCurrentCohortFromCoreState(state);
+    return state.cohorts.cohortManager.entities[currentCohortId]?.filters;
+};
+const selectCurrentCohortId = (state)=>{
+    return state.cohorts.cohortManager.currentCohortId;
+};
+const selectCurrentCohort = (state)=>cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
+const selectCurrentCohortName = (state)=>cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state)).name;
+/**
+ * Select a filter by its name from the current cohort. If the filter is not found
+ * returns undefined.
+ * @param state - Core
+ * @param index which cohort index to select from
+ * @param name name of the filter to select
+ */ const selectIndexedFilterByName = (state, index, name)=>{
+    return cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state)).filters[index]?.root[name];
+};
+/**
+ * Returns all the cohorts in the state
+ * @param state - the CoreState
+ *
+ * @category Cohort
+ * @category Selectors
+ */ const selectAvailableCohorts = (state)=>cohortSelectors.selectAll(state);
+/**
+ * Returns if the current cohort is modified
+ * @param state - the CoreState
+ * @category Cohort
+ * @category Selectors
+ * @hidden
+ */ const selectCurrentCohortModified = (state)=>{
+    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
+    return cohort?.modified;
+};
+/**
+ * Returns if the current cohort has been saved
+ * @param state - the CoreState
+ * @category Cohort
+ * @category Selectors
+ * @hidden
+ */ const selectCurrentCohortSaved = (state)=>{
+    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
+    return cohort?.saved;
+};
+/**
+ * Select a filter by its name from the current cohort. If the filter is not found
+ * returns undefined.
+ * @param state - Core
+ * @param name name of the filter to select
+ */ const selectAvailableCohortByName = (state, name)=>cohortSelectors.selectAll(state).find((cohort)=>cohort.name === name);
+/**
+ * Select a filter from the index.
+ * returns undefined.
+ * @param state - Core
+ * @param index which cohort index to select from
+ */ const selectIndexFilters = (state, index)=>{
+    const cohort = cohortSelectors.selectById(state, getCurrentCohortFromCoreState(state));
+    if (!cohort) {
+        console.error('No Cohort Defined');
+    }
+    return cohort?.filters?.[index] ?? EmptyFilterSet;
+};
+
 const isFileItem = (item)=>{
     return item && 'guid' in item;
 };
@@ -5668,6 +5680,7 @@ exports.downloadJSONDataFromGuppy = downloadJSONDataFromGuppy;
 exports.drsHostnamesReducer = drsHostnamesReducer;
 exports.duplicateCohort = duplicateCohort;
 exports.explorerApi = explorerApi;
+exports.explorerTags = explorerTags;
 exports.extractEnumFilterValue = extractEnumFilterValue;
 exports.extractFieldNameFromFullFieldName = extractFieldNameFromFullFieldName;
 exports.extractFileDatasetsInRecords = extractFileDatasetsInRecords;
@@ -5846,7 +5859,6 @@ exports.useGetAISearchVersionQuery = useGetAISearchVersionQuery;
 exports.useGetAccessibleDataQuery = useGetAccessibleDataQuery;
 exports.useGetActivePayModelQuery = useGetActivePayModelQuery;
 exports.useGetAggMDSQuery = useGetAggMDSQuery;
-exports.useGetAggsNoFilterSelfQuery = useGetAggsNoFilterSelfQuery;
 exports.useGetAggsQuery = useGetAggsQuery;
 exports.useGetAllFieldsForTypeQuery = useGetAllFieldsForTypeQuery;
 exports.useGetArrayTypes = useGetArrayTypes;
@@ -5898,11 +5910,11 @@ exports.useIsUserLoggedIn = useIsUserLoggedIn;
 exports.useLaunchWorkspaceMutation = useLaunchWorkspaceMutation;
 exports.useLazyFetchUserDetailsQuery = useLazyFetchUserDetailsQuery;
 exports.useLazyGeneralGQLQuery = useLazyGeneralGQLQuery;
-exports.useLazyGetAggsNoFilterSelfQuery = useLazyGetAggsNoFilterSelfQuery;
 exports.useLazyGetAggsQuery = useLazyGetAggsQuery;
 exports.useLazyGetAuthzMappingsQuery = useLazyGetAuthzMappingsQuery;
 exports.useLazyGetAuthzResourcesQuery = useLazyGetAuthzResourcesQuery;
 exports.useLazyGetCSRFQuery = useLazyGetCSRFQuery;
+exports.useLazyGetCountsQuery = useLazyGetCountsQuery;
 exports.useLazyGetCrosswalkDataQuery = useLazyGetCrosswalkDataQuery;
 exports.useLazyGetDownloadQuery = useLazyGetDownloadQuery;
 exports.useLazyGetExternalLoginsQuery = useLazyGetExternalLoginsQuery;