OpenFairyGUI API
    Preparing search index...

    Interface BackendTransactionPreview

    interface BackendTransactionPreview {
        baseRevision: number;
        impact: {
            entities: BackendTransactionEntityChange[];
            files: {
                change: "added" | "removed" | "updated";
                kind: "file" | "directory";
                path: string;
            }[];
        };
        mode: "execute-and-discard";
        persistence: {
            fileSystemAvailable: boolean;
            nextAction: "host-action"
            | "saveSession"
            | "materializeSession";
            requiredAfterApply: true;
            uamFidelity: "full" | "unsupported";
            writeVerified: false;
        };
        projectedRevision: number;
        sessionId: string;
    }
    Index
    baseRevision impact mode persistence projectedRevision sessionId
    baseRevision: number
    impact: {
        entities: BackendTransactionEntityChange[];
        files: {
            change: "added" | "removed" | "updated";
            kind: "file" | "directory";
            path: string;
        }[];
    }

    Complete, bounded comparison of current and projected UAM, not unsaved changes since last save.

    Type Declaration

    • entities: BackendTransactionEntityChange[]
    • files: {
          change: "added" | "removed" | "updated";
          kind: "file" | "directory";
          path: string;
      }[]

      Project-relative paths from the actual ProjectWriter, including empty directories. Not a disk write plan.

    mode: "execute-and-discard"
    persistence: {
        fileSystemAvailable: boolean;
        nextAction: "host-action" | "saveSession" | "materializeSession";
        requiredAfterApply: true;
        uamFidelity: "full" | "unsupported";
        writeVerified: false;
    }

    Type Declaration

    • fileSystemAvailable: boolean
    • nextAction: "host-action" | "saveSession" | "materializeSession"
    • requiredAfterApply: true
    • uamFidelity: "full" | "unsupported"
    • writeVerified: false

      Preflight never verifies filesystem permissions, materialize destinations or actual disk state.

    projectedRevision: number

    Revision after applying this batch at baseRevision, including an empty batch. Not reserved.

    sessionId: string

    Settings
    Member Visibility

    On This Page
    Properties