sanity-plugin-iframe-pane 2.3.1 → 2.3.2-canary.2

package/lib/index.cjs

@@ -1,93 +1,118 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
 var jsxRuntime = require('react/jsx-runtime');
 var icons = require('@sanity/icons');
 var ui = require('@sanity/ui');
+var framerMotion = require('framer-motion');
 var react = require('react');
+var sanity = require('sanity');
+var isValidSecret = require('./_chunks/is-valid-secret-7b704c76.cjs');
+var types = require('./_chunks/types-4a29b6ac.cjs');
 var usehooksTs = require('usehooks-ts');
+function GetUrlSecret(props) {
+  const {
+    urlSecretId,
+    setUrlSecret,
+    urlSecret,
+    setError
+  } = props;
+  const client = sanity.useClient({
+    apiVersion: isValidSecret.apiVersion
+  });
+  const [secretExpiresAt, setSecretExpiresAt] = react.useState(null);
+  if (!urlSecretId.includes(".")) {
+    throw new TypeError("`urlSecretId` must have a dot prefix, `".concat(urlSecretId, "` is not secure, add a prefix, for example `preview.").concat(urlSecretId, "` "));
+  }
+  react.useEffect(() => {
+    if (urlSecret) return;
+    async function getSecret(signal) {
+      const data = await client.fetch(isValidSecret.fetchSecretQuery, {
+        id: urlSecretId
+      }, {
+        signal,
+        tag: isValidSecret.tag
+      });
+      if (signal.aborted) return;
+      if (!(data == null ? void 0 : data.secret) || !(data == null ? void 0 : data._updatedAt)) {
+        try {
+          const newUpdatedAt = /* @__PURE__ */new Date();
+          const newSecret = await types.patchUrlSecret(client, urlSecretId, signal);
+          if (signal.aborted) return;
+          setUrlSecret(newSecret);
+          setSecretExpiresAt(types.getExpiresAt(newUpdatedAt));
+        } catch (err) {
+          console.error("Failed to create a new preview secret. Ensure the `client` has a `token` specified that has `write` permissions.", err);
+        }
+        return;
+      }
+      if ((data == null ? void 0 : data.secret) !== urlSecret) {
+        setUrlSecret(data == null ? void 0 : data.secret);
+        setSecretExpiresAt(types.getExpiresAt(new Date(data == null ? void 0 : data._updatedAt)));
+      }
+    }
+    const abort = new AbortController();
+    getSecret(abort.signal).catch(error => error.name !== "AbortError" && setError(error));
+    return () => abort.abort();
+  }, [client, setError, setUrlSecret, urlSecret, urlSecretId]);
+  react.useEffect(() => {
+    if (!secretExpiresAt) return;
+    const timeout = setTimeout(() => {
+      setUrlSecret(null);
+      setSecretExpiresAt(null);
+    }, Math.max(0, secretExpiresAt.getTime() - /* @__PURE__ */new Date().getTime()));
+    return () => clearTimeout(timeout);
+  }, [secretExpiresAt, setUrlSecret]);
+  return null;
+}
+function DisplayUrl(_ref) {
+  let {
+    displayUrl
+  } = _ref;
+  const truncatedUrl = react.useMemo(() => {
+    const url = new URL(displayUrl);
+    if (url.searchParams.has("secret")) {
+      url.searchParams.delete("secret");
+      url.searchParams.append("secret", "***");
+    }
+    return "".concat(url.origin === location.origin ? "" : url.origin).concat(url.pathname).concat(url.search);
+  }, [displayUrl]);
+  return /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+    size: 0,
+    textOverflow: "ellipsis",
+    title: displayUrl,
+    children: truncatedUrl
+  });
+}
 const sizes = {
   desktop: {
     width: "100%",
-    height: "100%",
-    maxHeight: "100%"
+    height: "100%"
   },
   mobile: {
     width: 414,
-    height: "100%",
-    maxHeight: 736
+    height: 746
   }
 };
 const DEFAULT_SIZE = "desktop";
-function Iframe(props) {
+function Toolbar(props) {
   const {
-    document: sanityDocument,
-    options
+    displayUrl,
+    iframeSize,
+    setIframeSize,
+    reloading,
+    showDisplayUrl,
+    reloadButton,
+    handleReload
   } = props;
-  const {
-    url,
-    defaultSize = DEFAULT_SIZE,
-    reload,
-    loader,
-    attributes = {},
-    showDisplayUrl = true
-  } = options;
-  const [displayUrl, setDisplayUrl] = react.useState(url && typeof url === "string" ? url : "");
-  const [iframeSize, setIframeSize] = react.useState((sizes == null ? void 0 : sizes[defaultSize]) ? defaultSize : DEFAULT_SIZE);
-  const [loading, setLoading] = react.useState(false);
   const input = react.useRef(null);
-  const iframe = react.useRef(null);
   const {
-    displayed
-  } = sanityDocument;
+    push: pushToast
+  } = ui.useToast();
   const [, copy] = usehooksTs.useCopyToClipboard();
-  function handleCopy() {
-    var _a;
-    if (!((_a = input == null ? void 0 : input.current) == null ? void 0 : _a.value)) return;
-    copy(input.current.value);
-  }
-  function handleReload() {
-    if (!(iframe == null ? void 0 : iframe.current)) {
-      return;
-    }
-    iframe.current.src = iframe.current.src;
-    setLoading(true);
-  }
-  function handleIframeLoad() {
-    setLoading(false);
-    if (attributes.onLoad && typeof attributes.onLoad === "function") {
-      attributes.onLoad();
-    }
-  }
-  react.useEffect(() => {
-    if ((reload == null ? void 0 : reload.revision) || (reload == null ? void 0 : reload.revision) == 0) {
-      setTimeout(() => {
-        handleReload();
-      }, Number(reload == null ? void 0 : reload.revision));
-    }
-  }, [displayed._rev, reload == null ? void 0 : reload.revision]);
-  react.useEffect(() => {
-    const getUrl = async () => {
-      setLoading(true);
-      const resolveUrl = typeof url === "function" ? await url(displayed) : "";
-      if (resolveUrl !== displayUrl && resolveUrl && typeof resolveUrl === "string") {
-        setDisplayUrl(resolveUrl);
-      }
-    };
-    if (typeof url === "function") {
-      getUrl();
-    }
-  }, [displayed._rev]);
-  if (!displayUrl || typeof displayUrl !== "string") {
-    return /* @__PURE__ */jsxRuntime.jsx(ui.ThemeProvider, {
-      children: /* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
-        padding: 5,
-        align: "center",
-        justify: "center",
-        children: /* @__PURE__ */jsxRuntime.jsx(ui.Spinner, {})
-      })
-    });
-  }
-  return /* @__PURE__ */jsxRuntime.jsxs(ui.ThemeProvider, {
+  return /* @__PURE__ */jsxRuntime.jsxs(jsxRuntime.Fragment, {
     children: [/* @__PURE__ */jsxRuntime.jsx("textarea", {
       style: {
         position: "absolute",
@@ -98,119 +123,402 @@ function Iframe(props) {
       value: displayUrl,
       readOnly: true,
       tabIndex: -1
-    }), /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
-      direction: "column",
-      style: {
-        height: "100%"
-      },
-      children: [/* @__PURE__ */jsxRuntime.jsx(ui.Card, {
-        padding: 2,
-        borderBottom: true,
-        children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+    }), /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
+      padding: 2,
+      borderBottom: true,
+      children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+        align: "center",
+        gap: 2,
+        children: [/* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
           align: "center",
-          gap: 2,
-          children: [/* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
-            align: "center",
-            gap: 1,
+          gap: 1,
+          children: /* @__PURE__ */jsxRuntime.jsx(ui.Tooltip, {
+            content: /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+              size: 1,
+              style: {
+                whiteSpace: "nowrap"
+              },
+              children: iframeSize === "mobile" ? "Exit mobile preview" : "Preview mobile viewport"
+            }),
+            padding: 2,
             children: /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+              disabled: !displayUrl,
               fontSize: [1],
               padding: 2,
-              tone: "primary",
               mode: iframeSize === "mobile" ? "default" : "ghost",
               icon: icons.MobileDeviceIcon,
               onClick: () => setIframeSize(iframeSize === "mobile" ? "desktop" : "mobile")
             })
-          }), /* @__PURE__ */jsxRuntime.jsx(ui.Box, {
-            flex: 1,
-            children: showDisplayUrl && /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
-              size: 0,
-              textOverflow: "ellipsis",
-              children: displayUrl
-            })
-          }), /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
-            align: "center",
-            gap: 1,
-            children: [(reload == null ? void 0 : reload.button) ? /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+          })
+        }), /* @__PURE__ */jsxRuntime.jsx(ui.Box, {
+          flex: 1,
+          children: showDisplayUrl && displayUrl && /* @__PURE__ */jsxRuntime.jsx(DisplayUrl, {
+            displayUrl
+          })
+        }), /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+          align: "center",
+          gap: 1,
+          children: [reloadButton ? /* @__PURE__ */jsxRuntime.jsx(ui.Tooltip, {
+            content: /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+              size: 1,
+              style: {
+                whiteSpace: "nowrap"
+              },
+              children: reloading ? "Reloading\u2026" : "Reload"
+            }),
+            padding: 2,
+            children: /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+              disabled: !displayUrl,
+              mode: "bleed",
               fontSize: [1],
               padding: 2,
-              icon: icons.UndoIcon,
-              title: "Reload",
+              icon: /* @__PURE__ */jsxRuntime.jsx(icons.UndoIcon, {
+                style: {
+                  transform: "rotate(90deg) scaleY(-1)"
+                }
+              }),
+              loading: reloading,
               "aria-label": "Reload",
               onClick: () => handleReload()
-            }) : null, /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+            })
+          }) : null, /* @__PURE__ */jsxRuntime.jsx(ui.Tooltip, {
+            content: /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+              size: 1,
+              style: {
+                whiteSpace: "nowrap"
+              },
+              children: "Copy URL"
+            }),
+            padding: 2,
+            children: /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+              mode: "bleed",
+              disabled: !displayUrl,
               fontSize: [1],
-              icon: icons.CopyIcon,
+              icon: icons.ClipboardIcon,
               padding: [2],
-              title: "Copy",
-              "aria-label": "Copy",
-              onClick: () => handleCopy()
-            }), /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+              "aria-label": "Copy URL",
+              onClick: () => {
+                var _a;
+                if (!((_a = input == null ? void 0 : input.current) == null ? void 0 : _a.value)) return;
+                copy(input.current.value);
+                pushToast({
+                  closable: true,
+                  status: "success",
+                  title: "The URL is copied to the clipboard"
+                });
+              }
+            })
+          }), /* @__PURE__ */jsxRuntime.jsx(ui.Tooltip, {
+            content: /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+              size: 1,
+              style: {
+                whiteSpace: "nowrap"
+              },
+              children: "Open URL in a new tab"
+            }),
+            padding: 2,
+            children: /* @__PURE__ */jsxRuntime.jsx(ui.Button, {
+              disabled: !displayUrl,
               fontSize: [1],
-              icon: icons.LeaveIcon,
-              padding: [2],
+              icon: icons.LaunchIcon,
+              mode: "ghost",
+              paddingY: [2],
               text: "Open",
-              tone: "primary",
+              "aria-label": "Open URL in a new tab",
               onClick: () => window.open(displayUrl)
-            })]
+            })
           })]
-        })
-      }), /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
+        })]
+      })
+    })]
+  });
+}
+const MotionFlex = framerMotion.motion(ui.Flex);
+function Iframe(props) {
+  var _a;
+  const [error, setError] = react.useState(null);
+  if (error) {
+    throw error;
+  }
+  const {
+    document: sanityDocument,
+    options
+  } = props;
+  const {
+    url,
+    urlSecretId,
+    defaultSize = DEFAULT_SIZE,
+    reload,
+    loader = "Loading\u2026",
+    attributes = {},
+    showDisplayUrl = true
+  } = options;
+  const [iframeSize, setIframeSize] = react.useState(((_a = sizes) == null ? void 0 : _a[defaultSize]) ? defaultSize : DEFAULT_SIZE);
+  const [workaroundEmptyDocument, setWorkaroundEmptyDocument] = react.useState(true);
+  react.useEffect(() => {
+    const timeout = setTimeout(() => setWorkaroundEmptyDocument(false), 1e3);
+    return () => clearTimeout(timeout);
+  }, []);
+  const prefersReducedMotion = ui.usePrefersReducedMotion();
+  const [urlState, setUrlState] = react.useState(() => typeof url === "function" ? "" : url);
+  const [loading, setLoading] = react.useState(true);
+  const [reloading, setReloading] = react.useState(false);
+  const iframe = react.useRef(null);
+  const {
+    displayed
+  } = sanityDocument;
+  const handleReload = react.useCallback(() => {
+    if (!(iframe == null ? void 0 : iframe.current)) {
+      return;
+    }
+    iframe.current.src = iframe.current.src;
+    setReloading(true);
+  }, []);
+  const deferredRevision = react.useDeferredValue(displayed._rev);
+  const displayUrl = typeof urlState === "string" ? urlState : "";
+  return /* @__PURE__ */jsxRuntime.jsx(framerMotion.MotionConfig, {
+    transition: prefersReducedMotion ? {
+      duration: 0
+    } : void 0,
+    children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+      direction: "column",
+      style: {
+        height: "100%"
+      },
+      children: [/* @__PURE__ */jsxRuntime.jsx(Toolbar, {
+        displayUrl,
+        iframeSize,
+        reloading,
+        setIframeSize,
+        showDisplayUrl,
+        reloadButton: !!(reload == null ? void 0 : reload.button),
+        handleReload
+      }), urlState === types.MissingSlug && !workaroundEmptyDocument ? /* @__PURE__ */jsxRuntime.jsx(MissingSlugScreen, {}) : /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
         tone: "transparent",
-        padding: iframeSize === "mobile" ? 2 : 0,
         style: {
           height: "100%"
         },
+        children: /* @__PURE__ */jsxRuntime.jsx(Frame, {
+          ref: iframe,
+          loader,
+          loading,
+          reloading,
+          iframeSize,
+          setReloading,
+          setLoading,
+          displayUrl,
+          attributes
+        })
+      }), typeof url === "function" && /* @__PURE__ */jsxRuntime.jsx(AsyncUrl, {
+        url,
+        displayed,
+        urlSecretId,
+        setDisplayUrl: setUrlState,
+        setError
+      }, deferredRevision), displayUrl && ((reload == null ? void 0 : reload.revision) || (reload == null ? void 0 : reload.revision) === 0) && /* @__PURE__ */jsxRuntime.jsx(ReloadOnRevision, {
+        revision: reload.revision,
+        _rev: deferredRevision,
+        handleReload
+      })]
+    })
+  });
+}
+const Frame = react.forwardRef(function Frame2(props, iframe) {
+  const {
+    loader,
+    loading,
+    setLoading,
+    iframeSize,
+    attributes,
+    reloading,
+    displayUrl,
+    setReloading
+  } = props;
+  function handleIframeLoad() {
+    setLoading(false);
+    setReloading(false);
+    if (attributes.onLoad && typeof attributes.onLoad === "function") {
+      attributes.onLoad();
+    }
+  }
+  return /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+    align: "center",
+    justify: "center",
+    style: {
+      height: "100%",
+      position: "relative"
+    },
+    children: [/* @__PURE__ */jsxRuntime.jsx(framerMotion.AnimatePresence, {
+      children: loader && loading && /* @__PURE__ */jsxRuntime.jsx(MotionFlex, {
+        initial: "initial",
+        animate: "animate",
+        exit: "exit",
+        variants: spinnerVariants,
+        justify: "center",
+        align: "center",
+        style: {
+          inset: "0",
+          position: "absolute"
+        },
         children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
-          align: "center",
-          justify: "center",
           style: {
-            height: "100%",
-            position: "relative"
+            ...sizes[iframeSize]
           },
-          children: [loader && loading && /* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
-            justify: "center",
-            align: "center",
-            style: {
-              inset: "0",
-              position: "absolute"
-            },
-            children: /* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
-              style: {
-                ...sizes[iframeSize],
-                backgroundColor: "rgba(0,0,0,0.2)"
-              },
-              justify: "center",
-              align: "center",
-              children: /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
-                padding: 4,
-                radius: 2,
-                shadow: 1,
-                children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
-                  align: "center",
-                  direction: "column",
-                  gap: 3,
-                  height: "fill",
-                  justify: "center",
-                  children: [/* @__PURE__ */jsxRuntime.jsx(ui.Spinner, {}), loader && typeof loader === "string" && /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
-                    size: 1,
-                    children: loader
-                  })]
-                })
-              })
-            })
-          }), /* @__PURE__ */jsxRuntime.jsx("iframe", {
-            ref: iframe,
-            title: "preview",
-            style: sizes[iframeSize],
-            frameBorder: "0",
-            src: displayUrl,
-            ...attributes,
-            onLoad: handleIframeLoad
+          justify: "center",
+          align: "center",
+          direction: "column",
+          gap: 4,
+          children: [/* @__PURE__ */jsxRuntime.jsx(ui.Spinner, {
+            muted: true
+          }), loader && typeof loader === "string" && /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+            muted: true,
+            size: 1,
+            children: loader
           })]
         })
-      })]
+      })
+    }), /* @__PURE__ */jsxRuntime.jsx(framerMotion.motion.iframe, {
+      ref: iframe,
+      title: "preview",
+      frameBorder: "0",
+      style: {
+        maxHeight: "100%"
+      },
+      src: displayUrl,
+      initial: ["background", iframeSize],
+      variants: iframeVariants,
+      animate: [loader && loading ? "background" : "active", reloading ? "reloading" : "idle", iframeSize],
+      ...attributes,
+      onLoad: handleIframeLoad
     })]
   });
+});
+const spinnerVariants = {
+  initial: {
+    opacity: 1
+  },
+  animate: {
+    opacity: [0, 0, 1]
+  },
+  exit: {
+    opacity: [1, 0, 0]
+  }
+};
+const iframeVariants = {
+  ...sizes,
+  desktop: {
+    ...sizes.desktop,
+    boxShadow: "0 0 0 0px var(--card-shadow-outline-color)"
+  },
+  mobile: {
+    ...sizes.mobile,
+    boxShadow: "0 0 0 1px var(--card-shadow-outline-color)"
+  },
+  background: {
+    opacity: 0,
+    scale: 1
+  },
+  idle: {
+    scale: 1
+  },
+  reloading: {
+    scale: [1, 1, 1, 0.98]
+  },
+  active: {
+    opacity: [0, 0, 1],
+    scale: 1
+  }
+};
+function ReloadOnRevision(props) {
+  const {
+    revision,
+    handleReload,
+    _rev
+  } = props;
+  const [initialRev] = react.useState(_rev);
+  react.useEffect(() => {
+    if (_rev !== initialRev) {
+      const timeout = setTimeout(handleReload, Number(revision === true ? 300 : revision));
+      return () => clearTimeout(timeout);
+    }
+  }, [_rev, revision, handleReload, initialRev]);
+  return null;
+}
+function AsyncUrl(props) {
+  const {
+    urlSecretId,
+    setDisplayUrl,
+    setError
+  } = props;
+  const [displayed] = react.useState(props.displayed);
+  const [url] = react.useState(() => props.url);
+  const [urlSecret, setUrlSecret] = react.useState(null);
+  react.useEffect(() => {
+    if (urlSecretId && !urlSecret) return;
+    const getUrl = async signal => {
+      const resolveUrl = await url(displayed, urlSecret, abort.signal);
+      if (!signal.aborted && resolveUrl) {
+        setDisplayUrl(resolveUrl);
+      }
+    };
+    const abort = new AbortController();
+    getUrl(abort.signal).catch(error => error.name !== "AbortError" && setError(error));
+    return () => abort.abort();
+  }, [displayed, setDisplayUrl, setError, url, urlSecret, urlSecretId]);
+  if (urlSecretId) {
+    return /* @__PURE__ */jsxRuntime.jsx(GetUrlSecret, {
+      urlSecretId,
+      urlSecret,
+      setUrlSecret,
+      setError
+    });
+  }
+  return null;
+}
+function MissingSlugScreen() {
+  return /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
+    height: "fill",
+    children: /* @__PURE__ */jsxRuntime.jsx(ui.Flex, {
+      align: "center",
+      height: "fill",
+      justify: "center",
+      padding: 4,
+      sizing: "border",
+      children: /* @__PURE__ */jsxRuntime.jsx(ui.Container, {
+        width: 0,
+        children: /* @__PURE__ */jsxRuntime.jsx(ui.Card, {
+          padding: 4,
+          radius: 2,
+          shadow: 1,
+          tone: "caution",
+          children: /* @__PURE__ */jsxRuntime.jsxs(ui.Flex, {
+            children: [/* @__PURE__ */jsxRuntime.jsx(ui.Box, {
+              children: /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+                size: 1,
+                children: /* @__PURE__ */jsxRuntime.jsx(icons.WarningOutlineIcon, {})
+              })
+            }), /* @__PURE__ */jsxRuntime.jsxs(ui.Stack, {
+              flex: 1,
+              marginLeft: 3,
+              space: 3,
+              children: [/* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+                as: "h1",
+                size: 1,
+                weight: "bold",
+                children: "Missing slug"
+              }), /* @__PURE__ */jsxRuntime.jsx(ui.Text, {
+                as: "p",
+                muted: true,
+                size: 1,
+                children: "Add a slug to see the preview."
+              })]
+            })]
+          })
+        })
+      })
+    })
+  });
 }
-module.exports = Iframe;
+exports.Iframe = Iframe;
+exports.default = Iframe;
 //# sourceMappingURL=index.cjs.map

package/lib/index.cjs.js

@@ -1,3 +1,5 @@
 import cjs from './index.cjs';
 
-export default cjs;
+export const Iframe = cjs.Iframe;
+
+export default cjs.default;