/**
 * GitDocumentDB
 * Copyright (c) Hidekazu Kubota
 *
 * This source code is licensed under the Mozilla Public License Version 2.0
 * found in the LICENSE file in the root directory of this source tree.
 */
import { ILogObject, TLogLevelName } from 'tslog';
/**
 * Plugin types
 *
 * @public
 */
export declare type PluginTypes = 'db' | 'remote';
/**
 * Database Options
 *
 * @remarks
 * localDir and dbName are OS-specific options.
 *
 * <b>It is recommended to use ASCII characters and case-insensitive names for cross-platform.</b>
 *
 * localDir - A local directory path that stores repositories of GitDocumentDB.
 *
 *   - Default is './gitddb'.
 *
 *   - A directory name allows Unicode characters except for OS reserved filenames and the following characters: \< \> : " | ? * ¥0.
 *
 *   - A colon : is generally not allowed, but a Windows drive letter followed by a colon is allowed. e.g.) C: D:
 *
 *   - A directory name cannot end with a period or a white space but the current directory . and the parent directory .. are allowed.
 *
 *   - A trailing slash / could be omitted.
 *
 * dbName - A name of a git repository
 *
 *   - dbName allows Unicode characters except for OS reserved filenames and the following characters: \< \> : " ¥ / \\ | ? * ¥0.
 *
 *   - dbName cannot end with a period or a white space.
 *
 *   - dbName does not allow '.' and '..'.
 *
 * logLevel - Default is 'info'.
 *
 * schema - Schema for a specific document type.
 *
 * serializeFormat - Format for serialization
 *
 * logToTransport - logToTransport function for all log levels. See https://tslog.js.org/#/?id=transports
 *
 * logColorEnabled - Enable color for console log. Default is true. When you write log into a file by logToTransport, false is recommended.
 *
 * @public
 */
export declare type DatabaseOptions = {
    localDir?: string;
    dbName: string;
    logLevel?: TLogLevelName;
    schema?: Schema;
    serialize?: SerializeFormatLabel;
    logToTransport?: (logObject: ILogObject) => void;
    logColorEnabled?: boolean;
};
/**
 * Database open options
 *
 * @remarks
 * - createIfNotExists: Default is true.
 *
 * @public
 */
export declare type OpenOptions = {
    createIfNotExists?: boolean;
};
/**
 * Schema for specific document type
 *
 * @public
 */
export declare type Schema = {
    json: JsonDiffPatchOptions;
};
/**
 * JsonDiffPatchOptions
 *
 * @remarks
 *  - plainTextProperties: Only property whose key matches plainTextProperties uses text-diff-and-patch algorithm (google-diff-match-patch).
 *
 *  - keyInArrayedObject: To diff between arrays that contain objects as elements, you must specify a key in the object. See https://github.com/benjamine/jsondiffpatch/blob/master/docs/arrays.md#an-object-hash
 *
 *  - keyOfUniqueArray: Set a key of a unique array. Unique array never include duplicated members after JSON patch.
 *
 * @example
 * ```
 * Example of plainTextProperties:
 * { a: { b: true }, c: true } matches 'b' (whose ancestor is only 'a') and 'c'.
 * { a: { _all: true } } matches all child properties of 'a'.
 * { a: { _regex: /abc/ } } matches child properties of 'a' which match /abc/.
 * ```
 *
 * @public
 */
export declare type JsonDiffPatchOptions = {
    keyInArrayedObject?: string[];
    keyOfUniqueArray?: string[];
    plainTextProperties?: {
        [key: string]: any;
    };
};
/**
 * Result of opening database
 *
 * @remarks
 * - isNew: Whether a repository is newly created or existing.
 *
 * - isCreatedByGitDDB: Whether a repository is created by GitDocumentDB or other means.
 *
 * - isValidVersion: Whether a repository version equals to the current databaseVersion of GitDocumentDB.
 *
 * @public
 */
export declare type DatabaseOpenResult = DatabaseInfo & {
    isNew: boolean;
    isCreatedByGitDDB: boolean;
    isValidVersion: boolean;
};
/**
 * Database information
 *
 * @remarks
 * - This is metadata unique to GitDocumentDB.
 *
 * - This metadata is saved to '.gitddb/info.json' in JSON format.
 *
 * - dbId: ULID of the database. (See https://github.com/ulid/spec for ULID.) The dbId is used for combining databases.
 *
 * - creator: A creator of the database. Default is 'GitDocumentDB'. 'GitDocumentDB' ensures that the repository is created according to the GitDocumentDB scheme.
 *
 * - version: A version of the GitDocumentDB specification. The version can be used for database migration.
 *
 * - serialize: Serialize format of the database.
 *
 * @public
 */
export declare type DatabaseInfo = {
    dbId: string;
    creator: string;
    version: string;
    serialize: SerializeFormatLabel;
};
/**
 * The type for a JSON document that is stored in a database
 *
 * @remarks
 * A JSON document must be a JavaScript object that matches the following conditions:
 *
 * - It must have an '_id' key that shows the unique identifier of a document
 *
 * - _id allows Unicode characters except for OS reserved filenames and the following characters: \< \> : " | ? * ¥0.
 *
 * - _id and a filename are linked. So _id is better to be ASCII characters and a case-insensitive name for cross-platform.
 *
 * - _id cannot start or end with a slash.
 *
 * - _id can include paths separated by slashes.
 *
 * - A directory name in paths cannot end with a period or a white space.
 *
 * - A directory name in paths does not allow '.' and '..'.
 *
 * @example
 * ```
 * {
 *   _id: 'nara/nara_park',
 *   flower: 'double cherry blossoms'
 * }
 * ```
 *
 * @public
 */
export declare type JsonDoc = {
    [key: string]: any;
};
/**
 * Type of document
 *
 * @remarks
 * - json: JsonDoc
 *
 * - text: utf8 string
 *
 * - binary: Uint8Array
 *
 * @public
 */
export declare type DocType = 'json' | 'text' | 'binary';
/**
 * Union type of Doc types
 *
 * @public
 */
export declare type Doc = JsonDoc | string | Uint8Array;
/**
 * Metadata for JsonDoc
 *
 * @remarks
 * - _id: _id of a JSON document. This is a file name without extension.
 *
 * - name: A file name in Git. e.g.) "foo.json", "bar/baz.md"
 *
 * - fileOid: SHA-1 hash of Git object (40 characters)
 *
 * - type: type shows a DocType. type of JsonDocMetadata is fixed to 'json'.
 *
 * @public
 */
export declare type JsonDocMetadata = {
    _id: string;
    name: string;
    fileOid: string;
    type: 'json';
};
/**
 * Metadata for TextDoc
 *
 * @remarks
 * - name: A file name in Git. e.g.) "foo", "bar/baz.md"
 *
 * - fileOid: SHA-1 hash of Git object (40 characters)
 *
 * - type: type shows a DocType. type of TextDocMetadata is fixed to 'text'.
 *
 * @public
 */
export declare type TextDocMetadata = {
    name: string;
    fileOid: string;
    type: 'text';
};
/**
 * Metadata for BinaryDoc
 *
 * @remarks
 * - name: A file name in Git. e.g.) "foo", "bar/baz.jpg"
 *
 * - fileOid: SHA-1 hash of Git object (40 characters)
 *
 * - type: type shows a DocType. The type of BinaryDocMetadata is fixed to 'binary'.
 *
 * @public
 */
export declare type BinaryDocMetadata = {
    name: string;
    fileOid: string;
    type: 'binary';
};
/**
 * Union type of Document metadata
 *
 * @public
 */
export declare type DocMetadata = JsonDocMetadata | TextDocMetadata | BinaryDocMetadata;
/**
 * JsonDoc with metadata
 *
 * @public
 */
export declare type FatJsonDoc = JsonDocMetadata & {
    doc: JsonDoc;
};
/**
 * Text (string) with metadata
 *
 * @public
 */
export declare type FatTextDoc = TextDocMetadata & {
    doc: string;
};
/**
 * Binary (Uint8Array) with metadata
 *
 * @public
 */
export declare type FatBinaryDoc = BinaryDocMetadata & {
    doc: Uint8Array;
};
/**
 * Union type of documents with a metadata
 *
 * @public
 */
export declare type FatDoc = FatJsonDoc | FatTextDoc | FatBinaryDoc;
/**
 * Format for serialization
 *
 * @public
 */
export declare type SerializeFormatLabel = 'json' | 'front-matter';
/**
 * Interface for serialize format classes
 *
 * @internal
 */
export interface SerializeFormat {
    format: SerializeFormatLabel;
    firstExtension: string;
    secondExtension: string | undefined;
    removeExtension: (path: string) => string;
    extension: (doc?: JsonDoc) => string;
    hasObjectExtension: (path: string) => boolean;
    serialize: (doc: JsonDoc) => {
        extension: string;
        data: string;
    };
}
/**
 * CollectionPath
 *
 * @remarks
 * CollectionPath must be paths that match the following conditions:
 *
 * - CollectionPath can include paths separated by slashes.
 *
 * - A directory name in paths allows Unicode characters except for OS reserved filenames and the following characters: \< \> : " | ? * ¥0.
 *
 * - CollectionPath is better to be ASCII characters and case-insensitive names for cross-platform.
 *
 * - A directory name in paths cannot end with a period or a white space.
 *
 * - A directory name in paths does not allow '.' and '..'.
 *
 * - CollectionPath cannot start with a slash.
 *
 * - Trailing slash could be omitted. e.g.) 'pages' and 'pages/' show the same CollectionPath.
 *
 * @public
 */
export declare type CollectionPath = string;
/**
 * Options for Collection constructor
 *
 * @remarks
 * - namePrefix: Automatically generated _id has a specified prefix in the collection.
 *
 * - debounceTime: put/insert/update operations for the same document are debounced by specified milliseconds in the collection. Default is -1 (do not debounce).
 *
 * @public
 */
export declare type CollectionOptions = {
    namePrefix?: string;
    debounceTime?: number;
    idGenerator?: () => string;
};
/**
 * Options for put APIs (put, update, insert, putFatDoc, updateFatDoc, and insertFatDoc)
 *
 * @remarks
 * - commitMessage: Git commit message. Default is '\<insert or update\>: path/to/the/file(\<fileOid\>)'.
 *
 * - insertOrUpdate: Change behavior of put and putFatDoc. Don't use this option. Use insert() or update() instead.
 *
 * - taskId: taskId is used in TaskQueue to distinguish CRUD and synchronization tasks. It is usually generated automatically. Set it if you would like to monitor this put task explicitly.
 *
 * - enqueueCallback: A callback function called just after this put task is enqueued to TaskQueue.
 *
 * - debounceTime: put/insert/update operations for the same document are debounced by specified milliseconds. This overwrite the same option in Collection Class. Default is -1 (do not debounce).
 *
 * @public
 */
export declare type PutOptions = {
    commitMessage?: string;
    insertOrUpdate?: 'insert' | 'update';
    taskId?: string;
    enqueueCallback?: (taskMetadata: TaskMetadata) => void;
    debounceTime?: number;
};
/**
 * Internal options for get APIs
 *
 * @remarks
 * revision and oid are mutually exclusive options. oid has priority.
 *
 * @internal
 */
export declare type GetInternalOptions = {
    revision?: number;
    oid?: string;
    withMetadata?: boolean;
};
/**
 * Options for get APIs (get, getFatDoc, getOldRevision, getFatDocOldRevision, getHistory, getFatDocHistory)
 *
 * @remarks
 * - forceDocType: Force return type.
 *
 * - getDocByOid does not have this option.
 *
 * @public
 */
export declare type GetOptions = {
    forceDocType?: DocType;
};
/**
 * Options for getHistory() and getFatDocHistory()
 *
 * @remarks
 * - filter: This filters an array of revisions by matching multiple HistoryFilters in OR condition.
 *
 * @public
 */
export declare type HistoryOptions = {
    filter?: HistoryFilter[];
};
/**
 * Filter for file history
 *
 * @public
 */
export declare type HistoryFilter = {
    author?: {
        name?: string;
        email?: string;
    };
    committer?: {
        name?: string;
        email?: string;
    };
};
/**
 * Options for delete
 *
 * @remarks
 * - commitMessage:  Git commit message. Default is 'delete: path/to/the/file(\<fileOid\>)'.
 *
 * - taskId: taskId is used in TaskQueue to distinguish CRUD and synchronization tasks. It is usually generated automatically. Set it if you would like to monitor this delete task explicitly.
 *
 * - enqueueCallback: A callback function called just after this delete task is enqueued to TaskQueue.
 *
 * @public
 */
export declare type DeleteOptions = {
    commitMessage?: string;
    taskId?: string;
    enqueueCallback?: (taskMetadata: TaskMetadata) => void;
};
/**
 * Options for find and findFatDoc
 *
 * @remarks
 * - descending: Sort _ids or names in descendant order. Default is false (ascending).
 *
 * - recursive: Get documents recursively from all subdirectories. Default is true.
 *
 * - prefix: Get documents whose _ids or names start with the prefix.
 *
 * - forceDocType: Force return DocType.
 *
 * @public
 */
export declare type FindOptions = {
    descending?: boolean;
    recursive?: boolean;
    prefix?: string;
    forceDocType?: DocType;
};
/**
 * Result of put APIs (put, update, insert, putFatDoc, updateFatDoc, and insertFatDoc)
 *
 * @remarks
 * - _id: _id of a JSON document. This is a file name without extension. PutResult does not have _id if a document is not {@link JsonDoc} type.
 *
 * - name: A file name in Git. e.g.) "foo.json", "bar/baz.md"
 *
 * - fileOid: SHA-1 hash of Git object (40 characters).
 *
 * - commit: Git commit object of this put operation.
 *
 * @public
 */
export declare type PutResult = PutResultJsonDoc | PutResultText | PutResultBinary;
/**
 * @public
 */
export declare type PutResultJsonDoc = {
    _id: string;
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'json';
};
/**
 * @public
 */
export declare type PutResultText = {
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'text';
};
/**
 * @public
 */
export declare type PutResultBinary = {
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'binary';
};
/**
 * Result of delete()
 *
 * @remarks
 * - _id: _id of a JSON document. This is a file name without extension. PutResult does not have _id if a document is not {@link JsonDoc} type.
 *
 * - name: A file name in Git. e.g.) "foo.json", "bar/baz.md"
 *
 * - fileOid: SHA-1 hash of Git object (40 characters)
 *
 * - commit: Git commit object of this put operation.
 *
 * @public
 */
export declare type DeleteResult = DeleteResultJsonDoc | DeleteResultText | DeleteResultBinary;
/**
 * @public
 */
export declare type DeleteResultJsonDoc = {
    _id: string;
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'json';
};
/**
 * @public
 */
export declare type DeleteResultText = {
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'text';
};
/**
 * @public
 */
export declare type DeleteResultBinary = {
    name: string;
    fileOid: string;
    commit: NormalizedCommit;
    type: 'binary';
};
/**
 * How to close a database
 *
 * @remarks
 * - force: Clear queued tasks immediately.
 *
 * - timeout: Clear queued tasks after timeout(msec). Default is 10000.
 *
 * @public
 */
export declare type DatabaseCloseOption = {
    force?: boolean;
    timeout?: number;
};
/**
 * Synchronization direction
 *
 * @remarks
 *
 * - pull: Only download from remote to local (currently not implemented)
 *
 * - push: Only upload from local to remote
 *
 * - both: Both download and upload between remote and local
 *
 * @public
 */
export declare type SyncDirection = 'pull' | 'push' | 'both';
/**
 * Connection settings for GitHub
 *
 * @remarks
 * - personalAccessToken: See https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
 *
 * - private: Whether the automatically created repository is private or not. Default is true.
 *
 * @public
 */
export declare type ConnectionSettingsGitHub = {
    type: 'github';
    engine?: string;
    personalAccessToken?: string;
    private?: boolean;
};
/**
 * Connection settings for SSH
 *
 * @public
 */
export declare type ConnectionSettingsSSH = {
    type: 'ssh';
    engine?: string;
    privateKeyPath: string;
    publicKeyPath: string;
    passPhrase?: string;
};
/**
 * Connection settings do not exist.
 *
 * @public
 */
export declare type ConnectionSettingsNone = {
    type: 'none';
    engine?: string;
};
/**
 * Connection settings for RemoteOptions
 *
 * @public
 */
export declare type ConnectionSettings = ConnectionSettingsNone | ConnectionSettingsGitHub | ConnectionSettingsSSH;
/**
 * Behavior when combining inconsistent DBs
 *
 * Default is 'combine-head-with-theirs'.
 *
 * @public
 */
export declare type CombineDbStrategies = 'throw-error' | 'combine-head-with-ours' | 'combine-head-with-theirs' | 'combine-history-with-ours' | 'combine-history-with-theirs' | 'replace-with-ours' | 'replace-with-theirs';
/**
 * Strategy for resolving conflicts
 *
 * @remarks
 * 'ours' and 'theirs' are borrowed terms from Git (https://git-scm.com/docs/merge-strategies)
 *
 * - 'ours-diff': (Default) Accept ours per JSON property. The merging process compares and merges properties in local and remote documents. When a remote property is conflicted with a local property in a document, the local property is accepted. If a document is not JSON, 'ours' strategy is applied.
 *
 * - 'theirs-diff': Accept theirs per JSON property. The merging process compares and merges properties in local and remote documents. When a remote property is conflicted with a local property in a document, the remote property is accepted. If a document is not JSON, 'theirs' strategy is applied.
 *
 * - 'ours': Accept ours. The merging process compares and merges per document. When a remote document is conflicted with a local document, the local document is accepted.
 *
 * - 'theirs': Accept theirs. The merging process compares and merges per document. When a remote document is conflicted with a local document, the remote document is accepted.
 *
 * - Compare function that returns one of the strategies ('ours-diff', 'theirs-diff', 'ours', and 'theirs') can be given. Each parameter is undefined when a document is deleted or does not exist.
 *
 * @public
 */
export declare type ConflictResolutionStrategies = ConflictResolutionStrategyLabels | ((ours?: FatDoc, theirs?: FatDoc) => ConflictResolutionStrategyLabels);
/**
 * @public
 */
export declare type ConflictResolutionStrategyLabels = 'ours-diff' | 'theirs-diff' | 'ours' | 'theirs';
/**
 * Write operation in resolving conflicts
 *
 * @remarks
 * - insert: A document in either 'ours' or 'theirs' is newly inserted.
 *
 * - update: A document is updated to either 'ours' document or 'theirs' document.
 *
 * - delete: A document is deleted.
 *
 * - insert-merge: A merged document of 'ours' and 'theirs' is newly inserted.
 *
 * - update-merge: A document is updated to a merged document of 'ours' and 'theirs'.
 *
 * @public
 */
export declare type WriteOperation = 'insert' | 'update' | 'delete' | 'insert-merge' | 'update-merge';
/**
 * Accepted conflict
 *
 * @remarks
 * - doc: Conflicted document (metadata only)
 *
 * - strategy: Applied strategy on the target
 *
 * - operation: Applied write operation on the target
 *
 * @public
 */
export declare type AcceptedConflict = {
    fatDoc: FatDoc;
    strategy: ConflictResolutionStrategyLabels;
    operation: WriteOperation;
};
/**
 * Options for Sync class
 *
 * @remarks
 * (network)
 *
 * - remoteUrl: Connection destination
 *
 * - syncDirection: Default is 'both'.
 *
 * - connection: Authentication and other settings on remote site
 *
 * (automation)
 *
 * - live: Synchronization repeats automatically if true. Default is false.
 *
 * - interval: Synchronization interval (milliseconds). This must be greater than MINIMUM_SYNC_INTERVAL(3000). Default is DEFAULT_SYNC_INTERVAL(30000).
 *
 * - retry: Number of network retries. Retry does not occur if retry is 0. Default is NETWORK_RETRY(3).
 *
 * - retryInterval: Retry interval (milliseconds). Default is NETWORK_RETRY_INTERVAL(2000).
 *
 * (merge)
 *
 * - conflictResolutionStrategy: Default is 'ours-diff'.
 *
 * - combineDbStrategy: Default is 'combine-head-with-theirs'.
 *
 * (result)
 *
 * - includeCommits: Whether SyncResult includes 'commits' property or not. Default is false.
 *
 * @public
 */
export declare type RemoteOptions = {
    remoteUrl?: string;
    syncDirection?: SyncDirection;
    connection?: ConnectionSettings;
    live?: boolean;
    interval?: number;
    retry?: number;
    retryInterval?: number;
    conflictResolutionStrategy?: ConflictResolutionStrategies;
    combineDbStrategy?: CombineDbStrategies;
    includeCommits?: boolean;
};
/**
 * Union type of properties of TaskStatistics
 *
 * @public
 */
export declare type TaskLabel = 'put' | 'insert' | 'update' | 'delete' | 'sync' | 'push';
/**
 * Task statistics after opening database
 *
 * @remarks
 * The statistics are on memory and not persistent. They are cleared by GitDocumentDB#close().
 *
 * @public
 */
export declare type TaskStatistics = {
    put: number;
    insert: number;
    update: number;
    delete: number;
    push: number;
    sync: number;
    cancel: number;
};
/**
 * Metadata of a task
 *
 * @public
 */
export declare type TaskMetadata = {
    label: TaskLabel;
    taskId: string;
    shortId?: string;
    shortName?: string;
    collectionPath?: string;
    enqueueTime?: string;
    syncRemoteName?: string;
    debounceTime?: number;
};
/**
 * Task in TaskQueue
 *
 * @internal
 */
export declare type Task = TaskMetadata & {
    func: (beforeResolve: () => void, beforeReject: () => void, taskMetadata: TaskMetadata) => Promise<void>;
    cancel: () => void;
    enqueueCallback?: (taskMetadata: TaskMetadata) => void;
};
/**
 * Inserted file in a merge operation
 *
 * @public
 */
export declare type ChangedFileInsert = {
    operation: 'insert';
    new: FatDoc;
};
/**
 * Updated file in a merge operation
 *
 * @public
 */
export declare type ChangedFileUpdate = {
    operation: 'update';
    old: FatDoc;
    new: FatDoc;
};
/**
 * Deleted file in a merge operation
 *
 * @public
 */
export declare type ChangedFileDelete = {
    operation: 'delete';
    old: FatDoc;
};
/**
 * Union type of changed files in a merge operation
 *
 * @public
 */
export declare type ChangedFile = ChangedFileInsert | ChangedFileUpdate | ChangedFileDelete;
/**
 * Duplicated file in combining operation
 *
 * @public
 */
export declare type DuplicatedFile = {
    original: DocMetadata;
    duplicate: DocMetadata;
};
/**
 * Normalized Commit
 *
 * @public
 */
export declare type NormalizedCommit = {
    oid: string;
    message: string;
    parent: string[];
    author: {
        name: string;
        email: string;
        timestamp: number;
    };
    committer: {
        name: string;
        email: string;
        timestamp: number;
    };
    gpgsig?: string;
};
/**
 * Synchronization did nothing.
 *
 * @public
 */
export declare type SyncResultNop = {
    action: 'nop';
};
/**
 * Synchronization pushed commits.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.remote: List of commits that had been pushed to remote
 *
 * @public
 */
export declare type SyncResultPush = {
    action: 'push';
    changes: {
        remote: ChangedFile[];
    };
    commits?: {
        remote: NormalizedCommit[];
    };
};
/**
 * Synchronization invoked fast-forward merge.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.local: List of commits that had been pulled to local
 *
 * @public
 */
export declare type SyncResultFastForwardMerge = {
    action: 'fast-forward merge';
    changes: {
        local: ChangedFile[];
    };
    commits?: {
        local: NormalizedCommit[];
    };
};
/**
 * Synchronization created a merge commit and failed to push it.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.local: List of commits that had been pulled to local
 *
 * @public
 */
export declare type SyncResultMergeAndPushError = {
    action: 'merge and push error';
    changes: {
        local: ChangedFile[];
    };
    commits?: {
        local: NormalizedCommit[];
    };
    error: Error;
};
/**
 * Synchronization created a merge commit and pushed it.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.local: List of commits that had been pulled to local
 *
 * - commits.remote: List of commits that had been pushed to remote
 *
 * @public
 */
export declare type SyncResultMergeAndPush = {
    action: 'merge and push';
    changes: {
        local: ChangedFile[];
        remote: ChangedFile[];
    };
    commits?: {
        local: NormalizedCommit[];
        remote: NormalizedCommit[];
    };
};
/**
 * Synchronization resolved conflicts, created a merge commit, and failed to push it.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.local: List of commits that had been pulled to local
 *
 * @public
 */
export declare type SyncResultResolveConflictsAndPushError = {
    action: 'resolve conflicts and push error';
    changes: {
        local: ChangedFile[];
    };
    conflicts: AcceptedConflict[];
    commits?: {
        local: NormalizedCommit[];
    };
    error: Error;
};
/**
 * Synchronization resolved conflicts, created a merge commit, and pushed it.
 *
 * @remarks
 * - commits are sorted from old to new.
 *
 * - commits.local: List of commits that had been pulled to local
 *
 * - commits.remote: List of commits that had been pushed to remote
 *
 * @public
 */
export declare type SyncResultResolveConflictsAndPush = {
    action: 'resolve conflicts and push';
    changes: {
        local: ChangedFile[];
        remote: ChangedFile[];
    };
    conflicts: AcceptedConflict[];
    commits?: {
        local: NormalizedCommit[];
        remote: NormalizedCommit[];
    };
};
/**
 * Synchronization combined databases.
 *
 * @remarks
 * Push action does not occur after combine action.
 *
 * @public
 */
export declare type SyncResultCombineDatabase = {
    action: 'combine database';
    duplicates: DuplicatedFile[];
};
/**
 * Synchronization was canceled.
 *
 * @public
 */
export declare type SyncResultCancel = {
    action: 'canceled';
};
/**
 * Union type of results from trySync() and tryPush()
 *
 * @public
 */
export declare type SyncResult = SyncResultNop | SyncResultPush | SyncResultFastForwardMerge | SyncResultMergeAndPushError | SyncResultMergeAndPush | SyncResultResolveConflictsAndPushError | SyncResultResolveConflictsAndPush | SyncResultCombineDatabase | SyncResultCancel;
/**
 * Union type of SyncEvents
 *
 * @public
 */
export declare type SyncEvent = 'change' | 'localChange' | 'remoteChange' | 'combine' | 'pause' | 'resume' | 'start' | 'complete' | 'error';
/**
 * Callback of 'change' event
 *
 * @public
 */
export declare type SyncChangeCallback = (syncResult: SyncResult, taskMetadata: TaskMetadata) => void;
/**
 * Callback of 'localChange' event
 *
 * @public
 */
export declare type SyncLocalChangeCallback = (changedFiles: ChangedFile[], taskMetadata: TaskMetadata) => void;
/**
 * Callback of 'remoteChange' event
 *
 * @public
 */
export declare type SyncRemoteChangeCallback = (changedFiles: ChangedFile[], taskMetadata: TaskMetadata) => void;
/**
 * Callback of 'combine' event
 *
 * @public
 */
export declare type SyncCombineDatabaseCallback = (duplicates: DuplicatedFile[]) => void;
/**
 * Callback of 'pause' event
 *
 * @public
 */
export declare type SyncPauseCallback = () => void;
/**
 * Callback of 'resume' event
 *
 * @public
 */
export declare type SyncResumeCallback = () => void;
/**
 * Callback of 'start' event
 *
 * @public
 */
export declare type SyncStartCallback = (taskMetadata: TaskMetadata, currentRetries: number) => void;
/**
 * Callback of 'complete' event
 *
 * @public
 */
export declare type SyncCompleteCallback = (taskMetadata: TaskMetadata) => void;
/**
 * Callback of 'error' event
 *
 * @public
 */
export declare type SyncErrorCallback = (error: Error, taskMetadata: TaskMetadata) => void;
/**
 * Union type of SyncEventCallbacks
 *
 * @public
 */
export declare type SyncCallback = SyncChangeCallback | SyncLocalChangeCallback | SyncRemoteChangeCallback | SyncCombineDatabaseCallback | SyncPauseCallback | SyncResumeCallback | SyncStartCallback | SyncCompleteCallback | SyncErrorCallback;
/**
 * Interface of JsonPatch
 *
 * @internal
 */
export interface IJsonPatch {
    patch(docOurs: JsonDoc, docTheirs: JsonDoc, diffOurs: {
        [key: string]: any;
    }, diffTheirs?: {
        [key: string]: any;
    } | undefined, strategy?: ConflictResolutionStrategyLabels): JsonDoc;
}
/**
 * Colored log
 *
 * @internal
 */
export declare type ColoredLog = (mes: string, colorTag?: () => (literals: TemplateStringsArray, ...placeholders: any[]) => string) => void;
/**
 * Colored logger
 *
 * @internal
 */
export declare type ColoredLogger = {
    silly: ColoredLog;
    debug: ColoredLog;
    trace: ColoredLog;
    info: ColoredLog;
    warn: ColoredLog;
    error: ColoredLog;
    fatal: ColoredLog;
};
//# sourceMappingURL=types.d.ts.map