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

package/src/lib/constants/company-filters.js

@@ -13,39 +13,69 @@
  * 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.
- */ /*
- * Companies (`orgs/{orgId}/companies`, read scoped to a host).
+ */ import { CRM_NEXT_ACTIVITY_FILTER_FIELD } from "../components/crm-next-activity-column.js";
+import { CRM_LIST_SEARCH } from "../model/crm-list-query.js";
+/*
+ * Companies (`orgs/{orgId}/companies`, read scoped to a host) — every clause
+ * and the search word on the list's one query, newest change first
+ * (AGL-3321).
  *
- * Every predicate here is appended to the listener's `visibleTo
- * array-contains-any`, which is the constraint that decides what a company
- * filter may be. Firestore carries ONE array clause per query, so the
- * word-prefix `contains` search the contact list declares through
- * `nameTokens` cannot run beside the scope predicate — a query with both is
- * refused outright, not served slowly. The name is therefore offered as a
- * PREFIX range and an exact match over `nameLower`, which the
- * `(visibleTo CONTAINS, nameLower ASC)` index serves with the scope in
- * place. No `tokensPath`, deliberately.
+ * The search box reads `searchTokens`, the word prefixes of the name and
+ * the domain every company writer stamps (`crmCompanyListFields`). Under a
+ * site the scope clause (`visibleTo array-contains-any`) is the query's one
+ * array clause, and the search folds into it (`scopedSearchTokens`) for a
+ * reader who may drop it.
  *
- * `ownerUid` is declared so the translator can answer it; the column itself
- * renders a person's name from the roster and offers a single-select
- * operator in the panel, which the section maps onto this field's `equals`.
- * Served by `(visibleTo CONTAINS, ownerUid ASC)`.
+ * The name is also an exact match and a PREFIX range over `nameLower` — the
+ * list's one range, which then orders the list by name. The owner is a
+ * choice from the roster, and "No next activity" asks `nextTaskAtMs ==
+ * null`. Each equality rides one `(field, updatedAt DESC)` composite, and
+ * one `(field, nameLower ASC)` beside it for the prefix.
  */ export const COMPANY_LIST_FILTER_FIELDS = [
     {
         column: 'name',
         kind: 'text',
         path: 'name',
         lowerPath: 'nameLower',
-        presence: 'always'
+        presence: 'always',
+        operators: [
+            'equals',
+            'startsWith'
+        ]
     },
     {
         column: 'ownerUid',
         kind: 'exact',
         path: 'ownerUid',
         operators: [
-            'equals'
+            'equals',
+            'isAnyOf'
         ]
+    },
+    CRM_NEXT_ACTIVITY_FILTER_FIELD
+];
+/**
+ * A collaborator's search (see `prefixSearch` in `useCrmListQuery`): the
+ * start of the name, beside the scope clause — the prefix range the
+ * `(field, nameLower)` composites already serve.
+ */ export const COMPANY_PREFIX_SEARCH = {
+    field: COMPANY_LIST_FILTER_FIELDS[0],
+    notice: 'Search matches the start of a company’s name for access limited to specific sites.'
+};
+/** The list's orders: newest change first, and by name under a prefix. */ export const COMPANY_LIST_SORTS = [
+    {
+        path: 'updatedAt',
+        direction: 'desc'
+    },
+    {
+        path: 'nameLower',
+        direction: 'asc'
     }
 ];
+export const COMPANY_LIST_DECLARATION = {
+    fields: COMPANY_LIST_FILTER_FIELDS,
+    sorts: COMPANY_LIST_SORTS,
+    search: CRM_LIST_SEARCH
+};
 
 //# sourceMappingURL=company-filters.js.map

package/src/lib/constants/company-filters.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/plugins/crm/src/lib/constants/company-filters.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 type { ListFilterField } from '@aglyn/shared-ui-jsx/const/list-filter'\n\n/*\n * Companies (`orgs/{orgId}/companies`, read scoped to a host).\n *\n * Every predicate here is appended to the listener's `visibleTo\n * array-contains-any`, which is the constraint that decides what a company\n * filter may be. Firestore carries ONE array clause per query, so the\n * word-prefix `contains` search the contact list declares through\n * `nameTokens` cannot run beside the scope predicate — a query with both is\n * refused outright, not served slowly. The name is therefore offered as a\n * PREFIX range and an exact match over `nameLower`, which the\n * `(visibleTo CONTAINS, nameLower ASC)` index serves with the scope in\n * place. No `tokensPath`, deliberately.\n *\n * `ownerUid` is declared so the translator can answer it; the column itself\n * renders a person's name from the roster and offers a single-select\n * operator in the panel, which the section maps onto this field's `equals`.\n * Served by `(visibleTo CONTAINS, ownerUid ASC)`.\n */\nexport const COMPANY_LIST_FILTER_FIELDS: readonly ListFilterField[] = [\n  {\n    column: 'name',\n    kind: 'text',\n    path: 'name',\n    lowerPath: 'nameLower',\n    presence: 'always',\n  },\n  {\n    column: 'ownerUid',\n    kind: 'exact',\n    path: 'ownerUid',\n    operators: ['equals'],\n  },\n]\n"],"names":["COMPANY_LIST_FILTER_FIELDS","column","kind","path","lowerPath","presence","operators"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAID;;;;;;;;;;;;;;;;;CAiBC,GACD,OAAO,MAAMA,6BAAyD;IACpE;QACEC,QAAQ;QACRC,MAAM;QACNC,MAAM;QACNC,WAAW;QACXC,UAAU;IACZ;IACA;QACEJ,QAAQ;QACRC,MAAM;QACNC,MAAM;QACNG,WAAW;YAAC;SAAS;IACvB;CACD,CAAA"}
+{"version":3,"sources":["../../../../../../../libs/plugins/crm/src/lib/constants/company-filters.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 type { ListFilterField } from '@aglyn/shared-ui-jsx/const/list-filter'\n\nimport { CRM_NEXT_ACTIVITY_FILTER_FIELD } from '../components/crm-next-activity-column'\nimport type { ListQueryDeclaration, ListQuerySort } from '@aglyn/shared-ui-jsx/const/list-query-plan'\nimport { CRM_LIST_SEARCH } from '../model/crm-list-query'\n\n/*\n * Companies (`orgs/{orgId}/companies`, read scoped to a host) — every clause\n * and the search word on the list's one query, newest change first\n * (AGL-3321).\n *\n * The search box reads `searchTokens`, the word prefixes of the name and\n * the domain every company writer stamps (`crmCompanyListFields`). Under a\n * site the scope clause (`visibleTo array-contains-any`) is the query's one\n * array clause, and the search folds into it (`scopedSearchTokens`) for a\n * reader who may drop it.\n *\n * The name is also an exact match and a PREFIX range over `nameLower` — the\n * list's one range, which then orders the list by name. The owner is a\n * choice from the roster, and \"No next activity\" asks `nextTaskAtMs ==\n * null`. Each equality rides one `(field, updatedAt DESC)` composite, and\n * one `(field, nameLower ASC)` beside it for the prefix.\n */\nexport const COMPANY_LIST_FILTER_FIELDS: readonly ListFilterField[] = [\n  {\n    column: 'name',\n    kind: 'text',\n    path: 'name',\n    lowerPath: 'nameLower',\n    presence: 'always',\n    operators: ['equals', 'startsWith'],\n  },\n  {\n    column: 'ownerUid',\n    kind: 'exact',\n    path: 'ownerUid',\n    operators: ['equals', 'isAnyOf'],\n  },\n  CRM_NEXT_ACTIVITY_FILTER_FIELD,\n]\n\n/**\n * A collaborator's search (see `prefixSearch` in `useCrmListQuery`): the\n * start of the name, beside the scope clause — the prefix range the\n * `(field, nameLower)` composites already serve.\n */\nexport const COMPANY_PREFIX_SEARCH = {\n  field: COMPANY_LIST_FILTER_FIELDS[0],\n  notice: 'Search matches the start of a company’s name for access limited to specific sites.',\n}\n\n/** The list's orders: newest change first, and by name under a prefix. */\nexport const COMPANY_LIST_SORTS: readonly ListQuerySort[] = [\n  { path: 'updatedAt', direction: 'desc' },\n  { path: 'nameLower', direction: 'asc' },\n]\n\nexport const COMPANY_LIST_DECLARATION: ListQueryDeclaration = {\n  fields: COMPANY_LIST_FILTER_FIELDS,\n  sorts: COMPANY_LIST_SORTS,\n  search: CRM_LIST_SEARCH,\n}\n"],"names":["CRM_NEXT_ACTIVITY_FILTER_FIELD","CRM_LIST_SEARCH","COMPANY_LIST_FILTER_FIELDS","column","kind","path","lowerPath","presence","operators","COMPANY_PREFIX_SEARCH","field","notice","COMPANY_LIST_SORTS","direction","COMPANY_LIST_DECLARATION","fields","sorts","search"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAID,SAASA,8BAA8B,QAAQ,4CAAwC;AAEvF,SAASC,eAAe,QAAQ,6BAAyB;AAEzD;;;;;;;;;;;;;;;;CAgBC,GACD,OAAO,MAAMC,6BAAyD;IACpE;QACEC,QAAQ;QACRC,MAAM;QACNC,MAAM;QACNC,WAAW;QACXC,UAAU;QACVC,WAAW;YAAC;YAAU;SAAa;IACrC;IACA;QACEL,QAAQ;QACRC,MAAM;QACNC,MAAM;QACNG,WAAW;YAAC;YAAU;SAAU;IAClC;IACAR;CACD,CAAA;AAED;;;;CAIC,GACD,OAAO,MAAMS,wBAAwB;IACnCC,OAAOR,0BAA0B,CAAC,EAAE;IACpCS,QAAQ;AACV,EAAC;AAED,wEAAwE,GACxE,OAAO,MAAMC,qBAA+C;IAC1D;QAAEP,MAAM;QAAaQ,WAAW;IAAO;IACvC;QAAER,MAAM;QAAaQ,WAAW;IAAM;CACvC,CAAA;AAED,OAAO,MAAMC,2BAAiD;IAC5DC,QAAQb;IACRc,OAAOJ;IACPK,QAAQhB;AACV,EAAC"}

package/src/lib/constants/contact-filters.d.ts

@@ -15,18 +15,17 @@
  * limitations under the License.
  */
 import { type ContactFieldDefinition } 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 { ListQueryDeclaration, ListQuerySort } from '@aglyn/shared-ui-jsx/const/list-query-plan';
+import { type CrmClauseAsked } from '../model/crm-list-query';
+/** What the Filters panel offers on a contact, in the grid's grammar. */
 export declare const CONTACT_LIST_FILTER_FIELDS: readonly ListFilterField[];
 /**
- * One filter field per active custom contact field (AGL-2617).
- *
- * A custom value lives under the facet's `custom` map, so every one is
- * window-only for the reason the facet fields above are, and its column is
- * the one the table shows it under — `crmContactCustomColumn(key)` — so a
- * clause and a column agree on the name and a saved view's columns and
- * filters name the same thing. The kind follows the definition's type, and
- * `nullable` is how a cleared value is stored, which is what makes both
- * empty operators honest here.
+ * One filter field per active custom contact field (AGL-2617). A custom
+ * value lives under the holder's `custom` map, so it is asked through the
+ * holder's facet key: equality on a picked, typed or ticked value, and
+ * "is not empty". Its column is the one the table shows it under —
+ * `crmContactCustomColumn(key)` — so a clause and a column agree on the name.
  */
 export declare function contactCustomFilterFields(definitions: readonly Pick<ContactFieldDefinition, 'key' | 'type' | 'retiredAt'>[]): ListFilterField[];
 /** The custom fields' headers, keyed by the column each filters as. */
@@ -36,3 +35,55 @@ export declare function contactCustomFilterHeaders(definitions: readonly Pick<Co
  * picker, and as the header of a filter-only hidden column.
  */
 export declare const CONTACT_LIST_FILTER_HEADERS: Readonly<Record<string, string>>;
+/** The list's one order: newest change first. */
+export declare const CONTACT_LIST_SORTS: readonly ListQuerySort[];
+/** The stored array a facet clause is asked of. */
+export declare const CONTACT_FACET_KEYS_PATH = "facetKeys";
+/** The fields the Contacts query asks — each a stored field, as named. */
+export declare const CONTACT_QUERY_FIELDS: readonly ListFilterField[];
+export declare const CONTACT_LIST_DECLARATION: ListQueryDeclaration;
+/**
+ * The ranges that stand ALONE beside the scope clause: Created and a name
+ * or address prefix each order the list by their own field, which the
+ * `(visibleTo, field)` composites serve and nothing beside them. Updated is
+ * not one: the list is ordered by it already, so it composes freely.
+ */
+export declare function contactSoloClause(clause: ListFilterRequest): boolean;
+/**
+ * A collaborator's search (see `prefixSearch` in `useCrmListQuery`): the
+ * start of the contact's name, beside the scope clause.
+ */
+export declare const CONTACT_PREFIX_SEARCH: {
+    field: ListFilterField;
+    notice: string;
+};
+/** Who is asking: the viewing holder, and whether their query may drop the scope clause. */
+export interface ContactQueryReader {
+    /** The viewing holder's group id under a site; `null` at the organization level. */
+    groupId: string | null;
+    /**
+     * Whether the reader's query may stand a facet or form clause in the
+     * scope clause's place (`useCrmFoldsScope`) — always at the organization
+     * level, where there is no scope clause.
+     */
+    foldsScope: boolean;
+}
+/**
+ * One grid clause as the clause the Contacts query asks — see the block at
+ * the top. A clause a query cannot serve for this reader is refused by
+ * name, never matched over the rows a page loaded.
+ */
+export declare function contactQueryClause(clause: ListFilterRequest, reader: ContactQueryReader): CrmClauseAsked;
+/**
+ * Whether an asked clause stands in for the scope clause: a facet key of
+ * the viewing holder, which only a record that holder keeps carries, or a
+ * form, which only its site's captures carry.
+ */
+export declare function contactClauseImpliesScope(groupId: string | null): (clause: ListFilterRequest) => boolean;
+/**
+ * The query shapes the Contacts list can send, as declarations the index
+ * pin enumerates (AGL-3321): the list's own, without its solo ranges, whose
+ * every equality rides `(field, updatedAt DESC)`; and each solo range beside
+ * the scope clause alone.
+ */
+export declare function contactIndexShapes(): ListQueryDeclaration[];