@aglyn/plugins-crm 1.0.0-beta.198 → 1.0.0-beta.200

package/src/lib/components/leads-section.js

@@ -31,21 +31,21 @@ import { useContactFieldDefinitions } from "../hooks/use-contact-field-definitio
 import { customFieldColumns } from "./contact-custom-columns.js";
 import { useCrmViewGrid } from "../hooks/use-crm-view-grid.js";
 import { CRM_LIST_SLOTS, CrmColumnOrderProvider } from "./crm-column-menu.js";
-import { useOrgLeads } from "../hooks/use-org-leads.js";
+import { useCrmFoldsScope, useCrmListQuery } from "../hooks/use-crm-list-query.js";
 import CrmViewsControl from "./crm-views-control.js";
 import { CrmListActions, CrmListToolbar } from "./crm-list-toolbar.js";
 import RowActionsMenu from "@aglyn/shared-ui-jsx/components/row-actions-menu.component";
-import { TABLE_PAGE_SIZE_DEFAULT } from "@aglyn/shared-ui-jsx/const/table-pagination";
-import EmptyStateComponent from "@aglyn/shared-ui-jsx/components/empty-state.component";
+import ListQueryNotices from "@aglyn/shared-ui-jsx/components/list-query-notices.component";
 import { useSnackbar } from "@aglyn/shared-ui-snackstack";
-import { useFirestore, useFirestoreCollection } from "@aglyn/tenant-feature-instance";
-import { Alert, Box, Button, Dialog, DialogActions, DialogContent, DialogTitle, MenuItem, Select, Stack, Typography } from "@mui/material";
-import { collection, deleteField, doc, limit, orderBy, query, serverTimestamp, updateDoc, where } from "firebase/firestore";
+import { useFirestore } from "@aglyn/tenant-feature-instance";
+import { Box, Button, Dialog, DialogActions, DialogContent, DialogTitle, MenuItem, Select, Stack, Typography } from "@mui/material";
+import { deleteField, doc, serverTimestamp, updateDoc } from "firebase/firestore";
 import { useRouter } from "next/navigation";
 import { useCallback, useEffect, useMemo, useState } from "react";
 import { downloadTextFile } from "../model/contacts-csv.js";
 import { crmRoutes } from "../model/crm-routes.js";
-import { LEAD_EMAIL_FILTER_OPTIONS, LEAD_FILTER_CODECS, LEAD_LIST_FILTER_FIELDS, LEAD_LIST_FILTER_HEADERS, LEAD_SOURCE_FILTER_NONE, LEAD_STATUS_FILTER_OPTIONS, leadClausesForGrid, leadClausesToStore, leadMatchesClauses, leadMatchesSearch } from "../model/lead-filters.js";
+import { LEAD_EMAIL_FILTER_OPTIONS, LEAD_FILTER_CODECS, LEAD_LIST_DECLARATION, LEAD_LIST_FILTER_FIELDS, LEAD_LIST_FILTER_HEADERS, LEAD_SOURCE_FILTER_NONE, LEAD_STATUS_FILTER_OPTIONS, leadClausesForGrid, LEAD_PREFIX_SEARCH, leadClauseImpliesScope, leadClausesToStore, leadQueryClause } from "../model/lead-filters.js";
+import { crmAskClauses, crmQueryRefusals } from "../model/crm-list-query.js";
 import { listFilterGridColumns } from "@aglyn/shared-ui-jsx/const/list-grid-filter";
 import { useListGridFilter } from "@aglyn/shared-ui-jsx/hooks/use-list-grid-filter";
 import ListFilterChips from "@aglyn/shared-ui-jsx/components/list-filter-chips.component";
@@ -64,28 +64,6 @@ import LeadSurfacesNote from "./lead-surfaces-note.js";
 import { LeadUnqualifyDialog } from "./lead-unqualify-dialog.js";
 import LeadsBulkBar from "./leads-bulk-bar.js";
 import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
-/**
- * How many leads the section reads: the newest by last seen, plus one probe
- * row so "there are more" is a fact rather than a guess at the boundary.
- *
- * A CEILING and a client-side filter rather than a paged status query, and
- * the reason is the lead documents themselves. Every lead the capture door
- * writes carries NO `status` — the field exists only once somebody in the
- * CRM has touched the lead — and Firestore cannot select documents by a
- * field's absence: `where('status','in',[…])`, `!=` and `not-in` all skip a
- * document without the field. A server-side "open leads" query would
- * therefore hide every lead nobody has worked yet, which is the entire
- * population the section exists to show on the day it ships. So the query
- * is the one order every lead can satisfy (`lastSeenAtMs`, stamped on every
- * capture), and the status filter narrows the loaded window — said out loud
- * beneath the table whenever the window is not the whole collection.
- *
- * The window is then PAGED in memory under the shared footer, the way the
- * workspace pickers page a slice of a window they cannot re-key: the rows
- * are already in the snapshot, so turning a page costs nothing, and the
- * footer's count is exact because it counts the filtered window rather than
- * a collection nobody has measured.
- */ const LEADS_WINDOW = 200;
 /**
  * `/crm/leads` — the people a site has met but not yet qualified (AGL-2608).
  *
@@ -95,7 +73,8 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
  * it is real. Reads `orgs/{orgId}/leads` narrowed by `visibleTo` to the sites
  * this viewer may see (AGL-3275) — the same collection and the same clause at
  * both levels, which is what lets ONE listener serve a section that used to
- * open one per site.
+ * open one per site — and pages it by a query that carries every filter and
+ * the search word (AGL-3321; see `leadQueryClause`).
  *
  * Under a site the clause names that site; at the ORGANIZATION level an
  * org-wide member reads without one, since the rules short-circuit on
@@ -122,46 +101,19 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
     const routes = crmRoutes(basePath != null ? basePath : '');
     /*
    * Under a site: the ORG collection, narrowed to what this site may see
-   * (AGL-3275). It read `hosts/{hostId}/leads` until the silo moved, and
-   * leaving it there would have shown a site its pre-migration rows and
-   * nothing captured since — then nothing at all, once AGL-3276 emptied the
-   * path it was reading.
-   */ const site = useFirestoreCollection(()=>hostId && orgId ? query(collection(firestore, 'orgs', orgId, 'leads'), where('visibleTo', 'array-contains-any', scopeTokensForHost(hostId)), orderBy('lastSeenAtMs', 'desc'), limit(LEADS_WINDOW + 1)) : null, [
-        firestore,
-        hostId,
-        orgId
-    ], {
-        idField: '$id'
-    });
-    // At the organization level: every site's window, merged.
-    const orgHostIds = useMemo(()=>{
-        var _ref;
-        return hostId ? [] : ((_ref = mount == null ? void 0 : mount.hosts) != null ? _ref : []).map((host)=>host.id);
-    }, [
-        hostId,
-        mount == null ? void 0 : mount.hosts
-    ]);
-    /*
-   * ONE LISTENER (AGL-3275), where this used to fan out across the org's
-   * sites and merge. At the organization level an org-wide member reads with
-   * no scope clause, which is what `visibleTo: null` asks for.
-   */ const orgLeads = useOrgLeads({
-        orgId,
-        visibleTo: null,
-        windowSize: LEADS_WINDOW
-    });
-    const leadDocs = useMemo(()=>hostId ? site.data.map((row)=>_extends({}, row, {
-                leadId: row.$id
-            })) : orgLeads.data, [
-        hostId,
-        site.data,
-        orgLeads.data
+   * (AGL-3275) by `visibleTo array-contains-any` over the site's own tokens.
+   * At the ORGANIZATION level an org-wide member reads with no scope clause,
+   * which is what `null` asks for.
+   */ const scopeTokens = useMemo(()=>hostId ? scopeTokensForHost(hostId) : null, [
+        hostId
     ]);
-    const status = hostId ? site.status : (mount == null ? void 0 : mount.hostsReady) && !orgHostIds.length ? 'success' : orgLeads.status;
-    const truncated = hostId ? leadDocs.length > LEADS_WINDOW : orgLeads.truncated;
-    const window = useMemo(()=>leadDocs.slice(0, LEADS_WINDOW), [
-        leadDocs
+    const dataRoot = useMemo(()=>orgId ? [
+            'orgs',
+            orgId
+        ] : null, [
+        orgId
     ]);
+    const foldsScope = useCrmFoldsScope(orgId, scopeTokens);
     /*
    * What the list is narrowed by is the saved VIEW'S (AGL-2617), and the
    * grid's own Filters panel and quick search edit it (AGL-3313): Status,
@@ -250,32 +202,46 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
         roster.options
     ]);
     /*
-   * Every clause and the search narrow the whole loaded WINDOW here, before
-   * the footer's count and the page slice (AGL-3246). The grid holds one
-   * page of it, so a filter or a quick search the grid ran itself would
-   * answer "no match" for a lead on page three.
-   */ const searchKey = gridFilter.searchWords.join(' ');
-    const rows = useMemo(()=>window.filter((lead)=>leadMatchesClauses(lead, clauses) && leadMatchesSearch(lead, searchKey)), [
-        window,
+   * Every clause and the search word on ONE query (AGL-3321): each stored
+   * clause asked through the field its writer keeps (`leadQueryClause`),
+   * paged by that query, and what one query cannot hold refused by name
+   * above the list — never matched over the rows a page happened to load.
+   */ const asked = useMemo(()=>crmAskClauses(clauses, (clause)=>leadQueryClause(clause, {
+                scopeTokens,
+                foldsScope
+            })), [
         clauses,
-        searchKey
+        scopeTokens,
+        foldsScope
     ]);
-    const [page, setPage] = useState(0);
-    const [pageSize, setPageSize] = useState(TABLE_PAGE_SIZE_DEFAULT);
-    // A new filter or search term starts on page one: page three of the open
-    // leads is not a page of the unqualified ones, and an out-of-range page
-    // renders empty.
-    useEffect(()=>{
-        setPage(0);
-    }, [
-        views.state.filters,
-        searchKey
+    const searchKey = gridFilter.searchWords.join(' ');
+    const paged = useCrmListQuery({
+        scope: dataRoot,
+        collection: 'leads',
+        visibleTo: scopeTokens,
+        foldsScope,
+        declaration: LEAD_LIST_DECLARATION,
+        clauses: asked.clauses,
+        search: gridFilter.searchWords,
+        impliesScope: leadClauseImpliesScope,
+        prefixSearch: LEAD_PREFIX_SEARCH
+    });
+    const status = paged.status;
+    const rows = useMemo(()=>paged.rows.map((row)=>_extends({}, row, {
+                leadId: row.$id
+            })), [
+        paged.rows
     ]);
-    const pageRows = useMemo(()=>rows.slice(page * pageSize, (page + 1) * pageSize), [
-        rows,
-        page,
-        pageSize
+    const refused = useMemo(()=>crmQueryRefusals(paged.plan, asked, {
+            fields: LEAD_LIST_FILTER_FIELDS,
+            headers: LEAD_LIST_FILTER_HEADERS,
+            options: filterOptions
+        }), [
+        paged.plan,
+        asked,
+        filterOptions
     ]);
+    /** The list as it opens — Open leads, nothing typed — whose emptiness is news. */ const opening = !searchKey.trim() && clauses.length === 1 && clauses[0].field === 'status' && clauses[0].value === 'open';
     /*
    * The ticked rows, for the bulk bar (AGL-2662). Cleared when the filter or
    * the search term changes: a selection made on the open leads is not a
@@ -284,7 +250,8 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
    */ const [selectedIds, setSelectedIds] = useState([]);
     useEffect(()=>setSelectedIds([]), [
         views.state.filters,
-        searchKey
+        searchKey,
+        paged.page
     ]);
     // How the file names the owner and, at the org level, the site.
     const csvOptions = useMemo(()=>_extends({
@@ -296,8 +263,7 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
         hostId,
         mount
     ]);
-    // The listed window — every row the filter and the search admit, not just
-    // the page.
+    // The page on screen; Export all on the bulk bar takes the whole list.
     const handleExport = useCallback(()=>{
         downloadTextFile('leads.csv', 'text/csv', leadsCsv(rows, csvOptions));
     }, [
@@ -729,63 +695,59 @@ import OrgLeadSurfacesNote from "./org-lead-surfaces-note.js";
                                 })
                             ]
                         }),
-                        status === 'success' && window.length === 0 ? /*#__PURE__*/ _jsx(EmptyStateComponent, {
-                            label: 'No leads yet',
-                            description: 'Bookings and lead-routed forms on your site become leads on their own — or add one with New lead, or bring a list in with Import CSV.'
-                        }) : /*#__PURE__*/ _jsxs(_Fragment, {
-                            children: [
-                                /*#__PURE__*/ _jsx(LeadsBulkBar, {
-                                    rows: rows,
+                        /*#__PURE__*/ _jsx(ListQueryNotices, {
+                            refused: refused,
+                            notices: paged.plan.notices
+                        }),
+                        /*#__PURE__*/ _jsx(LeadsBulkBar, {
+                            rows: rows,
+                            selected: selectedIds,
+                            onSelectedChange: setSelectedIds,
+                            roster: roster,
+                            csv: csvOptions,
+                            orgId: orgId,
+                            hostId: hostId,
+                            org: org
+                        }),
+                        /*#__PURE__*/ _jsx(CrmColumnOrderProvider, {
+                            value: grid.columnOrder,
+                            children: /*#__PURE__*/ _jsx(ListTable, {
+                                rows: rows,
+                                columns: grid.columns,
+                                slots: CRM_LIST_SLOTS,
+                                selectable: {
                                     selected: selectedIds,
-                                    onSelectedChange: setSelectedIds,
-                                    roster: roster,
-                                    csv: csvOptions,
-                                    orgId: orgId,
-                                    hostId: hostId,
-                                    org: org
-                                }),
-                                /*#__PURE__*/ _jsx(CrmColumnOrderProvider, {
-                                    value: grid.columnOrder,
-                                    children: /*#__PURE__*/ _jsx(ListTable, {
-                                        rows: pageRows,
-                                        columns: grid.columns,
-                                        slots: CRM_LIST_SLOTS,
-                                        selectable: {
-                                            selected: selectedIds,
-                                            onChange: setSelectedIds
-                                        },
-                                        loading: status === 'loading',
-                                        onOpen: (_id, row)=>router.push(routes.lead(row.leadId)),
-                                        // Columns and sort are the view's, controlled (AGL-2617).
-                                        columnVisibilityModel: grid.columnVisibilityModel,
-                                        onColumnVisibilityModelChange: grid.onColumnVisibilityModelChange,
-                                        sortModel: grid.sortModel,
-                                        onSortModelChange: grid.onSortModelChange,
-                                        // The panel and the search are the grid's; the section
-                                        // answers both over the whole window (AGL-3313).
-                                        filterMode: "server",
-                                        filterModel: gridFilter.filterModel,
-                                        onFilterModelChange: gridFilter.onFilterModelChange,
-                                        quickFilter: true,
-                                        noRowsLabel: `No leads match among the ${window.length.toLocaleString()} most recently seen`,
-                                        // Paged by the footer below, so the grid must not also slice.
-                                        hideFooter: true
-                                    })
-                                }),
-                                /*#__PURE__*/ _jsx(ListPagination, {
-                                    page: page,
-                                    pageSize: pageSize,
-                                    rowCount: pageRows.length,
-                                    count: rows.length,
-                                    onPageChange: setPage,
-                                    onPageSizeChange: setPageSize
-                                })
-                            ]
+                                    onChange: setSelectedIds
+                                },
+                                loading: status === 'loading',
+                                onOpen: (_id, row)=>router.push(routes.lead(row.leadId)),
+                                // Columns are the view's, controlled (AGL-2617). The query
+                                // orders the list — newest seen first — so the grid sorts
+                                // nothing itself: a sort over one page would reorder that page.
+                                columnVisibilityModel: grid.columnVisibilityModel,
+                                onColumnVisibilityModelChange: grid.onColumnVisibilityModelChange,
+                                sortingMode: "server",
+                                disableColumnSorting: true,
+                                // The panel and the search are the grid's; the query answers
+                                // both (AGL-3321).
+                                filterMode: "server",
+                                filterModel: gridFilter.filterModel,
+                                onFilterModelChange: gridFilter.onFilterModelChange,
+                                quickFilter: true,
+                                noRowsLabel: opening ? 'No open leads' : 'No leads match these filters',
+                                noRowsDescription: opening ? 'Bookings and lead-routed forms on your site become leads on their own — or add one with New lead, or bring a list in with Import CSV.' : undefined,
+                                // Paged by the footer below, so the grid must not also slice.
+                                hideFooter: true
+                            })
                         }),
-                        truncated ? /*#__PURE__*/ _jsx(Alert, {
-                            severity: "info",
-                            children: `Showing the ${LEADS_WINDOW.toLocaleString()} most recently seen ` + 'leads. The filters and the search narrow these ' + `${LEADS_WINDOW.toLocaleString()} only; older leads are still ` + 'listed in the Inbox and reached by campaign audiences.'
-                        }) : null
+                        /*#__PURE__*/ _jsx(ListPagination, {
+                            page: paged.page,
+                            pageSize: paged.pageSize,
+                            rowCount: rows.length,
+                            hasMore: paged.hasMore,
+                            onPageChange: paged.setPage,
+                            onPageSizeChange: paged.setPageSize
+                        })
                     ]
                 })
             }),