@equinor/subsurface-app-management 2.3.0 → 2.4.0

package/dist/api/index.d.ts

@@ -18,6 +18,8 @@ export type { ServiceNowIncidentResponse } from './models/ServiceNowIncidentResp
 export { ServiceNowUrgency } from './models/ServiceNowUrgency';
 export type { Step } from './models/Step';
 export type { Tutorial } from './models/Tutorial';
+export type { MyTutorialDto } from './models/MyTutorialDto';
+export type { StepDto } from './models/StepDto';
 export { TutorialPosition } from './models/TutorialPosition';
 export type { MyFeatureDto } from './models/MyFeatureDto';
 export { AmplifyApplicationService } from './services/AmplifyApplicationService';

package/dist/api/models/MyTutorialDto.d.ts

@@ -0,0 +1,9 @@
+import type { StepDto } from './StepDto';
+export type MyTutorialDto = {
+    id: string;
+    name: string;
+    path: string;
+    application: string;
+    steps: Array<StepDto>;
+    willPopUp: boolean;
+};

package/dist/api/models/StepDto.d.ts

@@ -0,0 +1,8 @@
+export type StepDto = {
+    id: string | null;
+    title?: string | null;
+    body?: string | null;
+    imgUrl?: string | null;
+    highlightElement?: boolean | null;
+    custom?: boolean | null;
+};

package/dist/api/services/TutorialService.d.ts

@@ -1,4 +1,5 @@
 import { CancelablePromise, Tutorial } from './..';
+import { MyTutorialDto } from '../models/MyTutorialDto';
 export declare class TutorialService {
     /**
      * Gets all tutorials for Application
@@ -13,4 +14,19 @@ export declare class TutorialService {
      * @throws ApiError
      */
     static getTutorialSasToken(): CancelablePromise<string>;
+    /**
+     * Gets all tutorials for Application
+     * @param applicationName
+     * @param includeDrafts
+     * @returns TutorialDto OK
+     * @throws ApiError
+     */
+    static getMyTutorials(applicationName: string): CancelablePromise<Array<MyTutorialDto>>;
+    /**
+     * Gets all draft tutorials for an application
+     * @param applicationName
+     * @returns TutorialDto OK
+     * @throws ApiError
+     */
+    static getDraftTutorialsForApplication(applicationName: string): CancelablePromise<Array<MyTutorialDto>>;
 }

package/dist/api/services/TutorialService.js

@@ -1 +1 @@
-import{OpenAPI_JSEMBARK_Prod as t}from"../core/OpenAPI.js";import{request as o}from"../core/request.js";class r{static getTutorialsForApplication(r){return o(t,{method:"GET",url:"/api/v1/Tutorial/{applicationName}",path:{applicationName:r}})}static getTutorialSasToken(){return o(t,{method:"GET",url:"/api/v1/Tutorial/SASToken"})}}export{r as TutorialService};
+import{OpenAPI_JSEMBARK_Prod as t,OpenAPI_SAM_Prod as a}from"../core/OpenAPI.js";import{request as i}from"../core/request.js";class r{static getTutorialsForApplication(a){return i(t,{method:"GET",url:"/api/v1/Tutorial/{applicationName}",path:{applicationName:a}})}static getTutorialSasToken(){return i(t,{method:"GET",url:"/api/v1/Tutorial/SASToken"})}static getMyTutorials(t){return i(a,{method:"GET",url:"/api/v1/Tutorial/{applicationName}/false",path:{applicationName:t}})}static getDraftTutorialsForApplication(t){return i(a,{method:"GET",url:"/api/v1/Tutorial/draft/{applicationName}",path:{applicationName:t}})}}export{r as TutorialService};

package/dist/components/Feature/Feature.js

@@ -1 +1 @@
-import{jsx as r,Fragment as e}from"react/jsx-runtime";import"../../providers/FeatureToggleProvider.js";import{useFeatureToggling as o}from"../../hooks/useFeatureToggling.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";const t=({children:t,fallback:i,...n})=>{const{showContent:s}=o({...n});return s?r(e,{children:t}):void 0===i?null:r(e,{children:i})};export{t as Feature};
+import{jsx as o,Fragment as e}from"react/jsx-runtime";import"../../providers/FeatureToggleProvider.js";import{useFeatureToggling as r}from"../../hooks/useFeatureToggling.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import"../../api/models/TutorialPosition.js";import"../../types/Environment.js";import"../../types/ReleaseNotes.js";const t=({children:t,fallback:i,...s})=>{const{showContent:p}=r({...s});return p?o(e,{children:t}):void 0===i?null:o(e,{children:i})};export{t as Feature};

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-import { useFeatureToggleContext } from '../providers/FeatureToggleProvider';
-import { useFeatureToggling } from './useFeatureToggling';
-import { useReleaseNotesQuery } from './useReleaseNotesQuery';
-export { useFeatureToggling, useReleaseNotesQuery, useFeatureToggleContext };
+export { useFeatureToggleContext } from '../providers/FeatureToggleProvider';
+export { useFeatureToggling } from './useFeatureToggling';
+export { useReleaseNotesQuery } from './useReleaseNotesQuery';
+export { useTutorialsQuery } from './useTutorialsQuery';

package/dist/hooks/useFeatureToggling.js

@@ -1 +1 @@
-import{useMemo as r}from"react";import{useFeatureToggleContext as e}from"../providers/FeatureToggleProvider.js";function t(t){const{featureUuid:o,showIfIsLoading:i=!1}="string"==typeof t?{featureUuid:t}:t,{features:n,isError:u,isLoading:s}=e();return{showContent:r((()=>{if(!i&&s||u)return!1;const r=n?.find((r=>r.uuid===o));return!r||r.active}),[i,s,u,n,o])}}export{t as useFeatureToggling};
+import{useMemo as r}from"react";import{useFeatureToggleContext as e}from"../providers/FeatureToggleProvider.js";function o(o){const{featureUuid:t,showIfIsLoading:i=!1}="string"==typeof o?{featureUuid:o}:o,{features:n,isError:u,isLoading:s}=e();return{showContent:r((()=>{if(!i&&s||u)return!1;const r=n?.find((r=>r.uuid===t));return r?r.active:(console.warn(`[FeatureToggling]: Feature with uuid ${t} not found. Defaulting to show.`),!0)}),[i,s,u,n,t])}}export{o as useFeatureToggling};

package/dist/hooks/useTutorialsQuery.d.ts

@@ -0,0 +1 @@
+export declare function useTutorialsQuery(): import("@tanstack/react-query").UseQueryResult<import("../api").MyTutorialDto[], Error>;

package/dist/hooks/useTutorialsQuery.js

@@ -0,0 +1 @@
+import{useQuery as t}from"@tanstack/react-query";import"../api/core/OpenAPI.js";import"../api/models/ApplicationCategory.js";import"../api/models/ServiceNowUrgency.js";import"../api/models/TutorialPosition.js";import{TutorialService as r}from"../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as e}from"../constants/queryKeys.js";import{EnvironmentType as o}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{getEnvironmentName as i,getAppName as s}from"../utils/environment.js";function m(){return t({queryKey:[e],queryFn:async()=>i(import.meta.env.VITE_ENVIRONMENT_NAME)===o.PRODUCTION?r.getMyTutorials(s(import.meta.env.VITE_NAME)):r.getDraftTutorialsForApplication(s(import.meta.env.VITE_NAME))})}export{m as useTutorialsQuery};

package/dist/index.js

@@ -1 +1 @@
-export{Feature}from"./components/Feature/Feature.js";export{FeatureRoute}from"./components/FeatureRoute/FeatureRoute.js";export{FeatureToggleProvider,useFeatureToggleContext}from"./providers/FeatureToggleProvider.js";export{useFeatureToggling}from"./hooks/useFeatureToggling.js";export{useReleaseNotesQuery}from"./hooks/useReleaseNotesQuery.js";export{TutorialProvider}from"./providers/TutorialProvider/TutorialProvider.js";export{useTutorial}from"./providers/TutorialProvider/TutorialProvider.hooks.js";export{EnvironmentType}from"./types/Environment.js";export{RELEASENOTE_TYPES_INFORMATION,ReleaseNoteType}from"./types/ReleaseNotes.js";import*as e from"./utils/environment.js";export{e as environment};export{ApiError}from"./api/core/ApiError.js";export{CancelError,CancelablePromise}from"./api/core/CancelablePromise.js";export{OpenAPI_APP,getJSEmbarkToken,getPortalToken,getSAMToken}from"./api/core/OpenAPI.js";export{request}from"./api/core/request.js";export{ApplicationCategory}from"./api/models/ApplicationCategory.js";export{ServiceNowUrgency}from"./api/models/ServiceNowUrgency.js";export{TutorialPosition}from"./api/models/TutorialPosition.js";export{AmplifyApplicationService}from"./api/services/AmplifyApplicationService.js";export{FeatureToggleService}from"./api/services/FeatureToggleService.js";export{ImpersonateUserService}from"./api/services/ImpersonateUserService.js";export{ReleaseNotesService}from"./api/services/ReleaseNotesService.js";export{ServiceNowService}from"./api/services/ServiceNowService.js";export{SlackService}from"./api/services/SlackService.js";export{TutorialService}from"./api/services/TutorialService.js";export{GET_FEATURE_TOGGLES_FOR_APP,GET_RELEASE_NOTES,GET_TUTORIALS_FOR_APP,GET_TUTORIALS_SAS_TOKEN,SAM_QUERIES}from"./constants/queryKeys.js";
+export{Feature}from"./components/Feature/Feature.js";export{FeatureRoute}from"./components/FeatureRoute/FeatureRoute.js";export{FeatureToggleProvider,useFeatureToggleContext}from"./providers/FeatureToggleProvider.js";export{useFeatureToggling}from"./hooks/useFeatureToggling.js";export{useReleaseNotesQuery}from"./hooks/useReleaseNotesQuery.js";export{useTutorialsQuery}from"./hooks/useTutorialsQuery.js";export{OldTutorialProvider}from"./providers/OldTutorialProvider/OldTutorialProvider.js";export{useOldTutorial}from"./providers/OldTutorialProvider/OldTutorialProvider.hooks.js";export{TutorialProvider,useTutorials}from"./providers/TutorialProvider/TutorialProvider.js";export{EnvironmentType}from"./types/Environment.js";export{RELEASENOTE_TYPES_INFORMATION,ReleaseNoteType}from"./types/ReleaseNotes.js";import*as e from"./utils/environment.js";export{e as environment};export{ApiError}from"./api/core/ApiError.js";export{CancelError,CancelablePromise}from"./api/core/CancelablePromise.js";export{OpenAPI_APP,getJSEmbarkToken,getPortalToken,getSAMToken}from"./api/core/OpenAPI.js";export{request}from"./api/core/request.js";export{ApplicationCategory}from"./api/models/ApplicationCategory.js";export{ServiceNowUrgency}from"./api/models/ServiceNowUrgency.js";export{TutorialPosition}from"./api/models/TutorialPosition.js";export{AmplifyApplicationService}from"./api/services/AmplifyApplicationService.js";export{FeatureToggleService}from"./api/services/FeatureToggleService.js";export{ImpersonateUserService}from"./api/services/ImpersonateUserService.js";export{ReleaseNotesService}from"./api/services/ReleaseNotesService.js";export{ServiceNowService}from"./api/services/ServiceNowService.js";export{SlackService}from"./api/services/SlackService.js";export{TutorialService}from"./api/services/TutorialService.js";export{GET_FEATURE_TOGGLES_FOR_APP,GET_RELEASE_NOTES,GET_TUTORIALS_FOR_APP,GET_TUTORIALS_SAS_TOKEN,SAM_QUERIES}from"./constants/queryKeys.js";

package/dist/providers/OldTutorialProvider/OldTutorialDialog.d.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+interface OldTutorialDialogProps {
+    resetHasStartedTutorial: () => void;
+}
+declare const OldTutorialDialog: FC<OldTutorialDialogProps>;
+export default OldTutorialDialog;

package/dist/providers/OldTutorialProvider/OldTutorialDialog.js

@@ -0,0 +1 @@
+import{jsxs as t,Fragment as r,jsx as e}from"react/jsx-runtime";import{useMemo as i}from"react";import{Button as o}from"@equinor/eds-core-react";import{DIALOG_EDGE_MARGIN as a,TUTORIAL_LOCALSTORAGE_VALUE_STRING as n}from"./OldTutorialProvider.const.js";import{useGetTutorialSasToken as l,useOldTutorial as s}from"./OldTutorialProvider.hooks.js";import{DialogTypography as m,DialogImage as c,DialogWrapper as d,StyledTutorialDialog as p,DialogContent as u,DialogActions as g,NavigateSteps as h}from"./OldTutorialProvider.styles.js";import{getBestPositionWithoutOverlap as T}from"./OldTutorialProvider.utils.js";import f from"./OldTutorialStepIndicator.js";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import{TutorialPosition as v}from"../../api/models/TutorialPosition.js";const O=({resetHasStartedTutorial:O})=>{const{data:y}=l(),{activeTutorial:P,currentStep:S,setCurrentStep:j,setActiveTutorial:x,dialogRef:k,allElementsToHighlight:$,customStepComponents:C,isLastStep:R,currentStepObject:B,setAllElementsToHighlight:E,shortNameFromParams:H,viewportWidth:I,clearSearchParam:_}=s(),w=i((()=>{if(B)return B.key&&C?C.find((t=>t.key===B.key))?.element:void 0===B.key||null===B.key?t(r,{children:[e(m,{variant:"h5",children:B.title}),e(m,{group:"paragraph",variant:"body_short",children:B.body}),B.imgUrl&&y&&e(c,{"data-testid":"tutorial-image",alt:"tutorial-image",src:`${B.imgUrl}?${y}`})]}):void 0}),[B,C,y]),L=i((()=>{if(P&&I&&$&&k.current)return P.steps[S].position?P.steps[S].position:P.dynamicPositioning?T($[S].getBoundingClientRect(),k.current.getBoundingClientRect()):v.BOTTOM_RIGHT}),[P,I,$,k,S]),N=i((()=>{if(L&&L!==v.CENTER)switch(L){case v.TOP_LEFT:return{marginTop:`${a}px`,marginLeft:`${a}px`};case v.TOP_RIGHT:return{marginTop:`${a}px`,marginRight:`${a}px`};case v.BOTTOM_LEFT:return{marginBottom:`${a}px`,marginLeft:`${a}px`};case v.BOTTOM_RIGHT:default:return{marginBottom:`${a}px`,marginRight:`${a}px`}}}),[L]),A=()=>{H&&_(),P&&(window.localStorage.setItem(P?.shortName,n),x(void 0),k.current?.close(),j(0),E(void 0),O())};return e(d,{children:e(p,{"data-testid":"tutorial-dialog",ref:k,style:N??void 0,children:t(u,{children:[w,e(f,{steps:P?.steps??[],currentStep:S}),t(g,{children:[e(o,{variant:"ghost",onClick:()=>{A()},children:"Skip"}),t(h,{children:[S&&0!==S?e(o,{variant:"ghost",onClick:()=>{j((t=>t-1))},children:"Previous"}):null,e(o,{variant:"outlined",onClick:()=>{R?A():j((t=>t+1))},children:R?"Done":"Next"})]})]})]})})})};export{O as default};

package/dist/providers/OldTutorialProvider/OldTutorialProvider.d.ts

@@ -0,0 +1,47 @@
+import { Dispatch, FC, MutableRefObject, ReactNode, SetStateAction } from 'react';
+import { CustomTutorialComponent } from './OldTutorialProvider.types';
+import { Step, Tutorial } from '../../api';
+import { EnvironmentType } from '../../types';
+export interface TutorialContextType {
+    activeTutorial: Tutorial | undefined;
+    setActiveTutorial: Dispatch<SetStateAction<Tutorial | undefined>>;
+    currentStep: number;
+    setCurrentStep: Dispatch<SetStateAction<number>>;
+    allElementsToHighlight: HTMLElement[] | undefined;
+    setAllElementsToHighlight: Dispatch<SetStateAction<HTMLElement[] | undefined>>;
+    customStepComponents: CustomTutorialComponent[] | undefined;
+    currentStepObject: Step | undefined;
+    isLastStep: boolean;
+    dialogRef: MutableRefObject<HTMLDialogElement | null>;
+    clearSearchParam: () => void;
+    shortNameFromParams: string | undefined;
+    setShortNameFromParams: Dispatch<SetStateAction<string | undefined>>;
+    tutorialsFromProps: Tutorial[];
+    tutorialError: boolean;
+    setTutorialError: Dispatch<SetStateAction<boolean>>;
+    viewportWidth: number;
+    appName: string;
+    environmentName: EnvironmentType;
+}
+export declare const TutorialContext: import("react").Context<TutorialContextType | undefined>;
+interface OldTutorialProviderProps {
+    children: ReactNode;
+    overrideAppName?: string;
+    overrideEnvironmentName?: EnvironmentType;
+    customStepComponents?: CustomTutorialComponent[];
+    tutorials?: Tutorial[];
+    ignoredQueryKeys?: string[];
+}
+/**
+ * Tutorial provider expects to be within a QueryClientProvider
+ * @deprecated - Use new TutorialProvider instead
+ * @param children Expects to wrap the application globally, typically in a providers file with multiple providers
+ * @param overrideAppName Overrides the "NAME" env variable, which is used to fetch the relevant tutorials for your app
+ * @param overrideEnvironmentName Overrides the "ENVIRONMENT_NAME" env variable, which is used for the possibility to hide tutorials in "production"
+ * @param customStepComponents Adds custom steps components with a key that can be used to link it to a step in a tutorial
+ * @param tutorials Passing tutorial object directly. This does not replace any tutorials found from API call, but rather is appended to them
+ * @param ignoredQueryKeys An array of query keys TutorialProviders will not wait to finish loading before looking for elements to highlight
+ * @constructor
+ */
+export declare const OldTutorialProvider: FC<OldTutorialProviderProps>;
+export {};

package/dist/providers/{TutorialProvider/TutorialProvider.hooks.d.ts → OldTutorialProvider/OldTutorialProvider.hooks.d.ts}

@@ -3,6 +3,7 @@ export declare const useGetTutorialsForApp: (appName: string) => import("@tansta
 export declare const useGetTutorialSasToken: () => import("@tanstack/react-query").UseQueryResult<string, Error>;
 /**
  * Use with caution. There has not been much testing of how using this hook in an app affects the tutorial logic
+ * @deprecated - Use new Tutorial hook instead
  */
-export declare const useTutorial: () => import("./TutorialProvider").TutorialContextType;
+export declare const useOldTutorial: () => import("./OldTutorialProvider").TutorialContextType;
 export declare const useIsFetchingWithTimeout: (predicateFn: (query: Query) => boolean) => boolean;

package/dist/providers/OldTutorialProvider/OldTutorialProvider.hooks.js

@@ -0,0 +1 @@
+import{useContext as r,useState as t,useEffect as e}from"react";import{useIsFetching as o,useQuery as i}from"@tanstack/react-query";import{TutorialService as u}from"../../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as s,GET_TUTORIALS_SAS_TOKEN as a}from"../../constants/queryKeys.js";import{TutorialContext as n}from"./OldTutorialProvider.js";const c=r=>i({queryKey:[s,r],queryFn:()=>u.getTutorialsForApplication(r)}),m=()=>i({queryKey:[a],queryFn:()=>u.getTutorialSasToken()}),p=()=>{const t=r(n);if(void 0===t)throw new Error("'useTutorial' must be used within a TutorialProvider");return t},l=r=>{const[i,u]=t(!0),s=o({predicate:r})>0;return e((()=>{const r=setTimeout((()=>{u(s)}),100);return()=>clearTimeout(r)}),[s]),i||i!==s};export{m as useGetTutorialSasToken,c as useGetTutorialsForApp,l as useIsFetchingWithTimeout,p as useOldTutorial};

package/dist/providers/OldTutorialProvider/OldTutorialProvider.js

@@ -0,0 +1 @@
+import{jsxs as e,jsx as t}from"react/jsx-runtime";import{createContext as r,useState as o,useRef as i,useMemo as n,useCallback as s,useEffect as l}from"react";import{useSearchParams as m}from"react-router-dom";import{TUTORIAL_SEARCH_PARAM_KEY as a}from"./OldTutorialProvider.const.js";import{useIsFetchingWithTimeout as u}from"./OldTutorialProvider.hooks.js";import{getAllElementsToHighlight as d}from"./OldTutorialProvider.utils.js";import c from"./OldTutorialProviderInner.js";import{getAppName as p,getEnvironmentName as h}from"../../utils/environment.js";const v=r(void 0),f=({children:r,overrideAppName:f,overrideEnvironmentName:y,customStepComponents:g,tutorials:T,ignoredQueryKeys:E})=>{const[w,N]=o(void 0),[P,k]=o(!1),[S,j]=m(),[C,O]=o(void 0),[A,x]=o(0),[I,F]=o(void 0),[H,L]=o(window.innerWidth),M=u((e=>!E?.some((t=>e.queryKey.includes(t))))),V=i(null),W=f??p(import.meta.env.VITE_NAME),_=y??h(import.meta.env.VITE_ENVIRONMENT_NAME),z=n((()=>{if(w)return w.steps.at(A)}),[w,A]),K=n((()=>!!w&&A>=w?.steps.length-1),[w,A]),R=s((()=>{S.delete(a),j(S),O(void 0)}),[S,j]);return l((()=>{if(C)return;const e=S.get(a);e&&O(e)}),[S,C]),l((()=>{const e=()=>{L(window.innerWidth)};return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[]),l((()=>{if(!w||P||M)return;const e=d(w);e.every((e=>null!==e))?F(e):(async()=>{await new Promise((e=>setTimeout(e,300)));const e=d(w);e.every((e=>null!==e))?F(e):(console.error("Could not find all elements to highlight for the tutorial. \n This is a list of elements that were found for each step: ",e),k(!0))})().catch((e=>{console.error("Error trying to get elements to highlight",e)}))}),[w,A,P,C,M]),l((()=>{if(!w||P||M)return;const e=w.steps.filter((e=>void 0!==e.key&&null!==e.key)).map((e=>e.key));if(0===e.length)return;const t=g?.map((e=>e.key));if(!t||0===t.length)return console.error("Could not find any custom components passed to the TutorialProvider \nExpected these keys for the active tutorial: ",e),void k(!0);e.map((e=>e&&t?.includes(e))).some((e=>!0!==e))&&(console.error("Could not find the custom components related to the active tutorial. \n The active tutorial expected to find these keys:  ",e,"\n However in the custom components we only found these keys: ",t),k(!0))}),[w,M,g,P]),e(v.Provider,{value:{currentStepObject:z,activeTutorial:w,setActiveTutorial:N,currentStep:A,setCurrentStep:x,allElementsToHighlight:I,setAllElementsToHighlight:F,customStepComponents:g,isLastStep:K,dialogRef:V,clearSearchParam:R,shortNameFromParams:C,setShortNameFromParams:O,tutorialsFromProps:T??[],tutorialError:P,setTutorialError:k,viewportWidth:H,appName:W,environmentName:_},children:[t(c,{}),r]})};export{f as OldTutorialProvider,v as TutorialContext};

package/dist/providers/OldTutorialProvider/OldTutorialProvider.utils.js

@@ -0,0 +1 @@
+import{DIALOG_EDGE_MARGIN as t}from"./OldTutorialProvider.const.js";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import{TutorialPosition as T}from"../../api/models/TutorialPosition.js";const o=(t,T)=>!(t.top>T.bottom||t.bottom<T.top||t.right<T.left||t.left>T.right),e=(o,e)=>{const i=e===T.BOTTOM_RIGHT||e===T.BOTTOM_LEFT,O=e===T.TOP_RIGHT||e===T.BOTTOM_RIGHT,r=innerWidth-t-o.width,p=innerHeight-t-o.height;return new DOMRect(O?r:t,i?p:t,o.width,o.height)},i=(t,i)=>o(t,e(i,T.BOTTOM_RIGHT))?o(t,e(i,T.BOTTOM_LEFT))?o(t,e(i,T.TOP_RIGHT))?o(t,e(i,T.TOP_LEFT))?T.BOTTOM_RIGHT:T.TOP_LEFT:T.TOP_RIGHT:T.BOTTOM_LEFT:T.BOTTOM_RIGHT,O=t=>t.steps.map(((T,o)=>document.getElementById(`${t.shortName}-${o}`)));export{O as getAllElementsToHighlight,i as getBestPositionWithoutOverlap};

package/dist/providers/OldTutorialProvider/OldTutorialProviderInner.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+declare const OldTutorialProviderInner: FC;
+export default OldTutorialProviderInner;

package/dist/providers/OldTutorialProvider/OldTutorialProviderInner.js

@@ -0,0 +1 @@
+import{jsxs as t,jsx as r,Fragment as e}from"react/jsx-runtime";import{useRef as o,useMemo as i,useCallback as l,useEffect as n}from"react";import{useLocation as a}from"react-router";import{Typography as s,Button as h}from"@equinor/eds-core-react";import{HIGHLIGHT_PADDING as p,TUTORIAL_HIGHLIGHTER_DATATEST_ID as c}from"./OldTutorialProvider.const.js";import{useOldTutorial as m,useGetTutorialsForApp as u}from"./OldTutorialProvider.hooks.js";import{TutorialErrorDialog as d,Highlighter as f}from"./OldTutorialProvider.styles.js";import g from"./OldTutorialDialog.js";import{EnvironmentType as w}from"../../types/Environment.js";const T=()=>{const{pathname:T}=a(),{activeTutorial:v,setActiveTutorial:P,dialogRef:j,allElementsToHighlight:x,shortNameFromParams:N,tutorialError:O,tutorialsFromProps:b,currentStep:C,viewportWidth:k,setTutorialError:E,clearSearchParam:I,appName:S,environmentName:$}=m(),y=o(!1),{data:D}=u(S),R=i((()=>{if(!(D||b&&0!==b.length))return[];const t=[];return b&&t.push(...b),D&&t.push(...D),t}),[D,b]),U=i((()=>{if(!x||!v||!k)return;const t=x[C],r=t.getBoundingClientRect();return t&&t.scrollIntoView({behavior:"smooth",block:"center"}),{top:r.top-p+window.scrollY,left:r.left-p,height:r.height+2*p,width:r.width+2*p}}),[v,x,C,k]),B=i((()=>R.filter((t=>T.includes(t.path)))),[R,T]),F=l((t=>{y.current||(P(t),y.current=!0)}),[P]);n((()=>{U&&!j.current?.open&&j.current?.showModal()}),[j,U]),n((()=>{if(B.length<1)return;const t=B.find((t=>t.shortName===N)),r=B.find((t=>!window.localStorage.getItem(t.shortName)&&t.willPopUp));t?F(t):r&&F(r)}),[F,N,B]);const H=()=>{I(),E(!1),P(void 0)},q=l((()=>{y.current=!1}),[]);return(v?.showInProd||$!==w.PRODUCTION)&&(v?.willPopUp||N)?O&&N?t(d,{open:!0,isDismissable:!0,onClose:H,children:[r(s,{children:"There was a problem starting this tutorial. Please report this in using the feedback function in the Top Bar."}),r(h,{variant:"outlined",onClick:H,children:"Close"})]}):O?null:t(e,{children:[U&&r(f,{"data-testid":c,style:{top:`${U.top}px`,left:`${U.left}px`,width:`${U.width}px`,height:`${U.height}px`}}),r(g,{resetHasStartedTutorial:q})]}):null};export{T as default};

package/dist/providers/OldTutorialProvider/OldTutorialStepIndicator.d.ts

@@ -0,0 +1,8 @@
+import { FC } from 'react';
+import { Step } from '../../api';
+interface OldTutorialStepIndicatorProps {
+    steps: Step[];
+    currentStep: number;
+}
+declare const OldTutorialStepIndicator: FC<OldTutorialStepIndicatorProps>;
+export default OldTutorialStepIndicator;

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

@@ -1,46 +1,20 @@
-import { Dispatch, FC, MutableRefObject, ReactNode, SetStateAction } from 'react';
-import { CustomTutorialComponent } from './TutorialProvider.types';
-import { Step, Tutorial } from '../../api';
-import { EnvironmentType } from '../../types';
-export interface TutorialContextType {
-    activeTutorial: Tutorial | undefined;
-    setActiveTutorial: Dispatch<SetStateAction<Tutorial | undefined>>;
-    currentStep: number;
-    setCurrentStep: Dispatch<SetStateAction<number>>;
-    allElementsToHighlight: HTMLElement[] | undefined;
-    setAllElementsToHighlight: Dispatch<SetStateAction<HTMLElement[] | undefined>>;
-    customStepComponents: CustomTutorialComponent[] | undefined;
-    currentStepObject: Step | undefined;
-    isLastStep: boolean;
-    dialogRef: MutableRefObject<HTMLDialogElement | null>;
-    clearSearchParam: () => void;
-    shortNameFromParams: string | undefined;
-    setShortNameFromParams: Dispatch<SetStateAction<string | undefined>>;
-    tutorialsFromProps: Tutorial[];
-    tutorialError: boolean;
-    setTutorialError: Dispatch<SetStateAction<boolean>>;
-    viewportWidth: number;
-    appName: string;
-    environmentName: EnvironmentType;
+import { FC, ReactNode } from 'react';
+import { MyTutorialDto } from '../../api/models/MyTutorialDto';
+interface TutorialContextType {
+    allTutorials: MyTutorialDto[];
+    tutorialsOnThisPage: MyTutorialDto[];
+    unseenTutorialsOnThisPage: MyTutorialDto[];
+    activeTutorial: MyTutorialDto | undefined;
+    startTutorial: (tutorialId: string) => void;
+    skipTutorial: (tutorialId: string) => void;
+    activeStep: number | undefined;
+    goToNextStep: () => void;
+    goToPreviousStep: () => void;
 }
-export declare const TutorialContext: import("react").Context<TutorialContextType | undefined>;
+export declare const TutorialDataContext: import("react").Context<TutorialContextType | undefined>;
+export declare function useTutorials(): TutorialContextType;
 interface TutorialProviderProps {
     children: ReactNode;
-    overrideAppName?: string;
-    overrideEnvironmentName?: EnvironmentType;
-    customStepComponents?: CustomTutorialComponent[];
-    tutorials?: Tutorial[];
-    ignoredQueryKeys?: string[];
 }
-/**
- * Tutorial provider expects to be within a QueryClientProvider
- * @param children Expects to wrap the application globally, typically in a providers file with multiple providers
- * @param overrideAppName Overrides the "NAME" env variable, which is used to fetch the relevant tutorials for your app
- * @param overrideEnvironmentName Overrides the "ENVIRONMENT_NAME" env variable, which is used for the possibility to hide tutorials in "production"
- * @param customStepComponents Adds custom steps components with a key that can be used to link it to a step in a tutorial
- * @param tutorials Passing tutorial object directly. This does not replace any tutorials found from API call, but rather is appended to them
- * @param ignoredQueryKeys An array of query keys TutorialProviders will not wait to finish loading before looking for elements to highlight
- * @constructor
- */
 export declare const TutorialProvider: FC<TutorialProviderProps>;
 export {};

package/dist/providers/TutorialProvider/TutorialProvider.js

@@ -1 +1 @@
-import{jsxs as e,jsx as t}from"react/jsx-runtime";import{createContext as r,useState as o,useRef as i,useMemo as n,useCallback as s,useEffect as l}from"react";import{useSearchParams as m}from"react-router-dom";import{TUTORIAL_SEARCH_PARAM_KEY as a}from"./TutorialProvider.const.js";import{getAllElementsToHighlight as u}from"./TutorialProvider.utils.js";import d from"./TutorialProviderInner.js";import{useIsFetchingWithTimeout as c}from"./TutorialProvider.hooks.js";import{getAppName as p,getEnvironmentName as h}from"../../utils/environment.js";const v=r(void 0),f=({children:r,overrideAppName:f,overrideEnvironmentName:y,customStepComponents:g,tutorials:T,ignoredQueryKeys:E})=>{const[w,N]=o(void 0),[P,k]=o(!1),[S,j]=m(),[C,A]=o(void 0),[x,I]=o(0),[F,H]=o(void 0),[L,M]=o(window.innerWidth),V=c((e=>!E?.some((t=>e.queryKey.includes(t))))),W=i(null),_=f??p(import.meta.env.VITE_NAME),z=y??h(import.meta.env.VITE_ENVIRONMENT_NAME),K=n((()=>{if(w)return w.steps.at(x)}),[w,x]),O=n((()=>!!w&&x>=w?.steps.length-1),[w,x]),R=s((()=>{S.delete(a),j(S),A(void 0)}),[S,j]);return l((()=>{if(C)return;const e=S.get(a);e&&A(e)}),[S,C]),l((()=>{const e=()=>{M(window.innerWidth)};return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[]),l((()=>{if(!w||P||V)return;const e=u(w);e.every((e=>null!==e))?H(e):(async()=>{await new Promise((e=>setTimeout(e,300)));const e=u(w);e.every((e=>null!==e))?H(e):(console.error("Could not find all elements to highlight for the tutorial. \n This is a list of elements that were found for each step: ",e),k(!0))})().catch((e=>{console.error("Error trying to get elements to highlight",e)}))}),[w,x,P,C,V]),l((()=>{if(!w||P||V)return;const e=w.steps.filter((e=>void 0!==e.key&&null!==e.key)).map((e=>e.key));if(0===e.length)return;const t=g?.map((e=>e.key));if(!t||0===t.length)return console.error("Could not find any custom components passed to the TutorialProvider \nExpected these keys for the active tutorial: ",e),void k(!0);e.map((e=>e&&t?.includes(e))).some((e=>!0!==e))&&(console.error("Could not find the custom components related to the active tutorial. \n The active tutorial expected to find these keys:  ",e,"\n However in the custom components we only found these keys: ",t),k(!0))}),[w,V,g,P]),e(v.Provider,{value:{currentStepObject:K,activeTutorial:w,setActiveTutorial:N,currentStep:x,setCurrentStep:I,allElementsToHighlight:F,setAllElementsToHighlight:H,customStepComponents:g,isLastStep:O,dialogRef:W,clearSearchParam:R,shortNameFromParams:C,setShortNameFromParams:A,tutorialsFromProps:T??[],tutorialError:P,setTutorialError:k,viewportWidth:L,appName:_,environmentName:z},children:[t(d,{}),r]})};export{v as TutorialContext,f as TutorialProvider};
+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};

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

@@ -0,0 +1,2 @@
+export declare const SEEN_TUTORIALS_LOCALSTORAGE_KEY: string;
+export declare function useSeenTutorials(): readonly [string[], (tutorialId: string) => void];

package/dist/providers/TutorialProvider/useSeenTutorials.js

@@ -0,0 +1 @@
+import{useState as r,useCallback as t}from"react";import{getAppName as e}from"../../utils/environment.js";const o=`sam-seen-tutorials-${e(import.meta.env.VITE_NAME)}`;function n(){const[e,n]=r(function(){const r=localStorage.getItem(o);if(r)try{const t=JSON.parse(r);if(!Array.isArray(t)||!t.every((r=>"string"==typeof r)))throw new Error("Invalid seen tutorial data in localStorage");return t}catch(r){console.error(r)}return[]}());return[e,t((r=>{n((t=>{const e=[...t,r];return localStorage.setItem(o,JSON.stringify(e)),e}))}),[])]}export{o as SEEN_TUTORIALS_LOCALSTORAGE_KEY,n as useSeenTutorials};

package/dist/providers/index.d.ts

@@ -1,3 +1,4 @@
-export { TutorialProvider } from './TutorialProvider/TutorialProvider';
+export { OldTutorialProvider } from './OldTutorialProvider/OldTutorialProvider';
 export { FeatureToggleProvider } from './FeatureToggleProvider';
-export { useTutorial } from './TutorialProvider/TutorialProvider.hooks';
+export { useOldTutorial } from './OldTutorialProvider/OldTutorialProvider.hooks';
+export { TutorialProvider, useTutorials, } from './TutorialProvider/TutorialProvider';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/subsurface-app-management",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "React Typescript components/hooks to communicate with equinor/sam",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -29,8 +29,6 @@
     "lint:fix": "eslint ./src ./.storybook --fix",
     "test": "vitest watch",
     "test:ci": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "test:coverage-ci": "CI=true vitest run --coverage --coverage.reporter=json --coverage.reporter=json-summary --silent",
     "setup-husky": "husky install",
     "precommit": "npx lint-staged",
     "build": "rollup -c && tsc --project tsconfig.build.json && resolve-tspaths --project tsconfig.build.json",

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

@@ -1,6 +0,0 @@
-import { FC } from 'react';
-interface TutorialDialogProps {
-    resetHasStartedTutorial: () => void;
-}
-declare const TutorialDialog: FC<TutorialDialogProps>;
-export default TutorialDialog;

package/dist/providers/TutorialProvider/TutorialDialog.js

@@ -1 +0,0 @@
-import{jsxs as t,Fragment as r,jsx as e}from"react/jsx-runtime";import{useMemo as i}from"react";import{Button as o}from"@equinor/eds-core-react";import{DIALOG_EDGE_MARGIN as a,TUTORIAL_LOCALSTORAGE_VALUE_STRING as n}from"./TutorialProvider.const.js";import{useGetTutorialSasToken as s,useTutorial as l}from"./TutorialProvider.hooks.js";import{DialogTypography as m,DialogImage as c,DialogWrapper as p,StyledTutorialDialog as d,DialogContent as u,DialogActions as g,NavigateSteps as h}from"./TutorialProvider.styles.js";import{getBestPositionWithoutOverlap as T}from"./TutorialProvider.utils.js";import f from"./TutorialStepIndicator.js";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import{TutorialPosition as v}from"../../api/models/TutorialPosition.js";const y=({resetHasStartedTutorial:y})=>{const{data:P}=s(),{activeTutorial:S,currentStep:j,setCurrentStep:x,setActiveTutorial:k,dialogRef:O,allElementsToHighlight:$,customStepComponents:C,isLastStep:R,currentStepObject:B,setAllElementsToHighlight:E,shortNameFromParams:H,viewportWidth:I,clearSearchParam:_}=l(),w=i((()=>{if(B)return B.key&&C?C.find((t=>t.key===B.key))?.element:void 0===B.key||null===B.key?t(r,{children:[e(m,{variant:"h5",children:B.title}),e(m,{group:"paragraph",variant:"body_short",children:B.body}),B.imgUrl&&P&&e(c,{"data-testid":"tutorial-image",alt:"tutorial-image",src:`${B.imgUrl}?${P}`})]}):void 0}),[B,C,P]),L=i((()=>{if(S&&I&&$&&O.current)return S.steps[j].position?S.steps[j].position:S.dynamicPositioning?T($[j].getBoundingClientRect(),O.current.getBoundingClientRect()):v.BOTTOM_RIGHT}),[S,I,$,O,j]),N=i((()=>{if(L&&L!==v.CENTER)switch(L){case v.TOP_LEFT:return{marginTop:`${a}px`,marginLeft:`${a}px`};case v.TOP_RIGHT:return{marginTop:`${a}px`,marginRight:`${a}px`};case v.BOTTOM_LEFT:return{marginBottom:`${a}px`,marginLeft:`${a}px`};case v.BOTTOM_RIGHT:default:return{marginBottom:`${a}px`,marginRight:`${a}px`}}}),[L]),A=()=>{H&&_(),S&&(window.localStorage.setItem(S?.shortName,n),k(void 0),O.current?.close(),x(0),E(void 0),y())};return e(p,{children:e(d,{"data-testid":"tutorial-dialog",ref:O,style:N??void 0,children:t(u,{children:[w,e(f,{steps:S?.steps??[],currentStep:j}),t(g,{children:[e(o,{variant:"ghost",onClick:()=>{A()},children:"Skip"}),t(h,{children:[j&&0!==j?e(o,{variant:"ghost",onClick:()=>{x((t=>t-1))},children:"Previous"}):null,e(o,{variant:"outlined",onClick:()=>{R?A():x((t=>t+1))},children:R?"Done":"Next"})]})]})]})})})};export{y as default};

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

@@ -1 +0,0 @@
-import{useContext as r,useState as t,useEffect as e}from"react";import{useIsFetching as o,useQuery as i}from"@tanstack/react-query";import{TutorialService as u}from"../../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as s,GET_TUTORIALS_SAS_TOKEN as a}from"../../constants/queryKeys.js";import{TutorialContext as n}from"./TutorialProvider.js";const c=r=>i({queryKey:[s,r],queryFn:()=>u.getTutorialsForApplication(r)}),m=()=>i({queryKey:[a],queryFn:()=>u.getTutorialSasToken()}),p=()=>{const t=r(n);if(void 0===t)throw new Error("'useTutorial' must be used within a TutorialProvider");return t},y=r=>{const[i,u]=t(!0),s=o({predicate:r})>0;return e((()=>{const r=setTimeout((()=>{u(s)}),100);return()=>clearTimeout(r)}),[s]),i||i!==s};export{m as useGetTutorialSasToken,c as useGetTutorialsForApp,y as useIsFetchingWithTimeout,p as useTutorial};

package/dist/providers/TutorialProvider/TutorialProvider.utils.js

@@ -1 +0,0 @@
-import{DIALOG_EDGE_MARGIN as t}from"./TutorialProvider.const.js";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import{TutorialPosition as T}from"../../api/models/TutorialPosition.js";const o=(t,T)=>!(t.top>T.bottom||t.bottom<T.top||t.right<T.left||t.left>T.right),e=(o,e)=>{const i=e===T.BOTTOM_RIGHT||e===T.BOTTOM_LEFT,r=e===T.TOP_RIGHT||e===T.BOTTOM_RIGHT,O=innerWidth-t-o.width,p=innerHeight-t-o.height;return new DOMRect(r?O:t,i?p:t,o.width,o.height)},i=(t,i)=>o(t,e(i,T.BOTTOM_RIGHT))?o(t,e(i,T.BOTTOM_LEFT))?o(t,e(i,T.TOP_RIGHT))?o(t,e(i,T.TOP_LEFT))?T.BOTTOM_RIGHT:T.TOP_LEFT:T.TOP_RIGHT:T.BOTTOM_LEFT:T.BOTTOM_RIGHT,r=t=>t.steps.map(((T,o)=>document.getElementById(`${t.shortName}-${o}`)));export{r as getAllElementsToHighlight,i as getBestPositionWithoutOverlap};

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

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const TutorialProviderInner: FC;
-export default TutorialProviderInner;

package/dist/providers/TutorialProvider/TutorialProviderInner.js

@@ -1 +0,0 @@
-import{jsxs as t,jsx as r,Fragment as e}from"react/jsx-runtime";import{useRef as o,useMemo as i,useCallback as n,useEffect as l}from"react";import{useLocation as a}from"react-router";import{Typography as s,Button as h}from"@equinor/eds-core-react";import p from"./TutorialDialog.js";import{HIGHLIGHT_PADDING as c,TUTORIAL_HIGHLIGHTER_DATATEST_ID as m}from"./TutorialProvider.const.js";import{useTutorial as u,useGetTutorialsForApp as d}from"./TutorialProvider.hooks.js";import{TutorialErrorDialog as f,Highlighter as g}from"./TutorialProvider.styles.js";import{EnvironmentType as w}from"../../types/Environment.js";const T=()=>{const{pathname:T}=a(),{activeTutorial:v,setActiveTutorial:P,dialogRef:j,allElementsToHighlight:x,shortNameFromParams:N,tutorialError:b,tutorialsFromProps:C,currentStep:k,viewportWidth:E,setTutorialError:I,clearSearchParam:S,appName:$,environmentName:y}=u(),D=o(!1),{data:R}=d($),U=i((()=>{if(!(R||C&&0!==C.length))return[];const t=[];return C&&t.push(...C),R&&t.push(...R),t}),[R,C]),B=i((()=>{if(!x||!v||!E)return;const t=x[k],r=t.getBoundingClientRect();return t&&t.scrollIntoView({behavior:"smooth",block:"center"}),{top:r.top-c+window.scrollY,left:r.left-c,height:r.height+2*c,width:r.width+2*c}}),[v,x,k,E]),F=i((()=>U.filter((t=>T.includes(t.path)))),[U,T]),H=n((t=>{D.current||(P(t),D.current=!0)}),[P]);l((()=>{B&&!j.current?.open&&j.current?.showModal()}),[j,B]),l((()=>{if(F.length<1)return;const t=F.find((t=>t.shortName===N)),r=F.find((t=>!window.localStorage.getItem(t.shortName)&&t.willPopUp));t?H(t):r&&H(r)}),[H,N,F]);const O=()=>{S(),I(!1),P(void 0)},q=n((()=>{D.current=!1}),[]);return(v?.showInProd||y!==w.PRODUCTION)&&(v?.willPopUp||N)?b&&N?t(f,{open:!0,isDismissable:!0,onClose:O,children:[r(s,{children:"There was a problem starting this tutorial. Please report this in using the feedback function in the Top Bar."}),r(h,{variant:"outlined",onClick:O,children:"Close"})]}):b?null:t(e,{children:[B&&r(g,{"data-testid":m,style:{top:`${B.top}px`,left:`${B.left}px`,width:`${B.width}px`,height:`${B.height}px`}}),r(p,{resetHasStartedTutorial:q})]}):null};export{T as default};

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

@@ -1,8 +0,0 @@
-import { FC } from 'react';
-import { Step } from '../../api';
-interface TutorialStepIndicatorProps {
-    steps: Step[];
-    currentStep: number;
-}
-declare const TutorialStepIndicator: FC<TutorialStepIndicatorProps>;
-export default TutorialStepIndicator;