react-live-chat-loader/module/hooks/useChat.js

Implement live chat in your react app without taking a performance hit.

import { useContext, useCallback, useEffect } from 'react';
import { LiveChatLoaderContext } from "../context";
import * as Providers from "../providers";
var requestIdleCallback = typeof window !== 'undefined' ? window.requestIdleCallback : null;
var connection = typeof window !== 'undefined' ?
// eslint-disable-next-line @typescript-eslint/no-explicit-any
window.navigator && window.navigator.connection : null;
var useChat = function useChat() {
  var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
      loadWhenIdle: false
    },
    loadWhenIdle = _ref.loadWhenIdle;
  var _useContext = useContext(LiveChatLoaderContext),
    provider = _useContext.provider,
    providerKey = _useContext.providerKey,
    idlePeriod = _useContext.idlePeriod,
    state = _useContext.state,
    setState = _useContext.setState,
    appID = _useContext.appID,
    locale = _useContext.locale,
    baseUrl = _useContext.baseUrl,
    instanceId = _useContext.instanceId,
    env = _useContext.env,
    geo = _useContext.geo,
    beforeInit = _useContext.beforeInit,
    onReady = _useContext.onReady;
  useEffect(function () {
    // Don't load if idlePeriod is 0, null or undefined
    if (typeof window === 'undefined' || !loadWhenIdle || !idlePeriod) return;

    // Don't load if 2g connection or save-data is enabled
    if (connection && (connection.saveData || /2g/.test(connection.effectiveType))) return;
    if (isNaN(idlePeriod)) return;

    // deadline.timeRemaining() has an upper limit of 50 milliseconds
    // We want to ensure the page has been idle for a significant period of time
    // Therefore we count consecutive maximum timeRemaining counts and load chat when we reach our threshold
    var elapsedIdlePeriod = 0;
    var previousTimeRemaining = 0;
    var _scheduleLoadChat = function scheduleLoadChat(deadline) {
      if (elapsedIdlePeriod > idlePeriod) return loadChat({
        open: false
      });
      var timeRemaining = deadline.timeRemaining();
      // To ensure browser is idle, only accumalte elapsedIdlePeriod when
      // two consecutive maximum timeRemaining's have been observed
      if (previousTimeRemaining > 49 && timeRemaining > 49) elapsedIdlePeriod += timeRemaining;
      previousTimeRemaining = timeRemaining;
      requestIdleCallback === null || requestIdleCallback === void 0 || requestIdleCallback(_scheduleLoadChat);
    };
    if (requestIdleCallback) {
      requestIdleCallback(_scheduleLoadChat);
    } else {
      setTimeout(function () {
        return loadChat({
          open: false
        });
      }, idlePeriod);
    }
  }, []);
  var chatProvider = Providers[provider];
  var loadChat = useCallback(function () {
    var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
        open: true
      },
      _ref2$open = _ref2.open,
      open = _ref2$open === void 0 ? true : _ref2$open;
    if (!providerKey) {
      //eslint-disable-next-line no-console
      console.error('No api key given to react-live-chat-loader');
      return;
    }
    if (!provider) {
      //eslint-disable-next-line no-console
      console.error('No provider given to react-live-chat-loader');
      return;
    }
    chatProvider.load({
      providerKey: providerKey,
      setState: setState,
      appID: appID,
      locale: locale,
      baseUrl: baseUrl,
      instanceId: instanceId,
      env: env,
      geo: geo,
      beforeInit: beforeInit,
      onReady: onReady
    });
    if (open) {
      chatProvider.open();
      if (state !== 'complete') setState('open');
    }
  }, [state]);
  return [state, loadChat];
};
export default useChat;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["useContext","useCallback","useEffect","LiveChatLoaderContext","Providers","requestIdleCallback","window","connection","navigator","useChat","_ref","arguments","length","undefined","loadWhenIdle","_useContext","provider","providerKey","idlePeriod","state","setState","appID","locale","baseUrl","instanceId","env","geo","beforeInit","onReady","saveData","test","effectiveType","isNaN","elapsedIdlePeriod","previousTimeRemaining","scheduleLoadChat","deadline","loadChat","open","timeRemaining","setTimeout","chatProvider","_ref2","_ref2$open","console","error","load"],"sources":["../../src/hooks/useChat.ts"],"sourcesContent":["import { useContext, useCallback, useEffect } from 'react'\n\nimport { State } from '../types'\nimport { LiveChatLoaderContext } from '../context'\nimport * as Providers from '../providers'\n\nconst requestIdleCallback =\n  typeof window !== 'undefined' ? window.requestIdleCallback : null\nconst connection =\n  typeof window !== 'undefined'\n    ? // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      window.navigator && (window.navigator as any).connection\n    : null\n\nconst useChat = (\n  {\n    loadWhenIdle\n  }: {\n    loadWhenIdle: boolean\n  } = { loadWhenIdle: false }\n): [State, ({ open }: { open: boolean }) => void] => {\n  const {\n    provider,\n    providerKey,\n    idlePeriod,\n    state,\n    setState,\n    appID,\n    locale,\n    baseUrl,\n    // instanceId, env and geo are only relevant for Adobe Dynamic Chat\n    instanceId,\n    env,\n    geo,\n    beforeInit,\n    onReady\n  } = useContext(LiveChatLoaderContext)\n\n  useEffect(() => {\n    // Don't load if idlePeriod is 0, null or undefined\n    if (typeof window === 'undefined' || !loadWhenIdle || !idlePeriod) return\n\n    // Don't load if 2g connection or save-data is enabled\n    if (\n      connection &&\n      (connection.saveData || /2g/.test(connection.effectiveType))\n    )\n      return\n\n    if (isNaN(idlePeriod)) return\n\n    // deadline.timeRemaining() has an upper limit of 50 milliseconds\n    // We want to ensure the page has been idle for a significant period of time\n    // Therefore we count consecutive maximum timeRemaining counts and load chat when we reach our threshold\n    let elapsedIdlePeriod = 0\n    let previousTimeRemaining = 0\n    const scheduleLoadChat = (deadline: IdleDeadline) => {\n      if (elapsedIdlePeriod > idlePeriod) return loadChat({ open: false })\n\n      const timeRemaining = deadline.timeRemaining()\n      // To ensure browser is idle, only accumalte elapsedIdlePeriod when\n      // two consecutive maximum timeRemaining's have been observed\n      if (previousTimeRemaining > 49 && timeRemaining > 49)\n        elapsedIdlePeriod += timeRemaining\n\n      previousTimeRemaining = timeRemaining\n      requestIdleCallback?.(scheduleLoadChat)\n    }\n\n    if (requestIdleCallback) {\n      requestIdleCallback(scheduleLoadChat)\n    } else {\n      setTimeout(() => loadChat({ open: false }), idlePeriod)\n    }\n  }, [])\n\n  const chatProvider = Providers[provider]\n\n  const loadChat = useCallback<(args: { open: boolean }) => void>(\n    ({ open = true } = { open: true }) => {\n      if (!providerKey) {\n        //eslint-disable-next-line no-console\n        console.error('No api key given to react-live-chat-loader')\n        return\n      }\n\n      if (!provider) {\n        //eslint-disable-next-line no-console\n        console.error('No provider given to react-live-chat-loader')\n        return\n      }\n\n      chatProvider.load({\n        providerKey,\n        setState,\n        appID,\n        locale,\n        baseUrl,\n        instanceId,\n        env,\n        geo,\n        beforeInit,\n        onReady\n      })\n\n      if (open) {\n        chatProvider.open()\n        if (state !== 'complete') setState('open')\n      }\n    },\n    [state]\n  )\n\n  return [state, loadChat]\n}\n\nexport default useChat\n"],"mappings":"AAAA,SAASA,UAAU,EAAEC,WAAW,EAAEC,SAAS,QAAQ,OAAO;AAG1D,SAASC,qBAAqB;AAC9B,OAAO,KAAKC,SAAS;AAErB,IAAMC,mBAAmB,GACvB,OAAOC,MAAM,KAAK,WAAW,GAAGA,MAAM,CAACD,mBAAmB,GAAG,IAAI;AACnE,IAAME,UAAU,GACd,OAAOD,MAAM,KAAK,WAAW;AACzB;AACAA,MAAM,CAACE,SAAS,IAAKF,MAAM,CAACE,SAAS,CAASD,UAAU,GACxD,IAAI;AAEV,IAAME,OAAO,GAAG,SAAVA,OAAOA,CAAA,EAMwC;EAAA,IAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAD/C;MAAEG,YAAY,EAAE;IAAM,CAAC;IAHzBA,YAAY,GAAAJ,IAAA,CAAZI,YAAY;EAKd,IAAAC,WAAA,GAeIf,UAAU,CAACG,qBAAqB,CAAC;IAdnCa,QAAQ,GAAAD,WAAA,CAARC,QAAQ;IACRC,WAAW,GAAAF,WAAA,CAAXE,WAAW;IACXC,UAAU,GAAAH,WAAA,CAAVG,UAAU;IACVC,KAAK,GAAAJ,WAAA,CAALI,KAAK;IACLC,QAAQ,GAAAL,WAAA,CAARK,QAAQ;IACRC,KAAK,GAAAN,WAAA,CAALM,KAAK;IACLC,MAAM,GAAAP,WAAA,CAANO,MAAM;IACNC,OAAO,GAAAR,WAAA,CAAPQ,OAAO;IAEPC,UAAU,GAAAT,WAAA,CAAVS,UAAU;IACVC,GAAG,GAAAV,WAAA,CAAHU,GAAG;IACHC,GAAG,GAAAX,WAAA,CAAHW,GAAG;IACHC,UAAU,GAAAZ,WAAA,CAAVY,UAAU;IACVC,OAAO,GAAAb,WAAA,CAAPa,OAAO;EAGT1B,SAAS,CAAC,YAAM;IACd;IACA,IAAI,OAAOI,MAAM,KAAK,WAAW,IAAI,CAACQ,YAAY,IAAI,CAACI,UAAU,EAAE;;IAEnE;IACA,IACEX,UAAU,KACTA,UAAU,CAACsB,QAAQ,IAAI,IAAI,CAACC,IAAI,CAACvB,UAAU,CAACwB,aAAa,CAAC,CAAC,EAE5D;IAEF,IAAIC,KAAK,CAACd,UAAU,CAAC,EAAE;;IAEvB;IACA;IACA;IACA,IAAIe,iBAAiB,GAAG,CAAC;IACzB,IAAIC,qBAAqB,GAAG,CAAC;IAC7B,IAAMC,iBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,QAAsB,EAAK;MACnD,IAAIH,iBAAiB,GAAGf,UAAU,EAAE,OAAOmB,QAAQ,CAAC;QAAEC,IAAI,EAAE;MAAM,CAAC,CAAC;MAEpE,IAAMC,aAAa,GAAGH,QAAQ,CAACG,aAAa,CAAC,CAAC;MAC9C;MACA;MACA,IAAIL,qBAAqB,GAAG,EAAE,IAAIK,aAAa,GAAG,EAAE,EAClDN,iBAAiB,IAAIM,aAAa;MAEpCL,qBAAqB,GAAGK,aAAa;MACrClC,mBAAmB,aAAnBA,mBAAmB,eAAnBA,mBAAmB,CAAG8B,iBAAgB,CAAC;IACzC,CAAC;IAED,IAAI9B,mBAAmB,EAAE;MACvBA,mBAAmB,CAAC8B,iBAAgB,CAAC;IACvC,CAAC,MAAM;MACLK,UAAU,CAAC;QAAA,OAAMH,QAAQ,CAAC;UAAEC,IAAI,EAAE;QAAM,CAAC,CAAC;MAAA,GAAEpB,UAAU,CAAC;IACzD;EACF,CAAC,EAAE,EAAE,CAAC;EAEN,IAAMuB,YAAY,GAAGrC,SAAS,CAACY,QAAQ,CAAC;EAExC,IAAMqB,QAAQ,GAAGpC,WAAW,CAC1B,YAAsC;IAAA,IAAAyC,KAAA,GAAA/B,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAnB;QAAE2B,IAAI,EAAE;MAAK,CAAC;MAAAK,UAAA,GAAAD,KAAA,CAA9BJ,IAAI;MAAJA,IAAI,GAAAK,UAAA,cAAG,IAAI,GAAAA,UAAA;IACZ,IAAI,CAAC1B,WAAW,EAAE;MAChB;MACA2B,OAAO,CAACC,KAAK,CAAC,4CAA4C,CAAC;MAC3D;IACF;IAEA,IAAI,CAAC7B,QAAQ,EAAE;MACb;MACA4B,OAAO,CAACC,KAAK,CAAC,6CAA6C,CAAC;MAC5D;IACF;IAEAJ,YAAY,CAACK,IAAI,CAAC;MAChB7B,WAAW,EAAXA,WAAW;MACXG,QAAQ,EAARA,QAAQ;MACRC,KAAK,EAALA,KAAK;MACLC,MAAM,EAANA,MAAM;MACNC,OAAO,EAAPA,OAAO;MACPC,UAAU,EAAVA,UAAU;MACVC,GAAG,EAAHA,GAAG;MACHC,GAAG,EAAHA,GAAG;MACHC,UAAU,EAAVA,UAAU;MACVC,OAAO,EAAPA;IACF,CAAC,CAAC;IAEF,IAAIU,IAAI,EAAE;MACRG,YAAY,CAACH,IAAI,CAAC,CAAC;MACnB,IAAInB,KAAK,KAAK,UAAU,EAAEC,QAAQ,CAAC,MAAM,CAAC;IAC5C;EACF,CAAC,EACD,CAACD,KAAK,CACR,CAAC;EAED,OAAO,CAACA,KAAK,EAAEkB,QAAQ,CAAC;AAC1B,CAAC;AAED,eAAe5B,OAAO","ignoreList":[]}