phx-react 1.3.1086 → 1.3.1089

package/dist/esm/stores/page-tracker/page-tracker.d.ts

@@ -0,0 +1,23 @@
+type PageEvent = 'forward' | 'back' | 'push' | undefined;
+export type PageTrackerState = {
+    /** current page index */
+    pageIndex: number;
+    /** correct `document.referrer` */
+    referrer: string;
+    /** whether the current page is the first page */
+    isFirstPage: boolean;
+    /** whether the current page is the last page */
+    isLastPage: boolean;
+    /** whether the user navigated to the page via browser back/forward buttons or by clicking a link */
+    pageEvent: PageEvent;
+    /** history browsing record */
+    pageHistory: Array<string>;
+    /** total page history length */
+    pageHistoryLength: number;
+};
+export type HistoryCustomState = {
+    __REACT_PAGE_TRACKER_INTERNAL__: Pick<PageTrackerState, 'pageIndex' | 'referrer' | 'pageHistory' | 'pageHistoryLength'>;
+};
+export declare const usePageTrackerHandler: () => void;
+export declare const PageTracker: () => null;
+export {};

package/dist/esm/stores/page-tracker/page-tracker.js

@@ -0,0 +1,125 @@
+'use client';
+import { __assign, __spreadArray } from "tslib";
+import { useEffect, useRef } from 'react';
+import { pageTrackerStore } from './page-tracker-store';
+var DEBUG = false;
+var useStrictModeDetector = function () {
+    var counterRef = useRef(0);
+    var isStrictMode = useRef(false);
+    var detectorHandler = function () {
+        counterRef.current++;
+        if (isStrictMode.current) {
+            return counterRef.current % 2 === 0;
+        }
+        return false;
+    };
+    return {
+        initStrictModeDetector: function () {
+            counterRef.current++;
+            if (counterRef.current === 2) {
+                isStrictMode.current = true;
+            }
+        },
+        strictModeDetector: function () {
+            return detectorHandler();
+        }
+    };
+};
+var debugLog = function (message) {
+    if (DEBUG) {
+        console.debug("[DEBUG PAGE CHANGE] ".concat(message));
+    }
+};
+var initHistoryState = function () {
+    var defaultData = {
+        __REACT_PAGE_TRACKER_INTERNAL__: {
+            pageIndex: 0,
+            referrer: document.referrer,
+            pageHistory: [location.href.replace(location.origin, '')],
+            pageHistoryLength: 1
+        }
+    };
+    if (typeof history.state === 'object' && history.state !== null) {
+        history.replaceState(__assign(__assign({}, history.state), defaultData), location.href);
+    }
+    else {
+        history.replaceState(defaultData, '');
+    }
+    pageTrackerStore.setState(defaultData.__REACT_PAGE_TRACKER_INTERNAL__);
+};
+export var usePageTrackerHandler = function () {
+    var initStrictModeDetector = useStrictModeDetector().initStrictModeDetector;
+    var pageIndex = useRef(0);
+    // for isLastPage usage
+    var visitedTotalLength = useRef(1);
+    useEffect(function () {
+        initHistoryState();
+        initStrictModeDetector();
+        /** Handle user operate original back/forward button or history.go()/back()/forward() or framework routing. **/
+        var handlePopState = function (event) {
+            var _a, _b;
+            var state = event.state;
+            var internal = state === null || state === void 0 ? void 0 : state.__REACT_PAGE_TRACKER_INTERNAL__;
+            if (!internal) {
+                // If the state isn't ours, ignore to avoid corrupting indices
+                return;
+            }
+            var statePageIndex = (_a = internal.pageIndex) !== null && _a !== void 0 ? _a : 0;
+            var pageEvent = pageIndex.current > statePageIndex ? 'back' : 'forward';
+            if (pageEvent === 'forward') {
+                pageIndex.current = statePageIndex; // moving forward to the state's index
+            }
+            else {
+                pageIndex.current = statePageIndex;
+            }
+            var pageHistory = __spreadArray([], (internal.pageHistory || []), true);
+            pageTrackerStore.setState({
+                pageIndex: pageIndex.current,
+                isFirstPage: pageIndex.current === 0,
+                isLastPage: pageHistory.length === visitedTotalLength.current,
+                referrer: (_b = internal.referrer) !== null && _b !== void 0 ? _b : '',
+                pageHistory: pageHistory,
+                pageHistoryLength: visitedTotalLength.current,
+                pageEvent: pageEvent
+            });
+        };
+        // save original pushState
+        var originalPushState = history.pushState.bind(history);
+        var normalize = function (raw) { return raw.replace(location.origin, ''); };
+        // override popstate using addEventListener
+        window.addEventListener('popstate', handlePopState);
+        history.pushState = function (state, title, url) {
+            var baseHistory = pageTrackerStore.getImmutablePageHistory();
+            // trim forward if navigating mid-stack
+            if (pageIndex.current < baseHistory.length - 1) {
+                baseHistory.splice(pageIndex.current + 1);
+            }
+            var nextUrl = url ? normalize(url) : normalize(location.href);
+            var newPageHistory = __spreadArray(__spreadArray([], baseHistory, true), [nextUrl], false);
+            var newPageIndex = newPageHistory.length - 1;
+            pageIndex.current = newPageIndex;
+            visitedTotalLength.current = newPageHistory.length;
+            var newState = {
+                pageIndex: newPageIndex,
+                referrer: normalize(window.location.href),
+                pageHistory: newPageHistory,
+                pageHistoryLength: visitedTotalLength.current
+            };
+            var stateWithPageInfo = __assign(__assign({}, state), { __REACT_PAGE_TRACKER_INTERNAL__: __assign({}, newState) });
+            pageTrackerStore.setState(__assign(__assign({}, newState), { isFirstPage: newPageIndex === 0, isLastPage: true, pageEvent: 'push' }));
+            debugLog("pushState: stateWithPageInfo.pageIndex -->".concat(stateWithPageInfo.__REACT_PAGE_TRACKER_INTERNAL__.pageIndex, " ,pageIndex.current --> ").concat(pageIndex.current, " referrer -->").concat(stateWithPageInfo.__REACT_PAGE_TRACKER_INTERNAL__.referrer));
+            return originalPushState(stateWithPageInfo, title || '', url || '');
+        };
+        return function () {
+            window.removeEventListener('popstate', handlePopState);
+            history.pushState = originalPushState;
+        };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+};
+export var PageTracker = function () {
+    // eslint-disable-next-line no-use-before-define
+    usePageTrackerHandler();
+    return null;
+};
+//# sourceMappingURL=page-tracker.js.map

package/dist/esm/stores/page-tracker/page-tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-tracker.js","sourceRoot":"","sources":["../../../../src/stores/page-tracker/page-tracker.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAA;;AACZ,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAoBvD,IAAM,KAAK,GAAG,KAAK,CAAA;AAQnB,IAAM,qBAAqB,GAAG;IAC5B,IAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAC5B,IAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAElC,IAAM,eAAe,GAAG;QACtB,UAAU,CAAC,OAAO,EAAE,CAAA;QACpB,IAAI,YAAY,CAAC,OAAO,EAAE;YACxB,OAAO,UAAU,CAAC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAA;SACpC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAA;IAED,OAAO;QACL,sBAAsB,EAAE;YACtB,UAAU,CAAC,OAAO,EAAE,CAAA;YACpB,IAAI,UAAU,CAAC,OAAO,KAAK,CAAC,EAAE;gBAC5B,YAAY,CAAC,OAAO,GAAG,IAAI,CAAA;aAC5B;QACH,CAAC;QACD,kBAAkB,EAAE;YAClB,OAAO,eAAe,EAAE,CAAA;QAC1B,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAED,IAAM,QAAQ,GAAG,UAAC,OAAe;IAC/B,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,KAAK,CAAC,8BAAuB,OAAO,CAAE,CAAC,CAAA;KAChD;AACH,CAAC,CAAA;AAED,IAAM,gBAAgB,GAAG;IACvB,IAAM,WAAW,GAAG;QAClB,+BAA+B,EAAE;YAC/B,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACzD,iBAAiB,EAAE,CAAC;SACQ;KAC/B,CAAA;IAED,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,KAAK,IAAI,EAAE;QAC/D,OAAO,CAAC,YAAY,uBAEb,OAAO,CAAC,KAAK,GACb,WAAW,GAEhB,QAAQ,CAAC,IAAI,CACd,CAAA;KACF;SAAM;QACL,OAAO,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;KACtC;IACD,gBAAgB,CAAC,QAAQ,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAA;AACxE,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,qBAAqB,GAAG;IAC3B,IAAA,sBAAsB,GAAK,qBAAqB,EAAE,uBAA5B,CAA4B;IAE1D,IAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAC3B,uBAAuB;IACvB,IAAM,kBAAkB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAEpC,SAAS,CAAC;QACR,gBAAgB,EAAE,CAAA;QAClB,sBAAsB,EAAE,CAAA;QAExB,+GAA+G;QAC/G,IAAM,cAAc,GAAG,UAAC,KAAoB;;YAC1C,IAAM,KAAK,GAAG,KAAK,CAAC,KAAkC,CAAA;YACtD,IAAM,QAAQ,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,+BAA+B,CAAA;YACvD,IAAI,CAAC,QAAQ,EAAE;gBACb,8DAA8D;gBAC9D,OAAM;aACP;YACD,IAAM,cAAc,GAAG,MAAA,QAAQ,CAAC,SAAS,mCAAI,CAAC,CAAA;YAC9C,IAAM,SAAS,GAAc,SAAS,CAAC,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;YACpF,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,SAAS,CAAC,OAAO,GAAG,cAAc,CAAA,CAAC,sCAAsC;aAC1E;iBAAM;gBACL,SAAS,CAAC,OAAO,GAAG,cAAc,CAAA;aACnC;YACD,IAAM,WAAW,qBAAO,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,OAAC,CAAA;YACrD,gBAAgB,CAAC,QAAQ,CAAC;gBACxB,SAAS,EAAE,SAAS,CAAC,OAAO;gBAC5B,WAAW,EAAE,SAAS,CAAC,OAAO,KAAK,CAAC;gBACpC,UAAU,EAAE,WAAW,CAAC,MAAM,KAAK,kBAAkB,CAAC,OAAO;gBAC7D,QAAQ,EAAE,MAAA,QAAQ,CAAC,QAAQ,mCAAI,EAAE;gBACjC,WAAW,aAAA;gBACX,iBAAiB,EAAE,kBAAkB,CAAC,OAAO;gBAC7C,SAAS,WAAA;aACV,CAAC,CAAA;QACJ,CAAC,CAAA;QAED,0BAA0B;QAC1B,IAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACzD,IAAM,SAAS,GAAG,UAAC,GAAW,IAAK,OAAA,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAhC,CAAgC,CAAA;QAEnE,2CAA2C;QAC3C,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAA;QACnD,OAAO,CAAC,SAAS,GAAG,UAAC,KAAc,EAAE,KAAa,EAAE,GAAmB;YACrE,IAAM,WAAW,GAAG,gBAAgB,CAAC,uBAAuB,EAAE,CAAA;YAC9D,uCAAuC;YACvC,IAAI,SAAS,CAAC,OAAO,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC9C,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA;aAC1C;YACD,IAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAC/D,IAAM,cAAc,mCAAO,WAAW,UAAE,OAAO,SAAC,CAAA;YAChD,IAAM,YAAY,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAA;YAC9C,SAAS,CAAC,OAAO,GAAG,YAAY,CAAA;YAChC,kBAAkB,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAA;YAClD,IAAM,QAAQ,GAAG;gBACf,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACzC,WAAW,EAAE,cAAc;gBAC3B,iBAAiB,EAAE,kBAAkB,CAAC,OAAO;aAC9C,CAAA;YAED,IAAM,iBAAiB,yBACjB,KAAgB,KACpB,+BAA+B,eAC1B,QAAQ,IAEd,CAAA;YACD,gBAAgB,CAAC,QAAQ,uBACpB,QAAQ,KACX,WAAW,EAAE,YAAY,KAAK,CAAC,EAC/B,UAAU,EAAE,IAAI,EAChB,SAAS,EAAE,MAAM,IACjB,CAAA;YAEF,QAAQ,CACN,oDAA6C,iBAAiB,CAAC,+BAA+B,CAAC,SAAS,qCAA2B,SAAS,CAAC,OAAO,0BAAgB,iBAAiB,CAAC,+BAA+B,CAAC,QAAQ,CAAE,CACjO,CAAA;YAED,OAAO,iBAAiB,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QACrE,CAAC,CAAA;QAED,OAAO;YACL,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAA;YACtD,OAAO,CAAC,SAAS,GAAG,iBAAiB,CAAA;QACvC,CAAC,CAAA;QACD,uDAAuD;IACzD,CAAC,EAAE,EAAE,CAAC,CAAA;AACR,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,WAAW,GAAG;IACzB,gDAAgD;IAChD,qBAAqB,EAAE,CAAA;IACvB,OAAO,IAAI,CAAA;AACb,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phx-react",
-  "version": "1.3.1086",
+  "version": "1.3.1089",
   "description": "PHX REACT",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",