@idevconn/use-draft 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by interface) to the interfaces
+      of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 iDEVconn
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,99 @@
+# @idevconn/use-draft
+
+Global unsaved-changes blocker for [TanStack Router](https://tanstack.com/router) SPAs.
+
+Aggregates dirty state from every mounted form via a [Zustand](https://zustand.docs.pmnd.rs/) store and blocks both:
+
+- **In-app navigation** through `useBlocker` (renders your own confirm dialog).
+- **Browser refresh / tab-close** through `beforeunload` (native dialog).
+
+Any component on the page can subscribe to the aggregate `isDirty` state — useful for showing an upload-in-progress indicator outside the form tree.
+
+## Install
+
+```bash
+npm install @idevconn/use-draft
+```
+
+Peer dependencies: `react >= 18`, `@tanstack/react-router >= 1.100`, `zustand >= 4`.
+
+## Usage
+
+### Inside a form
+
+```tsx
+import { useDraft } from "@idevconn/use-draft";
+import { useForm } from "react-hook-form";
+
+function ProductForm() {
+  const form = useForm<ProductInput>();
+  const { showDialog, confirmLeave, cancelLeave } = useDraft(form.formState.isDirty);
+
+  return (
+    <>
+      <form onSubmit={...}>{/* ... */}</form>
+      {showDialog && (
+        <ConfirmDialog
+          message="You have unsaved changes. Leave anyway?"
+          onConfirm={confirmLeave}
+          onCancel={cancelLeave}
+        />
+      )}
+    </>
+  );
+}
+```
+
+### When the dirty flag changes inside the navigation handler
+
+If you set the dirty state synchronously **right before** triggering navigation (e.g. on save), pass a **getter function**. `useBlocker` invokes the predicate lazily, so the getter sees the latest value before React has had a chance to re-render.
+
+```tsx
+const savedRef = useRef(false);
+useDraft(() => form.formState.isDirty && !savedRef.current);
+
+async function onSubmit(values: ProductInput) {
+  await mutation.mutateAsync(values);
+  savedRef.current = true; // synchronous
+  navigate({ to: "/products" }); // not blocked
+}
+```
+
+### Reading the aggregate state
+
+```tsx
+import { useDraftStore } from "@idevconn/use-draft";
+
+function UploadIndicator() {
+  const isDirty = useDraftStore((s) => s.isDirty);
+  return isDirty ? <span>Saving…</span> : null;
+}
+```
+
+## API
+
+### `useDraft(isDirty)`
+
+| Argument  | Type                          | Description                                                          |
+| --------- | ----------------------------- | -------------------------------------------------------------------- |
+| `isDirty` | `boolean \| (() => boolean)`  | Current dirty state, or a getter evaluated lazily on each navigation attempt. |
+
+Returns `{ showDialog, confirmLeave, cancelLeave }`. `showDialog` is `true` while navigation is held; call `confirmLeave()` to release it or `cancelLeave()` to stay.
+
+Side effects per mount:
+
+- Registers a synthetic form ID (`useId`) in the global `useDraftStore`.
+- Hooks `useBlocker({ shouldBlockFn, withResolver: true })`.
+- Adds a `beforeunload` listener that vetoes the unload when the aggregate `isDirty` is true.
+
+### `useDraftStore`
+
+A Zustand store exposing `{ dirtyForms, isDirty, markDirty, markClean, reset }`. Read-only for most consumers; the hook owns writes.
+
+## Why a global store?
+
+Multiple independent forms on the same page (a product edit form and an inline avatar uploader, say) each need to block navigation. Tracking the state per-component means each one only knows about its own dirty flag — the avatar uploader can't block when only the product form is dirty. The global store aggregates: any one dirty → page-level block.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  useDraft: () => useDraft,
+  useDraftStore: () => useDraftStore
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/use-draft.ts
+var import_react = require("react");
+var import_react_router = require("@tanstack/react-router");
+
+// src/store.ts
+var import_zustand = require("zustand");
+var useDraftStore = (0, import_zustand.create)()((set) => ({
+  dirtyForms: /* @__PURE__ */ new Set(),
+  isDirty: false,
+  markDirty: (formId) => set((state) => {
+    if (state.dirtyForms.has(formId)) return state;
+    const next = new Set(state.dirtyForms);
+    next.add(formId);
+    return { dirtyForms: next, isDirty: next.size > 0 };
+  }),
+  markClean: (formId) => set((state) => {
+    if (!state.dirtyForms.has(formId)) return state;
+    const next = new Set(state.dirtyForms);
+    next.delete(formId);
+    return { dirtyForms: next, isDirty: next.size > 0 };
+  }),
+  reset: () => set({ dirtyForms: /* @__PURE__ */ new Set(), isDirty: false })
+}));
+
+// src/use-draft.ts
+function useDraft(isDirty) {
+  const formId = (0, import_react.useId)();
+  const markDirty = useDraftStore((s) => s.markDirty);
+  const markClean = useDraftStore((s) => s.markClean);
+  const isDirtyNow = typeof isDirty === "function" ? isDirty() : isDirty;
+  (0, import_react.useEffect)(() => {
+    if (isDirtyNow) {
+      markDirty(formId);
+    } else {
+      markClean(formId);
+    }
+    return () => markClean(formId);
+  }, [isDirtyNow, formId, markDirty, markClean]);
+  const shouldBlockFn = (0, import_react.useCallback)(() => {
+    return typeof isDirty === "function" ? isDirty() : isDirty;
+  }, [isDirty]);
+  const { status, proceed, reset } = (0, import_react_router.useBlocker)({
+    shouldBlockFn,
+    withResolver: true
+  });
+  (0, import_react.useEffect)(() => {
+    function handleBeforeUnload(e) {
+      if (useDraftStore.getState().isDirty) {
+        e.preventDefault();
+      }
+    }
+    window.addEventListener("beforeunload", handleBeforeUnload);
+    return () => window.removeEventListener("beforeunload", handleBeforeUnload);
+  }, []);
+  return {
+    showDialog: status === "blocked",
+    confirmLeave: () => proceed?.(),
+    cancelLeave: () => reset?.()
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useDraft,
+  useDraftStore
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/use-draft.ts","../src/store.ts"],"sourcesContent":["export { useDraft } from \"./use-draft\";\nexport type { IsDirtyInput, UseDraftReturn } from \"./use-draft\";\nexport { useDraftStore } from \"./store\";\nexport type { DraftState } from \"./store\";\n","import { useCallback, useEffect, useId } from \"react\";\nimport { useBlocker } from \"@tanstack/react-router\";\nimport { useDraftStore } from \"./store\";\n\nexport interface UseDraftReturn {\n  /** True when navigation is blocked and the consumer should render its confirm dialog. */\n  showDialog: boolean;\n  /** Proceed with the originally-attempted navigation. */\n  confirmLeave: () => void;\n  /** Stay on the current page, dismiss the dialog. */\n  cancelLeave: () => void;\n}\n\nexport type IsDirtyInput = boolean | (() => boolean);\n\n/**\n * Track unsaved-changes state for the current form and block navigation\n * while it's dirty. The hook:\n *\n *   1. Reports this form's dirty state into the global draft store so other\n *      components (e.g. an upload indicator outside the form tree) can read\n *      the aggregate via `useDraftStore`.\n *   2. Hooks TanStack Router's `useBlocker` (with `withResolver: true`) so\n *      in-app navigation pauses on a status === \"blocked\" condition,\n *      letting the caller render a confirm dialog and call confirmLeave /\n *      cancelLeave.\n *   3. Adds a `beforeunload` listener so browser refresh / tab-close\n *      surfaces the native \"Leave site?\" dialog when ANY form is dirty.\n *\n * Pass a getter function (`() => isDirty`) rather than a boolean when the\n * dirty state changes inside the same event handler that triggers\n * navigation — `useBlocker` evaluates the predicate lazily, so a getter\n * reading from a `useRef` sees the synchronously-set value before React\n * has a chance to re-render.\n */\nexport function useDraft(isDirty: IsDirtyInput): UseDraftReturn {\n  const formId = useId();\n  const markDirty = useDraftStore((s) => s.markDirty);\n  const markClean = useDraftStore((s) => s.markClean);\n\n  const isDirtyNow = typeof isDirty === \"function\" ? isDirty() : isDirty;\n\n  useEffect(() => {\n    if (isDirtyNow) {\n      markDirty(formId);\n    } else {\n      markClean(formId);\n    }\n    return () => markClean(formId);\n  }, [isDirtyNow, formId, markDirty, markClean]);\n\n  const shouldBlockFn = useCallback(() => {\n    return typeof isDirty === \"function\" ? isDirty() : isDirty;\n  }, [isDirty]);\n\n  const { status, proceed, reset } = useBlocker({\n    shouldBlockFn,\n    withResolver: true,\n  });\n\n  useEffect(() => {\n    function handleBeforeUnload(e: BeforeUnloadEvent) {\n      if (useDraftStore.getState().isDirty) {\n        e.preventDefault();\n      }\n    }\n    window.addEventListener(\"beforeunload\", handleBeforeUnload);\n    return () => window.removeEventListener(\"beforeunload\", handleBeforeUnload);\n  }, []);\n\n  return {\n    showDialog: status === \"blocked\",\n    confirmLeave: () => proceed?.(),\n    cancelLeave: () => reset?.(),\n  };\n}\n","import { create } from \"zustand\";\n\nexport interface DraftState {\n  /** Set of form IDs currently flagged as dirty. */\n  dirtyForms: Set<string>;\n  /** True when at least one form is dirty. */\n  isDirty: boolean;\n  /** Flag the given form ID as dirty. Idempotent. */\n  markDirty: (formId: string) => void;\n  /** Clear the given form ID. Idempotent. */\n  markClean: (formId: string) => void;\n  /** Drop every dirty flag. Useful in tests / global logout. */\n  reset: () => void;\n}\n\n/**\n * Global store of dirty form IDs. Any component can subscribe with\n * `useDraftStore((s) => s.isDirty)` to react to the aggregate state — e.g.\n * an upload-in-progress indicator that lives outside the form tree.\n */\nexport const useDraftStore = create<DraftState>()((set) => ({\n  dirtyForms: new Set<string>(),\n  isDirty: false,\n  markDirty: (formId) =>\n    set((state) => {\n      if (state.dirtyForms.has(formId)) return state;\n      const next = new Set(state.dirtyForms);\n      next.add(formId);\n      return { dirtyForms: next, isDirty: next.size > 0 };\n    }),\n  markClean: (formId) =>\n    set((state) => {\n      if (!state.dirtyForms.has(formId)) return state;\n      const next = new Set(state.dirtyForms);\n      next.delete(formId);\n      return { dirtyForms: next, isDirty: next.size > 0 };\n    }),\n  reset: () => set({ dirtyForms: new Set<string>(), isDirty: false }),\n}));\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA8C;AAC9C,0BAA2B;;;ACD3B,qBAAuB;AAoBhB,IAAM,oBAAgB,uBAAmB,EAAE,CAAC,SAAS;AAAA,EAC1D,YAAY,oBAAI,IAAY;AAAA,EAC5B,SAAS;AAAA,EACT,WAAW,CAAC,WACV,IAAI,CAAC,UAAU;AACb,QAAI,MAAM,WAAW,IAAI,MAAM,EAAG,QAAO;AACzC,UAAM,OAAO,IAAI,IAAI,MAAM,UAAU;AACrC,SAAK,IAAI,MAAM;AACf,WAAO,EAAE,YAAY,MAAM,SAAS,KAAK,OAAO,EAAE;AAAA,EACpD,CAAC;AAAA,EACH,WAAW,CAAC,WACV,IAAI,CAAC,UAAU;AACb,QAAI,CAAC,MAAM,WAAW,IAAI,MAAM,EAAG,QAAO;AAC1C,UAAM,OAAO,IAAI,IAAI,MAAM,UAAU;AACrC,SAAK,OAAO,MAAM;AAClB,WAAO,EAAE,YAAY,MAAM,SAAS,KAAK,OAAO,EAAE;AAAA,EACpD,CAAC;AAAA,EACH,OAAO,MAAM,IAAI,EAAE,YAAY,oBAAI,IAAY,GAAG,SAAS,MAAM,CAAC;AACpE,EAAE;;;ADHK,SAAS,SAAS,SAAuC;AAC9D,QAAM,aAAS,oBAAM;AACrB,QAAM,YAAY,cAAc,CAAC,MAAM,EAAE,SAAS;AAClD,QAAM,YAAY,cAAc,CAAC,MAAM,EAAE,SAAS;AAElD,QAAM,aAAa,OAAO,YAAY,aAAa,QAAQ,IAAI;AAE/D,8BAAU,MAAM;AACd,QAAI,YAAY;AACd,gBAAU,MAAM;AAAA,IAClB,OAAO;AACL,gBAAU,MAAM;AAAA,IAClB;AACA,WAAO,MAAM,UAAU,MAAM;AAAA,EAC/B,GAAG,CAAC,YAAY,QAAQ,WAAW,SAAS,CAAC;AAE7C,QAAM,oBAAgB,0BAAY,MAAM;AACtC,WAAO,OAAO,YAAY,aAAa,QAAQ,IAAI;AAAA,EACrD,GAAG,CAAC,OAAO,CAAC;AAEZ,QAAM,EAAE,QAAQ,SAAS,MAAM,QAAI,gCAAW;AAAA,IAC5C;AAAA,IACA,cAAc;AAAA,EAChB,CAAC;AAED,8BAAU,MAAM;AACd,aAAS,mBAAmB,GAAsB;AAChD,UAAI,cAAc,SAAS,EAAE,SAAS;AACpC,UAAE,eAAe;AAAA,MACnB;AAAA,IACF;AACA,WAAO,iBAAiB,gBAAgB,kBAAkB;AAC1D,WAAO,MAAM,OAAO,oBAAoB,gBAAgB,kBAAkB;AAAA,EAC5E,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL,YAAY,WAAW;AAAA,IACvB,cAAc,MAAM,UAAU;AAAA,IAC9B,aAAa,MAAM,QAAQ;AAAA,EAC7B;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,53 @@
+import * as zustand from 'zustand';
+
+interface UseDraftReturn {
+    /** True when navigation is blocked and the consumer should render its confirm dialog. */
+    showDialog: boolean;
+    /** Proceed with the originally-attempted navigation. */
+    confirmLeave: () => void;
+    /** Stay on the current page, dismiss the dialog. */
+    cancelLeave: () => void;
+}
+type IsDirtyInput = boolean | (() => boolean);
+/**
+ * Track unsaved-changes state for the current form and block navigation
+ * while it's dirty. The hook:
+ *
+ *   1. Reports this form's dirty state into the global draft store so other
+ *      components (e.g. an upload indicator outside the form tree) can read
+ *      the aggregate via `useDraftStore`.
+ *   2. Hooks TanStack Router's `useBlocker` (with `withResolver: true`) so
+ *      in-app navigation pauses on a status === "blocked" condition,
+ *      letting the caller render a confirm dialog and call confirmLeave /
+ *      cancelLeave.
+ *   3. Adds a `beforeunload` listener so browser refresh / tab-close
+ *      surfaces the native "Leave site?" dialog when ANY form is dirty.
+ *
+ * Pass a getter function (`() => isDirty`) rather than a boolean when the
+ * dirty state changes inside the same event handler that triggers
+ * navigation — `useBlocker` evaluates the predicate lazily, so a getter
+ * reading from a `useRef` sees the synchronously-set value before React
+ * has a chance to re-render.
+ */
+declare function useDraft(isDirty: IsDirtyInput): UseDraftReturn;
+
+interface DraftState {
+    /** Set of form IDs currently flagged as dirty. */
+    dirtyForms: Set<string>;
+    /** True when at least one form is dirty. */
+    isDirty: boolean;
+    /** Flag the given form ID as dirty. Idempotent. */
+    markDirty: (formId: string) => void;
+    /** Clear the given form ID. Idempotent. */
+    markClean: (formId: string) => void;
+    /** Drop every dirty flag. Useful in tests / global logout. */
+    reset: () => void;
+}
+/**
+ * Global store of dirty form IDs. Any component can subscribe with
+ * `useDraftStore((s) => s.isDirty)` to react to the aggregate state — e.g.
+ * an upload-in-progress indicator that lives outside the form tree.
+ */
+declare const useDraftStore: zustand.UseBoundStore<zustand.StoreApi<DraftState>>;
+
+export { type DraftState, type IsDirtyInput, type UseDraftReturn, useDraft, useDraftStore };

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+import * as zustand from 'zustand';
+
+interface UseDraftReturn {
+    /** True when navigation is blocked and the consumer should render its confirm dialog. */
+    showDialog: boolean;
+    /** Proceed with the originally-attempted navigation. */
+    confirmLeave: () => void;
+    /** Stay on the current page, dismiss the dialog. */
+    cancelLeave: () => void;
+}
+type IsDirtyInput = boolean | (() => boolean);
+/**
+ * Track unsaved-changes state for the current form and block navigation
+ * while it's dirty. The hook:
+ *
+ *   1. Reports this form's dirty state into the global draft store so other
+ *      components (e.g. an upload indicator outside the form tree) can read
+ *      the aggregate via `useDraftStore`.
+ *   2. Hooks TanStack Router's `useBlocker` (with `withResolver: true`) so
+ *      in-app navigation pauses on a status === "blocked" condition,
+ *      letting the caller render a confirm dialog and call confirmLeave /
+ *      cancelLeave.
+ *   3. Adds a `beforeunload` listener so browser refresh / tab-close
+ *      surfaces the native "Leave site?" dialog when ANY form is dirty.
+ *
+ * Pass a getter function (`() => isDirty`) rather than a boolean when the
+ * dirty state changes inside the same event handler that triggers
+ * navigation — `useBlocker` evaluates the predicate lazily, so a getter
+ * reading from a `useRef` sees the synchronously-set value before React
+ * has a chance to re-render.
+ */
+declare function useDraft(isDirty: IsDirtyInput): UseDraftReturn;
+
+interface DraftState {
+    /** Set of form IDs currently flagged as dirty. */
+    dirtyForms: Set<string>;
+    /** True when at least one form is dirty. */
+    isDirty: boolean;
+    /** Flag the given form ID as dirty. Idempotent. */
+    markDirty: (formId: string) => void;
+    /** Clear the given form ID. Idempotent. */
+    markClean: (formId: string) => void;
+    /** Drop every dirty flag. Useful in tests / global logout. */
+    reset: () => void;
+}
+/**
+ * Global store of dirty form IDs. Any component can subscribe with
+ * `useDraftStore((s) => s.isDirty)` to react to the aggregate state — e.g.
+ * an upload-in-progress indicator that lives outside the form tree.
+ */
+declare const useDraftStore: zustand.UseBoundStore<zustand.StoreApi<DraftState>>;
+
+export { type DraftState, type IsDirtyInput, type UseDraftReturn, useDraft, useDraftStore };

package/dist/index.js

@@ -0,0 +1,65 @@
+// src/use-draft.ts
+import { useCallback, useEffect, useId } from "react";
+import { useBlocker } from "@tanstack/react-router";
+
+// src/store.ts
+import { create } from "zustand";
+var useDraftStore = create()((set) => ({
+  dirtyForms: /* @__PURE__ */ new Set(),
+  isDirty: false,
+  markDirty: (formId) => set((state) => {
+    if (state.dirtyForms.has(formId)) return state;
+    const next = new Set(state.dirtyForms);
+    next.add(formId);
+    return { dirtyForms: next, isDirty: next.size > 0 };
+  }),
+  markClean: (formId) => set((state) => {
+    if (!state.dirtyForms.has(formId)) return state;
+    const next = new Set(state.dirtyForms);
+    next.delete(formId);
+    return { dirtyForms: next, isDirty: next.size > 0 };
+  }),
+  reset: () => set({ dirtyForms: /* @__PURE__ */ new Set(), isDirty: false })
+}));
+
+// src/use-draft.ts
+function useDraft(isDirty) {
+  const formId = useId();
+  const markDirty = useDraftStore((s) => s.markDirty);
+  const markClean = useDraftStore((s) => s.markClean);
+  const isDirtyNow = typeof isDirty === "function" ? isDirty() : isDirty;
+  useEffect(() => {
+    if (isDirtyNow) {
+      markDirty(formId);
+    } else {
+      markClean(formId);
+    }
+    return () => markClean(formId);
+  }, [isDirtyNow, formId, markDirty, markClean]);
+  const shouldBlockFn = useCallback(() => {
+    return typeof isDirty === "function" ? isDirty() : isDirty;
+  }, [isDirty]);
+  const { status, proceed, reset } = useBlocker({
+    shouldBlockFn,
+    withResolver: true
+  });
+  useEffect(() => {
+    function handleBeforeUnload(e) {
+      if (useDraftStore.getState().isDirty) {
+        e.preventDefault();
+      }
+    }
+    window.addEventListener("beforeunload", handleBeforeUnload);
+    return () => window.removeEventListener("beforeunload", handleBeforeUnload);
+  }, []);
+  return {
+    showDialog: status === "blocked",
+    confirmLeave: () => proceed?.(),
+    cancelLeave: () => reset?.()
+  };
+}
+export {
+  useDraft,
+  useDraftStore
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/use-draft.ts","../src/store.ts"],"sourcesContent":["import { useCallback, useEffect, useId } from \"react\";\nimport { useBlocker } from \"@tanstack/react-router\";\nimport { useDraftStore } from \"./store\";\n\nexport interface UseDraftReturn {\n  /** True when navigation is blocked and the consumer should render its confirm dialog. */\n  showDialog: boolean;\n  /** Proceed with the originally-attempted navigation. */\n  confirmLeave: () => void;\n  /** Stay on the current page, dismiss the dialog. */\n  cancelLeave: () => void;\n}\n\nexport type IsDirtyInput = boolean | (() => boolean);\n\n/**\n * Track unsaved-changes state for the current form and block navigation\n * while it's dirty. The hook:\n *\n *   1. Reports this form's dirty state into the global draft store so other\n *      components (e.g. an upload indicator outside the form tree) can read\n *      the aggregate via `useDraftStore`.\n *   2. Hooks TanStack Router's `useBlocker` (with `withResolver: true`) so\n *      in-app navigation pauses on a status === \"blocked\" condition,\n *      letting the caller render a confirm dialog and call confirmLeave /\n *      cancelLeave.\n *   3. Adds a `beforeunload` listener so browser refresh / tab-close\n *      surfaces the native \"Leave site?\" dialog when ANY form is dirty.\n *\n * Pass a getter function (`() => isDirty`) rather than a boolean when the\n * dirty state changes inside the same event handler that triggers\n * navigation — `useBlocker` evaluates the predicate lazily, so a getter\n * reading from a `useRef` sees the synchronously-set value before React\n * has a chance to re-render.\n */\nexport function useDraft(isDirty: IsDirtyInput): UseDraftReturn {\n  const formId = useId();\n  const markDirty = useDraftStore((s) => s.markDirty);\n  const markClean = useDraftStore((s) => s.markClean);\n\n  const isDirtyNow = typeof isDirty === \"function\" ? isDirty() : isDirty;\n\n  useEffect(() => {\n    if (isDirtyNow) {\n      markDirty(formId);\n    } else {\n      markClean(formId);\n    }\n    return () => markClean(formId);\n  }, [isDirtyNow, formId, markDirty, markClean]);\n\n  const shouldBlockFn = useCallback(() => {\n    return typeof isDirty === \"function\" ? isDirty() : isDirty;\n  }, [isDirty]);\n\n  const { status, proceed, reset } = useBlocker({\n    shouldBlockFn,\n    withResolver: true,\n  });\n\n  useEffect(() => {\n    function handleBeforeUnload(e: BeforeUnloadEvent) {\n      if (useDraftStore.getState().isDirty) {\n        e.preventDefault();\n      }\n    }\n    window.addEventListener(\"beforeunload\", handleBeforeUnload);\n    return () => window.removeEventListener(\"beforeunload\", handleBeforeUnload);\n  }, []);\n\n  return {\n    showDialog: status === \"blocked\",\n    confirmLeave: () => proceed?.(),\n    cancelLeave: () => reset?.(),\n  };\n}\n","import { create } from \"zustand\";\n\nexport interface DraftState {\n  /** Set of form IDs currently flagged as dirty. */\n  dirtyForms: Set<string>;\n  /** True when at least one form is dirty. */\n  isDirty: boolean;\n  /** Flag the given form ID as dirty. Idempotent. */\n  markDirty: (formId: string) => void;\n  /** Clear the given form ID. Idempotent. */\n  markClean: (formId: string) => void;\n  /** Drop every dirty flag. Useful in tests / global logout. */\n  reset: () => void;\n}\n\n/**\n * Global store of dirty form IDs. Any component can subscribe with\n * `useDraftStore((s) => s.isDirty)` to react to the aggregate state — e.g.\n * an upload-in-progress indicator that lives outside the form tree.\n */\nexport const useDraftStore = create<DraftState>()((set) => ({\n  dirtyForms: new Set<string>(),\n  isDirty: false,\n  markDirty: (formId) =>\n    set((state) => {\n      if (state.dirtyForms.has(formId)) return state;\n      const next = new Set(state.dirtyForms);\n      next.add(formId);\n      return { dirtyForms: next, isDirty: next.size > 0 };\n    }),\n  markClean: (formId) =>\n    set((state) => {\n      if (!state.dirtyForms.has(formId)) return state;\n      const next = new Set(state.dirtyForms);\n      next.delete(formId);\n      return { dirtyForms: next, isDirty: next.size > 0 };\n    }),\n  reset: () => set({ dirtyForms: new Set<string>(), isDirty: false }),\n}));\n"],"mappings":";AAAA,SAAS,aAAa,WAAW,aAAa;AAC9C,SAAS,kBAAkB;;;ACD3B,SAAS,cAAc;AAoBhB,IAAM,gBAAgB,OAAmB,EAAE,CAAC,SAAS;AAAA,EAC1D,YAAY,oBAAI,IAAY;AAAA,EAC5B,SAAS;AAAA,EACT,WAAW,CAAC,WACV,IAAI,CAAC,UAAU;AACb,QAAI,MAAM,WAAW,IAAI,MAAM,EAAG,QAAO;AACzC,UAAM,OAAO,IAAI,IAAI,MAAM,UAAU;AACrC,SAAK,IAAI,MAAM;AACf,WAAO,EAAE,YAAY,MAAM,SAAS,KAAK,OAAO,EAAE;AAAA,EACpD,CAAC;AAAA,EACH,WAAW,CAAC,WACV,IAAI,CAAC,UAAU;AACb,QAAI,CAAC,MAAM,WAAW,IAAI,MAAM,EAAG,QAAO;AAC1C,UAAM,OAAO,IAAI,IAAI,MAAM,UAAU;AACrC,SAAK,OAAO,MAAM;AAClB,WAAO,EAAE,YAAY,MAAM,SAAS,KAAK,OAAO,EAAE;AAAA,EACpD,CAAC;AAAA,EACH,OAAO,MAAM,IAAI,EAAE,YAAY,oBAAI,IAAY,GAAG,SAAS,MAAM,CAAC;AACpE,EAAE;;;ADHK,SAAS,SAAS,SAAuC;AAC9D,QAAM,SAAS,MAAM;AACrB,QAAM,YAAY,cAAc,CAAC,MAAM,EAAE,SAAS;AAClD,QAAM,YAAY,cAAc,CAAC,MAAM,EAAE,SAAS;AAElD,QAAM,aAAa,OAAO,YAAY,aAAa,QAAQ,IAAI;AAE/D,YAAU,MAAM;AACd,QAAI,YAAY;AACd,gBAAU,MAAM;AAAA,IAClB,OAAO;AACL,gBAAU,MAAM;AAAA,IAClB;AACA,WAAO,MAAM,UAAU,MAAM;AAAA,EAC/B,GAAG,CAAC,YAAY,QAAQ,WAAW,SAAS,CAAC;AAE7C,QAAM,gBAAgB,YAAY,MAAM;AACtC,WAAO,OAAO,YAAY,aAAa,QAAQ,IAAI;AAAA,EACrD,GAAG,CAAC,OAAO,CAAC;AAEZ,QAAM,EAAE,QAAQ,SAAS,MAAM,IAAI,WAAW;AAAA,IAC5C;AAAA,IACA,cAAc;AAAA,EAChB,CAAC;AAED,YAAU,MAAM;AACd,aAAS,mBAAmB,GAAsB;AAChD,UAAI,cAAc,SAAS,EAAE,SAAS;AACpC,UAAE,eAAe;AAAA,MACnB;AAAA,IACF;AACA,WAAO,iBAAiB,gBAAgB,kBAAkB;AAC1D,WAAO,MAAM,OAAO,oBAAoB,gBAAgB,kBAAkB;AAAA,EAC5E,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL,YAAY,WAAW;AAAA,IACvB,cAAc,MAAM,UAAU;AAAA,IAC9B,aAAa,MAAM,QAAQ;AAAA,EAC7B;AACF;","names":[]}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@idevconn/use-draft",
+  "version": "0.1.0",
+  "description": "Global unsaved-changes blocker for TanStack Router SPAs. Aggregates dirty state from every mounted form via a Zustand store and blocks both in-app navigation (router dialog) and browser refresh/close (native dialog).",
+  "license": "Apache-2.0",
+  "author": "iDEVconn",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iDEVconn/use-draft.git"
+  },
+  "bugs": {
+    "url": "https://github.com/iDEVconn/use-draft/issues"
+  },
+  "homepage": "https://github.com/iDEVconn/use-draft#readme",
+  "keywords": [
+    "react",
+    "tanstack-router",
+    "zustand",
+    "forms",
+    "unsaved-changes",
+    "navigation-blocker",
+    "dirty-state"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run typecheck && npm run test && npm run build"
+  },
+  "peerDependencies": {
+    "@tanstack/react-router": ">=1.100.0",
+    "react": ">=18.0.0",
+    "zustand": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.31.0",
+    "@tanstack/react-router": "^1.169.0",
+    "@testing-library/jest-dom": "^6.9.0",
+    "@testing-library/react": "^16.3.0",
+    "@types/react": "^19.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "jsdom": "^25.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.5.0",
+    "vitest": "^4.1.7",
+    "zustand": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}