@equinor/subsurface-app-management 2.5.0 → 2.5.2

package/dist/hooks/useTutorialStepImage.js

@@ -1 +1 @@
-import{useQuery as r}from"@tanstack/react-query";import{TutorialService as e}from"../api/services/TutorialService.js";import{GET_TUTORIAL_STEP_IMAGE as t}from"../constants/queryKeys.js";function o(o){return r({queryKey:[t,o],queryFn:()=>e.getTutorialImage(o),enabled:void 0!==o})}export{o as useTutorialStepImage};
+import{useQuery as e}from"@tanstack/react-query";import{TutorialService as r}from"../api/services/TutorialService.js";import{GET_TUTORIAL_STEP_IMAGE as t}from"../constants/queryKeys.js";function i(i){return e({queryKey:[t,i],queryFn:()=>r.getTutorialImage(i),gcTime:1/0,staleTime:1/0,enabled:void 0!==i})}export{i as useTutorialStepImage};

package/dist/providers/TutorialProvider/TutorialProvider.d.ts

@@ -4,6 +4,7 @@ interface TutorialContextType {
     allTutorials: MyTutorialDto[];
     tutorialsOnThisPage: MyTutorialDto[];
     unseenTutorialsOnThisPage: MyTutorialDto[];
+    seenTutorialIDs: string[];
     activeTutorial: MyTutorialDto | undefined;
     startTutorial: (tutorialId: string) => void;
     skipTutorial: (tutorialId: string) => void;

package/dist/providers/TutorialProvider/TutorialProvider.js

@@ -1 +1 @@
-import{jsx as r}from"react/jsx-runtime";import{createContext as o,useContext as i,useState as t,useMemo as e}from"react";import{useLocation as n,matchPath as a}from"react-router";import{useSeenTutorials as u}from"./useSeenTutorials.js";import"../FeatureToggleProvider.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import{useTutorialsQuery as s}from"../../hooks/useTutorialsQuery.js";const d=o(void 0);function l(){const r=i(d);if(void 0===r)throw new Error("'useTutorials' must be used within provider");return r}const p=({children:o})=>{const{pathname:i}=n(),{data:l=[]}=s(),[p,v]=t(void 0),[c,f]=t(void 0),[m,h]=u(),w=e((()=>l?.filter((r=>null!==a(r.path,i)))),[i,l]),T=e((()=>w?.filter((r=>!m.includes(r.id)&&r.willPopUp))),[m,w]);return r(d.Provider,{value:{allTutorials:l,tutorialsOnThisPage:w,unseenTutorialsOnThisPage:T,activeTutorial:p,activeStep:c,startTutorial:r=>{if(!l?.some((o=>r===o.id)))throw new Error("Tutorial not found");v(l.find((o=>r===o.id))),f(0)},skipTutorial:r=>{p&&p.id===r&&(v(void 0),f(void 0)),h(r)},goToNextStep:()=>{if(!p)throw new Error("No currently active tutorial!");if(void 0===c)throw new Error("activeStep is undefined!");c+1>=p.steps.length?(h(p.id),v(void 0),f(void 0)):f(c+1)},goToPreviousStep:()=>{if(!p)throw new Error("No currently active tutorial!");if(void 0===c)throw new Error("activeStep is undefined!");0===c?(v(void 0),f(void 0)):f(c-1)}},children:o})};export{d as TutorialDataContext,p as TutorialProvider,l as useTutorials};
+import{jsx as r}from"react/jsx-runtime";import{createContext as o,useContext as t,useState as i,useMemo as e}from"react";import{useLocation as s,matchPath as n}from"react-router";import{useSeenTutorials as a}from"./useSeenTutorials.js";import"../FeatureToggleProvider.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import{useTutorialsQuery as u}from"../../hooks/useTutorialsQuery.js";import{usePrefetchTutorialStepImages as d}from"./hooks/usePrefetchTutorialStepImages.js";const l=o(void 0);function p(){const r=t(l);if(void 0===r)throw new Error("'useTutorials' must be used within provider");return r}const c=({children:o})=>{const{pathname:t}=s(),{data:p=[]}=u(),[c,v]=i(void 0),[f,m]=i(void 0),[h,T]=a();d();const w=e((()=>p?.filter((r=>null!==n(r.path,t)))),[t,p]),g=e((()=>w?.filter((r=>!h.includes(r.id)&&r.willPopUp))),[h,w]);return r(l.Provider,{value:{allTutorials:p,tutorialsOnThisPage:w,unseenTutorialsOnThisPage:g,activeTutorial:c,activeStep:f,seenTutorialIDs:h,startTutorial:r=>{if(!p?.some((o=>r===o.id)))throw new Error("Tutorial not found");v(p.find((o=>r===o.id))),m(0)},skipTutorial:r=>{c&&c.id===r&&(v(void 0),m(void 0)),T(r)},goToNextStep:()=>{if(!c)throw new Error("No currently active tutorial!");if(void 0===f)throw new Error("activeStep is undefined!");f+1>=c.steps.length?(T(c.id),v(void 0),m(void 0)):m(f+1)},goToPreviousStep:()=>{if(!c)throw new Error("No currently active tutorial!");if(void 0===f)throw new Error("activeStep is undefined!");0===f?(v(void 0),m(void 0)):m(f-1)}},children:o})};export{l as TutorialDataContext,c as TutorialProvider,p as useTutorials};

package/dist/providers/TutorialProvider/hooks/usePrefetchTutorialStepImages.d.ts

@@ -0,0 +1 @@
+export declare function usePrefetchTutorialStepImages(): void;

package/dist/providers/TutorialProvider/hooks/usePrefetchTutorialStepImages.js

@@ -0,0 +1 @@
+import{useRef as r,useEffect as e}from"react";import{useQueryClient as o}from"@tanstack/react-query";import{TutorialService as t}from"../../../api/services/TutorialService.js";import{GET_TUTORIAL_STEP_IMAGE as i}from"../../../constants/queryKeys.js";import"../../FeatureToggleProvider.js";import"../../../api/core/OpenAPI.js";import{useTutorialsQuery as s}from"../../../hooks/useTutorialsQuery.js";function m(){const{data:m=[]}=s(),c=o(),u=r([]);e((()=>{const r=r=>{for(const e of r.steps)e.imgUrl&&c.prefetchQuery({queryKey:[i,e.imgUrl],queryFn:()=>t.getTutorialImage(e.imgUrl),staleTime:1/0,gcTime:1/0})};for(const e of m)u.current.includes(e.id)||(u.current.push(e.id),r(e))}),[c,m])}export{m as usePrefetchTutorialStepImages};

package/package.json

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