@e1himself/react-promise-modal 2.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Prezly 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,217 @@
+# React Promise Modal
+
+[![npm version](https://badgen.net/npm/v/@e1himself/react-promise-modal)](https://www.npmjs.com/package/@e1himself/react-promise-modal)
+
+`usePromiseModal()` is a React hook that allows you to define a modal
+by providing a custom rendering function.
+
+After defining your modal you can invoke it as a normal function,
+and await for the returned promise to get the modal resolution result.
+
+## Usage
+
+1. Define your modal with `usePromiseModal()`
+2. Invoke it from your event handler using `invoke()`
+3. Wait for the modal to resolve with `await`
+
+```js
+// 1) Define your modal
+const confirmation = usePromiseModal((props) => <MyModal {...props} />);
+
+// 2) Call it in your event handler
+async function handleClick() {
+    // 3) Wait for the modal to resolve
+    if (await confirmation.invoke()) {
+        // TODO: Perform the operation.
+    }
+}
+```
+
+**Demo: https://codesandbox.io/p/sandbox/zen-jennings-4pmm3k**
+
+## API
+
+**The `usePromiseModal()` hook returns the following values**:
+
+```tsx
+const { invoke, modal, isDisplayed } = usePromiseModal(/* ... */);
+```
+
+- `invoke` — imperatively invoke the modal, optionally passing additional call-time arguments.
+  Returns a promise you can _await_ to get the modal resolution value, when it's available. 
+  Or _undefined_ if the modal has been dismissed or cancelled.
+
+- `modal` — the rendered modal markup (`ReactElement | null`). You should always render this
+  value into your component subtree.
+
+- `isDisplayed` — a boolean flag indicating if there is currently a pending modal
+  for this definition.
+
+**The modal render function receives these properties**:
+
+```tsx
+usePromiseModal(({ show, onDismiss, onSubmit }) => (
+    <MyModal show={show} onDismiss={onDismiss} onSubmit={onSubmit} />
+));
+```
+
+
+- `show` — boolean to tell if the window is visible or not. 
+   Used for in/out transitions. 
+   Primarily intended to be used as *react-bootstrap* Modal `show` property.
+
+- `onDismiss` — should be invoked when the modal is dismissed.
+  Always resolves the promise to `undefined`.
+
+- `onSubmit` — should be invoked when the modal is submitted/confirmed. 
+   Resolves to the value provided as an argument to it.
+   The resolve value cannot be `undefined`, because it is already reserved for dismissal.
+
+
+## Examples
+
+### Confirmation
+
+You can easily implement a confirmation modal using `usePromiseModal()`:
+
+```jsx
+import { usePromiseModal } from '@e1himself/react-promise-modal';
+
+function MyApp() {
+    const confirmation = usePromiseModal(({ show, onSubmit, onDismiss }) => {
+        // Use any modal implementation you want
+        <MyConfirmationModal title="⚠️ Are you sure?" show={show} onConfirm={() => onSubmit(true)} onDismiss={onDismiss} />
+    });
+    
+    async function handleDeleteAccount() {
+        if (await confirmation.invoke()) {
+            console.log('Confirmed');
+        } else {
+            console.log('Cancelled');
+        }
+    }
+    
+    return (
+        <div>
+           <button onClick={handleDeleteAccount}>Delete account</button>
+           {confirmation.modal}
+        </div>
+    )
+}
+```
+
+### Alert
+
+Alert is basically the same as confirmation, except there is no difference whether
+it is submitted or dismissed -- the modal has single action anyway. 
+So we only need `onDismiss`:
+
+```jsx
+import { usePromiseModal } from '@e1himself/react-promise-modal';
+
+function MyApp() {
+    const alert = usePromiseModal(({ show, onDismiss }) => {
+        // Use any modal implementation you want
+        <MyAlertModal title="✔ Account deleted!" show={show} onDismiss={onDismiss} />
+    });
+
+    async function handleDeleteAccount() {
+        await api.deleteAccount();
+        await alert.invoke();
+    }
+
+    return (
+        <div>
+            <button onClick={handleDeleteAccount}>Delete account</button>
+            {alert.modal}
+        </div>
+    )
+}
+
+```
+
+### Prompt User Input
+
+For data prompts all you need is to resolve the promise by submitting the value to `onSubmit`:
+either a scalar, or more complex shapes wrapped into an object:
+
+```tsx
+import { usePromiseModal } from '@e1himself/react-promise-modal';
+
+function MyApp() {
+    const prompt = usePromiseModal<string, { title: string }>(
+        (props) => <MyFilenamePromptModal {...props} />,
+    );
+
+    async function handleCreateFile() {
+        const filename = await prompt.invoke({ title: 'Please enter filename:' });
+        if (!filename) {
+            console.error('Filename is required');
+            return;
+        }
+        await api.createFile(filename);
+    }
+
+    return (
+        <div>
+            <button onClick={handleCreateFile}>Create new file</button>
+            {prompt.modal}
+        </div>
+    )
+}
+
+interface Props {
+    title: string;
+    show: boolean;
+    onSubmit: (filename: string) => void;
+    onDismiss: () => void;
+}
+
+function MyFilenamePromptModal({ title, show, onSubmit, onDismiss }: Props) {
+    const [filename, setFilename] = useState("Untitled.txt");
+
+    return (
+        // Use any modal implementation you want
+        <Modal show={show} onHide={onDismiss}>
+            <form onSubmit={() => onSubmit(filename)}>
+                <p>{title}</p>
+                <input autoFocus value={filename} onChange={(event) => setFilename(event.target.value)} />
+
+                <button variant="secondary" onClick={onDismiss}>Cancel</button>
+                <button variant="primary" type="submit">Confirm</button>
+            </form>
+        </Modal>
+    );
+}
+```
+
+## Additional Invoke-Time Arguments
+
+In addition to the three standard properties your render callback will always receive when rendered,
+you can also pass extra call-time properties. Declare them with the second generic type parameter of `usePromiseModal()`,
+and then pass to the `invoke()` method:
+
+```tsx
+import { usePromiseModal } from "@e1himself/react-promise-modal";
+
+const failureFeedback = usePromiseModal<undefined, { status: Status, failures: OperationFailure[] }>(
+    ({ status, failures, show, onSubmit, onDismiss }) => (
+        <FailureModal status={status} failures={failures} show={show} onSubmit={onSubmit} onDismiss={onDismiss} />
+    ),
+);
+
+// Invocation of the modal now requires these additional properties:
+async function handleFlakyOperation() {
+    const { status, failures } = await api.flakyOperation();
+    if (status !== 'success') {
+        await failureFeedback.invoke({ status, failures }); // Note: here we pass additional parameters call-time
+    }
+}
+```
+
+------------------
+
+# Credits
+
+Brought to you with :metal: by [Ivan Voskoboinyk](https://voskoboinyk.com/?utm_source=github&utm_campaign=react-promise-modal)
+while working in [Prezly](https://www.prezly.com/?utm_source=github&utm_campaign=react-promise-modal).

package/dist/ModalTransitions.d.ts

@@ -0,0 +1,22 @@
+import * as React from "react";
+export type Milliseconds = number;
+type Props = {
+    isOpen: boolean;
+    onClosed?: () => void;
+    transitionDuration: Milliseconds;
+    render: (props: RenderProps) => React.ReactElement | null;
+};
+type RenderProps = {
+    isOpen: boolean;
+    stage: `${Stage.CLOSED | Stage.OPEN | Stage.OPENING | Stage.CLOSING}`;
+    onClose: () => void;
+};
+export declare enum Stage {
+    UNMOUNTED = "unmounted",
+    OPEN = "open",
+    OPENING = "opening",
+    CLOSING = "closing",
+    CLOSED = "closed"
+}
+export declare function ModalTransitions({ isOpen: shouldOpen, onClosed, transitionDuration, render }: Props): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+export {};

package/dist/ModalTransitions.js

@@ -0,0 +1,112 @@
+"use strict";
+
+var _react = require("react");
+var React = _react;
+var _lib = require("./lib");
+var delay = _lib.delay;
+var noop = _lib.noop;
+var _useIsMounted = require("./useIsMounted");
+var useIsMounted = _useIsMounted.useIsMounted;
+var _useLatest = require("./useLatest");
+var useLatest = _useLatest.useLatest;
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+var Stage = /*#__PURE__*/exports.Stage = function (Stage) {
+  Stage["UNMOUNTED"] = "unmounted";
+  Stage["OPEN"] = "open";
+  Stage["OPENING"] = "opening";
+  Stage["CLOSING"] = "closing";
+  Stage["CLOSED"] = "closed";
+  return Stage;
+}({});
+function ModalTransitions(_ref) {
+  var shouldOpen = _ref.isOpen,
+    onClosed = _ref.onClosed,
+    transitionDuration = _ref.transitionDuration,
+    render = _ref.render;
+  var isMounted = useIsMounted();
+  var _React$useState = React.useState(Stage.UNMOUNTED),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    stage = _React$useState2[0],
+    setStage = _React$useState2[1];
+  var refs = useLatest({
+    stage: stage,
+    onClosed: onClosed,
+    transitionDuration: transitionDuration
+  });
+  var onOpen = React.useCallback(function () {
+    if (!isMounted()) {
+      return noop;
+    }
+    if (refs.current.stage === Stage.OPENING || refs.current.stage === Stage.OPEN) {
+      return noop; // Nothing to do
+    }
+    var cancel = false;
+
+    // First, render it closed
+    setStage(Stage.CLOSED);
+
+    // Then, immediately start "opening" sequence
+    delay(0).then(function () {
+      return setStage(Stage.OPENING);
+    }).then(function () {
+      return delay(refs.current.transitionDuration);
+    }) // Wait another `transitionDelay`
+    .then(function () {
+      if (cancel || !isMounted()) {
+        return;
+      }
+      // Mark it open.
+      setStage(Stage.OPEN);
+    });
+    return function () {
+      cancel = true;
+    };
+  }, []);
+  var onClose = React.useCallback(function () {
+    if (!isMounted()) {
+      return noop;
+    }
+    if (refs.current.stage === Stage.CLOSING || refs.current.stage === Stage.CLOSED) {
+      return noop; // Nothing to do
+    }
+    var cancel = false;
+    setStage(Stage.CLOSING);
+    delay(refs.current.transitionDuration).then(function () {
+      var _refs$current$onClose, _refs$current;
+      if (cancel || !isMounted()) {
+        return;
+      }
+      setStage(Stage.CLOSED);
+      (_refs$current$onClose = (_refs$current = refs.current).onClosed) === null || _refs$current$onClose === void 0 || _refs$current$onClose.call(_refs$current);
+    }).then(function () {
+      return delay(0);
+    }).then(function () {
+      return setStage(Stage.UNMOUNTED);
+    });
+    return function () {
+      cancel = true;
+    };
+  }, []);
+  React.useEffect(function () {
+    if (shouldOpen) {
+      return onOpen();
+    } else {
+      return onClose();
+    }
+  }, [open]);
+  if (stage === Stage.UNMOUNTED) {
+    // Do not render anything in "closed" stage
+    return null;
+  }
+  return render({
+    stage: stage,
+    isOpen: stage === Stage.OPEN || stage === Stage.OPENING,
+    onClose: onClose
+  });
+}
+exports.ModalTransitions = ModalTransitions;

package/dist/deferred.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This kinda follows the Jquery.Deferred type idea.
+ * @see https://api.jquery.com/jQuery.Deferred/
+ *
+ * Deferred is mostly a promise, but you can resolve or reject it from outside.
+ * This 'Deferred' here is a much more limited version of the JQuery Deferred.
+ */
+export type Deferred<T> = {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (reason: unknown) => void;
+    isSettled(): boolean;
+};
+export declare function createDeferred<T>(): Deferred<T>;

package/dist/deferred.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _lib = require("./lib");
+var noop = _lib.noop;
+/**
+ * This kinda follows the Jquery.Deferred type idea.
+ * @see https://api.jquery.com/jQuery.Deferred/
+ *
+ * Deferred is mostly a promise, but you can resolve or reject it from outside.
+ * This 'Deferred' here is a much more limited version of the JQuery Deferred.
+ */
+
+function createDeferred() {
+  var isSettled = false;
+  var resolvePromise = noop;
+  var rejectPromise = noop;
+  var promise = new Promise(function (resolve, reject) {
+    resolvePromise = resolve;
+    rejectPromise = reject;
+  });
+  return {
+    promise: promise,
+    resolve: function resolve(value) {
+      isSettled = true;
+      resolvePromise(value);
+    },
+    reject: function reject(reason) {
+      isSettled = true;
+      rejectPromise(reason);
+    },
+    isSettled: function (_isSettled) {
+      function isSettled() {
+        return _isSettled.apply(this, arguments);
+      }
+      isSettled.toString = function () {
+        return _isSettled.toString();
+      };
+      return isSettled;
+    }(function () {
+      return isSettled;
+    })
+  };
+}
+exports.createDeferred = createDeferred;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { usePromiseModal } from "./usePromiseModal";

package/dist/index.js

@@ -0,0 +1,4 @@
+"use strict";
+
+var _usePromiseModal = require("./usePromiseModal");
+exports.usePromiseModal = _usePromiseModal.usePromiseModal;

package/dist/lib.d.ts

@@ -0,0 +1,6 @@
+import type * as React from "react";
+export declare function noop(): void;
+export declare function generateId(): string;
+export declare function delay(ms: number): Promise<void>;
+export declare function isEvent(value: unknown): value is Event;
+export declare function isSyntheticEvent(value: unknown | Partial<React.SyntheticEvent>): value is React.SyntheticEvent;

package/dist/lib.js

@@ -0,0 +1,25 @@
+"use strict";
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function noop() {
+  // Nothing
+}
+exports.noop = noop;
+function generateId() {
+  return "".concat(new Date().getTime(), "-").concat(Math.random());
+}
+exports.generateId = generateId;
+function delay(ms) {
+  return new Promise(function (resolve) {
+    setTimeout(resolve, ms);
+  });
+}
+exports.delay = delay;
+function isEvent(value) {
+  return value instanceof Event;
+}
+exports.isEvent = isEvent;
+function isSyntheticEvent(value) {
+  return _typeof(value) === "object" && value !== null && "nativeEvent" in value && "persist" in value && "stopPropagation" in value && "preventDefault" in value;
+}
+exports.isSyntheticEvent = isSyntheticEvent;

package/dist/useIsMounted.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @see https://streamich.github.io/react-use/?path=/story/lifecycle-usemountedstate--docs
+ *
+ * Lifecycle hook providing ability to check component's mount status.
+ * Returns a function that will return true if component mounted and false otherwise.
+ */
+export declare function useIsMounted(): () => boolean;

package/dist/useIsMounted.js

@@ -0,0 +1,23 @@
+"use strict";
+
+var _react = require("react");
+var React = _react;
+/**
+ * @see https://streamich.github.io/react-use/?path=/story/lifecycle-usemountedstate--docs
+ *
+ * Lifecycle hook providing ability to check component's mount status.
+ * Returns a function that will return true if component mounted and false otherwise.
+ */
+function useIsMounted() {
+  var isMounted = React.useRef(false);
+  React.useEffect(function () {
+    isMounted.current = true;
+    return function () {
+      isMounted.current = false;
+    };
+  }, []);
+  return React.useCallback(function () {
+    return isMounted.current;
+  }, []);
+}
+exports.useIsMounted = useIsMounted;

package/dist/useLatest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @see https://streamich.github.io/react-use/?path=/story/state-uselatest--docs
+ *
+ * React state hook that returns the latest state as described in the React hooks FAQ.
+ * @see https://reactjs.org/docs/hooks-faq.html#why-am-i-seeing-stale-props-or-state-inside-my-function
+ *
+ * This is mostly useful to get access to the latest value of some props
+ * or state inside an asynchronous callback, instead of that value
+ * at the time the callback was created from.
+ */
+export declare function useLatest<T>(value: T): {
+    readonly current: T;
+};

package/dist/useLatest.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _react = require("react");
+var React = _react;
+/**
+ * @see https://streamich.github.io/react-use/?path=/story/state-uselatest--docs
+ *
+ * React state hook that returns the latest state as described in the React hooks FAQ.
+ * @see https://reactjs.org/docs/hooks-faq.html#why-am-i-seeing-stale-props-or-state-inside-my-function
+ *
+ * This is mostly useful to get access to the latest value of some props
+ * or state inside an asynchronous callback, instead of that value
+ * at the time the callback was created from.
+ */
+function useLatest(value) {
+  var ref = React.useRef(value);
+  ref.current = value;
+  return ref;
+}
+exports.useLatest = useLatest;

package/dist/usePromiseModal.d.ts

@@ -0,0 +1,25 @@
+import * as React from "react";
+import { type Milliseconds } from "./ModalTransitions";
+interface Options {
+    concurrencyMode?: ConcurrencyMode;
+    transitionDuration?: Milliseconds;
+}
+type ConcurrencyMode = "stack" | "replace" | "ignore";
+type RenderFunction<P> = (props: P) => React.ReactElement | null | undefined;
+interface RenderProps<T> {
+    show: boolean;
+    stage: "closed" | "opening" | "open" | "closing";
+    onDismiss: () => void;
+    onSubmit: (value: Exclude<T, undefined>) => void;
+}
+export declare function usePromiseModal<T>(render: RenderFunction<RenderProps<T>>, options?: Options): {
+    modal: React.ReactElement;
+    invoke: () => Promise<T | undefined>;
+    isDisplayed: boolean;
+};
+export declare function usePromiseModal<T, Args>(render: RenderFunction<RenderProps<T> & Omit<Args, keyof RenderProps<T>>>, options?: Options): {
+    modal: React.ReactElement;
+    invoke: (args: Args) => Promise<T | undefined>;
+    isDisplayed: boolean;
+};
+export {};

package/dist/usePromiseModal.js

@@ -0,0 +1,174 @@
+"use strict";
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+var _react = require("react");
+var React = _react;
+var _deferred = require("./deferred");
+var createDeferred = _deferred.createDeferred;
+var _lib = require("./lib");
+var generateId = _lib.generateId;
+var isEvent = _lib.isEvent;
+var isSyntheticEvent = _lib.isSyntheticEvent;
+var _ModalTransitions = require("./ModalTransitions");
+var ModalTransitions = _ModalTransitions.ModalTransitions;
+var _useIsMounted = require("./useIsMounted");
+var useIsMounted = _useIsMounted.useIsMounted;
+var _useLatest = require("./useLatest");
+var useLatest = _useLatest.useLatest;
+function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
+function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+var DEFAULT_CONCURRENCY_MODE = "replace";
+var DEFAULT_TRANSITION_DURATION = 300;
+function usePromiseModal(render) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    _ref$concurrencyMode = _ref.concurrencyMode,
+    concurrencyMode = _ref$concurrencyMode === void 0 ? DEFAULT_CONCURRENCY_MODE : _ref$concurrencyMode,
+    _ref$transitionDurati = _ref.transitionDuration,
+    transitionDuration = _ref$transitionDurati === void 0 ? DEFAULT_TRANSITION_DURATION : _ref$transitionDurati;
+  var isMounted = useIsMounted();
+  var _React$useState = React.useState([]),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    invoked = _React$useState2[0],
+    setInvoked = _React$useState2[1];
+  var refs = useLatest({
+    invoked: invoked
+  });
+  var isDisplayed = invoked.length > 0;
+  var modal = /*#__PURE__*/React.createElement(React.Fragment, null, invoked.map(function (invocation, index) {
+    var id = invocation.id,
+      args = invocation.args,
+      deferred = invocation.deferred;
+    return /*#__PURE__*/React.createElement(ModalTransitions, {
+      key: "react-promise-modal-".concat(id)
+      /* only show the latest invoked modal */,
+      isOpen: index === invoked.length - 1,
+      onClosed: function onClosed() {
+        if (isMounted()) {
+          // Remove the invocation when the modal is closed
+          setInvoked(function (prev) {
+            return prev.filter(function (x) {
+              return x.id !== invocation.id;
+            });
+          });
+        }
+      },
+      transitionDuration: transitionDuration,
+      render: function (_render2) {
+        function render(_x) {
+          return _render2.apply(this, arguments);
+        }
+        render.toString = function () {
+          return _render2.toString();
+        };
+        return render;
+      }(function (_ref2) {
+        var _render;
+        var isOpen = _ref2.isOpen,
+          stage = _ref2.stage,
+          onClose = _ref2.onClose;
+        return (_render = render(_objectSpread(_objectSpread({}, args), {}, {
+          stage: stage,
+          show: isOpen,
+          onDismiss: function onDismiss() {
+            deferred.resolve(undefined);
+            onClose();
+          },
+          onSubmit: function onSubmit(value) {
+            deferred.resolve(value);
+            onClose();
+          }
+        }))) !== null && _render !== void 0 ? _render : null;
+      })
+    });
+  }));
+  var invoke = React.useCallback(/*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(incomingArgs) {
+      var id, deferred, args, invocation, _t;
+      return _regenerator().w(function (_context) {
+        while (1) switch (_context.n) {
+          case 0:
+            id = generateId();
+            deferred = createDeferred();
+            args =
+            // Note: Do not spread the incoming args object, if it's a DOM Event or a React SyntheticEvent,
+            //       which is a super common scenario. Modal `invoke()` functions are passed to onClick handlers all the time.
+            //       Also, an event should never be used as a props object to spread anyway.
+            //       @see https://github.com/prezly/prezly/pull/12020#discussion_r1101325932
+            isEvent(incomingArgs) || isSyntheticEvent(incomingArgs) ? {} : incomingArgs;
+            invocation = {
+              id: id,
+              args: args,
+              deferred: deferred
+            };
+            _t = concurrencyMode;
+            _context.n = _t === "ignore" ? 1 : _t === "stack" ? 2 : _t === "replace" ? 3 : 3;
+            break;
+          case 1:
+            setInvoked(function (prev) {
+              if (prev.length > 0) {
+                // auto-dismiss the current call
+                deferred.resolve(undefined);
+                return prev;
+              }
+              return [invocation];
+            });
+            return _context.a(3, 4);
+          case 2:
+            setInvoked(function (prev) {
+              return [].concat(_toConsumableArray(prev), [invocation]);
+            });
+            return _context.a(3, 4);
+          case 3:
+            setInvoked(function (prev) {
+              // auto-dismiss all previous calls
+              prev.forEach(function (_ref4) {
+                var deferred = _ref4.deferred;
+                return deferred.resolve(undefined);
+              });
+              return [invocation];
+            });
+            return _context.a(3, 4);
+          case 4:
+            return _context.a(2, deferred.promise);
+        }
+      }, _callee);
+    }));
+    return function (_x2) {
+      return _ref3.apply(this, arguments);
+    };
+  }(), [concurrencyMode]);
+  React.useEffect(function () {
+    // Auto-dismiss all open modals on unmount
+    return function () {
+      refs.current.invoked.forEach(function (_ref5) {
+        var deferred = _ref5.deferred;
+        if (!deferred.isSettled()) {
+          deferred.resolve(undefined);
+        }
+      });
+    };
+  }, []);
+  return {
+    modal: modal,
+    invoke: invoke,
+    isDisplayed: isDisplayed
+  };
+}
+exports.usePromiseModal = usePromiseModal;

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@e1himself/react-promise-modal",
+  "version": "2.0.2",
+  "description": "The proper (and easy) way of doing modals in React. With Promises.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf package-lock.json pnpm-lock.yaml yarn.lock node_modules/ dist/",
+    "build": "npm run build:js && npm run build:types",
+    "build:js": "babel src/* -x .ts,.tsx -d dist/",
+    "build:types": "tsc --project .",
+    "test": "npm run test:ts && npm run test:types && npm run test:build",
+    "test:types": "tsc --project ./tsconfig.test.json",
+    "test:ts": "tsc --noEmit --lib es2018,dom --jsx react --skipLibCheck ./test/typescript.test.tsx",
+    "test:build": "node test/commonjs.test.js",
+    "publish": "np"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/e1himself/react-promise-modal.git"
+  },
+  "keywords": [
+    "react",
+    "modal",
+    "promise",
+    "async",
+    "await",
+    "confirmation"
+  ],
+  "author": "Ivan Voskboinyk <ivan@voskoboinyk.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/e1himself/react-promise-modal/issues"
+  },
+  "homepage": "https://github.com/e1himself/react-promise-modal#readme",
+  "dependencies": {
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-react": "^7.26.3",
+    "@babel/preset-typescript": "^7.26.0",
+    "babel-plugin-transform-es2015-modules-simple-commonjs": "^0.3.0",
+    "np": "^12.0.1",
+    "prettier": "^3.4.2",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.7.2"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  }
+}