{"version":3,"file":"TrackerContext-dfead95a.js","sources":["../../../app/javascript/analytics/OmniTracker/TrackerContext.tsx"],"sourcesContent":["import React, {\n  ReactElement, ReactNode, useContext, useEffect, useMemo,\n} from 'react'\nimport { AppName, FixedComponentTracker } from 'analytics/OmniTracker/index'\nimport { Maybe, PlainObject } from 'shared/util/types.util'\nimport Tracker, { FixedAppTracker } from 'analytics/tracker'\nimport { TrackingComponent } from 'analytics/OmniTracker/TrackingComponent'\nimport { mapKeys } from 'lodash'\nimport { v4 as uuid } from 'uuid'\n\nexport const AppTrackerContext = React.createContext<FixedAppTracker>(Tracker.forApp(AppName.CALENDAR))\n\nexport function ProvideAppTracker(\n  { app, children }: { app: AppName, children: ReactElement | ReactElement[] },\n): JSX.Element {\n  const tracker = useMemo(() => Tracker.forApp(app), [app])\n\n  const appContext = useMemo(() => ({ app }), [app])\n  useGlobalTrackingContext(appContext)\n\n  return (\n    <AppTrackerContext.Provider value={tracker}>\n      {children}\n    </AppTrackerContext.Provider>\n  )\n}\n\nexport function useAppTracker(): FixedAppTracker {\n  return useContext(AppTrackerContext)\n}\n\nexport const ComponentTrackerContext = React.createContext<Maybe<FixedComponentTracker>>(undefined)\n\nexport function ProvideComponentTracker(\n  { value, component, children }: {\n    value?: Maybe<FixedComponentTracker>\n    component?: TrackingComponent\n    children: ReactElement | ReactElement[]\n  },\n): JSX.Element {\n  let tracker = value\n  const appTracker = useAppTracker()\n  if (component) {\n    tracker = appTracker.forComponent(component)\n  }\n  return (\n    <ComponentTrackerContext.Provider value={tracker}>\n      {children}\n    </ComponentTrackerContext.Provider>\n  )\n}\n\ninterface Options {\n  fromContext?: boolean\n}\n\nexport function useComponentTracker(\n  fallbackComponent?: TrackingComponent,\n  { fromContext = true }: Options = {},\n): FixedComponentTracker {\n  let tracker = useContext(ComponentTrackerContext)\n  if (!fromContext) {\n    tracker = undefined\n  }\n  const appTracker = useAppTracker()\n\n  return useMemo(() => {\n    if (!tracker) {\n      if (!fallbackComponent) {\n        throw new Error(\n          'No component tracker available in the context and no fallback component '\n          + 'specified. Did you forget to use \"<ProvideComponentTracker value={tracker}>\" '\n          + 'in an ancestor component?',\n        )\n      }\n\n      tracker = appTracker.forComponent(fallbackComponent)\n    }\n    return tracker\n  }, [tracker, appTracker, fallbackComponent])\n}\n\ninterface GlobalTrackingContextOptions {\n  /**\n   * Controls whether the provided context shall be added to the global tracking context. Defaults to true.\n   */\n  enabled?: boolean\n  /**\n   * Controls whether we add an arbitrary flow id to the context. Used mainly with multi-step\n   * flows to better track them by selecting distinct events in a flow\n   */\n  useFlowId?: boolean\n}\n\n/**\n * A React hook that sets the given context as the global tracking context for all tracking events for\n * the duration while the component is mounted.\n *\n * **Note that this is a global setting and will affect all tracking events emitted by all components,\n * not just descendants of the component this hook is used in!**\n *\n * @param context An arbitrary context object to be provided to all tracking events. Must be serializable.\n * @param enabled Controls whether the context shall be added to the global tracking context. Can be manually\n *  set to false to remove the global tracking properties temporarily. Defaults to true.\n * @param useFlowId Controls whether we add an arbitrary flow id to the context. Used mainly with multi-step\n * flows to better track them by selecting distinct events in a flow\n */\nexport function useGlobalTrackingContext(\n  context: PlainObject, { enabled = true, useFlowId }: GlobalTrackingContextOptions = {},\n): void {\n  const flowId = useMemo(() => uuid(), [])\n  const trackedContext = useMemo(() => {\n    if (useFlowId) {\n      return { flowId, ...context }\n    }\n    return context\n  }, [context])\n\n  useEffect(() => {\n    if (enabled) {\n      Tracker.addGlobalContext(trackedContext)\n      return () => Tracker.removeGlobalContext(trackedContext)\n    }\n    return undefined\n  }, [trackedContext, enabled])\n}\n\n/**\n * Specialized version of useGlobalTrackingContext that sets the name of the current view (= page name)\n * in the global tracking context. Note that this is meant for full-page views only, not for sub-views\n * that don't cover the entire screen. For those, use ProvideTrackerContext instead.\n * @param view The name of the view to set.\n */\nexport function useViewTrackingContext(view: string): void {\n  const viewContext = useMemo(() => ({ view }), [view])\n  useGlobalTrackingContext(viewContext)\n}\n\ninterface ModalContextOptions {\n  shown?: boolean\n  context?: PlainObject\n  useFlowId?: boolean\n}\n\n/**\n * Specialized version of useGlobalTrackingContext that sets the name of the current modal\n * in the global tracking context. Note that this is meant for full-page views only, not for sub-views\n * that don't cover the entire screen. For those, use ProvideTrackerContext instead.\n * @param modal The name of the view to set.\n * @param shown Whether the modal is currently shown. Defaults to true. Only sets the global tracking context\n *  if this value is true.\n * @param context Additional context properties to set in the global tracking context.\n * @param useFlowId Controls whether this modal is a part of a multi-step flow or is being used a standalone\n * modal. Will generate a unique id for the the flow better analysis convenience.\n */\nexport function useModalTrackingContext(\n  modal: string, { shown = true, context, useFlowId }: ModalContextOptions = {},\n): void {\n  const modalContext = useMemo(() => ({ ...context, modal }), [modal, context])\n  useGlobalTrackingContext(modalContext, { enabled: shown, useFlowId })\n}\n\nconst TrackerContext = React.createContext<PlainObject>({})\n\nexport function useTrackerContext(): PlainObject {\n  return useContext(TrackerContext)\n}\n\ninterface ProvideTrackerContextProps {\n  context: PlainObject\n  as?: keyof JSX.IntrinsicElements\n  id?: string\n  className?: string\n  children: ReactNode\n}\n\n/**\n * Provides tracking context information to all tracking events (automatic & manual) emitted by\n * all descendant components.\n * Under the hood, this needs to render an actual HTML element to be able to scope the tracking\n * context to the subtree. The element rendered is configurable via the `as` prop.\n * @param context An arbitrary context object to be provided to all tracking events. Must be serializable.\n * @param ContainerTag The HTML tag to use for the container element. Defaults to `div`.\n * @param id The HTML id to use for the container element.\n * @param className The HTML class to use for the container element.\n * @param children The children to render.\n */\nexport function ProvideTrackerContext({\n  context, as: ContainerTag = 'div', id, className, children,\n}: ProvideTrackerContextProps): JSX.Element {\n  const parentContext = useTrackerContext()\n  const mergedContext = { ...parentContext, ...context }\n\n  const posthogAttributes = mapKeys(mergedContext, (_value, key) => `data-ph-capture-attribute-${key}`)\n\n  return (\n    <TrackerContext.Provider value={mergedContext}>\n      <ContainerTag\n        id={id}\n        className={className}\n        data-tracking-context={JSON.stringify(mergedContext)}\n        {...posthogAttributes}\n      >\n        {children}\n      </ContainerTag>\n    </TrackerContext.Provider>\n  )\n}\n"],"names":["AppTrackerContext","React","Tracker","AppName","ProvideAppTracker","app","children","tracker","useMemo","appContext","useGlobalTrackingContext","useAppTracker","useContext","ComponentTrackerContext","ProvideComponentTracker","value","component","appTracker","useComponentTracker","fallbackComponent","fromContext","context","enabled","useFlowId","flowId","uuid","trackedContext","useEffect","useViewTrackingContext","view","viewContext","useModalTrackingContext","modal","shown","modalContext"],"mappings":"0KAUO,MAAMA,EAAoBC,EAAM,cAA+BC,EAAQ,OAAOC,EAAQ,QAAQ,CAAC,EAE/F,SAASC,EACd,CAAE,IAAAC,EAAK,SAAAC,GACM,CACP,MAAAC,EAAUC,UAAQ,IAAMN,EAAQ,OAAOG,CAAG,EAAG,CAACA,CAAG,CAAC,EAElDI,EAAaD,EAAAA,QAAQ,KAAO,CAAE,IAAAH,IAAQ,CAACA,CAAG,CAAC,EACjD,OAAAK,EAAyBD,CAAU,kBAGhCT,EAAkB,SAAlB,CAA2B,MAAOO,GAChCD,CACH,CAEJ,CAEO,SAASK,GAAiC,CAC/C,OAAOC,EAAAA,WAAWZ,CAAiB,CACrC,CAEa,MAAAa,EAA0BZ,EAAM,cAA4C,MAAS,EAE3F,SAASa,EACd,CAAE,MAAAC,EAAO,UAAAC,EAAW,SAAAV,GAKP,CACb,IAAIC,EAAUQ,EACd,MAAME,EAAaN,IACnB,OAAIK,IACQT,EAAAU,EAAW,aAAaD,CAAS,mBAG1CH,EAAwB,SAAxB,CAAiC,MAAON,GACtCD,CACH,CAEJ,CAMO,SAASY,EACdC,EACA,CAAE,YAAAC,EAAc,EAAK,EAAa,CAAA,EACX,CACnB,IAAAb,EAAUK,aAAWC,CAAuB,EAC3CO,IACOb,EAAA,QAEZ,MAAMU,EAAaN,IAEnB,OAAOH,UAAQ,IAAM,CACnB,GAAI,CAACD,EAAS,CACZ,GAAI,CAACY,EACH,MAAM,IAAI,MACR,gLAAA,EAMMZ,EAAAU,EAAW,aAAaE,CAAiB,CACrD,CACO,OAAAZ,CACN,EAAA,CAACA,EAASU,EAAYE,CAAiB,CAAC,CAC7C,CA2BgB,SAAAT,EACdW,EAAsB,CAAE,QAAAC,EAAU,GAAM,UAAAC,CAAU,EAAkC,GAC9E,CACN,MAAMC,EAAShB,EAAQ,QAAA,IAAMiB,EAAK,EAAG,CAAE,CAAA,EACjCC,EAAiBlB,EAAAA,QAAQ,IACzBe,EACK,CAAE,OAAAC,EAAQ,GAAGH,GAEfA,EACN,CAACA,CAAO,CAAC,EAEZM,EAAAA,UAAU,IAAM,CACd,GAAIL,EACF,OAAApB,EAAQ,iBAAiBwB,CAAc,EAChC,IAAMxB,EAAQ,oBAAoBwB,CAAc,CAElD,EACN,CAACA,EAAgBJ,CAAO,CAAC,CAC9B,CAQO,SAASM,EAAuBC,EAAoB,CACnD,MAAAC,EAActB,EAAAA,QAAQ,KAAO,CAAE,KAAAqB,IAAS,CAACA,CAAI,CAAC,EACpDnB,EAAyBoB,CAAW,CACtC,CAmBgB,SAAAC,EACdC,EAAe,CAAE,MAAAC,EAAQ,GAAM,QAAAZ,EAAS,UAAAE,CAAmC,EAAA,GACrE,CACA,MAAAW,EAAe1B,EAAAA,QAAQ,KAAO,CAAE,GAAGa,EAAS,MAAAW,CAAU,GAAA,CAACA,EAAOX,CAAO,CAAC,EAC5EX,EAAyBwB,EAAc,CAAE,QAASD,EAAO,UAAAV,CAAW,CAAA,CACtE,CAEuBtB,EAAM,cAA2B,CAAE,CAAA"}