@contrail/documents 1.6.0-alpha.ws.2 → 1.6.0-alpha.ws.3

package/CHANGELOG.md

@@ -11,6 +11,7 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Document transaction contract types for the transactional write path: `DocumentOperation`, `DocumentElementPatch`, `WriteTransactionRequest`, and `WriteTransactionResponse`.
 - `DocumentWriteMode` type and an optional `writeMode` field on the `Document` interface, used to gate the transactional write path.
+- `DocumentTransactionMessage` — the WebSocket broadcast shape for a committed transaction (carries `sequenceNumber`, `clientTransactionId`, and inline `operations` or an `operationsDownloadUrl`).
 
 ## [1.5.6] - 2026-04-29
 

package/lib/index.d.ts

@@ -3,7 +3,6 @@ export * from './components';
 export * from './document-element-factory';
 export * from './document-element-property-binding-handler';
 export * from './document-action';
-export * from './document-transaction-validation';
 export * from './util/measure-text/measure-text';
 export * from './util/dynamic-text/dynamic-text-util';
 export * from './document-element-constants';

package/lib/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./components"), exports);
 __exportStar(require("./document-element-factory"), exports);
 __exportStar(require("./document-element-property-binding-handler"), exports);
 __exportStar(require("./document-action"), exports);
-__exportStar(require("./document-transaction-validation"), exports);
 __exportStar(require("./util/measure-text/measure-text"), exports);
 __exportStar(require("./util/dynamic-text/dynamic-text-util"), exports);
 __exportStar(require("./document-element-constants"), exports);

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

@@ -21,3 +21,18 @@ export interface WriteTransactionResponse {
     createdById: string;
     clientTransactionId?: string;
 }
+interface DocumentTransactionMessageBase {
+    type: 'DOCUMENT_TRANSACTION';
+    documentId: string;
+    sequenceNumber: number;
+    createdOn: string;
+    clientTransactionId?: string;
+}
+export type DocumentTransactionMessage = (DocumentTransactionMessageBase & {
+    operations: DocumentOperation[];
+    operationsDownloadUrl?: never;
+}) | (DocumentTransactionMessageBase & {
+    operationsDownloadUrl: string;
+    operations?: never;
+});
+export {};

package/package.json

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

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

@@ -1,16 +0,0 @@
-import { WriteTransactionRequest } from './types/document-transaction';
-export type WriteTransactionValidationCode = 'OPERATIONS_REQUIRED' | 'UNKNOWN_OPERATION_ACTION' | 'OPERATION_MISSING_ELEMENT' | 'OPERATION_MISSING_ELEMENT_ID' | 'UNKNOWN_ELEMENT_FIELD' | 'INVALID_ELEMENT_FIELD_TYPE' | 'INVALID_CLIENT_TRANSACTION_ID' | 'ELEMENT_DOCUMENT_ID_MISMATCH';
-export interface WriteTransactionValidationIssue {
-    code: WriteTransactionValidationCode;
-    index?: number;
-    action?: string;
-    field?: string;
-    fields?: string[];
-    expected?: string;
-    elementDocumentId?: string;
-    documentId?: string;
-}
-export interface ValidateWriteTransactionOptions {
-    documentId?: string;
-}
-export declare function validateWriteTransaction(request: WriteTransactionRequest, options?: ValidateWriteTransactionOptions): WriteTransactionValidationIssue[];

package/lib/document-transaction-validation.js

@@ -1,175 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateWriteTransaction = validateWriteTransaction;
-const KNOWN_OPERATION_ACTIONS = ['createElement', 'updateElement', 'deleteElement'];
-const CODE_RANK = {
-    OPERATIONS_REQUIRED: 1,
-    UNKNOWN_OPERATION_ACTION: 2,
-    OPERATION_MISSING_ELEMENT: 3,
-    OPERATION_MISSING_ELEMENT_ID: 4,
-    UNKNOWN_ELEMENT_FIELD: 5,
-    INVALID_ELEMENT_FIELD_TYPE: 6,
-    INVALID_CLIENT_TRANSACTION_ID: 7,
-    ELEMENT_DOCUMENT_ID_MISMATCH: 8,
-};
-const ELEMENT_FIELD_RULES = {
-    name: 'string',
-    size: { numericKeys: ['width', 'height'] },
-    position: { numericKeys: ['x', 'y', 'z'] },
-    clipContent: 'boolean',
-    ownedByReference: 'string',
-    writeMode: 'string',
-    style: 'allow',
-    model: 'allow',
-    modelBindings: 'allow',
-    elements: 'allow',
-    background: 'allow',
-    importedFrom: 'allow',
-    startingViewBox: 'allow',
-    startingLocation: 'allow',
-    specifiedId: 'string',
-    type: 'string',
-    rotate: { numericKeys: ['angle'] },
-    scale: { numericKeys: ['x', 'y'] },
-    text: 'string',
-    url: 'string',
-    label: 'string',
-    isLocked: 'boolean',
-    isHidden: 'boolean',
-    isTextTool: 'boolean',
-    documentGenerationConfigId: 'string',
-    elementIds: 'string[]',
-    points: 'array',
-    rowIds: 'string[]',
-    columnIds: 'string[]',
-    columnId: 'string',
-    rowId: 'string',
-    tableId: 'string',
-    colspan: 'number',
-    rowspan: 'number',
-    imageSize: { numericKeys: ['width', 'height'] },
-    imagePosition: { numericKeys: ['x', 'y', 'z'] },
-    alternateUrls: 'allow',
-    propertyBindings: 'allow',
-    lineDefinition: 'allow',
-    annotations: 'allow',
-    cropDefinition: 'allow',
-    embedInfo: 'allow',
-    entityData: 'allow',
-    start: 'allow',
-    end: 'allow',
-    propertyBindingsMetaData: 'allow',
-};
-function isPlainObject(value) {
-    return typeof value === 'object' && value !== null && !Array.isArray(value);
-}
-function collectElementFieldIssues(element, identityFields) {
-    const issues = [];
-    for (const [key, value] of Object.entries(element)) {
-        if (identityFields.includes(key)) {
-            if (value !== undefined && typeof value !== 'string') {
-                issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: key, expected: 'string' });
-            }
-            continue;
-        }
-        const rule = ELEMENT_FIELD_RULES[key];
-        if (!rule) {
-            issues.push({ code: 'UNKNOWN_ELEMENT_FIELD', field: key });
-            continue;
-        }
-        if (value === undefined || value === null || rule === 'allow') {
-            continue;
-        }
-        if (rule === 'string' || rule === 'number' || rule === 'boolean') {
-            if (typeof value !== rule) {
-                issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: key, expected: rule });
-            }
-        }
-        else if (rule === 'string[]') {
-            if (!Array.isArray(value) || value.some((entry) => typeof entry !== 'string')) {
-                issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: key, expected: 'string[]' });
-            }
-        }
-        else if (rule === 'array') {
-            if (!Array.isArray(value)) {
-                issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: key, expected: 'array' });
-            }
-        }
-        else {
-            if (!isPlainObject(value)) {
-                issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: key, expected: 'object' });
-                continue;
-            }
-            for (const numericKey of rule.numericKeys) {
-                const inner = value[numericKey];
-                if (inner !== undefined && inner !== null && typeof inner !== 'number') {
-                    issues.push({ code: 'INVALID_ELEMENT_FIELD_TYPE', field: `${key}.${numericKey}`, expected: 'number' });
-                }
-            }
-            const unknownInner = Object.keys(value).filter((innerKey) => !rule.numericKeys.includes(innerKey));
-            for (const innerKey of unknownInner) {
-                issues.push({ code: 'UNKNOWN_ELEMENT_FIELD', field: `${key}.${innerKey}` });
-            }
-        }
-    }
-    return issues;
-}
-const UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
-function validateOperation(operation, index, options) {
-    const action = operation === null || operation === void 0 ? void 0 : operation.action;
-    if (typeof action !== 'string' || !KNOWN_OPERATION_ACTIONS.includes(action)) {
-        return [{ code: 'UNKNOWN_OPERATION_ACTION', index, action: typeof action === 'string' ? action : undefined }];
-    }
-    if (action === 'deleteElement') {
-        const elementId = operation.elementId;
-        if (typeof elementId !== 'string' || elementId.length === 0) {
-            return [{ code: 'OPERATION_MISSING_ELEMENT_ID', index, action }];
-        }
-        return [];
-    }
-    if (action === 'updateElement') {
-        const elementId = operation.elementId;
-        if (typeof elementId !== 'string' || elementId.length === 0) {
-            return [{ code: 'OPERATION_MISSING_ELEMENT_ID', index, action }];
-        }
-        const changes = operation.changes;
-        if (!isPlainObject(changes)) {
-            return [{ code: 'OPERATION_MISSING_ELEMENT', index, action }];
-        }
-        return collectElementFieldIssues(changes, []).map((issue) => (Object.assign(Object.assign({}, issue), { index, action })));
-    }
-    const element = operation.element;
-    if (!isPlainObject(element) || typeof element.id !== 'string' || element.id.length === 0) {
-        return [{ code: 'OPERATION_MISSING_ELEMENT', index, action }];
-    }
-    const issues = collectElementFieldIssues(element, ['id', 'documentId']).map((issue) => (Object.assign(Object.assign({}, issue), { index, action })));
-    const elementDocumentId = element.documentId;
-    if (options.documentId !== undefined &&
-        typeof elementDocumentId === 'string' &&
-        elementDocumentId !== options.documentId) {
-        issues.push({
-            code: 'ELEMENT_DOCUMENT_ID_MISMATCH',
-            index,
-            action,
-            elementDocumentId,
-            documentId: options.documentId,
-        });
-    }
-    return issues;
-}
-function validateWriteTransaction(request, options = {}) {
-    const issues = [];
-    const operations = request === null || request === void 0 ? void 0 : request.operations;
-    if (!Array.isArray(operations) || operations.length === 0) {
-        issues.push({ code: 'OPERATIONS_REQUIRED' });
-    }
-    else {
-        operations.forEach((operation, index) => issues.push(...validateOperation(operation, index, options)));
-    }
-    const clientTransactionId = request === null || request === void 0 ? void 0 : request.clientTransactionId;
-    if (clientTransactionId !== undefined &&
-        (typeof clientTransactionId !== 'string' || !UUID_PATTERN.test(clientTransactionId))) {
-        issues.push({ code: 'INVALID_CLIENT_TRANSACTION_ID' });
-    }
-    return issues.sort((a, b) => { var _a, _b; return CODE_RANK[a.code] - CODE_RANK[b.code] || ((_a = a.index) !== null && _a !== void 0 ? _a : -1) - ((_b = b.index) !== null && _b !== void 0 ? _b : -1); });
-}