@cuemath/leap 2.8.21-rj-6 → 2.8.21-rj-7

package/dist/features/journey/use-journey/journey-context-provider.js

@@ -1,59 +1,62 @@
-import { jsxs as w, jsx as d } from "react/jsx-runtime";
-import { createContext as x, useState as v, useRef as J, useCallback as m, useMemo as $ } from "react";
-import { Coachmark as p } from "../comps/coachmark/coachmark.js";
-import { BlurOverlay as g } from "./journey-styled.js";
-const A = x(null), N = ({ children: f }) => {
-  const [o, c] = v([]), a = J(-1), r = J(), l = m(
+import { jsxs as v, jsx as J } from "react/jsx-runtime";
+import { createContext as x, useState as $, useRef as f, useCallback as i, useMemo as p } from "react";
+import { Coachmark as g } from "../comps/coachmark/coachmark.js";
+import { BlurOverlay as A } from "./journey-styled.js";
+const R = x(null), j = ({ children: C }) => {
+  const [o, u] = $([]), c = f(-1), r = f(), l = i(
     (e, t) => {
       if (o.length > 0)
         throw new Error(
           `setJourney: Other Journey is already active, Current Journey: ${r.current}, New Journey Request: ${e}`
         );
-      r.current = e, a.current = -1, c([...t]);
+      r.current = e, c.current = -1, u([...t]);
     },
     [o.length]
-  ), h = m((e, t) => {
+  ), h = i(() => {
+    r.current = void 0, c.current = -1, u([]);
+  }, []), y = i((e, t) => {
     if (!r.current || e !== r.current)
       throw new Error(
         r.current ? "addCoachmark was called before setJourney" : `A Journey is already active, Current Journey: ${r.current}, New Journey Request: ${e}`
       );
-    c((s) => [...s, t]);
-  }, []), y = m(
+    u((s) => [...s, t]);
+  }, []), d = i(
     (e, t = !1, s = 0) => {
       if (!r.current || e !== r.current)
         throw new Error(
           r.current ? "nextCoachmark was called before setJourney" : `A Journey is already active, Current Journey: ${r.current}, New Journey Request: ${e}`
         );
-      s !== 0 && c((n) => n.map((u) => ({ ...u, isActive: !1 })));
-      const k = setTimeout(() => {
-        clearTimeout(k);
-        const n = a.current + 1;
-        c((u) => {
-          if (n >= u.length || u.length === 0)
-            return r.current = void 0, a.current = -1, [];
-          a.current = n;
-          const i = [...u];
-          return i[n].isActive = !0, n > 0 && (i[n - 1].isActive = t), i;
+      s !== 0 && u((n) => n.map((a) => ({ ...a, isActive: !1 })));
+      const w = setTimeout(() => {
+        clearTimeout(w);
+        const n = c.current + 1;
+        u((a) => {
+          if (n >= a.length || a.length === 0)
+            return r.current = void 0, c.current = -1, [];
+          c.current = n;
+          const m = [...a];
+          return m[n].isActive = !0, n > 0 && (m[n - 1].isActive = t), m;
         });
       }, s);
     },
     []
-  ), C = $(
+  ), k = p(
     () => ({
-      nextCoachmark: y,
+      nextCoachmark: d,
       setJourney: l,
-      addCoachmark: h,
+      addCoachmark: y,
+      clearJourney: h,
       coachmarks: o
     }),
-    [y, l, h, o]
+    [d, l, y, h, o]
   );
-  return /* @__PURE__ */ w(A.Provider, { value: C, children: [
-    o.length > 0 && /* @__PURE__ */ d(g, { children: o.map((e, t) => /* @__PURE__ */ d(p, { coachmark: e }, `coachmark-${t}`)) }),
-    f
+  return /* @__PURE__ */ v(R.Provider, { value: k, children: [
+    o.length > 0 && /* @__PURE__ */ J(A, { children: o.map((e, t) => /* @__PURE__ */ J(g, { coachmark: e }, `coachmark-${t}`)) }),
+    C
   ] });
 };
 export {
-  A as JourneyContext,
-  N as JourneyProvider
+  R as JourneyContext,
+  j as JourneyProvider
 };
 //# sourceMappingURL=journey-context-provider.js.map

package/dist/features/journey/use-journey/journey-context-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"journey-context-provider.js","sources":["../../../../src/features/journey/use-journey/journey-context-provider.tsx"],"sourcesContent":["import type { TJourneyId } from '../journey-id/journey-id-types';\nimport type { ICoachmarkProps, IJourneyContext } from './journey-context-types';\nimport type { FC, ReactNode } from 'react';\n\nimport { createContext, useCallback, useMemo, useRef, useState } from 'react';\n\nimport { Coachmark } from '../comps/coachmark/coachmark';\nimport * as S from './journey-styled';\n\nexport const JourneyContext = createContext<IJourneyContext | null>(null);\n\nexport const JourneyProvider: FC<{ children: ReactNode }> = ({ children }) => {\n  const [coachmarkList, setCoachmarkList] = useState<ICoachmarkProps[]>([]);\n  const currentIndex = useRef(-1);\n  const currentJourneyIdStudent = useRef<TJourneyId | undefined>();\n\n  const setJourney = useCallback(\n    (id: TJourneyId, coachmarks: ICoachmarkProps[]) => {\n      if (coachmarkList.length > 0) {\n        throw new Error(\n          `setJourney: Other Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n        );\n      }\n      currentJourneyIdStudent.current = id;\n      currentIndex.current = -1;\n      setCoachmarkList([...coachmarks]);\n    },\n    [coachmarkList.length],\n  );\n\n  const addCoachmark = useCallback((id: TJourneyId, coachmark: ICoachmarkProps) => {\n    if (!currentJourneyIdStudent.current || id !== currentJourneyIdStudent.current) {\n      throw new Error(\n        currentJourneyIdStudent.current\n          ? `addCoachmark was called before setJourney`\n          : `A Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n      );\n    }\n\n    setCoachmarkList(prev => [...prev, coachmark]);\n  }, []);\n\n  const nextCoachmark = useCallback(\n    (id: TJourneyId, keepPrevActive: boolean = false, delayInMs: number = 0) => {\n      if (!currentJourneyIdStudent.current || id !== currentJourneyIdStudent.current) {\n        throw new Error(\n          currentJourneyIdStudent.current\n            ? `nextCoachmark was called before setJourney`\n            : `A Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n        );\n      }\n\n      if (delayInMs !== 0) {\n        // If delay is not 0, we will hide all them coachmarks and reveal only after the delay\n        setCoachmarkList(prevList => {\n          return prevList.map((item: ICoachmarkProps) => {\n            return { ...item, isActive: false };\n          });\n        });\n      }\n\n      const timer = setTimeout(() => {\n        clearTimeout(timer);\n        const currIndex = currentIndex.current + 1;\n\n        setCoachmarkList(prevList => {\n          // Finish onboarding\n          if (currIndex >= prevList.length || prevList.length === 0) {\n            currentJourneyIdStudent.current = undefined;\n            currentIndex.current = -1;\n\n            return [];\n          }\n\n          currentIndex.current = currIndex;\n          const updatedCoachmarkList = [...prevList];\n\n          (updatedCoachmarkList[currIndex] as ICoachmarkProps).isActive = true;\n\n          if (currIndex > 0) {\n            (updatedCoachmarkList[currIndex - 1] as ICoachmarkProps).isActive = keepPrevActive;\n          }\n\n          return updatedCoachmarkList;\n        });\n      }, delayInMs);\n    },\n    [],\n  );\n\n  const memoizedContextValue = useMemo(\n    () => ({\n      nextCoachmark,\n      setJourney,\n      addCoachmark,\n      coachmarks: coachmarkList,\n    }),\n    [nextCoachmark, setJourney, addCoachmark, coachmarkList],\n  );\n\n  return (\n    <JourneyContext.Provider value={memoizedContextValue}>\n      {coachmarkList.length > 0 && (\n        <S.BlurOverlay>\n          {coachmarkList.map((coachmark, index) => (\n            <Coachmark key={`coachmark-${index}`} coachmark={coachmark} />\n          ))}\n        </S.BlurOverlay>\n      )}\n      {children}\n    </JourneyContext.Provider>\n  );\n};\n"],"names":["JourneyContext","createContext","JourneyProvider","children","coachmarkList","setCoachmarkList","useState","currentIndex","useRef","currentJourneyIdStudent","setJourney","useCallback","id","coachmarks","addCoachmark","coachmark","prev","nextCoachmark","keepPrevActive","delayInMs","prevList","item","timer","currIndex","updatedCoachmarkList","memoizedContextValue","useMemo","jsxs","jsx","S.BlurOverlay","index","Coachmark"],"mappings":";;;;AASa,MAAAA,IAAiBC,EAAsC,IAAI,GAE3DC,IAA+C,CAAC,EAAE,UAAAC,QAAe;AAC5E,QAAM,CAACC,GAAeC,CAAgB,IAAIC,EAA4B,CAAE,CAAA,GAClEC,IAAeC,EAAO,EAAE,GACxBC,IAA0BD,KAE1BE,IAAaC;AAAA,IACjB,CAACC,GAAgBC,MAAkC;AAC7C,UAAAT,EAAc,SAAS;AACzB,cAAM,IAAI;AAAA,UACR,iEAAiEK,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,QAAA;AAGhI,MAAAH,EAAwB,UAAUG,GAClCL,EAAa,UAAU,IACNF,EAAA,CAAC,GAAGQ,CAAU,CAAC;AAAA,IAClC;AAAA,IACA,CAACT,EAAc,MAAM;AAAA,EAAA,GAGjBU,IAAeH,EAAY,CAACC,GAAgBG,MAA+B;AAC/E,QAAI,CAACN,EAAwB,WAAWG,MAAOH,EAAwB;AACrE,YAAM,IAAI;AAAA,QACRA,EAAwB,UACpB,8CACA,iDAAiDA,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,MAAA;AAIpH,IAAAP,EAAiB,CAAQW,MAAA,CAAC,GAAGA,GAAMD,CAAS,CAAC;AAAA,EAC/C,GAAG,CAAE,CAAA,GAECE,IAAgBN;AAAA,IACpB,CAACC,GAAgBM,IAA0B,IAAOC,IAAoB,MAAM;AAC1E,UAAI,CAACV,EAAwB,WAAWG,MAAOH,EAAwB;AACrE,cAAM,IAAI;AAAA,UACRA,EAAwB,UACpB,+CACA,iDAAiDA,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,QAAA;AAIpH,MAAIO,MAAc,KAEhBd,EAAiB,CAAYe,MACpBA,EAAS,IAAI,CAACC,OACZ,EAAE,GAAGA,GAAM,UAAU,GAAM,EACnC,CACF;AAGG,YAAAC,IAAQ,WAAW,MAAM;AAC7B,qBAAaA,CAAK;AACZ,cAAAC,IAAYhB,EAAa,UAAU;AAEzC,QAAAF,EAAiB,CAAYe,MAAA;AAE3B,cAAIG,KAAaH,EAAS,UAAUA,EAAS,WAAW;AACtD,mBAAAX,EAAwB,UAAU,QAClCF,EAAa,UAAU,IAEhB;AAGT,UAAAA,EAAa,UAAUgB;AACjB,gBAAAC,IAAuB,CAAC,GAAGJ,CAAQ;AAExC,iBAAAI,EAAqBD,CAAS,EAAsB,WAAW,IAE5DA,IAAY,MACbC,EAAqBD,IAAY,CAAC,EAAsB,WAAWL,IAG/DM;AAAA,QAAA,CACR;AAAA,SACAL,CAAS;AAAA,IACd;AAAA,IACA,CAAC;AAAA,EAAA,GAGGM,IAAuBC;AAAA,IAC3B,OAAO;AAAA,MACL,eAAAT;AAAA,MACA,YAAAP;AAAA,MACA,cAAAI;AAAA,MACA,YAAYV;AAAA,IAAA;AAAA,IAEd,CAACa,GAAeP,GAAYI,GAAcV,CAAa;AAAA,EAAA;AAGzD,SACG,gBAAAuB,EAAA3B,EAAe,UAAf,EAAwB,OAAOyB,GAC7B,UAAA;AAAA,IAAArB,EAAc,SAAS,KACtB,gBAAAwB,EAACC,GAAA,EACE,YAAc,IAAI,CAACd,GAAWe,wBAC5BC,GAAqC,EAAA,WAAAhB,EAAA,GAAtB,aAAae,CAAK,EAA0B,CAC7D,GACH;AAAA,IAED3B;AAAA,EACH,EAAA,CAAA;AAEJ;"}
+{"version":3,"file":"journey-context-provider.js","sources":["../../../../src/features/journey/use-journey/journey-context-provider.tsx"],"sourcesContent":["import type { TJourneyId } from '../journey-id/journey-id-types';\nimport type { ICoachmarkProps, IJourneyContext } from './journey-context-types';\nimport type { FC, ReactNode } from 'react';\n\nimport { createContext, useCallback, useMemo, useRef, useState } from 'react';\n\nimport { Coachmark } from '../comps/coachmark/coachmark';\nimport * as S from './journey-styled';\n\nexport const JourneyContext = createContext<IJourneyContext | null>(null);\n\nexport const JourneyProvider: FC<{ children: ReactNode }> = ({ children }) => {\n  const [coachmarkList, setCoachmarkList] = useState<ICoachmarkProps[]>([]);\n  const currentIndex = useRef(-1);\n  const currentJourneyIdStudent = useRef<TJourneyId | undefined>();\n\n  const setJourney = useCallback(\n    (id: TJourneyId, coachmarks: ICoachmarkProps[]) => {\n      if (coachmarkList.length > 0) {\n        throw new Error(\n          `setJourney: Other Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n        );\n      }\n      currentJourneyIdStudent.current = id;\n      currentIndex.current = -1;\n      setCoachmarkList([...coachmarks]);\n    },\n    [coachmarkList.length],\n  );\n\n  const clearJourney = useCallback(() => {\n    currentJourneyIdStudent.current = undefined;\n    currentIndex.current = -1;\n    setCoachmarkList([]);\n  }, []);\n\n  const addCoachmark = useCallback((id: TJourneyId, coachmark: ICoachmarkProps) => {\n    if (!currentJourneyIdStudent.current || id !== currentJourneyIdStudent.current) {\n      throw new Error(\n        currentJourneyIdStudent.current\n          ? `addCoachmark was called before setJourney`\n          : `A Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n      );\n    }\n\n    setCoachmarkList(prev => [...prev, coachmark]);\n  }, []);\n\n  const nextCoachmark = useCallback(\n    (id: TJourneyId, keepPrevActive: boolean = false, delayInMs: number = 0) => {\n      if (!currentJourneyIdStudent.current || id !== currentJourneyIdStudent.current) {\n        throw new Error(\n          currentJourneyIdStudent.current\n            ? `nextCoachmark was called before setJourney`\n            : `A Journey is already active, Current Journey: ${currentJourneyIdStudent.current}, New Journey Request: ${id}`,\n        );\n      }\n\n      if (delayInMs !== 0) {\n        // If delay is not 0, we will hide all them coachmarks and reveal only after the delay\n        setCoachmarkList(prevList => {\n          return prevList.map((item: ICoachmarkProps) => {\n            return { ...item, isActive: false };\n          });\n        });\n      }\n\n      const timer = setTimeout(() => {\n        clearTimeout(timer);\n        const currIndex = currentIndex.current + 1;\n\n        setCoachmarkList(prevList => {\n          // Finish onboarding\n          if (currIndex >= prevList.length || prevList.length === 0) {\n            currentJourneyIdStudent.current = undefined;\n            currentIndex.current = -1;\n\n            return [];\n          }\n\n          currentIndex.current = currIndex;\n          const updatedCoachmarkList = [...prevList];\n\n          (updatedCoachmarkList[currIndex] as ICoachmarkProps).isActive = true;\n\n          if (currIndex > 0) {\n            (updatedCoachmarkList[currIndex - 1] as ICoachmarkProps).isActive = keepPrevActive;\n          }\n\n          return updatedCoachmarkList;\n        });\n      }, delayInMs);\n    },\n    [],\n  );\n\n  const memoizedContextValue = useMemo(\n    () => ({\n      nextCoachmark,\n      setJourney,\n      addCoachmark,\n      clearJourney,\n      coachmarks: coachmarkList,\n    }),\n    [nextCoachmark, setJourney, addCoachmark, clearJourney, coachmarkList],\n  );\n\n  return (\n    <JourneyContext.Provider value={memoizedContextValue}>\n      {coachmarkList.length > 0 && (\n        <S.BlurOverlay>\n          {coachmarkList.map((coachmark, index) => (\n            <Coachmark key={`coachmark-${index}`} coachmark={coachmark} />\n          ))}\n        </S.BlurOverlay>\n      )}\n      {children}\n    </JourneyContext.Provider>\n  );\n};\n"],"names":["JourneyContext","createContext","JourneyProvider","children","coachmarkList","setCoachmarkList","useState","currentIndex","useRef","currentJourneyIdStudent","setJourney","useCallback","id","coachmarks","clearJourney","addCoachmark","coachmark","prev","nextCoachmark","keepPrevActive","delayInMs","prevList","item","timer","currIndex","updatedCoachmarkList","memoizedContextValue","useMemo","jsxs","jsx","S.BlurOverlay","index","Coachmark"],"mappings":";;;;AASa,MAAAA,IAAiBC,EAAsC,IAAI,GAE3DC,IAA+C,CAAC,EAAE,UAAAC,QAAe;AAC5E,QAAM,CAACC,GAAeC,CAAgB,IAAIC,EAA4B,CAAE,CAAA,GAClEC,IAAeC,EAAO,EAAE,GACxBC,IAA0BD,KAE1BE,IAAaC;AAAA,IACjB,CAACC,GAAgBC,MAAkC;AAC7C,UAAAT,EAAc,SAAS;AACzB,cAAM,IAAI;AAAA,UACR,iEAAiEK,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,QAAA;AAGhI,MAAAH,EAAwB,UAAUG,GAClCL,EAAa,UAAU,IACNF,EAAA,CAAC,GAAGQ,CAAU,CAAC;AAAA,IAClC;AAAA,IACA,CAACT,EAAc,MAAM;AAAA,EAAA,GAGjBU,IAAeH,EAAY,MAAM;AACrC,IAAAF,EAAwB,UAAU,QAClCF,EAAa,UAAU,IACvBF,EAAiB,CAAE,CAAA;AAAA,EACrB,GAAG,CAAE,CAAA,GAECU,IAAeJ,EAAY,CAACC,GAAgBI,MAA+B;AAC/E,QAAI,CAACP,EAAwB,WAAWG,MAAOH,EAAwB;AACrE,YAAM,IAAI;AAAA,QACRA,EAAwB,UACpB,8CACA,iDAAiDA,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,MAAA;AAIpH,IAAAP,EAAiB,CAAQY,MAAA,CAAC,GAAGA,GAAMD,CAAS,CAAC;AAAA,EAC/C,GAAG,CAAE,CAAA,GAECE,IAAgBP;AAAA,IACpB,CAACC,GAAgBO,IAA0B,IAAOC,IAAoB,MAAM;AAC1E,UAAI,CAACX,EAAwB,WAAWG,MAAOH,EAAwB;AACrE,cAAM,IAAI;AAAA,UACRA,EAAwB,UACpB,+CACA,iDAAiDA,EAAwB,OAAO,0BAA0BG,CAAE;AAAA,QAAA;AAIpH,MAAIQ,MAAc,KAEhBf,EAAiB,CAAYgB,MACpBA,EAAS,IAAI,CAACC,OACZ,EAAE,GAAGA,GAAM,UAAU,GAAM,EACnC,CACF;AAGG,YAAAC,IAAQ,WAAW,MAAM;AAC7B,qBAAaA,CAAK;AACZ,cAAAC,IAAYjB,EAAa,UAAU;AAEzC,QAAAF,EAAiB,CAAYgB,MAAA;AAE3B,cAAIG,KAAaH,EAAS,UAAUA,EAAS,WAAW;AACtD,mBAAAZ,EAAwB,UAAU,QAClCF,EAAa,UAAU,IAEhB;AAGT,UAAAA,EAAa,UAAUiB;AACjB,gBAAAC,IAAuB,CAAC,GAAGJ,CAAQ;AAExC,iBAAAI,EAAqBD,CAAS,EAAsB,WAAW,IAE5DA,IAAY,MACbC,EAAqBD,IAAY,CAAC,EAAsB,WAAWL,IAG/DM;AAAA,QAAA,CACR;AAAA,SACAL,CAAS;AAAA,IACd;AAAA,IACA,CAAC;AAAA,EAAA,GAGGM,IAAuBC;AAAA,IAC3B,OAAO;AAAA,MACL,eAAAT;AAAA,MACA,YAAAR;AAAA,MACA,cAAAK;AAAA,MACA,cAAAD;AAAA,MACA,YAAYV;AAAA,IAAA;AAAA,IAEd,CAACc,GAAeR,GAAYK,GAAcD,GAAcV,CAAa;AAAA,EAAA;AAGvE,SACG,gBAAAwB,EAAA5B,EAAe,UAAf,EAAwB,OAAO0B,GAC7B,UAAA;AAAA,IAAAtB,EAAc,SAAS,KACtB,gBAAAyB,EAACC,GAAA,EACE,YAAc,IAAI,CAACd,GAAWe,wBAC5BC,GAAqC,EAAA,WAAAhB,EAAA,GAAtB,aAAae,CAAK,EAA0B,CAC7D,GACH;AAAA,IAED5B;AAAA,EACH,EAAA,CAAA;AAEJ;"}

package/dist/index.d.ts

@@ -1279,6 +1279,17 @@ export declare interface IJourneyContext {
      * @param coachmark - The array of coachmarks to be used in this journey.
      */
     setJourney: (id: TJourneyId, coachmark: ICoachmarkProps[]) => void;
+    /**
+     * Clears the current journey, removing all coachmarks.
+     * Should be called inside useEffect to ensure cleanup.
+     * @example
+     * useEffect(() => {
+     *  return () => {
+     *   clearJourney();
+     * }
+     * }, []);
+     */
+    clearJourney: () => void;
     /**
      * Adds a single coachmark to an existing journey.
      * @param id - The journey identifier.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuemath/leap",
-  "version": "2.8.21-rj-6",
+  "version": "2.8.21-rj-7",
   "type": "module",
   "files": [
     "dist"