@docx-editor.dev/core 2.26.0 → 2.28.0

package/dist/failure-BIPVQbRm.d.ts

@@ -1,65 +0,0 @@
-/**
- * Lifecycle state of one collaboration replica.
- *
- * One axis, because the only question a host has to answer is whether to tell the reader to
- * wait or to reload:
- *
- * - `initializing` — joining. Edits are refused. Recovers on its own.
- * - `ready` — replicating. The only state that accepts edits.
- * - `disconnected` — the transport dropped. The replica is intact and recovers on its own,
- *   so wait rather than reload. Edits are refused until reconnect by default; a session
- *   created with offline editing enabled keeps accepting them, and the buffered updates
- *   merge on reconnect.
- * - `error` — this replica no longer agrees with the room. It does not recover: only a
- *   reload rejoins. {@link CollaborationStatusSnapshot.reason} says why.
- * - `destroyed` — torn down. Terminal.
- *
- * @public
- */
-type CollaborationStatus = 'initializing' | 'ready' | 'disconnected' | 'error' | 'destroyed';
-/**
- * Why a replica refused work, left `ready`, or failed a schema check.
- *
- * Free-form extras (a transport phrase, a blob key, a store refusal) travel in
- * {@link CollaborationFailure.detail}, not here. `invalid-shared-metadata` follows that rule:
- * it names one malformed field of the room's shared metadata, and which field is the detail.
- * Distinct from `invalid-document-id`, which rejects a document id this host passed in.
- * `concurrent-seed` reports two merged seed transactions in one room; the room cannot be
- * repaired client-side — create a new room from saved bytes.
- *
- * Two of these name a transport condition a host has to tell apart, because the answers are
- * opposite. `transport-disconnected` recovers on its own, so wait. `authentication-failed`
- * never does: the credential the provider re-sent was rejected, so refresh it and rejoin.
- * `transport` remains the catch-all for a provider that reported neither.
- *
- * @public
- */
-type CollaborationFailureCode = 'already-initialized' | 'authentication-failed' | 'baseline-digest-mismatch' | 'baseline-too-large' | 'blob-digest-mismatch' | 'blob-read' | 'blob-store-full' | 'blob-too-large' | 'collaboration-format-mismatch' | 'collaboration-session-destroyed' | 'collaboration-session-not-attached' | 'collaboration-session-not-ready' | 'collaboration-text-limit' | 'concurrent-seed' | 'document-id-mismatch' | 'duplicate-paragraph-id' | 'experimental-collaboration-body-text-only' | 'experimental-collaboration-existing-paragraphs-only' | 'experimental-collaboration-text-only' | 'experimental-collaboration-untracked-text-only' | 'immutable-baseline-changed' | 'immutable-metadata-changed' | 'initialization-aborted' | 'initialization-timeout' | 'invalid-baseline' | 'invalid-blob-descriptor' | 'invalid-bound' | 'invalid-document-id' | 'invalid-identity' | 'invalid-identity-color' | 'invalid-logical-id' | 'invalid-relationships' | 'invalid-saved-room' | 'invalid-session-id' | 'invalid-shared-metadata' | 'invalid-string' | 'local-mirror-failed' | 'materialize-dropped-content' | 'missing-blob' | 'missing-local-blob' | 'missing-root' | 'no-main-document-part' | 'not-initialized' | 'paragraph-set-mismatch' | 'port-already-attached' | 'protocol-version-mismatch' | 'prototype-key' | 'remote-apply-failed' | 'saved-room-unavailable' | 'schema-version-mismatch' | 'shared-schema-invalid' | 'text-too-long' | 'too-many-attributes' | 'too-many-children' | 'too-many-nodes' | 'too-many-parts' | 'too-many-relationships' | 'transport' | 'transport-disconnected' | 'tree-too-deep' | 'unknown-logical-id' | 'unknown-paragraph-id' | 'unsafe-part-name' | 'unsupported-root-key';
-/** True when `value` is a {@link CollaborationFailureCode} member. @public */
-declare function isCollaborationFailureCode(value: string): value is CollaborationFailureCode;
-/** One collaboration failure: a typed code plus optional free-form detail. @public */
-interface CollaborationFailure {
-    readonly code: CollaborationFailureCode;
-    readonly detail?: string;
-}
-/**
- * Cached status read. Same reference until status, reason, or last failure change.
- *
- * @public
- */
-interface CollaborationStatusSnapshot {
-    readonly status: CollaborationStatus;
-    readonly reason: CollaborationFailure | undefined;
-    readonly lastFailure: CollaborationFailure | undefined;
-}
-/** @internal */
-interface CollaborationStatusTracker {
-    status(): CollaborationStatus;
-    snapshot(): CollaborationStatusSnapshot;
-    set(status: CollaborationStatus, code?: CollaborationFailureCode, detail?: string): boolean;
-}
-/** @internal */
-declare function createCollaborationStatusTracker(initial?: CollaborationStatus): CollaborationStatusTracker;
-
-export { createCollaborationStatusTracker as d, isCollaborationFailureCode as i };
-export type { CollaborationStatus as C, CollaborationStatusSnapshot as a, CollaborationFailureCode as b, CollaborationFailure as c };