@byline/client 1.5.0 → 1.6.0

package/dist/collection-handle.js

@@ -118,6 +118,7 @@ export class CollectionHandle {
             reconstruct: true,
             readMode,
             filters,
+            lenient: options.lenient,
         });
         if (raw == null)
             return null;

package/dist/response.js

@@ -23,7 +23,7 @@ function toDate(value, fieldName) {
  * `fields` property for callers that know their collection's shape.
  */
 export function shapeDocument(raw) {
-    return {
+    const shaped = {
         id: raw.document_id ?? '',
         versionId: raw.document_version_id ?? '',
         path: raw.path ?? '',
@@ -32,6 +32,10 @@ export function shapeDocument(raw) {
         updatedAt: toDate(raw.updated_at, 'updated_at'),
         fields: (raw.fields ?? {}),
     };
+    if (Array.isArray(raw.restoreWarnings) && raw.restoreWarnings.length > 0) {
+        shaped._restoreWarnings = raw.restoreWarnings;
+    }
+    return shaped;
 }
 /**
  * Detect a raw (storage-shape) document vs a shaped `ClientDocument` vs a

package/dist/types.d.ts

@@ -168,6 +168,15 @@ export interface FindOneOptions<F = Record<string, any>> extends PopulateControl
 export interface FindByIdOptions<F = Record<string, any>> extends PopulateControls, StatusControls, BeforeReadControls {
     select?: (keyof F & string)[] | string[];
     locale?: string;
+    /**
+     * "Best-effort" reconstruction. When `true`, schema-mismatch warnings
+     * (e.g. a field's type was changed and old rows can't be rebuilt against
+     * the new shape) are surfaced on the returned `ClientDocument` as
+     * `_restoreWarnings` instead of being thrown. Intended for the admin
+     * edit path only — public reads should leave this `false` so partial
+     * data never reaches end users.
+     */
+    lenient?: boolean;
 }
 export interface FindByPathOptions<F = Record<string, any>> extends PopulateControls, StatusControls, BeforeReadControls {
     select?: (keyof F & string)[] | string[];
@@ -281,6 +290,15 @@ export interface ClientDocument<F = Record<string, any>> {
     updatedAt: Date;
     /** Reconstructed field data. */
     fields: F;
+    /**
+     * Schema-mismatch warnings produced by a "best-effort" reconstruction
+     * (`findById` with `lenient: true`). Present only when the document was
+     * loaded leniently and at least one orphan row was skipped — for example,
+     * after a `CollectionDefinition` change retired or replaced a field and
+     * older rows can no longer be rebuilt against the new shape. Absent on
+     * normal reads.
+     */
+    _restoreWarnings?: string[];
 }
 export interface FindResult<F = Record<string, any>> {
     docs: ClientDocument<F>[];

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/client",
   "private": false,
   "license": "MPL-2.0",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -38,8 +38,8 @@
   ],
   "dependencies": {
     "npm-run-all": "^4.1.5",
-    "@byline/auth": "1.4.0",
-    "@byline/core": "1.5.0"
+    "@byline/auth": "1.6.0",
+    "@byline/core": "1.6.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.14",
@@ -51,7 +51,7 @@
     "tsx": "^4.21.0",
     "typescript": "6.0.3",
     "vitest": "^4.1.5",
-    "@byline/db-postgres": "1.4.0"
+    "@byline/db-postgres": "1.6.0"
   },
   "publishConfig": {
     "access": "public",