@opengeni/sdk 0.57.0 → 2.2.0-canary.0

package/dist/editable-artifacts/index.d.ts

@@ -3,6 +3,8 @@ export { createBrowserEditableArtifactSession, createEditableArtifactReplicaId,
 export type { CreateBrowserEditableArtifactSessionOptions, EditableArtifactBrowserRuntime, } from "./browser-session.js";
 export { EditableArtifactSyncError, EditableArtifactTransportError } from "./errors.js";
 export type { EditableArtifactSyncErrorCode } from "./errors.js";
+export { classifyEditableArtifactOpenFailure } from "./open-failure.js";
+export type { EditableArtifactOpenFailureCategory, EditableArtifactOpenFailureEvent, EditableArtifactOpenFailureReporter, } from "./open-failure.js";
 export { createEditableArtifactHttpLiveTransport } from "./http-live-transport.js";
 export type { CreateEditableArtifactHttpLiveTransportOptions, EditableArtifactWebSocketCloseEvent, EditableArtifactWebSocketLike, EditableArtifactWebSocketMessageEvent, } from "./http-live-transport.js";
 export { EditableArtifactStorageConflictError, IndexedDbEditableArtifactStorage, MemoryEditableArtifactStorage, } from "./storage.js";

package/dist/editable-artifacts/open-failure.d.ts

@@ -0,0 +1,9 @@
+export type EditableArtifactOpenFailureCategory = "unsupported_old_format" | "byte_corruption" | "authored_causal_mismatch" | "runtime_package_mismatch" | "projection_parity_ci_failure";
+/** Content-free, bounded telemetry safe to emit for workbook-open failures. */
+export type EditableArtifactOpenFailureEvent = Readonly<{
+    category: EditableArtifactOpenFailureCategory;
+    code: string;
+}>;
+export type EditableArtifactOpenFailureReporter = (event: EditableArtifactOpenFailureEvent) => void;
+/** Maps only stable error codes; messages and workbook/formula content are ignored. */
+export declare function classifyEditableArtifactOpenFailure(error: unknown): EditableArtifactOpenFailureEvent | null;

package/dist/editable-artifacts/types.d.ts

@@ -33,7 +33,8 @@ type EditableArtifactSnapshotCommon = {
 export type EditableArtifactSpreadsheetSnapshot = EditableArtifactSnapshotCommon & {
     modality: "spreadsheet";
     causalFrontier: EditableArtifactCausalFrontier;
-    protocolVersion: number;
+    operationProtocolVersion: number;
+    snapshotVersion: number;
 };
 export type EditableArtifactSerializedSnapshot = EditableArtifactSnapshotCommon & {
     modality: EditableArtifactSerializedModality;
@@ -54,7 +55,7 @@ type EditableArtifactCommittedTransactionCommon = {
 export type EditableArtifactSpreadsheetCommittedTransaction = EditableArtifactCommittedTransactionCommon & {
     modality: "spreadsheet";
     causalFrontier: EditableArtifactCausalFrontier;
-    protocolVersion: number;
+    operationProtocolVersion: number;
     /** Exact whole canonical OGACO committed-transaction envelope. */
     committedTransactionBytes: Uint8Array;
 };
@@ -202,7 +203,7 @@ export type EditableArtifactStoredReplica = {
 };
 type EditableArtifactBootstrapCommon = {
     artifactId: EditableArtifactId;
-    protocolVersion: number;
+    liveProtocolVersion: number;
     headSequence: number;
     headStateHash: string;
     kernelVersion: string;

package/dist/editable-artifacts/worker/kernel-adapter.d.ts

@@ -2,7 +2,7 @@ import type { ArtifactWorkerInitializeInput } from "./wire-codec.js";
 import type { EditableArtifactModality } from "../types.js";
 export type ArtifactWorkerKernelSession = {
     readonly modality: EditableArtifactModality;
-    /** Replays one exact whole canonical OGACO001 transaction. */
+    /** Replays one exact whole canonical OGACO002 transaction. */
     applyCommitted: (committedTransactionBytes: Uint8Array) => void;
     /** Authors and applies one exact OGATX001 intent over the current frontier. */
     applyPending: (intentBytes: Uint8Array) => void;

package/dist/editable-artifacts-worker.js

@@ -15,7 +15,7 @@ import {
   requireMatchingHash,
   sha256Hex,
   transferListForArtifactWorkerRpcMessage
-} from "./chunk-VWE2QIVO.js";
+} from "./chunk-XNG7YGR3.js";
 
 // src/editable-artifacts/worker/kernel-adapter.ts
 import {
@@ -23,9 +23,18 @@ import {
   EDITABLE_ARTIFACT_INTENT_MAX_BYTES,
   EDITABLE_ARTIFACT_INTENT_VERSION,
   EDITABLE_ARTIFACT_PRODUCT_MAX_SNAPSHOT_BYTES,
-  SPREADSHEET_ARTIFACT_COMMAND_VERSION
+  SPREADSHEET_ARTIFACT_COMMAND_VERSION,
+  SPREADSHEET_ARTIFACT_MODEL_SCHEMA_VERSION
 } from "@opengeni/contracts/editable-artifacts";
-import { MAX_COMMITTED_TRANSACTION_BYTES } from "@opengeni/contracts/editable-artifact-committed-transaction";
+import {
+  SPREADSHEET_COLLABORATION_SNAPSHOT_VERSION,
+  SPREADSHEET_KERNEL_COMMAND_VERSION,
+  SPREADSHEET_KERNEL_SNAPSHOT_VERSION
+} from "@opengeni/contracts/editable-artifact-versions";
+import {
+  COMMITTED_TRANSACTION_PROTOCOL_VERSION,
+  MAX_COMMITTED_TRANSACTION_BYTES
+} from "@opengeni/contracts/editable-artifact-committed-transaction";
 var ArtifactWorkerPendingProjectionError = class extends Error {
   code;
   constructor(code, message = "pending transaction cannot project over confirmed state") {
@@ -391,6 +400,7 @@ function decodeCapabilities(bytes) {
     "safeRust",
     "sessionForks",
     "spreadsheetCommandVersion",
+    "spreadsheetModelSchemaVersion",
     "statefulSessions",
     "textLayout",
     "textLayoutFontBundleVersion",
@@ -446,6 +456,10 @@ function decodeCapabilities(bytes) {
       value.spreadsheetCommandVersion,
       "spreadsheetCommandVersion"
     ),
+    spreadsheetModelSchemaVersion: positiveInteger(
+      value.spreadsheetModelSchemaVersion,
+      "spreadsheetModelSchemaVersion"
+    ),
     maxCellsPerBatch: positiveInteger(value.maxCellsPerBatch, "maxCellsPerBatch"),
     maxCommands: positiveInteger(value.maxCommands, "maxCommands"),
     maxSnapshotBytes: positiveInteger(value.maxSnapshotBytes, "maxSnapshotBytes"),
@@ -568,7 +582,7 @@ function decodeCapabilities(bytes) {
       "workbookMetadataQueries"
     )
   };
-  if (normalized.abiVersion !== 1 || normalized.buildIdentityFormat !== "utf8" || normalized.canonicalStateHash !== "sha256:canonical-snapshot" || normalized.editableArtifactIntentVersion !== EDITABLE_ARTIFACT_INTENT_VERSION || normalized.spreadsheetCommandVersion !== SPREADSHEET_ARTIFACT_COMMAND_VERSION || normalized.collaborationSnapshotVersion !== 1 || normalized.commandSchemaVersion !== 1 || normalized.committedTransactionVersion !== 1 || normalized.documentCommandVersion !== 1 || normalized.documentQueryResponseVersion !== 1 || normalized.documentQueryVersion !== 1 || normalized.documentReceiptVersion !== 1 || normalized.documentSnapshotVersion !== 1 || normalized.documentStatefulSessions !== normalized.document || normalized.kernelSnapshotVersion !== 1 || normalized.maxCellsPerBatch !== WASM_MAX_CELLS_PER_BATCH || normalized.maxCommandBytes !== WASM_MAX_COMMAND_BYTES || normalized.maxSpreadsheetCommandBytes !== EDITABLE_ARTIFACT_COMMAND_MAX_BYTES || normalized.maxCommands !== 1e4 || normalized.maxIntentBytes !== EDITABLE_ARTIFACT_INTENT_MAX_BYTES || normalized.maxCommittedTransactionBytes !== MAX_COMMITTED_TRANSACTION_BYTES || normalized.maxDocumentCommandBytes !== WASM_MAX_COMMAND_BYTES || normalized.maxDocumentCommands !== 4096 || normalized.maxDocumentQueryBytes !== 256 || normalized.maxDocumentQueryResponseBytes !== 8 * 1024 * 1024 || normalized.maxDocumentSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.maxMetadataScannedCells !== 4e6 || normalized.maxQueryBytes !== 68 || normalized.maxQueryResponseBytes !== 8 * 1024 * 1024 || normalized.maxViewportArea !== 1048576 || normalized.maxViewportCells !== 262144 || normalized.maxMetadataSheets !== 1e4 || normalized.maxPresentationCommandBytes !== 4 * 1024 * 1024 || normalized.maxPresentationQueryBytes !== 96 || normalized.maxPresentationResponseBytes !== 8 * 1024 * 1024 || normalized.maxPresentationSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.maxTextLayoutFontBundleBytes !== 48 * 1024 * 1024 || normalized.maxTextLayoutRequestBytes !== 4 * 1024 * 1024 || normalized.maxTextLayoutResponseBytes !== 32 * 1024 * 1024 || normalized.maxSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.queryResponseVersion !== 1 || normalized.queryVersion !== 1 || normalized.receiptSchemaVersion !== 1 || normalized.retainedRenderPatchVersion !== 1 || normalized.retainedRenderTileVersion !== 1 || normalized.presentationCommandVersion !== 1 || normalized.presentationQueryResponseVersion !== 1 || normalized.presentationQueryVersion !== 1 || normalized.presentationSnapshotVersion !== 1 || normalized.presentationStatefulSessions !== normalized.presentation || normalized.safeRust !== true || normalized.statefulSessions !== true || normalized.textLayoutFontBundleVersion !== 1 || normalized.textLayoutRequestVersion !== 1 || normalized.textLayoutResponseVersion !== 1 || normalized.textLayoutStatefulSessions !== normalized.textLayout || normalized.sessionForks !== true || normalized.transport !== "bounded-uint8array" || normalized.workbookMetadataQueries !== normalized.collaboration) {
+  if (normalized.abiVersion !== 1 || normalized.buildIdentityFormat !== "utf8" || normalized.canonicalStateHash !== "sha256:canonical-snapshot" || normalized.editableArtifactIntentVersion !== EDITABLE_ARTIFACT_INTENT_VERSION || normalized.spreadsheetCommandVersion !== SPREADSHEET_ARTIFACT_COMMAND_VERSION || normalized.spreadsheetModelSchemaVersion !== SPREADSHEET_ARTIFACT_MODEL_SCHEMA_VERSION || normalized.collaborationSnapshotVersion !== SPREADSHEET_COLLABORATION_SNAPSHOT_VERSION || normalized.commandSchemaVersion !== SPREADSHEET_KERNEL_COMMAND_VERSION || normalized.committedTransactionVersion !== COMMITTED_TRANSACTION_PROTOCOL_VERSION || normalized.documentCommandVersion !== 1 || normalized.documentQueryResponseVersion !== 1 || normalized.documentQueryVersion !== 1 || normalized.documentReceiptVersion !== 1 || normalized.documentSnapshotVersion !== 1 || normalized.documentStatefulSessions !== normalized.document || normalized.kernelSnapshotVersion !== SPREADSHEET_KERNEL_SNAPSHOT_VERSION || normalized.maxCellsPerBatch !== WASM_MAX_CELLS_PER_BATCH || normalized.maxCommandBytes !== WASM_MAX_COMMAND_BYTES || normalized.maxSpreadsheetCommandBytes !== EDITABLE_ARTIFACT_COMMAND_MAX_BYTES || normalized.maxCommands !== 1e4 || normalized.maxIntentBytes !== EDITABLE_ARTIFACT_INTENT_MAX_BYTES || normalized.maxCommittedTransactionBytes !== MAX_COMMITTED_TRANSACTION_BYTES || normalized.maxDocumentCommandBytes !== WASM_MAX_COMMAND_BYTES || normalized.maxDocumentCommands !== 4096 || normalized.maxDocumentQueryBytes !== 256 || normalized.maxDocumentQueryResponseBytes !== 8 * 1024 * 1024 || normalized.maxDocumentSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.maxMetadataScannedCells !== 4e6 || normalized.maxQueryBytes !== 68 || normalized.maxQueryResponseBytes !== 8 * 1024 * 1024 || normalized.maxViewportArea !== 1048576 || normalized.maxViewportCells !== 262144 || normalized.maxMetadataSheets !== 1e4 || normalized.maxPresentationCommandBytes !== 4 * 1024 * 1024 || normalized.maxPresentationQueryBytes !== 96 || normalized.maxPresentationResponseBytes !== 8 * 1024 * 1024 || normalized.maxPresentationSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.maxTextLayoutFontBundleBytes !== 48 * 1024 * 1024 || normalized.maxTextLayoutRequestBytes !== 4 * 1024 * 1024 || normalized.maxTextLayoutResponseBytes !== 32 * 1024 * 1024 || normalized.maxSnapshotBytes !== WASM_MAX_SNAPSHOT_BYTES || normalized.queryResponseVersion !== 1 || normalized.queryVersion !== 1 || normalized.receiptSchemaVersion !== 1 || normalized.retainedRenderPatchVersion !== 1 || normalized.retainedRenderTileVersion !== 1 || normalized.presentationCommandVersion !== 1 || normalized.presentationQueryResponseVersion !== 1 || normalized.presentationQueryVersion !== 1 || normalized.presentationSnapshotVersion !== 1 || normalized.presentationStatefulSessions !== normalized.presentation || normalized.safeRust !== true || normalized.statefulSessions !== true || normalized.textLayoutFontBundleVersion !== 1 || normalized.textLayoutRequestVersion !== 1 || normalized.textLayoutResponseVersion !== 1 || normalized.textLayoutStatefulSessions !== normalized.textLayout || normalized.sessionForks !== true || normalized.transport !== "bounded-uint8array" || normalized.workbookMetadataQueries !== normalized.collaboration) {
     throw adapterError(
       "incompatible_wasm_build",
       "WASM capabilities do not match the SDK protocol"
@@ -612,7 +626,7 @@ function capabilityProfile(modality, capabilities) {
       );
     }
     return {
-      modelSchemaVersion: capabilities.collaborationSnapshotVersion,
+      modelSchemaVersion: capabilities.spreadsheetModelSchemaVersion,
       commandVersion: capabilities.spreadsheetCommandVersion,
       maximumSnapshotBytes: capabilities.maxSnapshotBytes,
       maximumCommandBytes: capabilities.maxSpreadsheetCommandBytes,
@@ -755,9 +769,13 @@ import {
   decodeEditableArtifactMutationIntent,
   hashEditableArtifactMutationIntent
 } from "@opengeni/contracts/editable-artifacts";
-import { decodeCommittedTransactionSummary } from "@opengeni/contracts/editable-artifact-committed-transaction";
+import {
+  COMMITTED_TRANSACTION_PROTOCOL_VERSION as COMMITTED_TRANSACTION_PROTOCOL_VERSION2,
+  decodeCommittedTransactionSummary
+} from "@opengeni/contracts/editable-artifact-committed-transaction";
 import { editableArtifactCodecFor } from "@opengeni/contracts/editable-artifact-codec-registry";
 import { decodeEditableArtifactSerializedCommit } from "@opengeni/contracts/editable-artifact-serialized-commit";
+import { SPREADSHEET_COLLABORATION_SNAPSHOT_VERSION as SPREADSHEET_COLLABORATION_SNAPSHOT_VERSION2 } from "@opengeni/contracts/editable-artifact-versions";
 var MAX_KNOWN_REQUESTS = 64;
 var MAX_QUEUED_REQUEST_BYTES = 192 * 1024 * 1024;
 var MAX_PENDING_AGGREGATE_BYTES = 64 * 1024 * 1024;
@@ -920,15 +938,17 @@ var ArtifactWorkerRuntime = class {
       "snapshot"
     );
     const snapshot = decodeSnapshotMetadata(frame.metadata, ownedBytes);
-    if (snapshot.modality !== initialization.modality || snapshot.modality !== adapter.modality || snapshot.modality === "spreadsheet" && snapshot.protocolVersion !== adapter.protocolVersion || snapshot.kernelVersion !== adapter.kernelVersion || snapshot.modelSchemaVersion !== adapter.modelSchemaVersion) {
+    if (snapshot.modality !== initialization.modality || snapshot.modality !== adapter.modality || snapshot.modality === "spreadsheet" && (snapshot.operationProtocolVersion !== COMMITTED_TRANSACTION_PROTOCOL_VERSION2 || snapshot.snapshotVersion !== SPREADSHEET_COLLABORATION_SNAPSHOT_VERSION2) || snapshot.modelSchemaVersion !== adapter.modelSchemaVersion) {
       throw runtimeError(
         "unsupported_protocol",
-        "snapshot protocol/kernel/schema is incompatible with the loaded collaboration kernel"
+        "snapshot protocol/schema is incompatible with the loaded collaboration kernel"
       );
     }
     const digest = await sha256Hex(ownedBytes);
     this.throwIfCancelled(frame.requestId);
-    requireMatchingHash(digest, snapshot.digest, "snapshot digest");
+    if (digest !== snapshot.digest) {
+      throw runtimeError("byte_corruption", "snapshot digest does not match its bytes");
+    }
     const canonical = requireBytesWithin(
       adapter.canonicalizeSnapshot(ownedBytes),
       initialization.maximumSnapshotBytes,
@@ -946,7 +966,12 @@ var ArtifactWorkerRuntime = class {
     try {
       stateHash = await nextConfirmed.stateHash();
       this.throwIfCancelled(frame.requestId);
-      requireMatchingHash(stateHash, snapshot.stateHash, "snapshot state");
+      if (stateHash !== snapshot.stateHash) {
+        throw runtimeError(
+          "authored_causal_mismatch",
+          "snapshot authored state does not match its state hash"
+        );
+      }
       if (snapshot.modality !== "spreadsheet" && nextConfirmed.nativeRevision() !== snapshot.nativeRevision) {
         throw runtimeError(
           "kernel_diverged",
@@ -968,7 +993,7 @@ var ArtifactWorkerRuntime = class {
         artifactId: snapshot.artifactId,
         modality: "spreadsheet",
         sequence: snapshot.sequence,
-        protocolVersion: snapshot.protocolVersion,
+        protocolVersion: adapter.protocolVersion,
         kernelVersion: snapshot.kernelVersion,
         modelSchemaVersion: snapshot.modelSchemaVersion,
         stateHash,
@@ -1172,7 +1197,7 @@ var ArtifactWorkerRuntime = class {
     if (transaction.modality !== installed.modality) {
       throw runtimeError("modality_mismatch", "committed transaction modality is incompatible");
     }
-    if (transaction.modality === "spreadsheet" && transaction.protocolVersion !== installed.protocolVersion)
+    if (transaction.modality === "spreadsheet" && transaction.operationProtocolVersion !== COMMITTED_TRANSACTION_PROTOCOL_VERSION2)
       throw runtimeError("unsupported_protocol", "committed transaction protocol is incompatible");
     if (transaction.startSequence !== installed.sequence + 1) {
       throw runtimeError("invalid_sequence", "committed transaction is not contiguous");
@@ -1559,14 +1584,14 @@ function assertCommittedEnvelopeMatchesOuter(transaction) {
   } catch (error) {
     throw new ArtifactWorkerProtocolError(
       "invalid_committed_transaction",
-      "committed transaction is not canonical OGACO001",
+      "committed transaction is not canonical OGACO002",
       { cause: error }
     );
   }
-  if (summary.operationProtocolVersion !== transaction.protocolVersion || summary.transactionId !== transaction.transactionId || summary.priorStateHash !== transaction.priorStateHash || summary.stateHash !== transaction.stateHash || !frontiersEqual(summary.resultingCausalFrontier, transaction.causalFrontier)) {
+  if (summary.operationProtocolVersion !== transaction.operationProtocolVersion || summary.transactionId !== transaction.transactionId || summary.priorStateHash !== transaction.priorStateHash || summary.stateHash !== transaction.stateHash || !frontiersEqual(summary.resultingCausalFrontier, transaction.causalFrontier)) {
     throw runtimeError(
       "committed_metadata_mismatch",
-      "outer committed metadata disagrees with its exact OGACO001 envelope"
+      "outer committed metadata disagrees with its exact OGACO002 envelope"
     );
   }
 }
@@ -1638,8 +1663,9 @@ function asWorkerFailure(error) {
     };
   }
   if (error instanceof Error) {
+    const rawCode = error.code;
     return {
-      code: "kernel_failed",
+      code: typeof rawCode === "string" ? normalizeErrorCode(rawCode) : "kernel_failed",
       message: sanitizeErrorMessage(error.message || "artifact kernel failed"),
       retryable: false
     };
@@ -1655,7 +1681,8 @@ function asProtocolError(error) {
   );
 }
 function normalizeErrorCode(value) {
-  return /^[a-z][a-z0-9_]{0,127}$/.test(value) ? value : "kernel_failed";
+  const normalized = value.toLowerCase();
+  return /^[a-z][a-z0-9_]{0,127}$/.test(normalized) ? normalized : "kernel_failed";
 }
 function sanitizeErrorMessage(value) {
   let output = "";