@aglyn/plugins-crm 1.0.0-beta.199 → 1.0.0-beta.201

package/src/lib/model/crm-list-query.js

@@ -0,0 +1,182 @@
+import { _ as _extends } from "@swc/helpers/_/_extends";
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * 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.
+ */ import { CRM_SCOPED_SEARCH_TOKENS_FIELD, CRM_SEARCH_TOKENS_FIELD, crmListFields } from "@aglyn/aglyn";
+import { scopedSearch } from "@aglyn/aglyn/app-utils/name-search";
+import { listQueryRefusals } from "@aglyn/shared-ui-jsx/components/list-query-notices.component";
+/*
+ * THE CRM LISTS ON THEIR QUERIES (AGL-3321).
+ *
+ * Every CRM list — Leads, Contacts, Companies, Deals, Tasks — declares its
+ * filterable fields, its one order and its search as a
+ * `ListQueryDeclaration`, and `planListQuery` puts every clause and the
+ * search word on ONE Firestore query paged by `useListQuery`. What a query
+ * cannot hold is refused by name (`ListQueryNotices`), never matched over
+ * the rows a page happened to load.
+ *
+ * This module is what the five share: the search every CRM record carries
+ * (`searchTokens`, and `scopedSearchTokens` under a site — see
+ * `crmListFields` in `@aglyn/aglyn`), the scope clause as the plan's base,
+ * a stored clause translated to the one its query asks, and the refusals
+ * read back through the clause the reader set.
+ */ /** Every CRM list's quick search: the tokens every writer stamps. */ export const CRM_LIST_SEARCH = {
+    tokensPath: CRM_SEARCH_TOKENS_FIELD,
+    scoped: scopedSearch(CRM_SCOPED_SEARCH_TOKENS_FIELD)
+};
+/**
+ * The scope clause as the plan's base: `visibleTo array-contains-any` over
+ * the reader's tokens under a site, nothing at the organization level
+ * (`null` tokens), where an org-wide member's listeners carry none.
+ */ export function crmListBase(visibleTo) {
+    return visibleTo ? [
+        {
+            path: 'visibleTo',
+            op: 'array-contains-any',
+            value: [
+                ...visibleTo
+            ]
+        }
+    ] : [];
+}
+/** The base's shape, for `listQueryIndexes`: the scope clause is an array clause. */ export const CRM_LIST_BASE_INDEX = [
+    {
+        path: 'visibleTo',
+        array: true
+    }
+];
+/**
+ * The declaration a reader may run.
+ *
+ * Under a site the search folds into the scope clause (`search.scoped`),
+ * and a query without `visibleTo` is one the rules can prove only for an
+ * ORG-WIDE member — `canReadScoped()` short-circuits on it, and for anybody
+ * else inspects `visibleTo`, which the folded query no longer constrains.
+ * A member whose reach is some sites keeps the scope clause, and the plan
+ * refuses their search by name rather than sending a query the rules deny.
+ */ export function crmListDeclarationFor(declaration, foldsScope) {
+    var _declaration_search;
+    if (foldsScope || !((_declaration_search = declaration.search) == null ? void 0 : _declaration_search.scoped)) return declaration;
+    return _extends({}, declaration, {
+        search: {
+            tokensPath: declaration.search.tokensPath
+        }
+    });
+}
+/** Every stored clause through `ask`, keeping where each came from. */ export function crmAskClauses(stored, ask) {
+    const clauses = [];
+    const origins = [];
+    const refused = [];
+    for (const clause of stored){
+        const asked = ask(clause);
+        if ('refused' in asked) {
+            refused.push({
+                clause,
+                reason: asked.refused
+            });
+        } else {
+            clauses.push(asked);
+            origins.push(clause);
+        }
+    }
+    return {
+        clauses,
+        origins,
+        refused
+    };
+}
+const sameClause = (a, b)=>a.field === b.field && a.op === b.op && a.value === b.value;
+/**
+ * The plan's refusals and the translation's, each named by the clause the
+ * reader SET, as `ListQueryNotices` takes them — through the platform's one
+ * wording (`listQueryRefusals`), so a notice and its chip read alike.
+ */ export function crmQueryRefusals(plan, asked, context) {
+    const planned = plan.refused.map((entry)=>{
+        if (entry.clause === 'search') return entry;
+        const clause = entry.clause;
+        const at = asked.clauses.findIndex((candidate)=>sameClause(candidate, clause));
+        return {
+            clause: at >= 0 ? asked.origins[at] : clause,
+            reason: entry.reason
+        };
+    });
+    return listQueryRefusals([
+        ...asked.refused,
+        ...planned
+    ], context);
+}
+/** The comma-separated values of an `isAnyOf`, or the one value of anything else. */ export function crmClauseValues(clause) {
+    const raw = clause.op === 'isAnyOf' ? clause.value.split(',') : [
+        clause.value
+    ];
+    return [
+        ...new Set(raw.map((value)=>value.trim()).filter(Boolean))
+    ];
+}
+/** One value as `equals`, several as `isAnyOf` — the shape the plan takes a list in. */ export function crmAnyOf(field, values) {
+    const unique = [
+        ...new Set(values)
+    ];
+    if (!unique.length) return {
+        refused: 'no value yet'
+    };
+    return unique.length === 1 ? {
+        field,
+        op: 'equals',
+        value: unique[0]
+    } : {
+        field,
+        op: 'isAnyOf',
+        value: unique.join(',')
+    };
+}
+/** A `select` field: equality and "any of" over stored values, nothing else. */ export function crmSelectField(column, path = column) {
+    return {
+        column,
+        kind: 'exact',
+        path,
+        operators: [
+            'equals',
+            'isAnyOf'
+        ]
+    };
+}
+/**
+ * The list fields a CLIENT edit writes beside its patch (AGL-3321): the
+ * record as the listener holds it with the patch laid over — a `null` or a
+ * sentinel in the patch reads as the field removed — through
+ * `crmListFields`, narrowed to `fields`. A client never writes a field the
+ * rules keep for the server (a lead's `emailStatus`), which is why the
+ * caller names the ones it may.
+ */ export function crmClientListFields(collection, record, patch, fields) {
+    const merged = _extends({}, record);
+    for (const [key, value] of Object.entries(patch)){
+        // A dotted path is a map entry (`custom.tier`), never a searched field.
+        if (key.includes('.')) continue;
+        merged[key] = value === null || isSentinel(value) ? undefined : value;
+    }
+    const computed = crmListFields(collection, merged);
+    return Object.fromEntries(fields.filter((field)=>field in computed).map((field)=>[
+            field,
+            computed[field]
+        ]));
+}
+/** A web-SDK `FieldValue` — `deleteField()`, the one a client edit of these fields sends. */ const isSentinel = (value)=>typeof value === 'object' && value !== null && !Array.isArray(value) && !(value instanceof Date) && typeof value.isEqual === 'function';
+/** The search fields every CRM record carries — what a client edit of searched text rewrites. */ export const CRM_CLIENT_SEARCH_FIELDS = [
+    'searchTokens',
+    'scopedSearchTokens'
+];
+
+//# sourceMappingURL=crm-list-query.js.map

package/src/lib/model/crm-list-query.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/crm/src/lib/model/crm-list-query.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  CRM_SCOPED_SEARCH_TOKENS_FIELD,\n  CRM_SEARCH_TOKENS_FIELD,\n  type CrmListCollection,\n  crmListFields,\n} from '@aglyn/aglyn'\nimport { scopedSearch } from '@aglyn/aglyn/app-utils/name-search'\nimport type { ListFilterField, ListFilterRequest } from '@aglyn/shared-ui-jsx/const/list-filter'\nimport type { ListFilterOption } from '@aglyn/shared-ui-jsx/const/list-grid-filter'\nimport { listQueryRefusals } from '@aglyn/shared-ui-jsx/components/list-query-notices.component'\nimport type {\n  ListQueryDeclaration,\n  ListQueryFilter,\n  ListQueryPlan,\n} from '@aglyn/shared-ui-jsx/const/list-query-plan'\n\n/*\n * THE CRM LISTS ON THEIR QUERIES (AGL-3321).\n *\n * Every CRM list — Leads, Contacts, Companies, Deals, Tasks — declares its\n * filterable fields, its one order and its search as a\n * `ListQueryDeclaration`, and `planListQuery` puts every clause and the\n * search word on ONE Firestore query paged by `useListQuery`. What a query\n * cannot hold is refused by name (`ListQueryNotices`), never matched over\n * the rows a page happened to load.\n *\n * This module is what the five share: the search every CRM record carries\n * (`searchTokens`, and `scopedSearchTokens` under a site — see\n * `crmListFields` in `@aglyn/aglyn`), the scope clause as the plan's base,\n * a stored clause translated to the one its query asks, and the refusals\n * read back through the clause the reader set.\n */\n\n/** Every CRM list's quick search: the tokens every writer stamps. */\nexport const CRM_LIST_SEARCH: NonNullable<ListQueryDeclaration['search']> = {\n  tokensPath: CRM_SEARCH_TOKENS_FIELD,\n  scoped: scopedSearch(CRM_SCOPED_SEARCH_TOKENS_FIELD),\n}\n\n/**\n * The scope clause as the plan's base: `visibleTo array-contains-any` over\n * the reader's tokens under a site, nothing at the organization level\n * (`null` tokens), where an org-wide member's listeners carry none.\n */\nexport function crmListBase(visibleTo: readonly string[] | null): ListQueryFilter[] {\n  return visibleTo ? [{ path: 'visibleTo', op: 'array-contains-any', value: [...visibleTo] }] : []\n}\n\n/** The base's shape, for `listQueryIndexes`: the scope clause is an array clause. */\nexport const CRM_LIST_BASE_INDEX = [{ path: 'visibleTo', array: true }] as const\n\n/**\n * The declaration a reader may run.\n *\n * Under a site the search folds into the scope clause (`search.scoped`),\n * and a query without `visibleTo` is one the rules can prove only for an\n * ORG-WIDE member — `canReadScoped()` short-circuits on it, and for anybody\n * else inspects `visibleTo`, which the folded query no longer constrains.\n * A member whose reach is some sites keeps the scope clause, and the plan\n * refuses their search by name rather than sending a query the rules deny.\n */\nexport function crmListDeclarationFor(\n  declaration: ListQueryDeclaration,\n  foldsScope: boolean,\n): ListQueryDeclaration {\n  if (foldsScope || !declaration.search?.scoped) return declaration\n  return { ...declaration, search: { tokensPath: declaration.search.tokensPath } }\n}\n\n/*------------------------------------------\n * WHAT A LIST STORES, AND WHAT IT ASKS.\n *\n * A saved view stores clauses in the grid's grammar — \"Status is Open\",\n * \"Owner is Dana\", \"Lead source is none\" — and some of them name no stored\n * field one query can ask as it is: Open is two statuses, an owner under a\n * site is that holder's facet key, a lead source is compared by its key. A\n * list translates each stored clause into the clause its query asks, plans\n * those, and reads the plan's refusals back through the stored clause, so\n * the notice names what the reader set (\"Status is Open is not applied\")\n * and never the field it was translated to.\n *-----------------------------------------*/\n\n/** How one stored clause is asked: a query clause, or why it cannot be. */\nexport type CrmClauseAsked = ListFilterRequest | { refused: string }\n\nexport interface CrmAskedClauses {\n  /** What the plan is asked, in the order the reader set them. */\n  clauses: ListFilterRequest[]\n  /** The stored clause each asked one stands for, index for index. */\n  origins: ListFilterRequest[]\n  /** Stored clauses refused before the plan saw them, with why. */\n  refused: Array<{ clause: ListFilterRequest; reason: string }>\n}\n\n/** Every stored clause through `ask`, keeping where each came from. */\nexport function crmAskClauses(\n  stored: readonly ListFilterRequest[],\n  ask: (clause: ListFilterRequest) => CrmClauseAsked,\n): CrmAskedClauses {\n  const clauses: ListFilterRequest[] = []\n  const origins: ListFilterRequest[] = []\n  const refused: CrmAskedClauses['refused'] = []\n  for (const clause of stored) {\n    const asked = ask(clause)\n    if ('refused' in asked) {\n      refused.push({ clause, reason: asked.refused })\n    } else {\n      clauses.push(asked)\n      origins.push(clause)\n    }\n  }\n  return { clauses, origins, refused }\n}\n\nconst sameClause = (a: ListFilterRequest, b: ListFilterRequest): boolean =>\n  a.field === b.field && a.op === b.op && a.value === b.value\n\n/**\n * The plan's refusals and the translation's, each named by the clause the\n * reader SET, as `ListQueryNotices` takes them — through the platform's one\n * wording (`listQueryRefusals`), so a notice and its chip read alike.\n */\nexport function crmQueryRefusals(\n  plan: Pick<ListQueryPlan, 'refused'>,\n  asked: CrmAskedClauses,\n  context: {\n    fields: readonly ListFilterField[]\n    headers?: Readonly<Record<string, string>>\n    options?: Readonly<Record<string, readonly ListFilterOption[]>>\n  },\n): Array<{ label: string; reason: string }> {\n  const planned = plan.refused.map((entry) => {\n    if (entry.clause === 'search') return entry\n    const clause = entry.clause\n    const at = asked.clauses.findIndex((candidate) => sameClause(candidate, clause))\n    return { clause: at >= 0 ? asked.origins[at] : clause, reason: entry.reason }\n  })\n  return listQueryRefusals([...asked.refused, ...planned], context)\n}\n\n/** The comma-separated values of an `isAnyOf`, or the one value of anything else. */\nexport function crmClauseValues(clause: Pick<ListFilterRequest, 'op' | 'value'>): string[] {\n  const raw = clause.op === 'isAnyOf' ? clause.value.split(',') : [clause.value]\n  return [...new Set(raw.map((value) => value.trim()).filter(Boolean))]\n}\n\n/** One value as `equals`, several as `isAnyOf` — the shape the plan takes a list in. */\nexport function crmAnyOf(field: string, values: readonly string[]): CrmClauseAsked {\n  const unique = [...new Set(values)]\n  if (!unique.length) return { refused: 'no value yet' }\n  return unique.length === 1\n    ? { field, op: 'equals', value: unique[0] }\n    : { field, op: 'isAnyOf', value: unique.join(',') }\n}\n\n/** A `select` field: equality and \"any of\" over stored values, nothing else. */\nexport function crmSelectField(column: string, path: string = column): ListFilterField {\n  return { column, kind: 'exact', path, operators: ['equals', 'isAnyOf'] }\n}\n\n/**\n * The list fields a CLIENT edit writes beside its patch (AGL-3321): the\n * record as the listener holds it with the patch laid over — a `null` or a\n * sentinel in the patch reads as the field removed — through\n * `crmListFields`, narrowed to `fields`. A client never writes a field the\n * rules keep for the server (a lead's `emailStatus`), which is why the\n * caller names the ones it may.\n */\nexport function crmClientListFields(\n  collection: CrmListCollection,\n  record: Readonly<Record<string, unknown>>,\n  patch: Readonly<Record<string, unknown>>,\n  fields: readonly string[],\n): Record<string, unknown> {\n  const merged: Record<string, unknown> = { ...record }\n  for (const [key, value] of Object.entries(patch)) {\n    // A dotted path is a map entry (`custom.tier`), never a searched field.\n    if (key.includes('.')) continue\n    merged[key] = value === null || isSentinel(value) ? undefined : value\n  }\n  const computed = crmListFields(collection, merged)\n  return Object.fromEntries(fields.filter((field) => field in computed).map((field) => [field, computed[field]]))\n}\n\n/** A web-SDK `FieldValue` — `deleteField()`, the one a client edit of these fields sends. */\nconst isSentinel = (value: unknown): boolean =>\n  typeof value === 'object' &&\n  value !== null &&\n  !Array.isArray(value) &&\n  !(value instanceof Date) &&\n  typeof (value as { isEqual?: unknown }).isEqual === 'function'\n\n/** The search fields every CRM record carries — what a client edit of searched text rewrites. */\nexport const CRM_CLIENT_SEARCH_FIELDS = ['searchTokens', 'scopedSearchTokens'] as const\n\n"],"names":["CRM_SCOPED_SEARCH_TOKENS_FIELD","CRM_SEARCH_TOKENS_FIELD","crmListFields","scopedSearch","listQueryRefusals","CRM_LIST_SEARCH","tokensPath","scoped","crmListBase","visibleTo","path","op","value","CRM_LIST_BASE_INDEX","array","crmListDeclarationFor","declaration","foldsScope","search","crmAskClauses","stored","ask","clauses","origins","refused","clause","asked","push","reason","sameClause","a","b","field","crmQueryRefusals","plan","context","planned","map","entry","at","findIndex","candidate","crmClauseValues","raw","split","Set","trim","filter","Boolean","crmAnyOf","values","unique","length","join","crmSelectField","column","kind","operators","crmClientListFields","collection","record","patch","fields","merged","key","Object","entries","includes","isSentinel","undefined","computed","fromEntries","Array","isArray","Date","isEqual","CRM_CLIENT_SEARCH_FIELDS"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,8BAA8B,EAC9BC,uBAAuB,EAEvBC,aAAa,QACR,eAAc;AACrB,SAASC,YAAY,QAAQ,qCAAoC;AAGjE,SAASC,iBAAiB,QAAQ,+DAA8D;AAOhG;;;;;;;;;;;;;;;CAeC,GAED,mEAAmE,GACnE,OAAO,MAAMC,kBAA+D;IAC1EC,YAAYL;IACZM,QAAQJ,aAAaH;AACvB,EAAC;AAED;;;;CAIC,GACD,OAAO,SAASQ,YAAYC,SAAmC;IAC7D,OAAOA,YAAY;QAAC;YAAEC,MAAM;YAAaC,IAAI;YAAsBC,OAAO;mBAAIH;aAAU;QAAC;KAAE,GAAG,EAAE;AAClG;AAEA,mFAAmF,GACnF,OAAO,MAAMI,sBAAsB;IAAC;QAAEH,MAAM;QAAaI,OAAO;IAAK;CAAE,CAAS;AAEhF;;;;;;;;;CASC,GACD,OAAO,SAASC,sBACdC,WAAiC,EACjCC,UAAmB;QAEAD;IAAnB,IAAIC,cAAc,GAACD,sBAAAA,YAAYE,MAAM,qBAAlBF,oBAAoBT,MAAM,GAAE,OAAOS;IACtD,OAAO,aAAKA;QAAaE,QAAQ;YAAEZ,YAAYU,YAAYE,MAAM,CAACZ,UAAU;QAAC;;AAC/E;AA2BA,qEAAqE,GACrE,OAAO,SAASa,cACdC,MAAoC,EACpCC,GAAkD;IAElD,MAAMC,UAA+B,EAAE;IACvC,MAAMC,UAA+B,EAAE;IACvC,MAAMC,UAAsC,EAAE;IAC9C,KAAK,MAAMC,UAAUL,OAAQ;QAC3B,MAAMM,QAAQL,IAAII;QAClB,IAAI,aAAaC,OAAO;YACtBF,QAAQG,IAAI,CAAC;gBAAEF;gBAAQG,QAAQF,MAAMF,OAAO;YAAC;QAC/C,OAAO;YACLF,QAAQK,IAAI,CAACD;YACbH,QAAQI,IAAI,CAACF;QACf;IACF;IACA,OAAO;QAAEH;QAASC;QAASC;IAAQ;AACrC;AAEA,MAAMK,aAAa,CAACC,GAAsBC,IACxCD,EAAEE,KAAK,KAAKD,EAAEC,KAAK,IAAIF,EAAEnB,EAAE,KAAKoB,EAAEpB,EAAE,IAAImB,EAAElB,KAAK,KAAKmB,EAAEnB,KAAK;AAE7D;;;;CAIC,GACD,OAAO,SAASqB,iBACdC,IAAoC,EACpCR,KAAsB,EACtBS,OAIC;IAED,MAAMC,UAAUF,KAAKV,OAAO,CAACa,GAAG,CAAC,CAACC;QAChC,IAAIA,MAAMb,MAAM,KAAK,UAAU,OAAOa;QACtC,MAAMb,SAASa,MAAMb,MAAM;QAC3B,MAAMc,KAAKb,MAAMJ,OAAO,CAACkB,SAAS,CAAC,CAACC,YAAcZ,WAAWY,WAAWhB;QACxE,OAAO;YAAEA,QAAQc,MAAM,IAAIb,MAAMH,OAAO,CAACgB,GAAG,GAAGd;YAAQG,QAAQU,MAAMV,MAAM;QAAC;IAC9E;IACA,OAAOxB,kBAAkB;WAAIsB,MAAMF,OAAO;WAAKY;KAAQ,EAAED;AAC3D;AAEA,mFAAmF,GACnF,OAAO,SAASO,gBAAgBjB,MAA+C;IAC7E,MAAMkB,MAAMlB,OAAOd,EAAE,KAAK,YAAYc,OAAOb,KAAK,CAACgC,KAAK,CAAC,OAAO;QAACnB,OAAOb,KAAK;KAAC;IAC9E,OAAO;WAAI,IAAIiC,IAAIF,IAAIN,GAAG,CAAC,CAACzB,QAAUA,MAAMkC,IAAI,IAAIC,MAAM,CAACC;KAAU;AACvE;AAEA,sFAAsF,GACtF,OAAO,SAASC,SAASjB,KAAa,EAAEkB,MAAyB;IAC/D,MAAMC,SAAS;WAAI,IAAIN,IAAIK;KAAQ;IACnC,IAAI,CAACC,OAAOC,MAAM,EAAE,OAAO;QAAE5B,SAAS;IAAe;IACrD,OAAO2B,OAAOC,MAAM,KAAK,IACrB;QAAEpB;QAAOrB,IAAI;QAAUC,OAAOuC,MAAM,CAAC,EAAE;IAAC,IACxC;QAAEnB;QAAOrB,IAAI;QAAWC,OAAOuC,OAAOE,IAAI,CAAC;IAAK;AACtD;AAEA,8EAA8E,GAC9E,OAAO,SAASC,eAAeC,MAAc,EAAE7C,OAAe6C,MAAM;IAClE,OAAO;QAAEA;QAAQC,MAAM;QAAS9C;QAAM+C,WAAW;YAAC;YAAU;SAAU;IAAC;AACzE;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,oBACdC,UAA6B,EAC7BC,MAAyC,EACzCC,KAAwC,EACxCC,MAAyB;IAEzB,MAAMC,SAAkC,aAAKH;IAC7C,KAAK,MAAM,CAACI,KAAKpD,MAAM,IAAIqD,OAAOC,OAAO,CAACL,OAAQ;QAChD,wEAAwE;QACxE,IAAIG,IAAIG,QAAQ,CAAC,MAAM;QACvBJ,MAAM,CAACC,IAAI,GAAGpD,UAAU,QAAQwD,WAAWxD,SAASyD,YAAYzD;IAClE;IACA,MAAM0D,WAAWpE,cAAcyD,YAAYI;IAC3C,OAAOE,OAAOM,WAAW,CAACT,OAAOf,MAAM,CAAC,CAACf,QAAUA,SAASsC,UAAUjC,GAAG,CAAC,CAACL,QAAU;YAACA;YAAOsC,QAAQ,CAACtC,MAAM;SAAC;AAC/G;AAEA,2FAA2F,GAC3F,MAAMoC,aAAa,CAACxD,QAClB,OAAOA,UAAU,YACjBA,UAAU,QACV,CAAC4D,MAAMC,OAAO,CAAC7D,UACf,CAAEA,CAAAA,iBAAiB8D,IAAG,KACtB,OAAO,AAAC9D,MAAgC+D,OAAO,KAAK;AAEtD,+FAA+F,GAC/F,OAAO,MAAMC,2BAA2B;IAAC;IAAgB;CAAqB,CAAS"}

package/src/lib/model/lead-filters.d.ts

@@ -14,22 +14,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { type EmailStateStatus, type CrmLeadFields, type CrmLeadStatus } from '@aglyn/aglyn';
+import { type EmailStateStatus, type CrmLeadStatus } from '@aglyn/aglyn';
 import type { CrmViewFilterClause } from '@aglyn/aglyn';
-import type { ListFilterField } from '@aglyn/shared-ui-jsx/const/list-filter';
+import type { ListFilterField, ListFilterRequest } from '@aglyn/shared-ui-jsx/const/list-filter';
 import { type ListGridFilterCodec } from '@aglyn/shared-ui-jsx/const/list-grid-filter';
+import type { ListQueryDeclaration, ListQuerySort } from '@aglyn/shared-ui-jsx/const/list-query-plan';
+import { type CrmClauseAsked } from './crm-list-query';
 /**
  * What the Leads section's `Show` control offers (AGL-2608): the two
  * aggregate views and each status on its own. `open` is the default — the
- * list opens on the work — and it is the one view a Firestore query cannot
- * express, because a lead nobody has touched carries no status field at all;
- * see the section for why the filter runs over a loaded window.
+ * list opens on the work — asked of the query as `status in [new, working]`,
+ * which every lead answers because every lead writer stores a status, `new`
+ * for one nobody has touched (`crmLeadListFields`, AGL-3321).
  */
 export type LeadFilter = 'open' | 'all' | CrmLeadStatus;
 export declare const LEAD_FILTERS: readonly LeadFilter[];
 export declare const LEAD_FILTER_LABELS: Record<LeadFilter, string>;
-/** Whether a lead belongs in a filter's view. An absent status is `new`. */
-export declare function leadMatchesFilter(lead: Pick<CrmLeadFields, 'status'>, filter: LeadFilter): boolean;
 /**
  * The Leads section's `Email` control (AGL-3245): every lead, the ones a
  * member must not email — any verdict but `ok` — the ones nothing has been
@@ -40,46 +40,12 @@ export declare function leadMatchesFilter(lead: Pick<CrmLeadFields, 'status'>, f
 export type LeadEmailFilter = 'any' | 'problem' | 'none' | EmailStateStatus;
 export declare const LEAD_EMAIL_FILTERS: readonly LeadEmailFilter[];
 export declare const LEAD_EMAIL_FILTER_LABELS: Record<LeadEmailFilter, string>;
-/** Whether a lead belongs in an email filter's view. */
-export declare function leadMatchesEmailFilter(lead: Readonly<Record<string, unknown>>, filter: LeadEmailFilter): boolean;
-/**
- * The Leads section's `Campaign` control (AGL-3254): every lead, or the
- * ones filed under one campaign — read off the lead's own `campaignIds`,
- * the field every campaign member carries. `''` is every lead, which is
- * what the control opens on; the ids are the site's containers', and the
- * section resolves their names for the menu.
- */
-export declare function leadMatchesCampaignFilter(lead: Readonly<Record<string, unknown>>, campaignId: string): boolean;
-/**
- * The fields the Leads section's search box reads (AGL-3246): who the lead
- * is and where they work — the words a person types to find one — plus the
- * tags, which are how an import names its batch (`sal-15`). `name` and
- * `email` are the capture door's fields rather than the CRM's, so the row is
- * read as a record rather than through `CrmLeadFields`.
- */
-export declare const LEAD_SEARCH_FIELDS: readonly ["name", "email", "company", "jobTitle", "tags"];
-/**
- * Whether a lead answers a search term.
- *
- * Case-insensitive, and every whitespace-separated word of the term must
- * appear in SOME searched field: `morgan lamphere` and `lamphere sal-15`
- * both find Morgan Lamphere, `morgan smith` does not. A blank term matches
- * every lead, so the box emptied is the list unfiltered.
- */
-export declare function leadMatchesSearch(lead: Readonly<Record<string, unknown>>, term: string): boolean;
 /**
  * The `Lead source` control's "no lead source" choice (AGL-3298). Held in
  * the saved view as an `isEmpty` clause, never as this string; it is only
  * the select's own value for the choice.
  */
 export declare const LEAD_SOURCE_FILTER_NONE = "\0none";
-/**
- * The Leads section's `Lead source` control (AGL-3298): every lead (`''`),
- * the ones holding one value — compared the way the picklist compares
- * labels, so a value typed in another case before the list existed is
- * still found — or the ones holding none.
- */
-export declare function leadMatchesLeadSourceFilter(lead: Readonly<Record<string, unknown>>, filter: string): boolean;
 /** The fields the grid's panel offers on Leads. */
 export declare const LEAD_LIST_FILTER_FIELDS: readonly ListFilterField[];
 /** What each filter field reads as on a chip. */
@@ -91,7 +57,7 @@ export declare const LEAD_STATUS_FILTER_OPTIONS: {
 }[];
 /** The choices for Email: every verdict, plus the two aggregates. */
 export declare const LEAD_EMAIL_FILTER_OPTIONS: {
-    value: "none" | "bounced" | "complained" | "ok" | "blocked" | "unsubscribed" | "do_not_contact" | "problem";
+    value: "none" | "bounced" | "complained" | "ok" | "undeliverable" | "blocked" | "unsubscribed" | "do_not_contact" | "problem";
     label: string;
 }[];
 /**
@@ -103,11 +69,51 @@ export declare const LEAD_EMAIL_FILTER_OPTIONS: {
 export declare function leadClausesForGrid(stored: readonly CrmViewFilterClause[]): CrmViewFilterClause[];
 /** The inverse of {@link leadClausesForGrid}: what the view stores. */
 export declare function leadClausesToStore(shown: readonly CrmViewFilterClause[]): CrmViewFilterClause[];
-/** Whether a lead answers every clause the grid shows. */
-export declare function leadMatchesClauses(lead: Readonly<Record<string, unknown>> & Pick<CrmLeadFields, 'status'>, clauses: readonly CrmViewFilterClause[]): boolean;
 /** Campaign clauses were stored as `contains`; the panel's select says `is`. */
 export declare const LEAD_CAMPAIGN_CODEC: ListGridFilterCodec;
 /** "No lead source" is an `isEmpty` clause, shown as a choice of the select. */
 export declare const LEAD_SOURCE_CODEC: ListGridFilterCodec;
 /** The Leads fields whose stored clauses translate their own way. */
 export declare const LEAD_FILTER_CODECS: Readonly<Record<string, ListGridFilterCodec>>;
+/** The one order the Leads list takes: newest seen first. */
+export declare const LEAD_LIST_SORTS: readonly ListQuerySort[];
+/** The fields the Leads query asks — each a stored field, as named. */
+export declare const LEAD_QUERY_FIELDS: readonly ListFilterField[];
+export declare const LEAD_LIST_DECLARATION: ListQueryDeclaration;
+/**
+ * A collaborator's search (see `prefixSearch` in `useCrmListQuery`): the
+ * start of the address, beside the scope clause — the `(visibleTo, email)`
+ * composite the Inbox's leads list reads too.
+ */
+export declare const LEAD_PREFIX_SEARCH: {
+    field: {
+        column: string;
+        kind: "text";
+        path: string;
+        lowerPath: string;
+        presence: "always";
+        operators: string[];
+    };
+    notice: string;
+};
+/** Whether an asked clause stands in for the scope clause: a campaign behind the site's scope. */
+export declare const leadClauseImpliesScope: (clause: ListFilterRequest) => boolean;
+/** Who is asking, for the one clause whose shape depends on it: the Campaign. */
+export interface LeadQueryReader {
+    /** The site's scope tokens, or `null` at the organization level. */
+    scopeTokens: readonly string[] | null;
+    /** Whether the reader may run a query without the scope clause (`useCrmFoldsScope`). */
+    foldsScope: boolean;
+}
+/**
+ * One grid clause as the clause the Leads query asks — see the block above.
+ * A value the list does not know is refused by name rather than dropped, so
+ * a stored view that names a retired choice says so.
+ */
+export declare function leadQueryClause(clause: CrmViewFilterClause | ListFilterRequest, reader?: LeadQueryReader): CrmClauseAsked;
+/**
+ * The query shape the Leads list can send beyond its own declaration, for
+ * the index pin (AGL-3321): a collaborator's address prefix beside the
+ * equalities they may set.
+ */
+export declare function leadIndexShapes(): ListQueryDeclaration[];