@opengeni/contracts 1.0.1 → 2.3.0-canary.0

package/dist/editable-artifact-committed-transaction.js

@@ -4,10 +4,10 @@ import {
   MAX_COMMITTED_TRANSACTION_CELLS,
   MAX_COMMITTED_TRANSACTION_OPERATIONS,
   decodeCommittedTransactionSummary
-} from "./chunk-Y3MLSLB4.js";
+} from "./chunk-3SIZGL3O.js";
 import {
   COMMITTED_TRANSACTION_PROTOCOL_VERSION
-} from "./chunk-BVGIYW7D.js";
+} from "./chunk-PX3VCKAU.js";
 export {
   COMMITTED_TRANSACTION_PROTOCOL_VERSION,
   MAX_COMMITTED_TRANSACTION_BYTES,

package/dist/editable-artifact-live.d.ts

@@ -1,5 +1,5 @@
 import { type EditableArtifactCausalEntry } from "./editable-artifacts.js";
-export declare const EDITABLE_ARTIFACT_LIVE_WIRE_VERSION = 1;
+export { EDITABLE_ARTIFACT_LIVE_WIRE_VERSION } from "./editable-artifact-versions.js";
 export type EditableArtifactId = string;
 export type EditableArtifactRequestHash = string;
 export type EditableArtifactStateHash = string;
@@ -31,8 +31,7 @@ type EditableArtifactLiveResumeCommon = Readonly<{
     requireSnapshot: boolean;
 }>;
 export type EditableArtifactLiveResume = (EditableArtifactLiveResumeCommon & Readonly<{
-    /** Omitted on OGALV001 for byte-compatible spreadsheet sessions. */
-    modality?: "spreadsheet";
+    modality: "spreadsheet";
     localCausalFrontier: EditableArtifactCausalFrontier;
 }>) | (EditableArtifactLiveResumeCommon & Readonly<{
     modality: "document" | "presentation";
@@ -56,9 +55,10 @@ type EditableArtifactLiveSnapshotCommon = Readonly<{
     bytes: Uint8Array;
 }>;
 export type EditableArtifactLiveSnapshot = (EditableArtifactLiveSnapshotCommon & Readonly<{
-    modality?: "spreadsheet";
+    modality: "spreadsheet";
     causalFrontier: EditableArtifactCausalFrontier;
-    protocolVersion: number;
+    operationProtocolVersion: number;
+    snapshotVersion: number;
 }>) | (EditableArtifactLiveSnapshotCommon & Readonly<{
     modality: "document" | "presentation";
     nativeRevision: number;
@@ -74,9 +74,9 @@ type EditableArtifactLiveCommittedTransactionCommon = Readonly<{
     committedTransactionBytes: Uint8Array;
 }>;
 export type EditableArtifactLiveCommittedTransaction = (EditableArtifactLiveCommittedTransactionCommon & Readonly<{
-    modality?: "spreadsheet";
+    modality: "spreadsheet";
     causalFrontier: EditableArtifactCausalFrontier;
-    protocolVersion: number;
+    operationProtocolVersion: number;
     /** Exact canonical whole OGACO transaction envelope. */
     committedTransactionBytes: Uint8Array;
 }>) | (EditableArtifactLiveCommittedTransactionCommon & Readonly<{
@@ -138,8 +138,7 @@ export type EditableArtifactLiveServerFrame = Readonly<{
     protocolVersion: number;
     artifactId: EditableArtifactId;
     streamEpoch: string;
-    /** Omitted on the wire for spreadsheet compatibility. */
-    modality?: EditableArtifactLiveModality;
+    modality: EditableArtifactLiveModality;
     writable: boolean;
     headSequence: number;
     minimumReplaySequence: number;
@@ -165,9 +164,10 @@ export type EditableArtifactLiveServerFrame = Readonly<{
     final: boolean;
     bytes: Uint8Array;
 }> & (Readonly<{
-    /** Omitted on the wire for spreadsheet compatibility. */
-    modality?: "spreadsheet";
+    modality: "spreadsheet";
     causalFrontier: EditableArtifactCausalFrontier;
+    operationProtocolVersion: number;
+    snapshotVersion: number;
 }> | Readonly<{
     modality: "document" | "presentation";
     nativeRevision: number;
@@ -273,4 +273,3 @@ export declare function inspectEditableArtifactLiveWireEnvelope(bytes: Uint8Arra
     metadata: Readonly<Record<string, unknown>>;
     payload: Uint8Array;
 }>;
-export {};

package/dist/editable-artifact-live.js

@@ -1,18 +1,20 @@
 import {
   EDITABLE_ARTIFACT_INTENT_MAX_BYTES,
   hashEditableArtifactMutationIntentBytes
-} from "./chunk-TZ6YEYN4.js";
-import "./chunk-YRKRZ6OF.js";
-import "./chunk-JBCIY7QD.js";
+} from "./chunk-NVJMJWLL.js";
+import "./chunk-7RMTKFJW.js";
+import "./chunk-Y3KNXVTD.js";
 import "./chunk-RIY7GYQS.js";
-import "./chunk-CADSX6UN.js";
+import "./chunk-YRKRZ6OF.js";
 import "./chunk-D2HKF2EF.js";
 import "./chunk-MYBZRDTY.js";
-import "./chunk-LSB7GRLG.js";
-import "./chunk-BVGIYW7D.js";
+import "./chunk-TXTQIYCV.js";
+import {
+  EDITABLE_ARTIFACT_LIVE_WIRE_VERSION
+} from "./chunk-PX3VCKAU.js";
 
 // src/editable-artifact-live.ts
-var MAGIC = new TextEncoder().encode("OGALV001");
+var MAGIC = new TextEncoder().encode("OGALV002");
 var HEADER_BYTES = 20;
 var MAX_METADATA_BYTES = 64 * 1024;
 var MAX_TOKEN_BYTES = 4096;
@@ -47,7 +49,6 @@ var MUTATION_REJECTION_CODES = /* @__PURE__ */ new Set([
   "unsupported",
   "unavailable"
 ]);
-var EDITABLE_ARTIFACT_LIVE_WIRE_VERSION = 1;
 var EditableArtifactLiveError = class extends Error {
   constructor(code, message, options = {}) {
     super(message, options.cause === void 0 ? void 0 : { cause: options.cause });
@@ -101,6 +102,7 @@ function encodeEditableArtifactLiveOpenWireFrame(frame) {
       protocolVersion,
       artifactId,
       token,
+      modality: resume.modality,
       localCursor: resume.localCursor,
       localStateHash: resume.localStateHash,
       localCausalFrontier: resume.localCausalFrontier,
@@ -144,26 +146,22 @@ function encodeEditableArtifactLiveMutationWireFrame(frame) {
 function encodeEditableArtifactLiveServerWireFrame(frame) {
   switch (frame.type) {
     case "open": {
-      const { modality, ...metadata } = frame;
       return encodeEnvelope(
         SERVER_OPEN,
-        modality === "document" || modality === "presentation" ? {
-          type: metadata.type,
-          protocolVersion: metadata.protocolVersion,
-          artifactId: metadata.artifactId,
-          streamEpoch: metadata.streamEpoch,
-          modality,
-          writable: metadata.writable,
-          headSequence: metadata.headSequence,
-          minimumReplaySequence: metadata.minimumReplaySequence,
-          maxClientFrameBytes: metadata.maxClientFrameBytes,
-          maxCommandBytes: metadata.maxCommandBytes,
-          maxIntentBytes: metadata.maxIntentBytes,
-          maxCommittedTransactionBytes: metadata.maxCommittedTransactionBytes,
-          maxSnapshotBytes: metadata.maxSnapshotBytes,
-          maxInFlightTransactions: metadata.maxInFlightTransactions,
-          maxInFlightBytes: metadata.maxInFlightBytes
-        } : metadata,
+        {
+          ...serverFrameIdentity(frame),
+          modality: frame.modality,
+          writable: frame.writable,
+          headSequence: frame.headSequence,
+          minimumReplaySequence: frame.minimumReplaySequence,
+          maxClientFrameBytes: frame.maxClientFrameBytes,
+          maxCommandBytes: frame.maxCommandBytes,
+          maxIntentBytes: frame.maxIntentBytes,
+          maxCommittedTransactionBytes: frame.maxCommittedTransactionBytes,
+          maxSnapshotBytes: frame.maxSnapshotBytes,
+          maxInFlightTransactions: frame.maxInFlightTransactions,
+          maxInFlightBytes: frame.maxInFlightBytes
+        },
         EMPTY_BYTES
       );
     }
@@ -197,9 +195,12 @@ function encodeEditableArtifactLiveServerWireFrame(frame) {
           protocolVersion: metadata.protocolVersion,
           artifactId: metadata.artifactId,
           streamEpoch: metadata.streamEpoch,
+          modality,
           sequence: metadata.sequence,
           stateHash: metadata.stateHash,
           causalFrontier: metadata.causalFrontier,
+          operationProtocolVersion: metadata.operationProtocolVersion,
+          snapshotVersion: metadata.snapshotVersion,
           digest: metadata.digest,
           kernelVersion: metadata.kernelVersion,
           modelSchemaVersion: metadata.modelSchemaVersion,
@@ -213,8 +214,9 @@ function encodeEditableArtifactLiveServerWireFrame(frame) {
     case "transaction": {
       const { committedTransactionBytes, ...transaction } = frame.transaction;
       const serializedTransaction = transaction;
-      const transactionMetadata = transaction.modality === void 0 || transaction.modality === "spreadsheet" ? {
+      const transactionMetadata = transaction.modality === "spreadsheet" ? {
         artifactId: transaction.artifactId,
+        modality: transaction.modality,
         transactionId: transaction.transactionId,
         requestHash: transaction.requestHash,
         startSequence: transaction.startSequence,
@@ -222,7 +224,7 @@ function encodeEditableArtifactLiveServerWireFrame(frame) {
         priorStateHash: transaction.priorStateHash,
         stateHash: transaction.stateHash,
         causalFrontier: transaction.causalFrontier,
-        protocolVersion: transaction.protocolVersion
+        operationProtocolVersion: transaction.operationProtocolVersion
       } : {
         artifactId: serializedTransaction.artifactId,
         modality: serializedTransaction.modality,
@@ -238,26 +240,75 @@ function encodeEditableArtifactLiveServerWireFrame(frame) {
       };
       return encodeEnvelope(
         SERVER_TRANSACTION,
-        { ...frame, transaction: transactionMetadata },
+        { ...serverFrameIdentity(frame), transaction: transactionMetadata },
         committedTransactionBytes
       );
     }
     case "barrier":
-      return encodeEnvelope(SERVER_BARRIER, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_BARRIER,
+        { ...serverFrameIdentity(frame), sequence: frame.sequence, stateHash: frame.stateHash },
+        EMPTY_BYTES
+      );
     case "watermark":
-      return encodeEnvelope(SERVER_WATERMARK, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_WATERMARK,
+        { ...serverFrameIdentity(frame), headSequence: frame.headSequence },
+        EMPTY_BYTES
+      );
     case "resyncRequired":
-      return encodeEnvelope(SERVER_RESYNC_REQUIRED, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_RESYNC_REQUIRED,
+        { ...serverFrameIdentity(frame), reason: frame.reason, headSequence: frame.headSequence },
+        EMPTY_BYTES
+      );
     case "applied":
-      return encodeEnvelope(SERVER_APPLIED, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_APPLIED,
+        { ...serverFrameIdentity(frame), sequence: frame.sequence, stateHash: frame.stateHash },
+        EMPTY_BYTES
+      );
     case "authorizationChanged":
-      return encodeEnvelope(SERVER_AUTHORIZATION_CHANGED, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_AUTHORIZATION_CHANGED,
+        { ...serverFrameIdentity(frame), writable: frame.writable },
+        EMPTY_BYTES
+      );
     case "mutationAccepted":
-      return encodeEnvelope(SERVER_MUTATION_ACCEPTED, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_MUTATION_ACCEPTED,
+        {
+          ...serverFrameIdentity(frame),
+          requestHash: frame.requestHash,
+          clientTransactionId: frame.clientTransactionId,
+          transactionId: frame.transactionId,
+          startSequence: frame.startSequence,
+          endSequence: frame.endSequence,
+          stateHash: frame.stateHash
+        },
+        EMPTY_BYTES
+      );
     case "mutationRejected":
-      return encodeEnvelope(SERVER_MUTATION_REJECTED, { ...frame }, EMPTY_BYTES);
+      return encodeEnvelope(
+        SERVER_MUTATION_REJECTED,
+        {
+          ...serverFrameIdentity(frame),
+          requestHash: frame.requestHash,
+          code: frame.code,
+          retryable: frame.retryable
+        },
+        EMPTY_BYTES
+      );
   }
 }
+function serverFrameIdentity(frame) {
+  return {
+    type: frame.type,
+    protocolVersion: frame.protocolVersion,
+    artifactId: frame.artifactId,
+    streamEpoch: frame.streamEpoch
+  };
+}
 function decodeEditableArtifactLiveServerWireFrame(bytes) {
   const decoded = decodeEnvelope(bytes);
   const metadata = decoded.metadata;
@@ -266,7 +317,7 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
       requireNoPayload(decoded.payload);
       const modality = serverModality(metadata);
       requireServerKeys(metadata, "open", [
-        ...modality === "spreadsheet" ? [] : ["modality"],
+        "modality",
         "writable",
         "headSequence",
         "minimumReplaySequence",
@@ -300,15 +351,16 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
         ),
         maxInFlightBytes: positiveInteger(metadata.maxInFlightBytes, "maxInFlightBytes")
       };
-      return Object.freeze(modality === "spreadsheet" ? common : { ...common, modality });
+      return Object.freeze({ ...common, modality });
     }
     case SERVER_SNAPSHOT: {
       const modality = serverModality(metadata);
       requireServerKeys(metadata, "snapshot", [
-        ...modality === "spreadsheet" ? [] : ["modality"],
+        "modality",
         "sequence",
         "stateHash",
         modality === "spreadsheet" ? "causalFrontier" : "nativeRevision",
+        ...modality === "spreadsheet" ? ["operationProtocolVersion", "snapshotVersion"] : [],
         "digest",
         "kernelVersion",
         "modelSchemaVersion",
@@ -344,7 +396,13 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
       return Object.freeze(
         modality === "spreadsheet" ? {
           ...common,
-          causalFrontier: requiredFrontier(metadata.causalFrontier)
+          modality,
+          causalFrontier: requiredFrontier(metadata.causalFrontier),
+          operationProtocolVersion: positiveInteger(
+            metadata.operationProtocolVersion,
+            "operationProtocolVersion"
+          ),
+          snapshotVersion: positiveInteger(metadata.snapshotVersion, "snapshotVersion")
         } : {
           ...common,
           modality,
@@ -360,6 +418,7 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
         transaction,
         modality === "spreadsheet" ? [
           "artifactId",
+          "modality",
           "transactionId",
           "requestHash",
           "startSequence",
@@ -367,7 +426,7 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
           "priorStateHash",
           "stateHash",
           "causalFrontier",
-          "protocolVersion"
+          "operationProtocolVersion"
         ] : [
           "artifactId",
           "modality",
@@ -413,8 +472,12 @@ function decodeEditableArtifactLiveServerWireFrame(bytes) {
         transaction: Object.freeze(
           modality === "spreadsheet" ? {
             ...common.transaction,
+            modality,
             causalFrontier: requiredFrontier(transaction.causalFrontier),
-            protocolVersion: positiveInteger(transaction.protocolVersion, "protocolVersion")
+            operationProtocolVersion: positiveInteger(
+              transaction.operationProtocolVersion,
+              "operationProtocolVersion"
+            )
           } : {
             ...common.transaction,
             modality,
@@ -531,6 +594,7 @@ function decodeOpen(metadata, payload) {
       "protocolVersion",
       "artifactId",
       "token",
+      "modality",
       "localCursor",
       "localStateHash",
       "localCausalFrontier",
@@ -702,12 +766,13 @@ function normalizeResume(resume) {
   if (localCursor === null !== (localStateHash === null)) {
     throw invalidFrame("resume cursor and state hash must both be null or both be present");
   }
-  const modality = resume.modality ?? "spreadsheet";
+  const modality = editableArtifactLiveModality(resume.modality);
   if (modality === "spreadsheet") {
     if (!("localCausalFrontier" in resume)) {
       throw invalidFrame("spreadsheet resume requires a causal frontier");
     }
     return Object.freeze({
+      modality,
       localCursor,
       localStateHash,
       localCausalFrontier: requiredFrontier(resume.localCausalFrontier),
@@ -748,13 +813,13 @@ function editableArtifactLiveModality(value) {
   return value;
 }
 function clientOpenModality(metadata) {
-  return metadata.modality === void 0 ? "spreadsheet" : editableArtifactLiveModality(metadata.modality);
+  return editableArtifactLiveModality(metadata.modality);
 }
 function serverModality(metadata) {
-  return metadata.modality === void 0 ? "spreadsheet" : editableArtifactLiveModality(metadata.modality);
+  return editableArtifactLiveModality(metadata.modality);
 }
 function transactionModality(transaction) {
-  return transaction.modality === void 0 ? "spreadsheet" : editableArtifactLiveModality(transaction.modality);
+  return editableArtifactLiveModality(transaction.modality);
 }
 function requireExactKeys(record, expected) {
   const keys = Object.keys(record);