@byline/client 3.20.3 → 3.21.0

package/dist/client.d.ts

@@ -6,7 +6,7 @@
  * Copyright (c) Infonomic Company Limited
  */
 import { type RequestContext } from '@byline/auth';
-import type { BylineLogger, CollectionDefinition, IDbAdapter, IStorageProvider, RichTextPopulateFn, RichTextToTextFn, SearchProvider, SlugifierFn } from '@byline/core';
+import type { BylineLogger, CollectionDefinition, CollectionRegistry, IDbAdapter, IStorageProvider, RichTextPopulateFn, RichTextToTextFn, SearchProvider, SlugifierFn } from '@byline/core';
 import { CollectionHandle } from './collection-handle.js';
 import type { BylineClientConfig, ClientSearchResults, ZoneSearchOptions } from './types.js';
 /**
@@ -14,9 +14,9 @@ import type { BylineClientConfig, ClientSearchResults, ZoneSearchOptions } from
  * definitions, and optional storage provider. Use `collection(path)` to get
  * a scoped handle for querying and mutating documents.
  */
-export declare class BylineClient {
+export declare class BylineClient<TRegistry extends CollectionRegistry = CollectionRegistry> {
     readonly db: IDbAdapter;
-    readonly collections: CollectionDefinition[];
+    readonly collections: readonly CollectionDefinition[];
     readonly storage: IStorageProvider | undefined;
     readonly logger: BylineLogger;
     readonly defaultLocale: string;
@@ -54,7 +54,7 @@ export declare class BylineClient {
      * Get a handle scoped to a single collection. All subsequent read/write
      * operations on the handle are performed against this collection.
      */
-    collection(path: string): CollectionHandle;
+    collection<TPath extends keyof TRegistry & string>(path: TPath): CollectionHandle<TRegistry[TPath]>;
     /**
      * Resolve a collection path to its database row id and current schema
      * version. Cached for the lifetime of this client instance. The version
@@ -73,4 +73,4 @@ export declare class BylineClient {
 /**
  * Create a new Byline client instance.
  */
-export declare function createBylineClient(config: BylineClientConfig): BylineClient;
+export declare function createBylineClient<TRegistry extends CollectionRegistry = CollectionRegistry>(config: BylineClientConfig): BylineClient<TRegistry>;

package/dist/collection-handle.d.ts

@@ -14,10 +14,10 @@ import type { AuditLogOptions, ClientDocument, ClientSearchResults, CollectionSe
  *
  * Created via `client.collection('posts')`.
  */
-export declare class CollectionHandle {
+export declare class CollectionHandle<TFields extends Record<string, any> = Record<string, any>> {
     private client;
     private definition;
-    constructor(client: BylineClient, definition: CollectionDefinition);
+    constructor(client: BylineClient<any>, definition: CollectionDefinition);
     /**
      * Find documents with optional filtering, sorting, pagination, and field
      * selection.
@@ -27,12 +27,12 @@ export declare class CollectionHandle {
      * (EXISTS subqueries against EAV store tables), and field-level sorting
      * (LATERAL JOINs).
      */
-    find<F = Record<string, any>>(options?: FindOptions<F>): Promise<FindResult<F>>;
+    find<F = TFields>(options?: FindOptions<F>): Promise<FindResult<F>>;
     /**
      * Find a single document matching the given options. Returns `null` if no
      * document matches.
      */
-    findOne<F = Record<string, any>>(options?: FindOneOptions<F>): Promise<ClientDocument<F> | null>;
+    findOne<F = TFields>(options?: FindOneOptions<F>): Promise<ClientDocument<F> | null>;
     /**
      * Ranked full-text search scoped to this collection, delegated to the
      * registered `SearchProvider` (see `ServerConfig.search`). Returns the
@@ -96,13 +96,13 @@ export declare class CollectionHandle {
     /**
      * Find a document by its logical document ID.
      */
-    findById<F = Record<string, any>>(documentId: string, options?: FindByIdOptions<F>): Promise<ClientDocument<F> | null>;
+    findById<F = TFields>(documentId: string, options?: FindByIdOptions<F>): Promise<ClientDocument<F> | null>;
     /**
      * Find a document by its URL path/slug. Returns `null` when no document
      * exists at the given path (the storage adapter resolves missing paths
      * to `null` rather than throwing).
      */
-    findByPath<F = Record<string, any>>(path: string, options?: FindByPathOptions<F>): Promise<ClientDocument<F> | null>;
+    findByPath<F = TFields>(path: string, options?: FindByPathOptions<F>): Promise<ClientDocument<F> | null>;
     /**
      * Create a new document in this collection.
      *
@@ -182,7 +182,7 @@ export declare class CollectionHandle {
      * mirrors the storage adapter's `{ documents, meta }` shape, then is
      * mapped to the same `{ docs, meta }` envelope `find()` returns.
      */
-    history<F = Record<string, any>>(documentId: string, options?: HistoryOptions): Promise<FindResult<F>>;
+    history<F = TFields>(documentId: string, options?: HistoryOptions): Promise<FindResult<F>>;
     /**
      * Fetch the document-grain audit log for a single document (docs/06-auth-and-security/02-auditability.md —
      * Workstream 3): the non-versioned system-field writes (path,
@@ -210,7 +210,7 @@ export declare class CollectionHandle {
      * expected to have already passed an access check on the parent
      * document. Use `history()` instead if you want the access gate.
      */
-    findByVersion<F = Record<string, any>>(versionId: string, options?: FindByVersionOptions<F>): Promise<ClientDocument<F> | null>;
+    findByVersion<F = TFields>(versionId: string, options?: FindByVersionOptions<F>): Promise<ClientDocument<F> | null>;
     /**
      * Place or move a document within this collection's tree — a single upsert
      * covering place, reorder, and re-parent (they differ only in whether the
@@ -236,7 +236,7 @@ export declare class CollectionHandle {
      * `'published'` (the client default) — an unpublished node hides its whole
      * subtree in that mode.
      */
-    getSubtree<F = Record<string, any>>(options?: GetSubtreeOptions<F>): Promise<TreeNode<F>[]>;
+    getSubtree<F = TFields>(options?: GetSubtreeOptions<F>): Promise<TreeNode<F>[]>;
     /**
      * Walk a document's ancestor chain upward, returning the ancestors
      * **root-first** (the breadcrumb trail, excluding the node itself), hydrated
@@ -245,7 +245,7 @@ export declare class CollectionHandle {
      * truncated chain), so a broken spine surfaces as a short chain the caller can
      * detect rather than a silently-compacted one.
      */
-    getAncestors<F = Record<string, any>>(documentId: string, options?: GetAncestorsOptions<F>): Promise<ClientDocument<F>[]>;
+    getAncestors<F = TFields>(documentId: string, options?: GetAncestorsOptions<F>): Promise<ClientDocument<F>[]>;
     /**
      * Resolve a document's placement state in the tree — the tri-state that
      * `getAncestors` cannot express (it returns `[]` for both a root and an

package/dist/search.d.ts

@@ -21,7 +21,7 @@ import type { ReadContext, ReadMode, SearchHit } from '@byline/core';
 import type { BylineClient } from './client.js';
 import type { ClientSearchResults, HydratedSearchHit, ZoneSearchOptions } from './types.js';
 export interface FinalizeSearchHitsParams {
-    client: BylineClient;
+    client: BylineClient<any>;
     requestContext: RequestContext;
     hits: SearchHit[];
     locale?: string;
@@ -57,4 +57,4 @@ export declare function finalizeSearchHits(params: FinalizeSearchHitsParams): Pr
  * `ERR_VALIDATION` for a zone no collection indexes into; rethrows the
  * ability error only when the actor can read none of the members.
  */
-export declare function zoneSearch(client: BylineClient, options: ZoneSearchOptions): Promise<ClientSearchResults>;
+export declare function zoneSearch(client: BylineClient<any>, options: ZoneSearchOptions): Promise<ClientSearchResults>;

package/dist/types.d.ts

@@ -31,7 +31,7 @@ export interface BylineClientConfig {
     /** The database adapter (e.g. from @byline/db-postgres). Required when `config` is omitted. */
     db?: IDbAdapter;
     /** All registered collection definitions. Required when `config` is omitted. */
-    collections?: CollectionDefinition[];
+    collections?: readonly CollectionDefinition[];
     /** Optional storage provider — needed for delete file cleanup. */
     storage?: IStorageProvider;
     /**

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/client",
   "private": false,
   "license": "MPL-2.0",
-  "version": "3.20.3",
+  "version": "3.21.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -37,8 +37,8 @@
     "dist"
   ],
   "dependencies": {
-    "@byline/auth": "3.20.3",
-    "@byline/core": "3.20.3"
+    "@byline/auth": "3.21.0",
+    "@byline/core": "3.21.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.2",
@@ -51,8 +51,8 @@
     "tsx": "^4.23.0",
     "typescript": "^7.0.2",
     "vitest": "^4.1.10",
-    "@byline/db-postgres": "3.20.3",
-    "@byline/search-postgres": "3.20.3"
+    "@byline/db-postgres": "3.21.0",
+    "@byline/search-postgres": "3.21.0"
   },
   "publishConfig": {
     "access": "public",