@tanstack/history 1.7.1 → 1.8.0

package/dist/cjs/index.cjs

@@ -0,0 +1,265 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const pushStateEvent = "pushstate";
+const popStateEvent = "popstate";
+const beforeUnloadEvent = "beforeunload";
+const beforeUnloadListener = (event) => {
+  event.preventDefault();
+  return event.returnValue = "";
+};
+const stopBlocking = () => {
+  removeEventListener(beforeUnloadEvent, beforeUnloadListener, {
+    capture: true
+  });
+};
+function createHistory(opts) {
+  let location = opts.getLocation();
+  let subscribers = /* @__PURE__ */ new Set();
+  let blockers = [];
+  const onUpdate = () => {
+    location = opts.getLocation();
+    subscribers.forEach((subscriber) => subscriber());
+  };
+  const tryNavigation = async (task) => {
+    var _a;
+    if (typeof document !== "undefined" && blockers.length) {
+      for (let blocker of blockers) {
+        const allowed = await blocker();
+        if (!allowed) {
+          (_a = opts.onBlocked) == null ? void 0 : _a.call(opts, onUpdate);
+          return;
+        }
+      }
+    }
+    task();
+  };
+  return {
+    get location() {
+      return location;
+    },
+    subscribe: (cb) => {
+      subscribers.add(cb);
+      return () => {
+        subscribers.delete(cb);
+      };
+    },
+    push: (path, state) => {
+      state = assignKey(state);
+      tryNavigation(() => {
+        opts.pushState(path, state);
+        onUpdate();
+      });
+    },
+    replace: (path, state) => {
+      state = assignKey(state);
+      tryNavigation(() => {
+        opts.replaceState(path, state);
+        onUpdate();
+      });
+    },
+    go: (index) => {
+      tryNavigation(() => {
+        opts.go(index);
+      });
+    },
+    back: () => {
+      tryNavigation(() => {
+        opts.back();
+      });
+    },
+    forward: () => {
+      tryNavigation(() => {
+        opts.forward();
+      });
+    },
+    createHref: (str) => opts.createHref(str),
+    block: (blocker) => {
+      blockers.push(blocker);
+      if (blockers.length === 1) {
+        addEventListener(beforeUnloadEvent, beforeUnloadListener, {
+          capture: true
+        });
+      }
+      return () => {
+        blockers = blockers.filter((b) => b !== blocker);
+        if (!blockers.length) {
+          stopBlocking();
+        }
+      };
+    },
+    flush: () => {
+      var _a;
+      return (_a = opts.flush) == null ? void 0 : _a.call(opts);
+    },
+    destroy: () => {
+      var _a;
+      return (_a = opts.destroy) == null ? void 0 : _a.call(opts);
+    },
+    notify: onUpdate
+  };
+}
+function assignKey(state) {
+  if (!state) {
+    state = {};
+  }
+  return {
+    ...state,
+    key: createRandomKey()
+  };
+}
+function createBrowserHistory(opts) {
+  const win = (opts == null ? void 0 : opts.window) ?? (typeof document !== "undefined" ? window : void 0);
+  const createHref = (opts == null ? void 0 : opts.createHref) ?? ((path) => path);
+  const parseLocation = (opts == null ? void 0 : opts.parseLocation) ?? (() => parseHref(
+    `${win.location.pathname}${win.location.search}${win.location.hash}`,
+    win.history.state
+  ));
+  let currentLocation = parseLocation();
+  let rollbackLocation;
+  const getLocation = () => currentLocation;
+  let next;
+  let tracking = true;
+  let scheduled;
+  const untrack = (fn) => {
+    tracking = false;
+    fn();
+    tracking = true;
+  };
+  const flush = () => {
+    untrack(() => {
+      if (!next)
+        return;
+      win.history[next.isPush ? "pushState" : "replaceState"](
+        next.state,
+        "",
+        next.href
+      );
+      next = void 0;
+      scheduled = void 0;
+      rollbackLocation = void 0;
+    });
+  };
+  const queueHistoryAction = (type, destHref, state) => {
+    const href = createHref(destHref);
+    if (!scheduled) {
+      rollbackLocation = currentLocation;
+    }
+    currentLocation = parseHref(destHref, state);
+    next = {
+      href,
+      state,
+      isPush: (next == null ? void 0 : next.isPush) || type === "push"
+    };
+    if (!scheduled) {
+      scheduled = Promise.resolve().then(() => flush());
+    }
+  };
+  const onPushPop = () => {
+    currentLocation = parseLocation();
+    history.notify();
+  };
+  var originalPushState = win.history.pushState;
+  var originalReplaceState = win.history.replaceState;
+  const history = createHistory({
+    getLocation,
+    pushState: (href, state) => queueHistoryAction("push", href, state),
+    replaceState: (href, state) => queueHistoryAction("replace", href, state),
+    back: () => win.history.back(),
+    forward: () => win.history.forward(),
+    go: (n) => win.history.go(n),
+    createHref: (href) => createHref(href),
+    flush,
+    destroy: () => {
+      win.history.pushState = originalPushState;
+      win.history.replaceState = originalReplaceState;
+      win.removeEventListener(pushStateEvent, onPushPop);
+      win.removeEventListener(popStateEvent, onPushPop);
+    },
+    onBlocked: (onUpdate) => {
+      if (rollbackLocation && currentLocation !== rollbackLocation) {
+        currentLocation = rollbackLocation;
+        onUpdate();
+      }
+    }
+  });
+  win.addEventListener(pushStateEvent, onPushPop);
+  win.addEventListener(popStateEvent, onPushPop);
+  win.history.pushState = function() {
+    let res = originalPushState.apply(win.history, arguments);
+    if (tracking)
+      history.notify();
+    return res;
+  };
+  win.history.replaceState = function() {
+    let res = originalReplaceState.apply(win.history, arguments);
+    if (tracking)
+      history.notify();
+    return res;
+  };
+  return history;
+}
+function createHashHistory(opts) {
+  const win = (opts == null ? void 0 : opts.window) ?? (typeof document !== "undefined" ? window : void 0);
+  return createBrowserHistory({
+    window: win,
+    parseLocation: () => {
+      const hashHref = win.location.hash.split("#").slice(1).join("#") ?? "/";
+      return parseHref(hashHref, win.history.state);
+    },
+    createHref: (href) => `${win.location.pathname}${win.location.search}#${href}`
+  });
+}
+function createMemoryHistory(opts = {
+  initialEntries: ["/"]
+}) {
+  const entries = opts.initialEntries;
+  let index = opts.initialIndex ?? entries.length - 1;
+  let currentState = {
+    key: createRandomKey()
+  };
+  const getLocation = () => parseHref(entries[index], currentState);
+  return createHistory({
+    getLocation,
+    pushState: (path, state) => {
+      currentState = state;
+      entries.push(path);
+      index++;
+    },
+    replaceState: (path, state) => {
+      currentState = state;
+      entries[index] = path;
+    },
+    back: () => {
+      index--;
+    },
+    forward: () => {
+      index = Math.min(index + 1, entries.length - 1);
+    },
+    go: (n) => {
+      index = Math.min(Math.max(index + n, 0), entries.length - 1);
+    },
+    createHref: (path) => path
+  });
+}
+function parseHref(href, state) {
+  let hashIndex = href.indexOf("#");
+  let searchIndex = href.indexOf("?");
+  return {
+    href,
+    pathname: href.substring(
+      0,
+      hashIndex > 0 ? searchIndex > 0 ? Math.min(hashIndex, searchIndex) : hashIndex : searchIndex > 0 ? searchIndex : href.length
+    ),
+    hash: hashIndex > -1 ? href.substring(hashIndex) : "",
+    search: searchIndex > -1 ? href.slice(searchIndex, hashIndex === -1 ? void 0 : hashIndex) : "",
+    state: state || {}
+  };
+}
+function createRandomKey() {
+  return (Math.random() + 1).toString(36).substring(7);
+}
+exports.createBrowserHistory = createBrowserHistory;
+exports.createHashHistory = createHashHistory;
+exports.createHistory = createHistory;
+exports.createMemoryHistory = createMemoryHistory;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../../src/index.ts"],"sourcesContent":["// While the public API was clearly inspired by the \"history\" npm package,\n// This implementation attempts to be more lightweight by\n// making assumptions about the way TanStack Router works\n\nexport interface RouterHistory {\n  location: HistoryLocation\n  subscribe: (cb: () => void) => () => void\n  push: (path: string, state?: any) => void\n  replace: (path: string, state?: any) => void\n  go: (index: number) => void\n  back: () => void\n  forward: () => void\n  createHref: (href: string) => string\n  block: (blocker: BlockerFn) => () => void\n  flush: () => void\n  destroy: () => void\n  notify: () => void\n}\n\nexport interface HistoryLocation extends ParsedPath {\n  state: HistoryState\n}\n\nexport interface ParsedPath {\n  href: string\n  pathname: string\n  search: string\n  hash: string\n}\n\nexport interface HistoryState {\n  key: string\n}\n\ntype ShouldAllowNavigation = any\n\nexport type BlockerFn = () =>\n  | Promise<ShouldAllowNavigation>\n  | ShouldAllowNavigation\n\nconst pushStateEvent = 'pushstate'\nconst popStateEvent = 'popstate'\nconst beforeUnloadEvent = 'beforeunload'\n\nconst beforeUnloadListener = (event: Event) => {\n  event.preventDefault()\n  // @ts-ignore\n  return (event.returnValue = '')\n}\n\nconst stopBlocking = () => {\n  removeEventListener(beforeUnloadEvent, beforeUnloadListener, {\n    capture: true,\n  })\n}\n\nexport function createHistory(opts: {\n  getLocation: () => HistoryLocation\n  pushState: (path: string, state: any) => void\n  replaceState: (path: string, state: any) => void\n  go: (n: number) => void\n  back: () => void\n  forward: () => void\n  createHref: (path: string) => string\n  flush?: () => void\n  destroy?: () => void\n  onBlocked?: (onUpdate: () => void) => void\n}): RouterHistory {\n  let location = opts.getLocation()\n  let subscribers = new Set<() => void>()\n  let blockers: BlockerFn[] = []\n\n  const onUpdate = () => {\n    location = opts.getLocation()\n    subscribers.forEach((subscriber) => subscriber())\n  }\n\n  const tryNavigation = async (task: () => void) => {\n    if (typeof document !== 'undefined' && blockers.length) {\n      for (let blocker of blockers) {\n        const allowed = await blocker()\n        if (!allowed) {\n          opts.onBlocked?.(onUpdate)\n          return\n        }\n      }\n    }\n\n    task()\n  }\n\n  return {\n    get location() {\n      return location\n    },\n    subscribe: (cb: () => void) => {\n      subscribers.add(cb)\n\n      return () => {\n        subscribers.delete(cb)\n      }\n    },\n    push: (path: string, state: any) => {\n      state = assignKey(state)\n      tryNavigation(() => {\n        opts.pushState(path, state)\n        onUpdate()\n      })\n    },\n    replace: (path: string, state: any) => {\n      state = assignKey(state)\n      tryNavigation(() => {\n        opts.replaceState(path, state)\n        onUpdate()\n      })\n    },\n    go: (index) => {\n      tryNavigation(() => {\n        opts.go(index)\n      })\n    },\n    back: () => {\n      tryNavigation(() => {\n        opts.back()\n      })\n    },\n    forward: () => {\n      tryNavigation(() => {\n        opts.forward()\n      })\n    },\n    createHref: (str) => opts.createHref(str),\n    block: (blocker) => {\n      blockers.push(blocker)\n\n      if (blockers.length === 1) {\n        addEventListener(beforeUnloadEvent, beforeUnloadListener, {\n          capture: true,\n        })\n      }\n\n      return () => {\n        blockers = blockers.filter((b) => b !== blocker)\n\n        if (!blockers.length) {\n          stopBlocking()\n        }\n      }\n    },\n    flush: () => opts.flush?.(),\n    destroy: () => opts.destroy?.(),\n    notify: onUpdate,\n  }\n}\n\nfunction assignKey(state: HistoryState) {\n  if (!state) {\n    state = {} as HistoryState\n  }\n  return {\n    ...state,\n    key: createRandomKey(),\n  }\n}\n\n/**\n * Creates a history object that can be used to interact with the browser's\n * navigation. This is a lightweight API wrapping the browser's native methods.\n * It is designed to work with TanStack Router, but could be used as a standalone API as well.\n * IMPORTANT: This API implements history throttling via a microtask to prevent\n * excessive calls to the history API. In some browsers, calling history.pushState or\n * history.replaceState in quick succession can cause the browser to ignore subsequent\n * calls. This API smooths out those differences and ensures that your application\n * state will *eventually* match the browser state. In most cases, this is not a problem,\n * but if you need to ensure that the browser state is up to date, you can use the\n * `history.flush` method to immediately flush all pending state changes to the browser URL.\n * @param opts\n * @param opts.getHref A function that returns the current href (path + search + hash)\n * @param opts.createHref A function that takes a path and returns a href (path + search + hash)\n * @returns A history instance\n */\nexport function createBrowserHistory(opts?: {\n  parseLocation?: () => HistoryLocation\n  createHref?: (path: string) => string\n  window?: any\n}): RouterHistory {\n  const win =\n    opts?.window ??\n    (typeof document !== 'undefined' ? window : (undefined as any))\n\n  const createHref = opts?.createHref ?? ((path) => path)\n  const parseLocation =\n    opts?.parseLocation ??\n    (() =>\n      parseHref(\n        `${win.location.pathname}${win.location.search}${win.location.hash}`,\n        win.history.state,\n      ))\n\n  let currentLocation = parseLocation()\n  let rollbackLocation: HistoryLocation | undefined\n\n  const getLocation = () => currentLocation\n\n  let next:\n    | undefined\n    | {\n        // This is the latest location that we were attempting to push/replace\n        href: string\n        // This is the latest state that we were attempting to push/replace\n        state: any\n        // This is the latest type that we were attempting to push/replace\n        isPush: boolean\n      }\n\n  // Because we are proactively updating the location\n  // in memory before actually updating the browser history,\n  // we need to track when we are doing this so we don't\n  // notify subscribers twice on the last update.\n  let tracking = true\n\n  // We need to track the current scheduled update to prevent\n  // multiple updates from being scheduled at the same time.\n  let scheduled: Promise<void> | undefined\n\n  // This function is a wrapper to prevent any of the callback's\n  // side effects from causing a subscriber notification\n  const untrack = (fn: () => void) => {\n    tracking = false\n    fn()\n    tracking = true\n  }\n\n  // This function flushes the next update to the browser history\n  const flush = () => {\n    // Do not notify subscribers about this push/replace call\n    untrack(() => {\n      if (!next) return\n      win.history[next.isPush ? 'pushState' : 'replaceState'](\n        next.state,\n        '',\n        next.href,\n      )\n      // Reset the nextIsPush flag and clear the scheduled update\n      next = undefined\n      scheduled = undefined\n      rollbackLocation = undefined\n    })\n  }\n\n  // This function queues up a call to update the browser history\n  const queueHistoryAction = (\n    type: 'push' | 'replace',\n    destHref: string,\n    state: any,\n  ) => {\n    const href = createHref(destHref)\n\n    if (!scheduled) {\n      rollbackLocation = currentLocation\n    }\n\n    // Update the location in memory\n    currentLocation = parseHref(destHref, state)\n\n    // Keep track of the next location we need to flush to the URL\n    next = {\n      href,\n      state,\n      isPush: next?.isPush || type === 'push',\n    }\n\n    if (!scheduled) {\n      // Schedule an update to the browser history\n      scheduled = Promise.resolve().then(() => flush())\n    }\n  }\n\n  const onPushPop = () => {\n    currentLocation = parseLocation()\n    history.notify()\n  }\n\n  var originalPushState = win.history.pushState\n  var originalReplaceState = win.history.replaceState\n\n  const history = createHistory({\n    getLocation,\n    pushState: (href, state) => queueHistoryAction('push', href, state),\n    replaceState: (href, state) => queueHistoryAction('replace', href, state),\n    back: () => win.history.back(),\n    forward: () => win.history.forward(),\n    go: (n) => win.history.go(n),\n    createHref: (href) => createHref(href),\n    flush,\n    destroy: () => {\n      win.history.pushState = originalPushState\n      win.history.replaceState = originalReplaceState\n      win.removeEventListener(pushStateEvent, onPushPop)\n      win.removeEventListener(popStateEvent, onPushPop)\n    },\n    onBlocked: (onUpdate) => {\n      // If a navigation is blocked, we need to rollback the location\n      // that we optimistically updated in memory.\n      if (rollbackLocation && currentLocation !== rollbackLocation) {\n        currentLocation = rollbackLocation\n        // Notify subscribers\n        onUpdate()\n      }\n    },\n  })\n\n  win.addEventListener(pushStateEvent, onPushPop)\n  win.addEventListener(popStateEvent, onPushPop)\n\n  win.history.pushState = function () {\n    let res = originalPushState.apply(win.history, arguments as any)\n    if (tracking) history.notify()\n    return res\n  }\n\n  win.history.replaceState = function () {\n    let res = originalReplaceState.apply(win.history, arguments as any)\n    if (tracking) history.notify()\n    return res\n  }\n\n  return history\n}\n\nexport function createHashHistory(opts?: { window?: any }): RouterHistory {\n  const win =\n    opts?.window ??\n    (typeof document !== 'undefined' ? window : (undefined as any))\n  return createBrowserHistory({\n    window: win,\n    parseLocation: () => {\n      const hashHref = win.location.hash.split('#').slice(1).join('#') ?? '/'\n      return parseHref(hashHref, win.history.state)\n    },\n    createHref: (href) =>\n      `${win.location.pathname}${win.location.search}#${href}`,\n  })\n}\n\nexport function createMemoryHistory(\n  opts: {\n    initialEntries: string[]\n    initialIndex?: number\n  } = {\n    initialEntries: ['/'],\n  },\n): RouterHistory {\n  const entries = opts.initialEntries\n  let index = opts.initialIndex ?? entries.length - 1\n  let currentState = {\n    key: createRandomKey(),\n  } as HistoryState\n\n  const getLocation = () => parseHref(entries[index]!, currentState)\n\n  return createHistory({\n    getLocation,\n\n    pushState: (path, state) => {\n      currentState = state\n      entries.push(path)\n      index++\n    },\n    replaceState: (path, state) => {\n      currentState = state\n      entries[index] = path\n    },\n    back: () => {\n      index--\n    },\n    forward: () => {\n      index = Math.min(index + 1, entries.length - 1)\n    },\n    go: (n) => {\n      index = Math.min(Math.max(index + n, 0), entries.length - 1)\n    },\n    createHref: (path) => path,\n  })\n}\n\nfunction parseHref(href: string, state: HistoryState): HistoryLocation {\n  let hashIndex = href.indexOf('#')\n  let searchIndex = href.indexOf('?')\n\n  return {\n    href,\n    pathname: href.substring(\n      0,\n      hashIndex > 0\n        ? searchIndex > 0\n          ? Math.min(hashIndex, searchIndex)\n          : hashIndex\n        : searchIndex > 0\n          ? searchIndex\n          : href.length,\n    ),\n    hash: hashIndex > -1 ? href.substring(hashIndex) : '',\n    search:\n      searchIndex > -1\n        ? href.slice(searchIndex, hashIndex === -1 ? undefined : hashIndex)\n        : '',\n    state: state || {},\n  }\n}\n\n// Thanks co-pilot!\nfunction createRandomKey() {\n  return (Math.random() + 1).toString(36).substring(7)\n}\n"],"names":[],"mappings":";;AAwCA,MAAM,iBAAiB;AACvB,MAAM,gBAAgB;AACtB,MAAM,oBAAoB;AAE1B,MAAM,uBAAuB,CAAC,UAAiB;AAC7C,QAAM,eAAe;AAErB,SAAQ,MAAM,cAAc;AAC9B;AAEA,MAAM,eAAe,MAAM;AACzB,sBAAoB,mBAAmB,sBAAsB;AAAA,IAC3D,SAAS;AAAA,EAAA,CACV;AACH;AAEO,SAAS,cAAc,MAWZ;AACZ,MAAA,WAAW,KAAK;AAChB,MAAA,kCAAkB;AACtB,MAAI,WAAwB,CAAA;AAE5B,QAAM,WAAW,MAAM;AACrB,eAAW,KAAK;AAChB,gBAAY,QAAQ,CAAC,eAAe,WAAY,CAAA;AAAA,EAAA;AAG5C,QAAA,gBAAgB,OAAO,SAAqB;;AAChD,QAAI,OAAO,aAAa,eAAe,SAAS,QAAQ;AACtD,eAAS,WAAW,UAAU;AACtB,cAAA,UAAU,MAAM;AACtB,YAAI,CAAC,SAAS;AACZ,qBAAK,cAAL,8BAAiB;AACjB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEK;EAAA;AAGA,SAAA;AAAA,IACL,IAAI,WAAW;AACN,aAAA;AAAA,IACT;AAAA,IACA,WAAW,CAAC,OAAmB;AAC7B,kBAAY,IAAI,EAAE;AAElB,aAAO,MAAM;AACX,oBAAY,OAAO,EAAE;AAAA,MAAA;AAAA,IAEzB;AAAA,IACA,MAAM,CAAC,MAAc,UAAe;AAClC,cAAQ,UAAU,KAAK;AACvB,oBAAc,MAAM;AACb,aAAA,UAAU,MAAM,KAAK;AACjB;MAAA,CACV;AAAA,IACH;AAAA,IACA,SAAS,CAAC,MAAc,UAAe;AACrC,cAAQ,UAAU,KAAK;AACvB,oBAAc,MAAM;AACb,aAAA,aAAa,MAAM,KAAK;AACpB;MAAA,CACV;AAAA,IACH;AAAA,IACA,IAAI,CAAC,UAAU;AACb,oBAAc,MAAM;AAClB,aAAK,GAAG,KAAK;AAAA,MAAA,CACd;AAAA,IACH;AAAA,IACA,MAAM,MAAM;AACV,oBAAc,MAAM;AAClB,aAAK,KAAK;AAAA,MAAA,CACX;AAAA,IACH;AAAA,IACA,SAAS,MAAM;AACb,oBAAc,MAAM;AAClB,aAAK,QAAQ;AAAA,MAAA,CACd;AAAA,IACH;AAAA,IACA,YAAY,CAAC,QAAQ,KAAK,WAAW,GAAG;AAAA,IACxC,OAAO,CAAC,YAAY;AAClB,eAAS,KAAK,OAAO;AAEjB,UAAA,SAAS,WAAW,GAAG;AACzB,yBAAiB,mBAAmB,sBAAsB;AAAA,UACxD,SAAS;AAAA,QAAA,CACV;AAAA,MACH;AAEA,aAAO,MAAM;AACX,mBAAW,SAAS,OAAO,CAAC,MAAM,MAAM,OAAO;AAE3C,YAAA,CAAC,SAAS,QAAQ;AACP;QACf;AAAA,MAAA;AAAA,IAEJ;AAAA,IACA,OAAO,MAAA;;AAAM,wBAAK,UAAL;AAAA;AAAA,IACb,SAAS,MAAA;;AAAM,wBAAK,YAAL;AAAA;AAAA,IACf,QAAQ;AAAA,EAAA;AAEZ;AAEA,SAAS,UAAU,OAAqB;AACtC,MAAI,CAAC,OAAO;AACV,YAAQ,CAAA;AAAA,EACV;AACO,SAAA;AAAA,IACL,GAAG;AAAA,IACH,KAAK,gBAAgB;AAAA,EAAA;AAEzB;AAkBO,SAAS,qBAAqB,MAInB;AAChB,QAAM,OACJ,6BAAM,YACL,OAAO,aAAa,cAAc,SAAU;AAE/C,QAAM,cAAa,6BAAM,gBAAe,CAAC,SAAS;AAC5C,QAAA,iBACJ,6BAAM,mBACL,MACC;AAAA,IACE,GAAG,IAAI,SAAS,QAAQ,GAAG,IAAI,SAAS,MAAM,GAAG,IAAI,SAAS,IAAI;AAAA,IAClE,IAAI,QAAQ;AAAA,EAAA;AAGlB,MAAI,kBAAkB;AAClB,MAAA;AAEJ,QAAM,cAAc,MAAM;AAEtB,MAAA;AAeJ,MAAI,WAAW;AAIX,MAAA;AAIE,QAAA,UAAU,CAAC,OAAmB;AACvB,eAAA;AACR;AACQ,eAAA;AAAA,EAAA;AAIb,QAAM,QAAQ,MAAM;AAElB,YAAQ,MAAM;AACZ,UAAI,CAAC;AAAM;AACX,UAAI,QAAQ,KAAK,SAAS,cAAc,cAAc;AAAA,QACpD,KAAK;AAAA,QACL;AAAA,QACA,KAAK;AAAA,MAAA;AAGA,aAAA;AACK,kBAAA;AACO,yBAAA;AAAA,IAAA,CACpB;AAAA,EAAA;AAIH,QAAM,qBAAqB,CACzB,MACA,UACA,UACG;AACG,UAAA,OAAO,WAAW,QAAQ;AAEhC,QAAI,CAAC,WAAW;AACK,yBAAA;AAAA,IACrB;AAGkB,sBAAA,UAAU,UAAU,KAAK;AAGpC,WAAA;AAAA,MACL;AAAA,MACA;AAAA,MACA,SAAQ,6BAAM,WAAU,SAAS;AAAA,IAAA;AAGnC,QAAI,CAAC,WAAW;AAEd,kBAAY,QAAQ,QAAQ,EAAE,KAAK,MAAM,OAAO;AAAA,IAClD;AAAA,EAAA;AAGF,QAAM,YAAY,MAAM;AACtB,sBAAkB,cAAc;AAChC,YAAQ,OAAO;AAAA,EAAA;AAGb,MAAA,oBAAoB,IAAI,QAAQ;AAChC,MAAA,uBAAuB,IAAI,QAAQ;AAEvC,QAAM,UAAU,cAAc;AAAA,IAC5B;AAAA,IACA,WAAW,CAAC,MAAM,UAAU,mBAAmB,QAAQ,MAAM,KAAK;AAAA,IAClE,cAAc,CAAC,MAAM,UAAU,mBAAmB,WAAW,MAAM,KAAK;AAAA,IACxE,MAAM,MAAM,IAAI,QAAQ,KAAK;AAAA,IAC7B,SAAS,MAAM,IAAI,QAAQ,QAAQ;AAAA,IACnC,IAAI,CAAC,MAAM,IAAI,QAAQ,GAAG,CAAC;AAAA,IAC3B,YAAY,CAAC,SAAS,WAAW,IAAI;AAAA,IACrC;AAAA,IACA,SAAS,MAAM;AACb,UAAI,QAAQ,YAAY;AACxB,UAAI,QAAQ,eAAe;AACvB,UAAA,oBAAoB,gBAAgB,SAAS;AAC7C,UAAA,oBAAoB,eAAe,SAAS;AAAA,IAClD;AAAA,IACA,WAAW,CAAC,aAAa;AAGnB,UAAA,oBAAoB,oBAAoB,kBAAkB;AAC1C,0BAAA;AAET;MACX;AAAA,IACF;AAAA,EAAA,CACD;AAEG,MAAA,iBAAiB,gBAAgB,SAAS;AAC1C,MAAA,iBAAiB,eAAe,SAAS;AAEzC,MAAA,QAAQ,YAAY,WAAY;AAClC,QAAI,MAAM,kBAAkB,MAAM,IAAI,SAAS,SAAgB;AAC3D,QAAA;AAAU,cAAQ,OAAO;AACtB,WAAA;AAAA,EAAA;AAGL,MAAA,QAAQ,eAAe,WAAY;AACrC,QAAI,MAAM,qBAAqB,MAAM,IAAI,SAAS,SAAgB;AAC9D,QAAA;AAAU,cAAQ,OAAO;AACtB,WAAA;AAAA,EAAA;AAGF,SAAA;AACT;AAEO,SAAS,kBAAkB,MAAwC;AACxE,QAAM,OACJ,6BAAM,YACL,OAAO,aAAa,cAAc,SAAU;AAC/C,SAAO,qBAAqB;AAAA,IAC1B,QAAQ;AAAA,IACR,eAAe,MAAM;AACnB,YAAM,WAAW,IAAI,SAAS,KAAK,MAAM,GAAG,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK;AACpE,aAAO,UAAU,UAAU,IAAI,QAAQ,KAAK;AAAA,IAC9C;AAAA,IACA,YAAY,CAAC,SACX,GAAG,IAAI,SAAS,QAAQ,GAAG,IAAI,SAAS,MAAM,IAAI,IAAI;AAAA,EAAA,CACzD;AACH;AAEO,SAAS,oBACd,OAGI;AAAA,EACF,gBAAgB,CAAC,GAAG;AACtB,GACe;AACf,QAAM,UAAU,KAAK;AACrB,MAAI,QAAQ,KAAK,gBAAgB,QAAQ,SAAS;AAClD,MAAI,eAAe;AAAA,IACjB,KAAK,gBAAgB;AAAA,EAAA;AAGvB,QAAM,cAAc,MAAM,UAAU,QAAQ,KAAK,GAAI,YAAY;AAEjE,SAAO,cAAc;AAAA,IACnB;AAAA,IAEA,WAAW,CAAC,MAAM,UAAU;AACX,qBAAA;AACf,cAAQ,KAAK,IAAI;AACjB;AAAA,IACF;AAAA,IACA,cAAc,CAAC,MAAM,UAAU;AACd,qBAAA;AACf,cAAQ,KAAK,IAAI;AAAA,IACnB;AAAA,IACA,MAAM,MAAM;AACV;AAAA,IACF;AAAA,IACA,SAAS,MAAM;AACb,cAAQ,KAAK,IAAI,QAAQ,GAAG,QAAQ,SAAS,CAAC;AAAA,IAChD;AAAA,IACA,IAAI,CAAC,MAAM;AACD,cAAA,KAAK,IAAI,KAAK,IAAI,QAAQ,GAAG,CAAC,GAAG,QAAQ,SAAS,CAAC;AAAA,IAC7D;AAAA,IACA,YAAY,CAAC,SAAS;AAAA,EAAA,CACvB;AACH;AAEA,SAAS,UAAU,MAAc,OAAsC;AACjE,MAAA,YAAY,KAAK,QAAQ,GAAG;AAC5B,MAAA,cAAc,KAAK,QAAQ,GAAG;AAE3B,SAAA;AAAA,IACL;AAAA,IACA,UAAU,KAAK;AAAA,MACb;AAAA,MACA,YAAY,IACR,cAAc,IACZ,KAAK,IAAI,WAAW,WAAW,IAC/B,YACF,cAAc,IACZ,cACA,KAAK;AAAA,IACb;AAAA,IACA,MAAM,YAAY,KAAK,KAAK,UAAU,SAAS,IAAI;AAAA,IACnD,QACE,cAAc,KACV,KAAK,MAAM,aAAa,cAAc,KAAK,SAAY,SAAS,IAChE;AAAA,IACN,OAAO,SAAS,CAAC;AAAA,EAAA;AAErB;AAGA,SAAS,kBAAkB;AACjB,UAAA,KAAK,WAAW,GAAG,SAAS,EAAE,EAAE,UAAU,CAAC;AACrD;;;;;"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,69 @@
+export interface RouterHistory {
+    location: HistoryLocation;
+    subscribe: (cb: () => void) => () => void;
+    push: (path: string, state?: any) => void;
+    replace: (path: string, state?: any) => void;
+    go: (index: number) => void;
+    back: () => void;
+    forward: () => void;
+    createHref: (href: string) => string;
+    block: (blocker: BlockerFn) => () => void;
+    flush: () => void;
+    destroy: () => void;
+    notify: () => void;
+}
+export interface HistoryLocation extends ParsedPath {
+    state: HistoryState;
+}
+export interface ParsedPath {
+    href: string;
+    pathname: string;
+    search: string;
+    hash: string;
+}
+export interface HistoryState {
+    key: string;
+}
+type ShouldAllowNavigation = any;
+export type BlockerFn = () => Promise<ShouldAllowNavigation> | ShouldAllowNavigation;
+export declare function createHistory(opts: {
+    getLocation: () => HistoryLocation;
+    pushState: (path: string, state: any) => void;
+    replaceState: (path: string, state: any) => void;
+    go: (n: number) => void;
+    back: () => void;
+    forward: () => void;
+    createHref: (path: string) => string;
+    flush?: () => void;
+    destroy?: () => void;
+    onBlocked?: (onUpdate: () => void) => void;
+}): RouterHistory;
+/**
+ * Creates a history object that can be used to interact with the browser's
+ * navigation. This is a lightweight API wrapping the browser's native methods.
+ * It is designed to work with TanStack Router, but could be used as a standalone API as well.
+ * IMPORTANT: This API implements history throttling via a microtask to prevent
+ * excessive calls to the history API. In some browsers, calling history.pushState or
+ * history.replaceState in quick succession can cause the browser to ignore subsequent
+ * calls. This API smooths out those differences and ensures that your application
+ * state will *eventually* match the browser state. In most cases, this is not a problem,
+ * but if you need to ensure that the browser state is up to date, you can use the
+ * `history.flush` method to immediately flush all pending state changes to the browser URL.
+ * @param opts
+ * @param opts.getHref A function that returns the current href (path + search + hash)
+ * @param opts.createHref A function that takes a path and returns a href (path + search + hash)
+ * @returns A history instance
+ */
+export declare function createBrowserHistory(opts?: {
+    parseLocation?: () => HistoryLocation;
+    createHref?: (path: string) => string;
+    window?: any;
+}): RouterHistory;
+export declare function createHashHistory(opts?: {
+    window?: any;
+}): RouterHistory;
+export declare function createMemoryHistory(opts?: {
+    initialEntries: string[];
+    initialIndex?: number;
+}): RouterHistory;
+export {};

package/{build/types → dist/esm}/index.d.ts

@@ -1,14 +1,4 @@
-/**
- * @tanstack/history/src/index.ts
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-interface RouterHistory {
+export interface RouterHistory {
     location: HistoryLocation;
     subscribe: (cb: () => void) => () => void;
     push: (path: string, state?: any) => void;
@@ -22,21 +12,21 @@ interface RouterHistory {
     destroy: () => void;
     notify: () => void;
 }
-interface HistoryLocation extends ParsedPath {
+export interface HistoryLocation extends ParsedPath {
     state: HistoryState;
 }
-interface ParsedPath {
+export interface ParsedPath {
     href: string;
     pathname: string;
     search: string;
     hash: string;
 }
-interface HistoryState {
+export interface HistoryState {
     key: string;
 }
 type ShouldAllowNavigation = any;
-type BlockerFn = () => Promise<ShouldAllowNavigation> | ShouldAllowNavigation;
-declare function createHistory(opts: {
+export type BlockerFn = () => Promise<ShouldAllowNavigation> | ShouldAllowNavigation;
+export declare function createHistory(opts: {
     getLocation: () => HistoryLocation;
     pushState: (path: string, state: any) => void;
     replaceState: (path: string, state: any) => void;
@@ -64,17 +54,16 @@ declare function createHistory(opts: {
  * @param opts.createHref A function that takes a path and returns a href (path + search + hash)
  * @returns A history instance
  */
-declare function createBrowserHistory(opts?: {
+export declare function createBrowserHistory(opts?: {
     parseLocation?: () => HistoryLocation;
     createHref?: (path: string) => string;
     window?: any;
 }): RouterHistory;
-declare function createHashHistory(opts?: {
+export declare function createHashHistory(opts?: {
     window?: any;
 }): RouterHistory;
-declare function createMemoryHistory(opts?: {
+export declare function createMemoryHistory(opts?: {
     initialEntries: string[];
     initialIndex?: number;
 }): RouterHistory;
-
-export { type BlockerFn, type HistoryLocation, type HistoryState, type ParsedPath, type RouterHistory, createBrowserHistory, createHashHistory, createHistory, createMemoryHistory };
+export {};

package/dist/esm/index.js

@@ -0,0 +1,265 @@
+const pushStateEvent = "pushstate";
+const popStateEvent = "popstate";
+const beforeUnloadEvent = "beforeunload";
+const beforeUnloadListener = (event) => {
+  event.preventDefault();
+  return event.returnValue = "";
+};
+const stopBlocking = () => {
+  removeEventListener(beforeUnloadEvent, beforeUnloadListener, {
+    capture: true
+  });
+};
+function createHistory(opts) {
+  let location = opts.getLocation();
+  let subscribers = /* @__PURE__ */ new Set();
+  let blockers = [];
+  const onUpdate = () => {
+    location = opts.getLocation();
+    subscribers.forEach((subscriber) => subscriber());
+  };
+  const tryNavigation = async (task) => {
+    var _a;
+    if (typeof document !== "undefined" && blockers.length) {
+      for (let blocker of blockers) {
+        const allowed = await blocker();
+        if (!allowed) {
+          (_a = opts.onBlocked) == null ? void 0 : _a.call(opts, onUpdate);
+          return;
+        }
+      }
+    }
+    task();
+  };
+  return {
+    get location() {
+      return location;
+    },
+    subscribe: (cb) => {
+      subscribers.add(cb);
+      return () => {
+        subscribers.delete(cb);
+      };
+    },
+    push: (path, state) => {
+      state = assignKey(state);
+      tryNavigation(() => {
+        opts.pushState(path, state);
+        onUpdate();
+      });
+    },
+    replace: (path, state) => {
+      state = assignKey(state);
+      tryNavigation(() => {
+        opts.replaceState(path, state);
+        onUpdate();
+      });
+    },
+    go: (index) => {
+      tryNavigation(() => {
+        opts.go(index);
+      });
+    },
+    back: () => {
+      tryNavigation(() => {
+        opts.back();
+      });
+    },
+    forward: () => {
+      tryNavigation(() => {
+        opts.forward();
+      });
+    },
+    createHref: (str) => opts.createHref(str),
+    block: (blocker) => {
+      blockers.push(blocker);
+      if (blockers.length === 1) {
+        addEventListener(beforeUnloadEvent, beforeUnloadListener, {
+          capture: true
+        });
+      }
+      return () => {
+        blockers = blockers.filter((b) => b !== blocker);
+        if (!blockers.length) {
+          stopBlocking();
+        }
+      };
+    },
+    flush: () => {
+      var _a;
+      return (_a = opts.flush) == null ? void 0 : _a.call(opts);
+    },
+    destroy: () => {
+      var _a;
+      return (_a = opts.destroy) == null ? void 0 : _a.call(opts);
+    },
+    notify: onUpdate
+  };
+}
+function assignKey(state) {
+  if (!state) {
+    state = {};
+  }
+  return {
+    ...state,
+    key: createRandomKey()
+  };
+}
+function createBrowserHistory(opts) {
+  const win = (opts == null ? void 0 : opts.window) ?? (typeof document !== "undefined" ? window : void 0);
+  const createHref = (opts == null ? void 0 : opts.createHref) ?? ((path) => path);
+  const parseLocation = (opts == null ? void 0 : opts.parseLocation) ?? (() => parseHref(
+    `${win.location.pathname}${win.location.search}${win.location.hash}`,
+    win.history.state
+  ));
+  let currentLocation = parseLocation();
+  let rollbackLocation;
+  const getLocation = () => currentLocation;
+  let next;
+  let tracking = true;
+  let scheduled;
+  const untrack = (fn) => {
+    tracking = false;
+    fn();
+    tracking = true;
+  };
+  const flush = () => {
+    untrack(() => {
+      if (!next)
+        return;
+      win.history[next.isPush ? "pushState" : "replaceState"](
+        next.state,
+        "",
+        next.href
+      );
+      next = void 0;
+      scheduled = void 0;
+      rollbackLocation = void 0;
+    });
+  };
+  const queueHistoryAction = (type, destHref, state) => {
+    const href = createHref(destHref);
+    if (!scheduled) {
+      rollbackLocation = currentLocation;
+    }
+    currentLocation = parseHref(destHref, state);
+    next = {
+      href,
+      state,
+      isPush: (next == null ? void 0 : next.isPush) || type === "push"
+    };
+    if (!scheduled) {
+      scheduled = Promise.resolve().then(() => flush());
+    }
+  };
+  const onPushPop = () => {
+    currentLocation = parseLocation();
+    history.notify();
+  };
+  var originalPushState = win.history.pushState;
+  var originalReplaceState = win.history.replaceState;
+  const history = createHistory({
+    getLocation,
+    pushState: (href, state) => queueHistoryAction("push", href, state),
+    replaceState: (href, state) => queueHistoryAction("replace", href, state),
+    back: () => win.history.back(),
+    forward: () => win.history.forward(),
+    go: (n) => win.history.go(n),
+    createHref: (href) => createHref(href),
+    flush,
+    destroy: () => {
+      win.history.pushState = originalPushState;
+      win.history.replaceState = originalReplaceState;
+      win.removeEventListener(pushStateEvent, onPushPop);
+      win.removeEventListener(popStateEvent, onPushPop);
+    },
+    onBlocked: (onUpdate) => {
+      if (rollbackLocation && currentLocation !== rollbackLocation) {
+        currentLocation = rollbackLocation;
+        onUpdate();
+      }
+    }
+  });
+  win.addEventListener(pushStateEvent, onPushPop);
+  win.addEventListener(popStateEvent, onPushPop);
+  win.history.pushState = function() {
+    let res = originalPushState.apply(win.history, arguments);
+    if (tracking)
+      history.notify();
+    return res;
+  };
+  win.history.replaceState = function() {
+    let res = originalReplaceState.apply(win.history, arguments);
+    if (tracking)
+      history.notify();
+    return res;
+  };
+  return history;
+}
+function createHashHistory(opts) {
+  const win = (opts == null ? void 0 : opts.window) ?? (typeof document !== "undefined" ? window : void 0);
+  return createBrowserHistory({
+    window: win,
+    parseLocation: () => {
+      const hashHref = win.location.hash.split("#").slice(1).join("#") ?? "/";
+      return parseHref(hashHref, win.history.state);
+    },
+    createHref: (href) => `${win.location.pathname}${win.location.search}#${href}`
+  });
+}
+function createMemoryHistory(opts = {
+  initialEntries: ["/"]
+}) {
+  const entries = opts.initialEntries;
+  let index = opts.initialIndex ?? entries.length - 1;
+  let currentState = {
+    key: createRandomKey()
+  };
+  const getLocation = () => parseHref(entries[index], currentState);
+  return createHistory({
+    getLocation,
+    pushState: (path, state) => {
+      currentState = state;
+      entries.push(path);
+      index++;
+    },
+    replaceState: (path, state) => {
+      currentState = state;
+      entries[index] = path;
+    },
+    back: () => {
+      index--;
+    },
+    forward: () => {
+      index = Math.min(index + 1, entries.length - 1);
+    },
+    go: (n) => {
+      index = Math.min(Math.max(index + n, 0), entries.length - 1);
+    },
+    createHref: (path) => path
+  });
+}
+function parseHref(href, state) {
+  let hashIndex = href.indexOf("#");
+  let searchIndex = href.indexOf("?");
+  return {
+    href,
+    pathname: href.substring(
+      0,
+      hashIndex > 0 ? searchIndex > 0 ? Math.min(hashIndex, searchIndex) : hashIndex : searchIndex > 0 ? searchIndex : href.length
+    ),
+    hash: hashIndex > -1 ? href.substring(hashIndex) : "",
+    search: searchIndex > -1 ? href.slice(searchIndex, hashIndex === -1 ? void 0 : hashIndex) : "",
+    state: state || {}
+  };
+}
+function createRandomKey() {
+  return (Math.random() + 1).toString(36).substring(7);
+}
+export {
+  createBrowserHistory,
+  createHashHistory,
+  createHistory,
+  createMemoryHistory
+};
+//# sourceMappingURL=index.js.map