use actionable::{Action, Identifier, ResourceName};

use serde::{Deserialize, Serialize};

use crate::{

    document::KeyId,

    schema::{CollectionName, ViewName},

};

/// The base BonsaiDb resource namespace. All database objects have this as

/// their first name segment.

#[must_use]

/// Creates a resource name with the database `name`.

#[must_use]

/// Creates a resource name for a `collection` within a `database`.

#[must_use]

/// Creates a resource name for a document `id` within `collection` within `database`.

#[must_use]

/// Creaets a resource name for a `view` within `database`.

#[must_use]

/// Creates a resource name for `PubSub` `topic` within `database`.

#[must_use]

/// Creates a resource name for the key-value store in `database`.

#[must_use]

/// Creates a resource name for `key` within `namespace` within the key-value store of `database`.

#[must_use]

/// Creates a resource name for encryption key `key_id`.

#[must_use]

        })

/// Creates a resource name for `user_id`.

#[must_use]

/// Actions that can be permitted within BonsaiDb.

pub enum BonsaiAction {

    /// Actions that operate on a server

    Server(ServerAction),

    /// Actions that operate on a specific database.

    Database(DatabaseAction),

}

/// Actions that operate on a server.

pub enum ServerAction {

    /// Permits connecting to the server. Upon negotiating authentication, the

    /// effective permissions of the connected party will be checked for

    /// permissions to `Connect`. If not allowed, the connection will be

    /// terminated.

    Connect,

    /// Permits [`StorageConnection::list_available_schemas`](crate::connection::StorageConnection::list_available_schemas).

    ListAvailableSchemas,

    /// Permits [`StorageConnection::list_databases`](crate::connection::StorageConnection::list_databases).

    ListDatabases,

    /// Permits [`StorageConnection::create_database`](crate::connection::StorageConnection::create_database).

    CreateDatabase,

    /// Permits [`StorageConnection::delete_database`](crate::connection::StorageConnection::delete_database).

    DeleteDatabase,

    /// Permits [`StorageConnection::create_user`](crate::connection::StorageConnection::create_user).

    CreateUser,

    /// Permits [`StorageConnection::set_user_password`](crate::connection::StorageConnection::set_user_password).

    SetPassword,

    /// Permits the ability to log in with a password.

    Authenticate(AuthenticationMethod),

    /// Permits [`StorageConnection::add_permission_group_to_user`](crate::connection::StorageConnection::add_permission_group_to_user) and [`StorageConnection::remove_permission_group_from_user`](crate::connection::StorageConnection::remove_permission_group_from_user).

    ModifyUserPermissionGroups,

    /// Permits .

    /// Permits [`StorageConnection::add_role_to_user`](crate::connection::StorageConnection::add_role_to_user) and [`StorageConnection::remove_role_from_user`](crate::connection::StorageConnection::remove_role_from_user).

    ModifyUserRoles,

}

/// Methods for user authentication.

pub enum AuthenticationMethod {

    /// Authenticate the user using password hashing (Argon2).

    PasswordHash,

}

/// Actions that operate on a specific database.

pub enum DatabaseAction {

    /// The ability to compact data to reclaim space.

    Compact,

    /// Actions that operate on a document.

    Document(DocumentAction),

    /// Actions that operate on a view.

    View(ViewAction),

    /// Actions that operate on transactions.

    Transaction(TransactionAction),

    /// Actions that operate on the `PubSub` system.

    PubSub(PubSubAction),

    /// Actions that operate on the key-value store.

    KeyValue(KeyValueAction),

}

/// Actions that operate on a document.

pub enum DocumentAction {

    /// Allows document retrieval through

    /// [`Connection::get()`](crate::connection::Connection::get) and

    /// [`Connection::get_multiple()`](crate::connection::Connection::get_multiple).

    /// See [`document_resource_name()`] for the format of document resource

    /// names.

    Get,

    /// Allows listing documents through

    /// [`Connection::list()`](crate::connection::Connection::list). See

    /// [`collection_resource_name()`] for the format of collection resource

    /// names.

    List,

    /// Allows inserting a document through

    /// [`Connection::apply_transaction()`](crate::connection::Connection::apply_transaction).

    /// See [`collection_resource_name()`] for the format of collection resource

    /// names.

    Insert,

    /// Allows updating a document through

    /// [`Connection::apply_transaction()`](crate::connection::Connection::apply_transaction).

    /// See [`document_resource_name()`] for the format of document resource

    /// names.

    Update,

    /// Allows deleting a document through

    /// [`Connection::apply_transaction()`](crate::connection::Connection::apply_transaction).

    /// See [`document_resource_name()`] for the format of document resource

    /// names.

    Delete,

}

/// Actions that operate on a view.

pub enum ViewAction {

    /// Allows querying a view with

    /// [`Connection::query()`](crate::connection::Connection::query). See

    /// [`view_resource_name`] for the format of view resource names.

    Query,

    /// Allows reducing a view with

    /// [`Connection::reduce()`](crate::connection::Connection::reduce). See

    /// [`view_resource_name`] for the format of view resource names.

    Reduce,

    /// Allows deleting associated docs with

    /// [`Connection::delete_docs()`](crate::connection::Connection::delete_docs).

    /// See [`view_resource_name`] for the format of view resource names.

    DeleteDocs,

}

/// Actions that operate on transactions.

pub enum TransactionAction {

    /// Allows listing executed transactions with

    /// [`Connection::list_executed_transactions()`](crate::connection::Connection::list_executed_transactions).

    /// This action is checked against the database's resource name. See

    /// [`database_resource_name()`] for the format of database resource names.

    ListExecuted,

    /// Allows retrieving the last executed transaction id with

    /// [`Connection::last_transaction_id()`](crate::connection::Connection::last_transaction_id).

    /// This action is checked against the database's resource name. See

    /// [`database_resource_name()`] for the format of database resource names.

    GetLastId,

}

/// Actions that operate on the `PubSub` system.

pub enum PubSubAction {

    /// Allows creating a subscriber with

    /// [`PubSub::create_subscriber()`](crate::pubsub::PubSub::create_subscriber).

    /// This action is checked against the database's resource name. See

    /// [`database_resource_name()`] for the format of database resource names.

    CreateSuscriber,

    /// Allows publishing a payload to a `PubSub` topic with

    /// [`PubSub::publish()`](crate::pubsub::PubSub::publish). See

    /// [`pubsub_topic_resource_name()`] for the format of `PubSub` topic

    /// resource names.

    Publish,

    /// Allows subscribing to a `PubSub` topic with

    /// [`PubSub::subscribe_to()`](crate::pubsub::Subscriber::subscribe_to). See

    /// [`pubsub_topic_resource_name()`] for the format of `PubSub` topic

    /// resource names.

    SubscribeTo,

    /// Allows unsubscribing from a `PubSub` topic with

    /// [`PubSub::unsubscribe_from()`](crate::pubsub::Subscriber::unsubscribe_from). See

    /// [`pubsub_topic_resource_name()`] for the format of `PubSub` topic

    /// resource names.

    UnsubscribeFrom,

}

/// Actions that operate on the key-value store.

pub enum KeyValueAction {

    /// Allows executing a key-value store operation with

    /// [`KeyValue::execute_key_operation()`](crate::keyvalue::KeyValue::execute_key_operation).

    /// See [`keyvalue_key_resource_name()`] for the format of key resource names.

    ExecuteOperation,

}

/// Actions that use encryption keys.

pub enum EncryptionKeyAction {

    /// Uses a key to encrypt data.

    Encrypt,

    /// Uses a key to decrypt data.

    Decrypt,

}