@namespace("keybase.1")

protocol kbfsCommon {
  enum FSStatusCode {
    START_0,
    FINISH_1,
    ERROR_2
  }

  enum FSNotificationType {
    ENCRYPTING_0,
    DECRYPTING_1,
    SIGNING_2,
    VERIFYING_3,
    REKEYING_4,
    CONNECTION_5,
    MD_READ_SUCCESS_6,
    FILE_CREATED_7,
    FILE_MODIFIED_8,
    FILE_DELETED_9,
    FILE_RENAMED_10,
    INITIALIZED_11,
    SYNC_CONFIG_CHANGED_12
  }

  enum FSErrorType {
    ACCESS_DENIED_0,
    USER_NOT_FOUND_1,
    REVOKED_DATA_DETECTED_2,
    NOT_LOGGED_IN_3,
    TIMEOUT_4,
    REKEY_NEEDED_5,
    BAD_FOLDER_6,
    NOT_IMPLEMENTED_7,
    OLD_VERSION_8,
    OVER_QUOTA_9,
    NO_SIG_CHAIN_10,
    TOO_MANY_FOLDERS_11,
    EXDEV_NOT_SUPPORTED_12,
    DISK_LIMIT_REACHED_13,
    DISK_CACHE_ERROR_LOG_SEND_14,
    OFFLINE_ARCHIVED_15,
    OFFLINE_UNSYNCED_16
}

  record FSNotification {
    string filename;
    string status;
    FSStatusCode statusCode;
    FSNotificationType notificationType;
    FSErrorType errorType;
    map<string> params;
    @lint("ignore")
    UID writerUid;
    Time localTime;
    FolderType folderType;
  }

  record FSEditListRequest {
    Folder folder;
    int requestID;
  }

  record FSFolderWriterEdit {
    string filename;
    FSNotificationType notificationType;
    Time serverTime;
  }

  record FSFolderWriterEditHistory {
    string writerName;
    array<FSFolderWriterEdit> edits;
    array<FSFolderWriterEdit> deletes;
  }

  record FSFolderEditHistory {
    Folder folder;
    Time serverTime;
    array<FSFolderWriterEditHistory> history;
  }

  record FSSyncStatusRequest {
    int requestID;
  }

  record FSPathSyncStatus {
    FolderType folderType;
    string path;  // could be a file or directory
    // How many total encrypted, padded bytes are still syncing, as part of
    // operations on this path.
    int64 syncingBytes;
    // How many outstanding operations are there for this path?
    int64 syncingOps;

    // If this notification happened due to a completed sync for this
    // path, how many bytes just finished syncing?
    int64 syncedBytes;
  }

  record FSSyncStatus {
    int64 totalSyncingBytes;
    array<string> syncingPaths;
    union { null, Time} endEstimate;
  }

  record FolderSyncStatus {
    // Bytes available and total on the partition hosting the sync cache.
    int64 localDiskBytesAvailable;
    int64 localDiskBytesTotal;
    PrefetchStatus prefetchStatus;
    PrefetchProgress prefetchProgress;
    int64 storedBytesTotal;
    boolean outOfSyncSpace;
  }
}