@byline/client 4.19.0 → 5.1.0

package/dist/test-adapter.test-helper.js

@@ -0,0 +1,117 @@
+export function testAdapter(overrides = {}) {
+    const unused = () => {
+        throw new Error('Unexpected adapter operation in unit fixture');
+    };
+    return {
+        withTransaction: unused,
+        withReadSnapshot: unused,
+        ...overrides,
+        revisions: {
+            readStructure: unused,
+            assertCompatibleSchema: unused,
+            isInTransaction: () => false,
+            lock: unused,
+            advance: unused,
+            ...overrides.revisions,
+        },
+        commands: {
+            collections: {
+                lockCollectionRegistration: unused,
+                create: unused,
+                update: unused,
+                delete: unused,
+                ...overrides.commands?.collections,
+            },
+            documents: {
+                createDocumentVersion: unused,
+                updateDocumentPath: unused,
+                setDocumentAvailableLocales: unused,
+                setDocumentStatus: unused,
+                archivePublishedVersions: unused,
+                softDeleteDocument: unused,
+                restoreSoftDeletedDocument: unused,
+                deleteDocumentLocale: unused,
+                setOrderKey: unused,
+                placeTreeNode: unused,
+                removeFromTree: unused,
+                promoteChildrenAndRemoveFromTree: unused,
+                ...overrides.commands?.documents,
+                publishSchedules: {
+                    lockDocuments: unused,
+                    schedule: unused,
+                    confirm: unused,
+                    cancel: unused,
+                    suspendForContentEdit: unused,
+                    claimDue: unused,
+                    lockClaim: unused,
+                    deleteClaim: unused,
+                    suspendClaimForContentEdit: unused,
+                    releaseClaim: unused,
+                    ...overrides.commands?.documents?.publishSchedules,
+                },
+            },
+            counters: {
+                ensureCounterGroup: unused,
+                nextCounterValue: unused,
+                nextScopedCounterValue: unused,
+                ...overrides.commands?.counters,
+            },
+            audit: {
+                append: unused,
+                ...overrides.commands?.audit,
+            },
+            singletons: {
+                lockSlot: unused,
+                setMapping: unused,
+                clearMapping: unused,
+                ...overrides.commands?.singletons,
+            },
+        },
+        queries: {
+            collections: {
+                getAllCollections: unused,
+                getCollectionByPath: unused,
+                getCollectionById: unused,
+                ...overrides.queries?.collections,
+            },
+            documents: {
+                getDocumentRevision: unused,
+                getDocumentSystemFieldsForUpdate: unused,
+                getDocumentById: unused,
+                getCurrentVersionMetadata: unused,
+                getCurrentPath: unused,
+                getDocumentByPath: unused,
+                getDocumentByVersion: unused,
+                getDocumentsByVersionIds: unused,
+                getDocumentsByDocumentIds: unused,
+                getDocumentHistory: unused,
+                getPublishedVersion: unused,
+                getPublishedDocumentIds: unused,
+                getDocumentCountsByStatus: unused,
+                findDocuments: unused,
+                getLastOrderKey: unused,
+                getNeighborOrderKeys: unused,
+                getCanonicalDocumentOrder: unused,
+                getTreeAncestors: unused,
+                getTreeChildren: unused,
+                getTreeParent: unused,
+                getTreeSubtree: unused,
+                ...overrides.queries?.documents,
+                publishSchedules: {
+                    get: unused,
+                    list: unused,
+                    ...overrides.queries?.documents?.publishSchedules,
+                },
+            },
+            audit: {
+                getDocumentAuditLog: unused,
+                findAuditLog: unused,
+                ...overrides.queries?.audit,
+            },
+            singletons: {
+                getMappedDocumentId: unused,
+                ...overrides.queries?.singletons,
+            },
+        },
+    };
+}

package/dist/types.d.ts

@@ -6,7 +6,7 @@
  * Copyright (c) Infonomic Company Limited
  */
 import type { RequestContext } from '@byline/auth';
-import type { BylineLogger, CollectionDefinition, DocumentPublishSchedule, IDbAdapter, IStorageProvider, MissingLocalePolicy, PopulateSpec, PredicateValue, QueryPredicate, ReadContext, ReadMode, RichTextPopulateFn, RichTextToTextFn, SearchFacetBucket, SearchHit, SearchMatching, SearchProvider, ServerConfig, SlugifierFn, SortSpec } from '@byline/core';
+import type { BylineLogger, CollectionDefinition, DocumentPublishSchedule, IDbAdapter, IStorageProvider, MissingLocalePolicy, PopulateSpec, PredicateValue, QueryPredicate, ReadContext, ReadMode, RichTextPopulateFn, RichTextToTextFn, SearchFacetBucket, SearchHit, SearchMatching, SearchProvider, ServerConfig, SingletonSavePrecondition, SlugifierFn, SortSpec } from '@byline/core';
 export type { FilterOperators, PredicateValue, QueryPredicate, SearchFacetBucket, SearchHit, SearchProvider, SearchResults, SortDirection, SortSpec, } from '@byline/core';
 export interface BylineClientConfig {
     /**
@@ -408,6 +408,8 @@ export interface CreateOptions {
     availableLocales?: string[];
 }
 export interface UpdateOptions {
+    /** Revision from the editable document observed before preparing this update. */
+    expectedRevision: number;
     /** Locale for field value resolution. Defaults to the client's `defaultLocale`. */
     locale?: string;
     /**
@@ -424,14 +426,13 @@ export interface UpdateOptions {
     availableLocales?: string[];
 }
 /** Write controls for `SingletonHandle.update()`. */
-export interface UpdateSingletonOptions {
-    /** Locale for field value resolution. Defaults to the client's `defaultLocale`. */
+export type UpdateSingletonOptions = SingletonSavePrecondition & {
+    /** Locale for field value resolution. Defaults to the client's defaultLocale. */
     locale?: string;
-    /** Reject the save when this is not the slot's current version id. */
-    expectedVersionId?: string;
-}
+};
 /** Optimistic, absolute-time input for `CollectionHandle.schedulePublish()`. */
 export interface SchedulePublishOptions {
+    expectedRevision: number;
     /** ISO instant carrying an explicit UTC offset or `Z`. */
     publishAt: string;
     /** The current version the editor reviewed and intends to publish. */
@@ -439,6 +440,7 @@ export interface SchedulePublishOptions {
 }
 /** Reviewed current version used to re-arm a suspended publication. */
 export interface ConfirmScheduledPublishOptions {
+    expectedRevision: number;
     expectedVersionId: string;
 }
 /**
@@ -459,6 +461,7 @@ export type DocumentPublishScheduleInfo = Omit<DocumentPublishSchedule, 'executi
  * may be null/omitted (append as last child, or prepend before a given sibling).
  */
 export interface PlaceTreeNodeOptions {
+    expectedRevision: number;
     /** The new parent; `null` makes the node a root. */
     parentDocumentId: string | null;
     /** Left neighbour — the node lands immediately after it. */
@@ -470,6 +473,7 @@ export interface PlaceTreeNodeOptions {
 }
 /** Options for an idempotent tree removal or post-commit hook retry. */
 export interface RemoveFromTreeOptions {
+    expectedRevision: number;
     /** Re-run `afterTreeChange` when the document is already unplaced. */
     reconcile?: boolean;
 }
@@ -706,3 +710,26 @@ export type WithPopulated<F, K extends keyof F, Target> = {
 export type WithPopulatedMany<F, K extends keyof F, Target> = {
     [P in keyof F]: P extends K ? Array<PopulatedRelation<Target>> : F[P];
 };
+/** Only explicit current editable reads carry mutation observations. */
+export interface EditableDocument<F = Record<string, any>> extends ClientDocument<F> {
+    revision: number;
+    scheduledPublication: DocumentPublishScheduleInfo | null;
+}
+export type EditableSingleton<F = Record<string, any>> = {
+    state: 'empty';
+} | {
+    state: 'document';
+    document: Omit<EditableDocument<F>, 'path'>;
+};
+export interface EditableFindResult<F = Record<string, any>> {
+    docs: EditableDocument<F>[];
+    meta: FindResult<F>['meta'];
+}
+export interface EditableTreeNode<F = Record<string, any>> {
+    document: EditableDocument<F>;
+    depth: number;
+    children: EditableTreeNode<F>[];
+}
+export type FindByIdForEditOptions<F = Record<string, any>> = Omit<FindByIdOptions<F>, 'status'>;
+export type FindForEditOptions<F = Record<string, any>> = Omit<FindOptions<F>, 'status'>;
+export type GetSubtreeForEditOptions<F = Record<string, any>> = Omit<GetSubtreeOptions<F>, 'status'>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/client",
   "private": false,
   "license": "MPL-2.0",
-  "version": "4.19.0",
+  "version": "5.1.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -44,21 +44,21 @@
   ],
   "dependencies": {
     "uuid": "^14.0.2",
-    "@byline/auth": "4.19.0",
-    "@byline/core": "4.19.0"
+    "@byline/auth": "5.1.0",
+    "@byline/core": "5.1.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.10",
-    "@types/node": "^26.4.0",
+    "@biomejs/biome": "2.5.12",
+    "@types/node": "^26.5.0",
     "chokidar": "^5.0.0",
     "chokidar-cli": "^3.0.0",
     "dotenv": "^17.4.2",
     "npm-run-all": "^4.1.5",
-    "tsc-alias": "^1.9.2",
+    "tsc-alias": "^1.9.4",
     "typescript": "^7.0.2",
-    "vitest": "^4.1.11",
-    "@byline/db-postgres": "4.19.0",
-    "@byline/search-postgres": "4.19.0"
+    "vitest": "^5.0.0",
+    "@byline/db-postgres": "5.1.0",
+    "@byline/search-postgres": "5.1.0"
   },
   "publishConfig": {
     "access": "public",
@@ -73,6 +73,6 @@
     "test": "vitest run --mode=node",
     "test:watch": "vitest --mode=node",
     "test:integration": "vitest run --mode=integration",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit && tsc --noEmit -p tests/tsconfig.json"
   }
 }