@simmalugnt-se/payload-editor-assistant 0.9.0 → 0.9.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.1
+
+- The assistant no longer shows on Payload's sign-in pages (login, logout, forgot and reset
+  password, first user, unauthorized). Right after signing in, the panel opened on the login page
+  before Admin loaded.
+
 ## 0.9.0
 
 - Translation: on a document with localized text that is empty in the open language but filled in

package/dist/components/EditorAssistantAction.js

@@ -1,6 +1,8 @@
 "use client";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { useAuth, useTranslation } from "@payloadcms/ui";
+import { useAuth, useConfig, useTranslation } from "@payloadcms/ui";
+import { usePathname } from "next/navigation";
+import { isAuthView } from "../view.js";
 import { useAssistantState } from "./assistant-context.js";
 import { COPY, uiLanguage } from "./copy.js";
 /** The one control that opens and closes the assistant panel, in Admin's header. */
@@ -8,7 +10,9 @@ export function EditorAssistantAction() {
     const { user } = useAuth();
     const { i18n } = useTranslation();
     const { open, setOpen } = useAssistantState();
-    if (!user) {
+    const { config } = useConfig();
+    const pathname = usePathname();
+    if (!user || isAuthView(pathname ?? "", config.routes.admin, config.admin.routes)) {
         return null;
     }
     return (_jsxs("button", { "aria-expanded": open, className: open ? "ea-trigger ea-trigger--open" : "ea-trigger", onClick: (event) => {

package/dist/components/EditorAssistantProvider.js

@@ -1,14 +1,19 @@
 "use client";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { useAuth } from "@payloadcms/ui";
+import { useAuth, useConfig } from "@payloadcms/ui";
+import { usePathname } from "next/navigation";
 import "../styles/assistant.css";
+import { isAuthView } from "../view.js";
 import { AssistantStateProvider, useAssistantState } from "./assistant-context.js";
 import { ChangedFieldsHighlight } from "./ChangedFieldsHighlight.js";
 import { EditorAssistantAside } from "./EditorAssistantAside.js";
 import { useNavRoom } from "./nav-room.js";
 export function EditorAssistantProvider({ children, shortcuts = [], collections = [], }) {
     const { user } = useAuth();
-    return (_jsx(AssistantStateProvider, { shortcuts: shortcuts, collections: collections, userId: user?.id, children: user ? _jsx(EditorAssistantShell, { children: children }) : children }));
+    const { config } = useConfig();
+    const pathname = usePathname();
+    const signingIn = isAuthView(pathname ?? "", config.routes.admin, config.admin.routes);
+    return (_jsx(AssistantStateProvider, { shortcuts: shortcuts, collections: collections, userId: user?.id, children: user && !signingIn ? _jsx(EditorAssistantShell, { children: children }) : children }));
 }
 function EditorAssistantShell({ children }) {
     const { open } = useAssistantState();

package/dist/view.d.ts

@@ -15,6 +15,12 @@ export type AdminView = {
 };
 export type AdminViewKind = AdminView["kind"];
 export declare function parseAdminView(pathname: string, adminRoute?: string): AdminView;
+/**
+ * Whether the path is one of Payload's sign-in pages (login, logout, forgot, reset, first user,
+ * unauthorized). The assistant does not show there, even in the moment after signing in when the
+ * user is known but the login page is still open.
+ */
+export declare function isAuthView(pathname: string, adminRoute: string, routes?: Partial<Record<string, string>>): boolean;
 /** Keep only views that point at something the host allowlisted. */
 export declare function sanitizeAdminView(value: unknown, allowed: {
     collections: Record<string, unknown>;

package/dist/view.js

@@ -24,6 +24,33 @@ export function parseAdminView(pathname, adminRoute = "/admin") {
     }
     return { kind: "other" };
 }
+/** Payload's own sign-in routes (`admin.routes`), with Payload's defaults. */
+const AUTH_ROUTES = {
+    login: "/login",
+    logout: "/logout",
+    inactivity: "/logout-inactivity",
+    forgot: "/forgot",
+    reset: "/reset",
+    createFirstUser: "/create-first-user",
+    unauthorized: "/unauthorized",
+};
+/**
+ * Whether the path is one of Payload's sign-in pages (login, logout, forgot, reset, first user,
+ * unauthorized). The assistant does not show there, even in the moment after signing in when the
+ * user is known but the login page is still open.
+ */
+export function isAuthView(pathname, adminRoute, routes = {}) {
+    const base = trimSlashes(adminRoute);
+    const path = trimSlashes(pathname.split(/[?#]/)[0] ?? "");
+    const rest = base ? stripPrefix(path, base) : path;
+    if (!rest) {
+        return false;
+    }
+    return Object.entries(AUTH_ROUTES).some(([key, fallback]) => {
+        const route = trimSlashes(routes[key] ?? fallback);
+        return Boolean(route) && (rest === route || rest.startsWith(`${route}/`));
+    });
+}
 /** Keep only views that point at something the host allowlisted. */
 export function sanitizeAdminView(value, allowed) {
     if (!value || typeof value !== "object") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simmalugnt-se/payload-editor-assistant",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Context-aware editor assistant plugin for Payload Admin",
   "keywords": [
     "payload",