✨ Expose query keys

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/subsurface-app-management",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "React Typescript components/hooks to communicate with equinor/sam",
   "types": "dist/index.d.ts",
   "type": "module",

src/constants/index.ts

@@ -0,0 +1 @@
+export * from './queryKeys';

src/constants/queryKeys.ts

@@ -0,0 +1,9 @@
+export const GET_FEATURE_TOGGLES_FOR_APP = 'getFeatureToggleFromAppName';
+export const GET_TUTORIALS_FOR_APP = 'getTutorialsForApp';
+export const GET_TUTORIALS_SAS_TOKEN = 'getTutorialsSasToken';
+
+export const SAM_QUERIES = [
+  GET_FEATURE_TOGGLES_FOR_APP,
+  GET_TUTORIALS_FOR_APP,
+  GET_TUTORIALS_SAS_TOKEN,
+];

src/index.ts

@@ -9,3 +9,5 @@ export * from './types';
 export * from './utils';
 
 export * from './api';
+
+export * from './constants';

src/providers/FeatureToggleProvider.tsx

@@ -5,6 +5,7 @@ import { useQuery } from '@tanstack/react-query';
 // These 2 api imports need to be separated to be able to use vi.mock in tests
 import { FeatureAPIType, GraphUser } from 'src/api';
 import { FeatureToggleService } from 'src/api/services/FeatureToggleService';
+import { GET_FEATURE_TOGGLES_FOR_APP } from 'src/constants/queryKeys';
 import { EnvironmentType } from 'src/types';
 import { environment } from 'src/utils';
 import { getEnvironmentName } from 'src/utils/environment';
@@ -66,7 +67,7 @@ export const FeatureToggleProvider: FC<FeatureToggleProviderProps> = ({
     isLoading,
     isError,
   } = useQuery({
-    queryKey: ['getFeatureToggleFromAppName'],
+    queryKey: [GET_FEATURE_TOGGLES_FOR_APP],
     queryFn: async () =>
       FeatureToggleService.getFeatureToggleFromApplicationName(applicationName),
   });

src/providers/TutorialProvider/TutorialProvider.const.ts

@@ -3,6 +3,3 @@ export const DIALOG_EDGE_MARGIN = 24;
 export const TUTORIAL_SEARCH_PARAM_KEY = 'tutorial';
 export const TUTORIAL_LOCALSTORAGE_VALUE_STRING = 'hasCompletedTutorial';
 export const TUTORIAL_HIGHLIGHTER_DATATEST_ID = 'tutorial-highlighter';
-
-export const GET_TUTORIALS_FOR_APP = 'getTutorialsForApp';
-export const GET_TUTORIALS_SAS_TOKEN = 'getTutorialsSasToken';

src/providers/TutorialProvider/TutorialProvider.hooks.ts

@@ -2,11 +2,11 @@ import { useContext } from 'react';
 
 import { useQuery } from '@tanstack/react-query';
 
+import { TutorialService } from 'src/api/services/TutorialService';
 import {
   GET_TUTORIALS_FOR_APP,
   GET_TUTORIALS_SAS_TOKEN,
-} from './TutorialProvider.const';
-import { TutorialService } from 'src/api/services/TutorialService';
+} from 'src/constants/queryKeys';
 import { TutorialContext } from 'src/providers/TutorialProvider/TutorialProvider';
 
 export const useGetTutorialsForApp = (appName: string) => {

src/providers/TutorialProvider/TutorialProvider.stories.tsx

@@ -7,11 +7,11 @@ import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 
 import { CustomTutorialComponent } from './TutorialProvider.types';
 import { Tutorial } from 'src/api';
-import { TutorialProvider } from 'src/providers';
 import {
   GET_TUTORIALS_FOR_APP,
   GET_TUTORIALS_SAS_TOKEN,
-} from 'src/providers/TutorialProvider/TutorialProvider.const';
+} from 'src/constants/queryKeys';
+import { TutorialProvider } from 'src/providers';
 
 import styled, { keyframes } from 'styled-components';
 

src/providers/TutorialProvider/TutorialProvider.test.tsx

@@ -7,12 +7,14 @@ import { waitFor } from '@testing-library/react';
 import { render, renderHook, screen, userEvent } from '../../tests/test-utils';
 import {
   DIALOG_EDGE_MARGIN,
-  GET_TUTORIALS_FOR_APP,
-  GET_TUTORIALS_SAS_TOKEN,
   TUTORIAL_HIGHLIGHTER_DATATEST_ID,
   TUTORIAL_LOCALSTORAGE_VALUE_STRING,
 } from './TutorialProvider.const';
 import { CancelablePromise, Step, Tutorial, TutorialPosition } from 'src/api';
+import {
+  GET_TUTORIALS_FOR_APP,
+  GET_TUTORIALS_SAS_TOKEN,
+} from 'src/constants/queryKeys';
 import { TutorialProvider } from 'src/providers';
 import { useTutorial } from 'src/providers/TutorialProvider/TutorialProvider.hooks';
 import { EnvironmentType } from 'src/types';