@contrail/documents 1.5.6 → 1.6.0-alpha-fetch.1

package/CHANGELOG.md

@@ -7,6 +7,18 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+- Document transaction contract types for the transactional write path: `DocumentOperation`, `DocumentElementPatch`, `WriteTransactionRequest`, and `WriteTransactionResponse`.
+- `DocumentTransaction` and `GetDocumentTransactionsResponse` types for reading committed transactions back (client catch-up and gap repair).
+- `DocumentWriteMode` type and an optional `writeMode` field on the `Document` interface, used to gate the transactional write path.
+
+## [1.5.6] - 2026-04-29
+
+### Fixed
+
+- `DynamicTextUtil.getItemCount` now filters out component models missing both `item` and `color` to avoid errors when underlying models fail to fetch.
+
 ## [1.5.3] - 2026-04-22
 
 ### Added

package/lib/types/document-transaction.d.ts

@@ -0,0 +1,33 @@
+import { DocumentElement } from './document-element';
+export type DocumentOperation = {
+    action: 'createElement';
+    element: DocumentElement;
+} | {
+    action: 'updateElement';
+    elementId: string;
+    changes: DocumentElementPatch;
+} | {
+    action: 'deleteElement';
+    elementId: string;
+};
+export type DocumentElementPatch = Partial<Omit<DocumentElement, 'id' | 'documentId'>>;
+export interface WriteTransactionRequest {
+    clientTransactionId?: string;
+    operations: DocumentOperation[];
+}
+export interface WriteTransactionResponse {
+    sequenceNumber: number;
+    createdOn: string;
+    createdById: string;
+    clientTransactionId?: string;
+}
+export interface DocumentTransaction {
+    sequenceNumber: number;
+    clientTransactionId?: string;
+    operations: DocumentOperation[];
+}
+export interface GetDocumentTransactionsResponse {
+    transactions: DocumentTransaction[];
+    hasMore: boolean;
+    lastReturnedSequenceNumber: number;
+}

package/lib/types/document-transaction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/document.d.ts

@@ -4,6 +4,7 @@ export interface ImportReferenceDetail {
     importedSlideReference?: string;
     importedFileReference?: string;
 }
+export type DocumentWriteMode = 'transactional';
 export interface Document {
     id?: string;
     name?: string;
@@ -22,4 +23,5 @@ export interface Document {
     };
     clipContent?: boolean;
     ownedByReference?: string;
+    writeMode?: DocumentWriteMode;
 }

package/lib/types/index.d.ts

@@ -6,4 +6,5 @@ export * from './document-element-holder';
 export * from './document-element';
 export * from './document-navigation-event';
 export * from './document';
+export * from './document-transaction';
 export * from './element-transformation';

package/lib/types/index.js

@@ -22,4 +22,5 @@ __exportStar(require("./document-element-holder"), exports);
 __exportStar(require("./document-element"), exports);
 __exportStar(require("./document-navigation-event"), exports);
 __exportStar(require("./document"), exports);
+__exportStar(require("./document-transaction"), exports);
 __exportStar(require("./element-transformation"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/documents",
-  "version": "1.5.6",
+  "version": "1.6.0-alpha-fetch.1",
   "description": "Documents library for contrail platform",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",