@byline/client 1.0.0 → 1.2.0

package/dist/collection-handle.d.ts

@@ -5,7 +5,7 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-import type { ChangeStatusResult, CollectionDefinition, CreateDocumentResult, DeleteDocumentResult, UnpublishResult, UpdateDocumentResult } from '@byline/core';
+import type { ChangeStatusResult, CollectionDefinition, CreateDocumentResult, DeleteDocumentResult, RestoreVersionResult, UnpublishResult, UpdateDocumentResult } from '@byline/core';
 import type { BylineClient } from './client.js';
 import type { ClientDocument, CreateOptions, FindByIdOptions, FindByPathOptions, FindByVersionOptions, FindOneOptions, FindOptions, FindResult, HistoryOptions, UpdateOptions } from './types.js';
 /**
@@ -68,6 +68,18 @@ export declare class CollectionHandle {
      * Archive the currently-published version(s) of a document.
      */
     unpublish(documentId: string): Promise<UnpublishResult>;
+    /**
+     * Restore a historical version as the new current version of this
+     * document. Creates a new immutable version row whose content is copied
+     * from the source version (all locales, with block / array `_id` identity
+     * preserved) and whose status defaults to the workflow's first status —
+     * never re-publishes silently.
+     *
+     * Reuses the `update` ability. Fires `beforeUpdate` / `afterUpdate` with
+     * a `restore: { sourceVersionId }` field on the hook context so userland
+     * hooks can branch.
+     */
+    restoreVersion(documentId: string, sourceVersionId: string): Promise<RestoreVersionResult>;
     /**
      * Soft-delete a document. All versions are flagged `is_deleted = true`
      * and disappear from read paths (the `current_documents` view filters

package/dist/collection-handle.js

@@ -5,7 +5,7 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-import { applyAfterRead, applyBeforeRead, assertActorCanPerform, changeDocumentStatus, createDocument, createReadContext, deleteDocument, mergePredicates, parseSort, parseWhere, populateDocuments, populateRichTextFields, unpublishDocument, updateDocument, } from '@byline/core';
+import { applyAfterRead, applyBeforeRead, assertActorCanPerform, changeDocumentStatus, createDocument, createReadContext, deleteDocument, mergePredicates, parseSort, parseWhere, populateDocuments, populateRichTextFields, restoreDocumentVersion, unpublishDocument, updateDocument, } from '@byline/core';
 import { shapeDocument, shapePopulatedInPlace } from './response.js';
 /**
  * A handle scoped to a single collection. Provides read (and eventually write)
@@ -234,6 +234,21 @@ export class CollectionHandle {
         const ctx = await this.buildLifecycleContext();
         return unpublishDocument(ctx, { documentId });
     }
+    /**
+     * Restore a historical version as the new current version of this
+     * document. Creates a new immutable version row whose content is copied
+     * from the source version (all locales, with block / array `_id` identity
+     * preserved) and whose status defaults to the workflow's first status —
+     * never re-publishes silently.
+     *
+     * Reuses the `update` ability. Fires `beforeUpdate` / `afterUpdate` with
+     * a `restore: { sourceVersionId }` field on the hook context so userland
+     * hooks can branch.
+     */
+    async restoreVersion(documentId, sourceVersionId) {
+        const ctx = await this.buildLifecycleContext();
+        return restoreDocumentVersion(ctx, { documentId, sourceVersionId });
+    }
     /**
      * Soft-delete a document. All versions are flagged `is_deleted = true`
      * and disappear from read paths (the `current_documents` view filters

package/dist/index.d.ts

@@ -5,7 +5,7 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-export { type ChangeStatusResult, type CreateDocumentResult, type CycleRelationValue, createReadContext, type DeleteDocumentResult, ERR_CONFLICT, ERR_INVALID_TRANSITION, ERR_NOT_FOUND, ERR_READ_BUDGET_EXCEEDED, ERR_VALIDATION, type PopulatedRelationValue, type PopulateFieldOptions, type PopulateFieldSpec, type PopulateMap, type PopulateSpec, type ReadContext, type ReadMode, type UnpublishResult, type UnresolvedRelationValue, type UpdateDocumentResult, } from '@byline/core';
+export { type ChangeStatusResult, type CreateDocumentResult, type CycleRelationValue, createReadContext, type DeleteDocumentResult, ERR_CONFLICT, ERR_INVALID_TRANSITION, ERR_NOT_FOUND, ERR_READ_BUDGET_EXCEEDED, ERR_VALIDATION, type PopulatedRelationValue, type PopulateFieldOptions, type PopulateFieldSpec, type PopulateMap, type PopulateSpec, type ReadContext, type ReadMode, type RestoreVersionResult, type UnpublishResult, type UnresolvedRelationValue, type UpdateDocumentResult, } from '@byline/core';
 export { BylineClient, createBylineClient } from './client.js';
 export { CollectionHandle } from './collection-handle.js';
 export type { BylineClientConfig, ClientDocument, CreateOptions, FilterOperators, FindByIdOptions, FindByPathOptions, FindOneOptions, FindOptions, FindResult, PopulatedRelation, SortDirection, SortSpec, UpdateOptions, WhereClause, WhereValue, WithPopulated, } from './types.js';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/client",
   "private": false,
   "license": "MPL-2.0",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -38,8 +38,8 @@
   ],
   "dependencies": {
     "npm-run-all": "^4.1.5",
-    "@byline/auth": "1.0.0",
-    "@byline/core": "1.0.0"
+    "@byline/auth": "1.2.0",
+    "@byline/core": "1.2.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.0.0"
+    "@byline/db-postgres": "1.2.0"
   },
   "publishConfig": {
     "access": "public",