@byline/client 4.17.0 → 4.18.0

package/dist/collection-handle.js

@@ -9,7 +9,7 @@ import { applyAfterRead, assertActorCanPerform, buildSearchDocument, cancelDocum
 import { getReadSecurityDomain, resolveReadRequestContext, resolveReadSecurityFilters, } from './read-context.js';
 import { expectedDocumentId } from './read-internals.js';
 import { shapeDocument, shapePopulatedInPlace } from './response.js';
-import { assertSearchQueryLength, finalizeSearchHits } from './search.js';
+import { assertSearchFieldScope, assertSearchQueryLength, finalizeSearchHits } from './search.js';
 function toScheduleInfo(schedule) {
     const { executionToken: _executionToken, executionExpiresAt: _executionExpiresAt, ...info } = schedule;
     return info;
@@ -148,8 +148,10 @@ export class CollectionHandle {
                     'see `@byline/search-postgres` → `postgresSearch()` for the built-in driver.',
             });
         }
+        assertSearchFieldScope(provider, options.fieldScope);
         const results = await provider.search({
             query: options.query,
+            fieldScope: options.fieldScope,
             matching: options.matching,
             collectionPath: this.definition.path,
             locale: options.locale ?? this.client.defaultLocale,

package/dist/search.d.ts

@@ -17,9 +17,11 @@
  * into shaped `ClientDocument`s in the same query.
  */
 import type { RequestContext } from '@byline/auth';
-import type { ReadContext, ReadMode, SearchHit } from '@byline/core';
+import type { ReadContext, ReadMode, SearchHit, SearchProvider } from '@byline/core';
 import type { BylineClient } from './client.js';
 import type { ClientSearchResults, HydratedSearchHit, ZoneSearchOptions } from './types.js';
+/** Validate the optional logical body-field scope before calling a provider. */
+export declare function assertSearchFieldScope(provider: SearchProvider, fieldScope: string[] | undefined): void;
 export interface FinalizeSearchHitsParams {
     client: BylineClient<any>;
     requestContext: RequestContext;

package/dist/search.js

@@ -7,6 +7,20 @@
  */
 import { assertActorCanPerform, createReadContext, ERR_VALIDATION, getCollectionAdminConfig, MAX_SEARCH_QUERY_LENGTH, resolveSearchZones, } from '@byline/core';
 import { resolveReadRequestContext, resolveReadSecurityFilters } from './read-context.js';
+/** Validate the optional logical body-field scope before calling a provider. */
+export function assertSearchFieldScope(provider, fieldScope) {
+    if (fieldScope == null)
+        return;
+    if (fieldScope.length === 0 ||
+        fieldScope.some((field) => typeof field !== 'string' || field.trim().length === 0)) {
+        throw ERR_VALIDATION({ message: 'Search fieldScope must contain one or more field names.' });
+    }
+    if (!provider.capabilities.fullText.fieldScope) {
+        throw ERR_VALIDATION({
+            message: 'The registered search provider does not support field-scoped full-text queries.',
+        });
+    }
+}
 /**
  * Authorise (and optionally hydrate) provider hits, per collection:
  *
@@ -163,6 +177,7 @@ export async function zoneSearch(client, options) {
     if (readable.size === 0) {
         throw firstAbilityError;
     }
+    assertSearchFieldScope(provider, options.fieldScope);
     let aggregateRestricted = readable.size !== members.length;
     if (!options._bypassBeforeRead) {
         for (const member of members) {
@@ -176,6 +191,7 @@ export async function zoneSearch(client, options) {
     }
     const results = await provider.search({
         query: options.query,
+        fieldScope: options.fieldScope,
         matching: options.matching,
         zone: options.zone,
         locale: options.locale ?? client.defaultLocale,

package/dist/types.d.ts

@@ -183,6 +183,8 @@ interface StatusControls {
 export interface CollectionSearchOptions extends BeforeReadControls {
     /** Free-text query string. */
     query: string;
+    /** Restrict full-text matching to named fields from the collection's `search.body`. */
+    fieldScope?: string[];
     /** Provider-neutral term and phrase matching semantics. */
     matching?: SearchMatching;
     /** Restrict to a single content locale (defaults to the client default). */
@@ -217,6 +219,8 @@ export interface CollectionSearchOptions extends BeforeReadControls {
 export interface ZoneSearchOptions extends BeforeReadControls {
     /** Free-text query string. */
     query: string;
+    /** Restrict full-text matching to body-field names shared by participating collections. */
+    fieldScope?: string[];
     /** Provider-neutral term and phrase matching semantics. */
     matching?: SearchMatching;
     /** The zone (named cross-collection scope) to search. */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/client",
   "private": false,
   "license": "MPL-2.0",
-  "version": "4.17.0",
+  "version": "4.18.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -44,8 +44,8 @@
   ],
   "dependencies": {
     "uuid": "^14.0.2",
-    "@byline/auth": "4.17.0",
-    "@byline/core": "4.17.0"
+    "@byline/auth": "4.18.0",
+    "@byline/core": "4.18.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.10",
@@ -57,8 +57,8 @@
     "tsc-alias": "^1.9.2",
     "typescript": "^7.0.2",
     "vitest": "^4.1.11",
-    "@byline/search-postgres": "4.17.0",
-    "@byline/db-postgres": "4.17.0"
+    "@byline/search-postgres": "4.18.0",
+    "@byline/db-postgres": "4.18.0"
   },
   "publishConfig": {
     "access": "public",