import { ContactsModuleRdfLib } from "./rdflib/ContactsModuleRdfLib.js";
export default ContactsModuleRdfLib;
export interface ContactsModule {
    /**
     * Lists all known address books of the given Solid user.
     * Private instances will only be listed, if the fetcher has access to the preferences document and
     * the private type index, otherwise only public instances will be returned and the privateUris will be an empty array.
     * @param webId - The WebID of the user whose address books to list
     * @return The URIs of the address books grouped by public (listed) and private (unlisted) instances
     */
    listAddressBooks(webId: string): Promise<AddressBookLists>;
    /**
     * Creates a new address book in the given container
     * @param command
     * @return The URI of the newly created address book
     */
    createAddressBook({ containerUri, name, ownerWebId, }: CreateAddressBookCommand): Promise<string>;
    /**
     * Fetch the index data of address book identified by the given URI
     * @param uri - The URI of the address book to read
     * @return The address book title and all known people and groups in that address book
     */
    readAddressBook(uri: string): Promise<AddressBook>;
    /**
     * Creates a new contact within a given address book
     * @param command
     * @return The URI of the newly created contact
     */
    createNewContact({ addressBookUri, contact, }: CreateNewContactCommand): Promise<string>;
    /**
     * Fetches the given contact and returns available information
     * @param uri - The URI of the contact to read
     * @return FullContact name, email addresses and phone numbers
     */
    readContact(uri: string): Promise<FullContact>;
    /**
     * Changes the name of the given contact to a new value
     * @param command
     */
    renameContact(command: RenameContactCommand): Promise<void>;
    /**
     * Creates a new group within a given address book
     * @param command
     * @return The URI of the newly created group
     */
    createNewGroup({ addressBookUri, groupName, }: CreateNewGroupCommand): Promise<string>;
    /**
     * Fetches the given group and returns available information
     * @param uri - The URI of the contact to read
     * @return FullGroup name and list of group members
     */
    readGroup(uri: string): Promise<FullGroup>;
    /**
     * Adds an existing contact to an existing group
     * @param command
     */
    addContactToGroup(command: AddContactToGroupCommand): Promise<void>;
    /**
     * Removes an existing contact from an existing group
     * @param command
     */
    removeContactFromGroup(command: RemoveContactFromGroupCommand): Promise<void>;
    /**
     * Adds a new phone number to the given contact
     *
     * @param command
     * @return The URI of the newly created phone number resource
     */
    addNewPhoneNumber(command: AddNewPhoneNumberCommand): Promise<string>;
    /**
     * Adds a new email address to the given contact
     *
     * @param command
     * @return The URI of the newly created email address resource
     */
    addNewEmailAddress(command: AddNewEmailAddressCommand): Promise<string>;
    /**
     * Removes the given phone number from the given contact
     *
     * @param command
     */
    removePhoneNumber(command: RemovePhoneNumberCommand): Promise<void>;
    /**
     * Updates the given phone number to a new value
     *
     * @param command
     */
    updatePhoneNumber(command: UpdatePhoneNumberCommand): Promise<void>;
    /**
     * Updates the given email address to a new value
     *
     * @param command
     */
    updateEmailAddress(command: UpdateEmailAddressCommand): Promise<void>;
    /**
     * Removes the given email address from the given contact
     *
     * @param command
     */
    removeEmailAddress(command: RemoveEmailAddressCommand): Promise<void>;
}
/**
 * Data needed to create a new address book
 */
export interface CreateAddressBookCommand {
    /**
     * The URI of the target container
     */
    containerUri: string;
    /**
     * The human-readable title for the address book
     */
    name: string;
    /**
     * WebID of the Solid user who creates the address book.
     * If given, the private type index of that user will be updated to include the new address book.
     */
    ownerWebId?: string;
}
/**
 * Data needed to create a new contact within an address book
 */
export interface CreateNewContactCommand {
    /**
     * The URI of an existing address book the new contact should be added to
     */
    addressBookUri: string;
    /**
     * The data of the contact to create
     */
    contact: NewContact;
    /**
     * URIs of existing groups to add the contact to
     */
    groupUris?: string[];
}
/**
 * Data of a new contact to create
 */
export interface NewContact {
    name: string;
    email?: string;
    phoneNumber?: string;
}
/**
 * Index data of an address book
 */
export interface AddressBook {
    uri: string;
    title: string;
    contacts: Contact[];
    groups: Group[];
}
/**
 * Lists URIs of address book found in index documents
 */
export interface AddressBookLists {
    /**
     * URIs listed in the public type index
     */
    publicUris: string[];
    /**
     * URIS listed in the private type index. Stays empty if the index is not accessible.
     */
    privateUris: string[];
}
/**
 * Partial contact data listed when reading an address book or a group
 */
export interface Contact {
    /**
     * The URI identifying the contact
     */
    uri: string;
    /**
     * The human-readable name of the contact
     */
    name: string;
}
/**
 * Extensive contact data returned when reading a contact
 */
export interface FullContact {
    uri: string;
    name: string;
    emails: Email[];
    phoneNumbers: PhoneNumber[];
}
/**
 * E-mail address associated to a contact
 */
export interface Email {
    uri: string;
    value: string;
}
/**
 * Phone number associated to a contact
 */
export interface PhoneNumber {
    uri: string;
    value: string;
}
/**
 * Partial group data listed when reading an address book
 */
export interface Group {
    /**
     * The URI identifying the group
     */
    uri: string;
    /**
     * The human-readable name of the group
     */
    name: string;
}
/**
 * Extensive contact data returned when reading a contact
 */
export interface FullGroup {
    /**
     * The URI identifying the group
     */
    uri: string;
    /**
     * The human-readable name of the group
     */
    name: string;
    /**
     * List of group members
     */
    members: Contact[];
}
/**
 * Data needed to create a new group within an address book
 */
export interface CreateNewGroupCommand {
    /**
     * The URI of an existing address book the new group should be added to
     */
    addressBookUri: string;
    /**
     * The name of the group to create
     */
    groupName: string;
}
/**
 * Data needed to add an existing contact to an existing group
 */
export interface AddContactToGroupCommand {
    /**
     * The URI of an existing group, to that the contact should be added
     */
    contactUri: string;
    /**
     * The URI of an existing contact, that should be added to the group
     */
    groupUri: string;
}
/**
 * Data needed to remove an existing contact from an existing group
 */
export interface RemoveContactFromGroupCommand {
    /**
     * The URI of an existing group, from that the contact should be removed
     */
    contactUri: string;
    /**
     * The URI of an existing contact, that should be removed to the group
     */
    groupUri: string;
}
/**
 * Data needed to add a phone number to an existing contact
 */
export interface AddNewPhoneNumberCommand {
    /**
     * The URI of the contact
     */
    contactUri: string;
    /**
     * The phone number to add (RFC 3966 telephone-subscriber part format)
     */
    newPhoneNumber: string;
}
/**
 * Data needed to remove a phone number from an existing contact
 */
export interface RemovePhoneNumberCommand {
    /**
     * The URI of the contact
     */
    contactUri: string;
    /**
     *  The URI of the phone number resource to remove
     */
    phoneNumberUri: string;
}
/**
 * Data needed to remove an email address from an existing contact
 */
export interface AddNewEmailAddressCommand {
    /**
     * The URI of the contact
     */
    contactUri: string;
    /**
     * The email address to add
     */
    newEmailAddress: string;
}
/**
 * Data needed to remove an email address from an existing contact
 */
export interface RemoveEmailAddressCommand {
    /**
     * The URI of the contact
     */
    contactUri: string;
    /**
     * The URI of the email address resource to remove
     */
    emailAddressUri: string;
}
/**
 * Data needed to update an existing phone number
 */
export interface UpdatePhoneNumberCommand {
    /**
     * The URI of the phone number to update
     */
    phoneNumberUri: string;
    /**
     * The new phone number (RFC 3966 telephone-subscriber part format)
     */
    newPhoneNumber: string;
}
/**
 * Data needed to update an existing email address
 */
export interface UpdateEmailAddressCommand {
    /**
     * The URI of the email address to update
     */
    emailAddressUri: string;
    /**
     * The new email address
     */
    newEmailAddress: string;
}
/**
 * Data needed to rename a contact
 */
export interface RenameContactCommand {
    /**
     * The URI of the contact to rename
     */
    contactUri: string;
    /**
     * The new name
     */
    newName: string;
}