@mengine/medeo-client 2.1.1-dsl.9 → 3.0.1-dsl.0

package/dist/{index-DAfOkcnZ.d.ts → index-pULoWyd9.d.ts}

@@ -1,4 +1,4 @@
-import { j as DslDiagnostic, o as VideoDraftContent, p as CommitOptions } from "./video-draft-types-GqXnsOzA.js";
+import { Ct as MedeoDslSnapshot, D as UploadText, E as DslEditor, G as CommitOptions, M as MedeoDsl, gt as DslDiagnostic, i as AudioScriptView, kt as ResourceSystem, o as VideoDraftProjection, p as VideoDraftContent, zt as TrackRole } from "./index-B1Lqm_Z1.js";
 import { LoroDoc, PeerID, VersionVector } from "loro-crdt";
 import { DocState, LocalSaveState } from "@mengine/sync";
 import { BaseDocStorage, Connection, DocDiff, DocPushReceipt, DocSnapshotRecord, DocStorage, DocStorageOptions, DocUpdate, DocUpdateRecord } from "@mengine/storage";
@@ -255,7 +255,7 @@ type PushResultKind = 'ack' | 'duplicate' | 'rejected' | 'failed' | 'nothing_to_
  */
 interface PushResult {
   kind: PushResultKind;
-  /** Server document sequence observed after a successful `ack` or `duplicate`. */
+  /** Server sequence from an `ack`/`duplicate`, retained on an idle retry so its revision can be verified. */
   mengineUpdateSeq?: number | undefined;
   /** @deprecated Ack-only sequence retained until consumers adopt `mengineUpdateSeq`. */
   updateSeq?: number | undefined;
@@ -301,10 +301,12 @@ interface ManualSyncDocOptions {
 }
 /** Shared explicit pull/push lifecycle; model-specific editors never implement transport. */
 declare class ManualSyncTransport {
-  private readonly client;
+  protected readonly client: MengineHttpClient;
   protected readonly doc: LoroDoc;
   private watermark;
   private disposed;
+  /** A retry with no new bytes still verifies the revision from its last durable receipt. */
+  private confirmedSequence?;
   protected constructor(client: MengineHttpClient, doc: LoroDoc, watermark: VersionVector);
   editorPeerId(): PeerID;
   protected assertActive(): void;
@@ -360,6 +362,189 @@ declare class ManualSyncTransport {
   private serverVVFrom;
 }
 //#endregion
+//#region src/manual-sync/manual-sync-doc.d.ts
+/** Explicit synchronization over the same DSL/editor used by the live Session. */
+declare class ManualSyncDoc extends ManualSyncTransport {
+  readonly dsl: MedeoDsl;
+  readonly editor: DslEditor;
+  private constructor();
+  /** `uploadText` stores raw content the editor writes, such as a PhoneticScript's text, in Memota. */
+  static open(options: ManualSyncDocOptions & {
+    uploadText?: UploadText;
+  }): Promise<ManualSyncDoc>;
+  snapshot(): {
+    readonly "timeline-entities": {
+      readonly [x: string]: {
+        readonly [x: string]: never;
+      };
+    };
+    readonly "track-entities": {
+      readonly [x: string]: {
+        readonly role: TrackRole;
+        readonly hidden?: boolean | undefined;
+      };
+    };
+    readonly "clip-entities": {
+      readonly [x: string]: {
+        readonly seqMarker: {
+          readonly inMs: number;
+          readonly outMs: number;
+          readonly rate?: number | undefined;
+          readonly fillTimeline?: true | undefined;
+        };
+        readonly volume?: number | undefined;
+        readonly source: string;
+        readonly anchor?: {
+          readonly to: string;
+          readonly offsetMs: number;
+          readonly fallback_abs_ms: number;
+        } | undefined;
+      };
+    };
+    readonly "media-entities": {
+      readonly [x: string]: {
+        readonly system: ResourceSystem;
+        readonly key: string;
+        readonly digest?: string | undefined;
+        readonly kind: "video";
+        readonly durationMs: number;
+        readonly storageKey?: string | undefined;
+      } | {
+        readonly system: ResourceSystem;
+        readonly key: string;
+        readonly digest?: string | undefined;
+        readonly kind: "audio" | "voiceover-recording";
+        readonly durationMs: number;
+        readonly storageKey: string;
+      } | {
+        readonly system: ResourceSystem;
+        readonly key: string;
+        readonly digest?: string | undefined;
+        readonly kind: "image";
+        readonly storageKey?: string | undefined;
+      };
+    };
+    readonly "audio-script-entities": {
+      readonly [x: string]: {
+        readonly segments: readonly {
+          readonly id: string;
+          readonly text: string;
+          readonly startMs?: number | undefined;
+          readonly endMs?: number | undefined;
+        }[];
+        readonly defaultLanguage?: string | undefined;
+        readonly system?: "memota" | undefined;
+        readonly key?: string | undefined;
+        readonly storageKey?: string | undefined;
+        readonly digest?: string | undefined;
+      };
+    };
+    readonly "phonetic-script-entities": {
+      readonly [x: string]: {
+        readonly phoneme: {
+          readonly phonemeScript?: string | undefined;
+          readonly audioScriptId: string;
+          readonly segmentId: string;
+          readonly start?: import("loro-crdt").Cursor | undefined;
+          readonly end?: import("loro-crdt").Cursor | undefined;
+        };
+        readonly system?: "memota" | undefined;
+        readonly key?: string | undefined;
+        readonly storageKey?: string | undefined;
+        readonly digest?: string | undefined;
+      };
+    };
+    readonly "caption-entities": {
+      readonly [x: string]: {
+        readonly selection?: {
+          readonly audioScriptId: string;
+          readonly segmentId: string;
+          readonly start?: import("loro-crdt").Cursor | undefined;
+          readonly end?: import("loro-crdt").Cursor | undefined;
+        } | undefined;
+        readonly text?: string | undefined;
+        readonly style?: {
+          readonly font?: {
+            readonly system: "font-library";
+            readonly key: string;
+          } | undefined;
+          readonly fontSize?: number | undefined;
+          readonly fontColor?: string | undefined;
+          readonly fontWeight?: number | undefined;
+          readonly entranceAnimation?: string | undefined;
+          readonly entranceAnimationDurationMs?: number | undefined;
+          readonly strokeColor?: string | undefined;
+          readonly strokeWidth?: number | undefined;
+          readonly positionX?: number | undefined;
+          readonly positionY?: number | undefined;
+        } | undefined;
+      };
+    };
+    readonly "voice-entities": {
+      readonly [x: string]: {
+        readonly system: "voice-library";
+        readonly key: string;
+        readonly name?: string | undefined;
+      };
+    };
+    readonly "voice-timbre-relations": {
+      readonly [x: string]: {
+        readonly recordingId: string;
+        readonly voiceId: string;
+      };
+    };
+    readonly "derived-from-relations": {
+      readonly [x: string]: {
+        readonly entityId: string;
+        readonly sourceId: string;
+        readonly sourceDigest?: string | undefined;
+      };
+    };
+    readonly 'contain-relations': readonly {
+      readonly treeId: import("loro-crdt").TreeID;
+      readonly entityId: string;
+      readonly children: readonly /*elided*/any[];
+    }[];
+    readonly richText: {
+      readonly [x: string]: {
+        readonly bodyId: string;
+        readonly plainText: string;
+        readonly delta: readonly {
+          readonly insert: string;
+          readonly attributes?: {
+            readonly [x: string]: unknown;
+          } | undefined;
+        }[];
+      };
+    };
+    readonly captionText: {
+      readonly [x: string]: {
+        readonly text: string;
+        readonly start: number;
+        readonly end: number;
+        readonly bodyId: string;
+      };
+    };
+    readonly phoneticText: {
+      readonly [x: string]: {
+        readonly text: string;
+        readonly start: number;
+        readonly end: number;
+        readonly bodyId: string;
+      };
+    };
+    readonly diagnostics: readonly {
+      readonly code: string;
+      readonly path: string;
+      readonly message: string;
+    }[];
+  };
+  projectVideoDraft(): VideoDraftProjection;
+  /** Read the acknowledged server revision; without a new push, confirm against the current server view. */
+  readPersistedDraft(updateSeq?: number): Promise<MengineDraftResponse>;
+  dispose(): void;
+}
+//#endregion
 //#region src/storage/medeo-http-doc-storage.d.ts
 interface MedeoHttpDocStorageOptions {
   docId: string;
@@ -581,6 +766,7 @@ type DocumentSessionModel<Snapshot, Editor, Document> = (doc: LoroDoc, guard: Do
 declare class DocumentSession<Snapshot, Editor, Document> {
   private readonly options;
   private readonly model;
+  private readonly validateDocument;
   private readonly docId;
   private readonly local;
   private readonly server;
@@ -607,7 +793,7 @@ declare class DocumentSession<Snapshot, Editor, Document> {
    * doc (e.g. nothing was edited since the last confirmed push).
    */
   private serverVVValue;
-  constructor(options: MengineDocSessionOptions, model: DocumentSessionModel<Snapshot, Editor, Document>);
+  constructor(options: MengineDocSessionOptions, model: DocumentSessionModel<Snapshot, Editor, Document>, validateDocument: (doc: LoroDoc) => void);
   /**
    * Observe every push verdict, including `duplicate` and failures.
    *
@@ -719,6 +905,20 @@ declare class DocumentSession<Snapshot, Editor, Document> {
   private waitForInitialLoad;
 }
 //#endregion
+//#region src/session/mengine-doc-session.d.ts
+type MengineDocSessionUpdateEvent = DocumentSessionUpdateEvent<MedeoDslSnapshot>;
+/** Default collaborative session: one DSL handle and one editor over the synchronized LoroDoc. */
+declare class MengineDocSession extends DocumentSession<MedeoDslSnapshot, DslEditor, MedeoDsl> {
+  /** `uploadText` stores raw content the editor writes, such as a PhoneticScript's text, in Memota. */
+  constructor(options: MengineDocSessionOptions & {
+    uploadText?: UploadText;
+  });
+  get dsl(): MedeoDsl;
+  projectVideoDraft(): VideoDraftProjection;
+  /** The document's AudioScripts with what says and shows them; read from the same snapshot as the VideoDraft. */
+  projectAudioScripts(): AudioScriptView[];
+}
+//#endregion
 //#region src/storage/memory-doc-storage.d.ts
 /**
  * Runtime-neutral local `DocStorage` backed by in-process memory.
@@ -744,4 +944,4 @@ declare class MemoryDocStorage extends BaseDocStorage {
   private now;
 }
 //#endregion
-export { MenginePushRejectedError as A, MengineSyncResponse as B, PushResult as C, MengineHttpClient as D, readMengineEventStream as E, MenginePushResponse as F, base64ToBytes as H, MenginePushUpdateResponse as I, MengineRejectedResponse as L, MengineAuditResponse as M, MengineDocumentVersion as N, MengineHttpClientOptions as O, MengineDraftResponse as P, MengineSnapshotResponse as R, PullResult as S, MengineEventStreamOptions as T, bytesToBase64 as U, MengineUpdateMeta as V, ManualSyncTransport as _, MengineDocSessionOptions as a, DocVersionMark as b, WaitForLocalSaveOptions as c, MengineUndoState as d, MedeoHttpDocStorage as f, ManualSyncDocOptions as g, PushOutcomeKind as h, MengineAckFailedError as i, MengineAuditEntry as j, MengineHttpRequestError as k, WaitForServerAckOptions as l, PushOutcome as m, DocumentSession as n, MengineDocSyncState as o, MedeoHttpDocStorageOptions as p, DocumentSessionUpdateEvent as r, MengineLocalSaveState as s, MemoryDocStorage as t, DocStorageLike as u, decodeDocVersionMark as v, PushResultKind as w, PullFailureReason as x, encodeDocVersionMark as y, MengineSseUpdateEvent as z };
+export { MenginePushRejectedError as A, MengineSyncResponse as B, PushResult as C, MengineHttpClient as D, readMengineEventStream as E, MenginePushResponse as F, base64ToBytes as H, MenginePushUpdateResponse as I, MengineRejectedResponse as L, MengineAuditResponse as M, MengineDocumentVersion as N, MengineHttpClientOptions as O, MengineDraftResponse as P, MengineSnapshotResponse as R, PullResult as S, MengineEventStreamOptions as T, bytesToBase64 as U, MengineUpdateMeta as V, ManualSyncDocOptions as _, MengineDocSessionOptions as a, DocVersionMark as b, WaitForLocalSaveOptions as c, MengineUndoState as d, MedeoHttpDocStorage as f, ManualSyncDoc as g, PushOutcomeKind as h, MengineAckFailedError as i, MengineAuditEntry as j, MengineHttpRequestError as k, WaitForServerAckOptions as l, PushOutcome as m, MengineDocSession as n, MengineDocSyncState as o, MedeoHttpDocStorageOptions as p, MengineDocSessionUpdateEvent as r, MengineLocalSaveState as s, MemoryDocStorage as t, DocStorageLike as u, decodeDocVersionMark as v, PushResultKind as w, PullFailureReason as x, encodeDocVersionMark as y, MengineSseUpdateEvent as z };

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { $ as TextMutation, A as DeepReadonly, C as CaptionContent, D as Clip, E as CaptionText, F as EntityTables, G as ResourceSystem, H as RelationTable, I as EntityValues, K as RichTextSnapshot, L as FieldPatch, M as DslMutation, N as EntityMutation, O as ContainMutation, P as EntityTable, Q as TextMark, R as MedeoDslSnapshot, S as Caption, T as CaptionStyle, U as RelationTables, V as RelationMutation, W as RelationValues, X as TextDelta, Y as StoredFile, Z as TextEdit, _ as defaultIdFactory, a as VideoDraftCaptionStyle, b as tupleHash, c as VideoDraftInput, d as VideoDraftTrack, et as TextRun, f as VideoDraftTrackItem, g as EntityIdKind, h as DslIdFactory, i as VideoDraft, it as Voice, j as DslDiagnostic, k as ContainNode, l as VideoDraftPartUnion, m as OpActor, n as DEFAULT_UNIT_TIME_MS, nt as Track, o as VideoDraftContent, p as CommitOptions, r as VideoCreationSettings, rt as TrackRole, s as VideoDraftContentPartUnion, t as CaptionDisplayCue, tt as TimeAnchor, u as VideoDraftTimeline, v as relationId, w as CaptionSelection, x as AudioScript, y as resourceId, z as Media } from "./video-draft-types-GqXnsOzA.js";
-import { A as MedeoDslDraft, C as UnsupportedDocumentFormatError, D as captionContentCodec, E as InvalidAtomic, F as ClipSource, I as DslClipUpdate, L as MoveDslClipsInput, M as medeoDslLoroShape, N as AddDslClip, O as isInvalidAtomic, P as AddDslClipsInput, R as ReplaceDslClipsInput, S as DslTransaction, T as documentFormat, _ as VoiceoverCaptionInput, a as toAudioScriptViews, b as MedeoDsl, c as resolveDslLayout, d as DslProjectionError, f as DslTrackLayout, g as ApplyVoiceoverInput, h as UploadText, i as AudioScriptView, j as MedeoDslLoroState, k as timeAnchorCodec, l as DslClipLayout, m as DslEditor, n as ImportedVideoDraft, o as VideoDraftProjection, p as createInitialMedeoDsl, r as fromVideoDraft, s as toVideoDraft, t as FromVideoDraftOptions, u as DslLayout, v as VoiceoverResult, w as assertDslDocument, x as DslAudit, y as CreateMedeoDslOptions, z as ClipPlacement } from "./index-C5wDKYqC.js";
-import { A as MenginePushRejectedError, B as MengineSyncResponse, C as PushResult, D as MengineHttpClient, E as readMengineEventStream, F as MenginePushResponse, H as base64ToBytes, I as MenginePushUpdateResponse, L as MengineRejectedResponse, M as MengineAuditResponse, N as MengineDocumentVersion, O as MengineHttpClientOptions, P as MengineDraftResponse, R as MengineSnapshotResponse, S as PullResult, T as MengineEventStreamOptions, U as bytesToBase64, V as MengineUpdateMeta, a as MengineDocSessionOptions, b as DocVersionMark, c as WaitForLocalSaveOptions, d as MengineUndoState, f as MedeoHttpDocStorage, g as ManualSyncDocOptions, h as PushOutcomeKind, i as MengineAckFailedError, j as MengineAuditEntry, k as MengineHttpRequestError, l as WaitForServerAckOptions, m as PushOutcome, o as MengineDocSyncState, p as MedeoHttpDocStorageOptions, s as MengineLocalSaveState, t as MemoryDocStorage, u as DocStorageLike, v as decodeDocVersionMark, w as PushResultKind, x as PullFailureReason, y as encodeDocVersionMark, z as MengineSseUpdateEvent } from "./index-DAfOkcnZ.js";
-import { n as MengineDocSessionUpdateEvent, r as ManualSyncDoc, t as MengineDocSession } from "./index-CHiPztZr.js";
+import { $ as ClipPlacement, A as VoiceoverResult, At as RichTextSnapshot, B as isInvalidAtomic, Bt as Voice, C as DslProjectionError, Ct as MedeoDslSnapshot, D as UploadText, Dt as RelationTables, E as DslEditor, Et as RelationTable, F as UnsupportedDocumentFormatError, Ft as TextMutation, G as CommitOptions, H as MedeoDslDraft, I as assertDslDocument, It as TextRun, J as AddDslClipsInput, K as OpActor, L as documentFormat, Lt as TimeAnchor, M as MedeoDsl, Mt as TextDelta, N as DslAudit, Nt as TextEdit, O as ApplyVoiceoverInput, Ot as RelationValues, P as DslTransaction, Pt as TextMark, Q as ReplaceDslClipsInput, R as InvalidAtomic, Rt as Track, S as DslLayout, St as FieldPatch, T as createInitialMedeoDsl, Tt as RelationMutation, U as MedeoDslLoroState, V as timeAnchorCodec, W as medeoDslLoroShape, X as DslClipUpdate, Y as ClipSource, Z as MoveDslClipsInput, _ as VideoDraftTimeline, _t as DslMutation, a as toAudioScriptViews, at as tupleHash, b as resolveDslLayout, bt as EntityTables, c as CaptionDisplayCue, ct as CaptionContent, d as VideoDraft, dt as CaptionText, et as DslIdFactory, f as VideoDraftCaptionStyle, ft as Clip, g as VideoDraftPartUnion, gt as DslDiagnostic, h as VideoDraftInput, ht as DeepReadonly, i as AudioScriptView, it as resourceId, j as CreateMedeoDslOptions, jt as StoredFile, k as VoiceoverCaptionInput, kt as ResourceSystem, l as DEFAULT_UNIT_TIME_MS, lt as CaptionSelection, m as VideoDraftContentPartUnion, mt as ContainNode, n as ImportedVideoDraft, nt as defaultIdFactory, o as VideoDraftProjection, ot as AudioScript, p as VideoDraftContent, pt as ContainMutation, q as AddDslClip, r as fromVideoDraft, rt as relationId, s as toVideoDraft, st as Caption, t as FromVideoDraftOptions, tt as EntityIdKind, u as VideoCreationSettings, ut as CaptionStyle, v as VideoDraftTrack, vt as EntityMutation, w as DslTrackLayout, wt as Media, x as DslClipLayout, xt as EntityValues, y as VideoDraftTrackItem, yt as EntityTable, z as captionContentCodec, zt as TrackRole } from "./index-B1Lqm_Z1.js";
+import { A as MenginePushRejectedError, B as MengineSyncResponse, C as PushResult, D as MengineHttpClient, E as readMengineEventStream, F as MenginePushResponse, H as base64ToBytes, I as MenginePushUpdateResponse, L as MengineRejectedResponse, M as MengineAuditResponse, N as MengineDocumentVersion, O as MengineHttpClientOptions, P as MengineDraftResponse, R as MengineSnapshotResponse, S as PullResult, T as MengineEventStreamOptions, U as bytesToBase64, V as MengineUpdateMeta, _ as ManualSyncDocOptions, a as MengineDocSessionOptions, b as DocVersionMark, c as WaitForLocalSaveOptions, d as MengineUndoState, f as MedeoHttpDocStorage, g as ManualSyncDoc, h as PushOutcomeKind, i as MengineAckFailedError, j as MengineAuditEntry, k as MengineHttpRequestError, l as WaitForServerAckOptions, m as PushOutcome, n as MengineDocSession, o as MengineDocSyncState, p as MedeoHttpDocStorageOptions, r as MengineDocSessionUpdateEvent, s as MengineLocalSaveState, t as MemoryDocStorage, u as DocStorageLike, v as decodeDocVersionMark, w as PushResultKind, x as PullFailureReason, y as encodeDocVersionMark, z as MengineSseUpdateEvent } from "./index-pULoWyd9.js";
 export { type AddDslClip, type AddDslClipsInput, type ApplyVoiceoverInput, type AudioScript, type AudioScriptView, type Caption, type CaptionContent, type CaptionDisplayCue, type CaptionSelection, type CaptionStyle, type CaptionText, type Clip, type ClipPlacement, type ClipSource, type CommitOptions, type ContainMutation, type ContainNode, type CreateMedeoDslOptions, DEFAULT_UNIT_TIME_MS, type DeepReadonly, type DocStorageLike, type DocVersionMark, type DslAudit, type DslClipLayout, type DslClipUpdate, type DslDiagnostic, DslEditor, type DslIdFactory, type DslLayout, type DslMutation, DslProjectionError, type DslTrackLayout, type DslTransaction, type EntityIdKind, type EntityMutation, type EntityTable, type EntityTables, type EntityValues, type FieldPatch, type FromVideoDraftOptions, type ImportedVideoDraft, type InvalidAtomic, ManualSyncDoc, type ManualSyncDocOptions, MedeoDsl, type MedeoDslDraft, type MedeoDslLoroState, type MedeoDslSnapshot, MedeoHttpDocStorage, type MedeoHttpDocStorageOptions, type Media, MemoryDocStorage, MengineAckFailedError, type MengineAuditEntry, type MengineAuditResponse, MengineDocSession, type MengineDocSessionOptions, type MengineDocSessionUpdateEvent, type MengineDocSyncState, type MengineDocumentVersion, type MengineDraftResponse, type MengineEventStreamOptions, MengineHttpClient, type MengineHttpClientOptions, MengineHttpRequestError, type MengineLocalSaveState, MenginePushRejectedError, type MenginePushResponse, type MenginePushUpdateResponse, type MengineRejectedResponse, type MengineSnapshotResponse, type MengineSseUpdateEvent, type MengineSyncResponse, type MengineUndoState, type MengineUpdateMeta, type MoveDslClipsInput, type OpActor, type PullFailureReason, type PullResult, type PushOutcome, type PushOutcomeKind, type PushResult, type PushResultKind, type RelationMutation, type RelationTable, type RelationTables, type RelationValues, type ReplaceDslClipsInput, type ResourceSystem, type RichTextSnapshot, type StoredFile, type TextDelta, type TextEdit, type TextMark, type TextMutation, type TextRun, type TimeAnchor, type Track, type TrackRole, UnsupportedDocumentFormatError, type UploadText, type VideoCreationSettings, type VideoDraft, type VideoDraftCaptionStyle, type VideoDraftContent, type VideoDraftContentPartUnion, type VideoDraftInput, type VideoDraftPartUnion, type VideoDraftProjection, type VideoDraftTimeline, type VideoDraftTrack, type VideoDraftTrackItem, type Voice, type VoiceoverCaptionInput, type VoiceoverResult, type WaitForLocalSaveOptions, type WaitForServerAckOptions, assertDslDocument, base64ToBytes, bytesToBase64, captionContentCodec, createInitialMedeoDsl, decodeDocVersionMark, defaultIdFactory, documentFormat, encodeDocVersionMark, fromVideoDraft, isInvalidAtomic, medeoDslLoroShape, readMengineEventStream, relationId, resolveDslLayout, resourceId, timeAnchorCodec, toAudioScriptViews, toVideoDraft, tupleHash };