Skip to content

Bring projects, wikis, and teams together with AI. AppFlowy is the AI collaborative workspace where you achieve more without losing control of your data. The leading open source Notion alternative.

17.1 KB
Raw Blame
use std::sync::Weak;

use strum_macros::Display;

use flowy_derive::{Flowy_Event, ProtoBuf_Enum};
use lib_dispatch::prelude::*;

use crate::event_handler::*;
use crate::manager::DatabaseManager;

pub fn init(database_manager: Weak<DatabaseManager>) -> AFPlugin {
  let plugin = AFPlugin::new()
    .name(env!("CARGO_PKG_NAME"))
    .state(database_manager);
  plugin
         .event(DatabaseEvent::GetDatabase, get_database_data_handler)
         .event(DatabaseEvent::GetDatabaseData, get_database_data_handler)
         .event(DatabaseEvent::GetDatabaseId, get_database_id_handler)
         .event(DatabaseEvent::GetDatabaseSetting, get_database_setting_handler)
         .event(DatabaseEvent::UpdateDatabaseSetting, update_database_setting_handler)
         .event(DatabaseEvent::GetAllFilters, get_all_filters_handler)
         .event(DatabaseEvent::GetAllSorts, get_all_sorts_handler)
         .event(DatabaseEvent::DeleteAllSorts, delete_all_sorts_handler)
         // Field
         .event(DatabaseEvent::GetFields, get_fields_handler)
         .event(DatabaseEvent::GetPrimaryField, get_primary_field_handler)
         .event(DatabaseEvent::UpdateField, update_field_handler)
         .event(DatabaseEvent::UpdateFieldTypeOption, update_field_type_option_handler)
         .event(DatabaseEvent::DeleteField, delete_field_handler)
         .event(DatabaseEvent::ClearField, clear_field_handler)
         .event(DatabaseEvent::UpdateFieldType, switch_to_field_handler)
         .event(DatabaseEvent::DuplicateField, duplicate_field_handler)
         .event(DatabaseEvent::MoveField, move_field_handler)
         .event(DatabaseEvent::CreateField, create_field_handler)
         // Row
         .event(DatabaseEvent::CreateRow, create_row_handler)
         .event(DatabaseEvent::GetRow, get_row_handler)
         .event(DatabaseEvent::InitRow, init_row_handler)
         .event(DatabaseEvent::GetRowMeta, get_row_meta_handler)
         .event(DatabaseEvent::UpdateRowMeta, update_row_meta_handler)
         .event(DatabaseEvent::DeleteRows, delete_rows_handler)
         .event(DatabaseEvent::DuplicateRow, duplicate_row_handler)
         .event(DatabaseEvent::MoveRow, move_row_handler)
         .event(DatabaseEvent::RemoveCover, remove_cover_handler)
         // Cell
         .event(DatabaseEvent::GetCell, get_cell_handler)
         .event(DatabaseEvent::UpdateCell, update_cell_handler)
         // SelectOption
         .event(DatabaseEvent::CreateSelectOption, new_select_option_handler)
         .event(DatabaseEvent::InsertOrUpdateSelectOption, insert_or_update_select_option_handler)
         .event(DatabaseEvent::DeleteSelectOption, delete_select_option_handler)
         .event(DatabaseEvent::UpdateSelectOptionCell, update_select_option_cell_handler)
         // Checklist
         .event(DatabaseEvent::UpdateChecklistCell, update_checklist_cell_handler)
         // Date
         .event(DatabaseEvent::UpdateDateCell, update_date_cell_handler)
         // Group
         .event(DatabaseEvent::SetGroupByField, set_group_by_field_handler)
         .event(DatabaseEvent::MoveGroup, move_group_handler)
         .event(DatabaseEvent::MoveGroupRow, move_group_row_handler)
         .event(DatabaseEvent::GetGroups, get_groups_handler)
         .event(DatabaseEvent::GetGroup, get_group_handler)
         .event(DatabaseEvent::UpdateGroup, update_group_handler)
         .event(DatabaseEvent::CreateGroup, create_group_handler)
         .event(DatabaseEvent::DeleteGroup, delete_group_handler)
         // Database
         .event(DatabaseEvent::GetDefaultDatabaseViewId, get_default_database_view_id_handler)
         .event(DatabaseEvent::GetDatabases, get_databases_handler)
         // Calendar
         .event(DatabaseEvent::GetAllCalendarEvents, get_calendar_events_handler)
         .event(DatabaseEvent::GetNoDateCalendarEvents, get_no_date_calendar_events_handler)
         .event(DatabaseEvent::GetCalendarEvent, get_calendar_event_handler)
         .event(DatabaseEvent::MoveCalendarEvent, move_calendar_event_handler)
         // Layout setting
         .event(DatabaseEvent::SetLayoutSetting, set_layout_setting_handler)
         .event(DatabaseEvent::GetLayoutSetting, get_layout_setting_handler)
         .event(DatabaseEvent::CreateDatabaseView, create_database_view)
         // Export
         .event(DatabaseEvent::ExportCSV, export_csv_handler)
         .event(DatabaseEvent::ExportRawDatabaseData, export_raw_database_data_handler)
         .event(DatabaseEvent::GetDatabaseSnapshots, get_snapshots_handler)
         // Field settings
         .event(DatabaseEvent::GetFieldSettings, get_field_settings_handler)
         .event(DatabaseEvent::GetAllFieldSettings, get_all_field_settings_handler)
         .event(DatabaseEvent::UpdateFieldSettings, update_field_settings_handler)
         // Calculations
         .event(DatabaseEvent::GetAllCalculations, get_all_calculations_handler)
         .event(DatabaseEvent::UpdateCalculation, update_calculation_handler)
         .event(DatabaseEvent::RemoveCalculation, remove_calculation_handler)
         // Relation
         .event(DatabaseEvent::GetRelatedDatabaseIds, get_related_database_ids_handler)
         .event(DatabaseEvent::UpdateRelationCell, update_relation_cell_handler)
         .event(DatabaseEvent::GetRelatedRowDatas, get_related_row_datas_handler)
         .event(DatabaseEvent::GetRelatedDatabaseRows, get_related_database_rows_handler)
         // AI
         .event(DatabaseEvent::SummarizeRow, summarize_row_handler)
         .event(DatabaseEvent::TranslateRow, translate_row_handler)
         // Media
         .event(DatabaseEvent::UpdateMediaCell, update_media_cell_handler)
         .event(DatabaseEvent::RenameMediaFile, rename_media_cell_file_handler)
         .event(DatabaseEvent::GetDatabaseCustomPrompts, get_database_custom_prompts_handler)
         .event(DatabaseEvent::TestCustomPromptDatabaseConfiguration, test_custom_prompt_database_configuration_handler)
}

/// [DatabaseEvent] defines events that are used to interact with the Grid. You could check [this](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/architecture/backend/protobuf)
/// out, it includes how to use these annotations: input, output, etc.
#[derive(Clone, Copy, PartialEq, Eq, Debug, Display, Hash, ProtoBuf_Enum, Flowy_Event)]
#[event_err = "FlowyError"]
pub enum DatabaseEvent {
  /// [GetDatabase] event is used to get the [DatabasePB]
  ///
  /// The event handler accepts a [DatabaseViewIdPB] and returns a [DatabasePB] if there are no errors.
  #[event(input = "DatabaseViewIdPB", output = "DatabasePB")]
  GetDatabase = 0,

  #[event(input = "DatabaseViewIdPB", output = "DatabaseIdPB")]
  GetDatabaseId = 1,

  /// [GetDatabaseSetting] event is used to get the database's settings.
  ///
  /// The event handler accepts [DatabaseViewIdPB] and return [DatabaseViewSettingPB]
  /// if there is no errors.
  #[event(input = "DatabaseViewIdPB", output = "DatabaseViewSettingPB")]
  GetDatabaseSetting = 2,

  /// [UpdateDatabaseSetting] event is used to update the database's settings.
  ///
  /// The event handler accepts [DatabaseSettingChangesetPB] and return errors if failed to modify the grid's settings.
  #[event(input = "DatabaseSettingChangesetPB")]
  UpdateDatabaseSetting = 3,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedFilterPB")]
  GetAllFilters = 4,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedSortPB")]
  GetAllSorts = 5,

  #[event(input = "DatabaseViewIdPB")]
  DeleteAllSorts = 6,

  #[event(input = "DatabaseViewIdPB")]
  GetDatabaseData = 7,

  /// [GetFields] event is used to get the database's fields.
  ///
  /// The event handler accepts a [GetFieldPayloadPB] and returns a [RepeatedFieldPB]
  /// if there are no errors.
  #[event(input = "GetFieldPayloadPB", output = "RepeatedFieldPB")]
  GetFields = 10,

  /// [UpdateField] event is used to update a field's attributes.
  ///
  /// The event handler accepts a [FieldChangesetPB] and returns errors if failed to modify the
  /// field.
  #[event(input = "FieldChangesetPB")]
  UpdateField = 11,

  /// [UpdateFieldTypeOption] event is used to update the field's type-option data. Certain field
  /// types have user-defined options such as color, date format, number format, or a list of values
  /// for a multi-select list. These options are defined within a specialization of the
  /// FieldTypeOption class.
  ///
  /// Check out [this](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/architecture/frontend/grid#fieldtype)
  /// for more information.
  ///
  /// The event handler accepts a [TypeOptionChangesetPB] and returns errors if failed to modify the
  /// field.
  #[event(input = "TypeOptionChangesetPB")]
  UpdateFieldTypeOption = 12,

  /// [DeleteField] event is used to delete a Field. [DeleteFieldPayloadPB] is the context that
  /// is used to delete the field from the Database.
  #[event(input = "DeleteFieldPayloadPB")]
  DeleteField = 14,

  /// [ClearField] event is used to clear all Cells in a Field. [ClearFieldPayloadPB] is the context that
  /// is used to clear the field from the Database.
  #[event(input = "ClearFieldPayloadPB")]
  ClearField = 15,

  /// [UpdateFieldType] event is used to update the current Field's type.
  /// It will insert a new FieldTypeOptionData if the new FieldType doesn't exist before, otherwise
  /// reuse the existing FieldTypeOptionData. You could check the [DatabaseRevisionPad] for more details.
  #[event(input = "UpdateFieldTypePayloadPB")]
  UpdateFieldType = 20,

  /// [DuplicateField] event is used to duplicate a Field. The duplicated field data is kind of
  /// deep copy of the target field. The passed in [DuplicateFieldPayloadPB] is the context that is
  /// used to duplicate the field.
  ///
  /// Return errors if failed to duplicate the field.
  ///
  #[event(input = "DuplicateFieldPayloadPB")]
  DuplicateField = 21,

  /// [MoveFieldPB] event is used to reorder a field in a view. The
  /// [MoveFieldPayloadPB] contains the `field_id` of the moved field and its
  /// new position.
  #[event(input = "MoveFieldPayloadPB")]
  MoveField = 22,

  /// [CreateField] event is used to create a new field with an optional
  /// TypeOptionData.
  #[event(input = "CreateFieldPayloadPB", output = "FieldPB")]
  CreateField = 24,

  #[event(input = "DatabaseViewIdPB", output = "FieldPB")]
  GetPrimaryField = 25,

  /// [CreateSelectOption] event is used to create a new select option. Returns a [SelectOptionPB] if
  /// there are no errors.
  #[event(input = "CreateSelectOptionPayloadPB", output = "SelectOptionPB")]
  CreateSelectOption = 30,

  /// [InsertOrUpdateSelectOption] event is used to update a FieldTypeOptionData whose field_type is
  /// FieldType::SingleSelect or FieldType::MultiSelect.
  ///
  /// This event may trigger the DatabaseNotification::DidUpdateCell event.
  /// For example, DatabaseNotification::DidUpdateCell will be triggered if the [SelectOptionChangesetPB]
  /// carries a change that updates the name of the option.
  #[event(input = "RepeatedSelectOptionPayload")]
  InsertOrUpdateSelectOption = 31,

  #[event(input = "RepeatedSelectOptionPayload")]
  DeleteSelectOption = 32,

  #[event(input = "CreateRowPayloadPB", output = "RowMetaPB")]
  CreateRow = 50,

  /// [GetRow] event is used to get the row data,[RowPB]. [OptionalRowPB] is a wrapper that enables
  /// to return a nullable row data.
  #[event(input = "DatabaseViewRowIdPB", output = "OptionalRowPB")]
  GetRow = 51,

  #[event(input = "RepeatedRowIdPB")]
  DeleteRows = 52,

  #[event(input = "DatabaseViewRowIdPB")]
  DuplicateRow = 53,

  #[event(input = "MoveRowPayloadPB")]
  MoveRow = 54,

  #[event(input = "DatabaseViewRowIdPB", output = "RowMetaPB")]
  GetRowMeta = 55,

  #[event(input = "UpdateRowMetaChangesetPB")]
  UpdateRowMeta = 56,

  #[event(input = "RemoveCoverPayloadPB")]
  RemoveCover = 57,

  #[event(input = "CellIdPB", output = "CellPB")]
  GetCell = 70,

  /// [UpdateCell] event is used to update the cell content. The passed in data, [CellChangesetPB],
  /// carries the changes that will be applied to the cell content by calling `update_cell` function.
  ///
  /// The 'content' property of the [CellChangesetPB] is a String type. It can be used directly if the
  /// cell uses string data. For example, the TextCell or NumberCell.
  ///
  /// But,it can be treated as a generic type, because we can use [serde] to deserialize the string
  /// into a specific data type. For the moment, the 'content' will be deserialized to a concrete type
  /// when the FieldType is SingleSelect, DateTime, and MultiSelect. Please see
  /// the [UpdateSelectOptionCell] and [UpdateDateCell] events for more details.
  #[event(input = "CellChangesetPB")]
  UpdateCell = 71,

  /// [UpdateSelectOptionCell] event is used to update a select option cell's data. [SelectOptionCellChangesetPB]
  /// contains options that will be deleted or inserted. It can be cast to [CellChangesetPB] that
  /// will be used by the `update_cell` function.
  #[event(input = "SelectOptionCellChangesetPB")]
  UpdateSelectOptionCell = 72,

  #[event(input = "ChecklistCellDataChangesetPB")]
  UpdateChecklistCell = 73,

  /// [UpdateDateCell] event is used to update a date cell's data. [DateCellChangesetPB]
  /// contains the date and the time string. It can be cast to [CellChangesetPB] that
  /// will be used by the `update_cell` function.
  #[event(input = "DateCellChangesetPB")]
  UpdateDateCell = 80,

  /// [SetGroupByField] event is used to create a new grouping in a database
  /// view based on the `field_id`
  #[event(input = "GroupByFieldPayloadPB")]
  SetGroupByField = 90,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedGroupPB")]
  GetGroups = 100,

  #[event(input = "DatabaseGroupIdPB", output = "GroupPB")]
  GetGroup = 101,

  #[event(input = "MoveGroupPayloadPB")]
  MoveGroup = 111,

  #[event(input = "MoveGroupRowPayloadPB")]
  MoveGroupRow = 112,

  #[event(input = "UpdateGroupPB")]
  UpdateGroup = 113,

  #[event(input = "CreateGroupPayloadPB")]
  CreateGroup = 114,

  #[event(input = "DeleteGroupPayloadPB")]
  DeleteGroup = 115,

  #[event(input = "DatabaseIdPB", output = "DatabaseViewIdPB")]
  GetDefaultDatabaseViewId = 119,

  /// Returns all the databases
  #[event(output = "RepeatedDatabaseDescriptionPB")]
  GetDatabases = 120,

  #[event(input = "LayoutSettingChangesetPB")]
  SetLayoutSetting = 121,

  #[event(input = "DatabaseLayoutMetaPB", output = "DatabaseLayoutSettingPB")]
  GetLayoutSetting = 122,

  #[event(input = "CalendarEventRequestPB", output = "RepeatedCalendarEventPB")]
  GetAllCalendarEvents = 123,

  #[event(
    input = "CalendarEventRequestPB",
    output = "RepeatedNoDateCalendarEventPB"
  )]
  GetNoDateCalendarEvents = 124,

  #[event(input = "DatabaseViewRowIdPB", output = "CalendarEventPB")]
  GetCalendarEvent = 125,

  #[event(input = "MoveCalendarEventPB")]
  MoveCalendarEvent = 126,

  #[event(input = "CreateDatabaseViewPayloadPB")]
  CreateDatabaseView = 130,

  #[event(input = "DatabaseViewIdPB", output = "DatabaseExportDataPB")]
  ExportCSV = 141,

  /// Returns all the snapshots of the database view.
  #[event(input = "DatabaseViewIdPB", output = "RepeatedDatabaseSnapshotPB")]
  GetDatabaseSnapshots = 150,

  /// Returns the field settings for the provided fields in the given view
  #[event(input = "FieldIdsPB", output = "RepeatedFieldSettingsPB")]
  GetFieldSettings = 160,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedFieldSettingsPB")]
  GetAllFieldSettings = 161,

  /// Updates the field settings for a field in the given view
  #[event(input = "FieldSettingsChangesetPB")]
  UpdateFieldSettings = 162,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedCalculationsPB")]
  GetAllCalculations = 163,

  #[event(input = "UpdateCalculationChangesetPB")]
  UpdateCalculation = 164,

  #[event(input = "RemoveCalculationChangesetPB")]
  RemoveCalculation = 165,

  /// Currently unused. Get a list of database ids that this database relates
  /// to.
  #[event(input = "DatabaseViewIdPB", output = "RepeatedDatabaseIdPB")]
  GetRelatedDatabaseIds = 170,

  /// Updates a relation cell, adding or removing links to rows in another
  /// database
  #[event(input = "RelationCellChangesetPB")]
  UpdateRelationCell = 171,

  /// Get the names of the linked rows in a relation cell.
  #[event(input = "GetRelatedRowDataPB", output = "RepeatedRelatedRowDataPB")]
  GetRelatedRowDatas = 172,

  /// Get the names of all the rows in a related database.
  #[event(input = "DatabaseIdPB", output = "RepeatedRelatedRowDataPB")]
  GetRelatedDatabaseRows = 173,

  #[event(input = "SummaryRowPB")]
  SummarizeRow = 174,

  #[event(input = "TranslateRowPB")]
  TranslateRow = 175,

  #[event(input = "DatabaseViewRowIdPB")]
  InitRow = 176,

  #[event(input = "DatabaseViewIdPB", output = "RepeatedRowMetaPB")]
  GetAllRows = 177,

  #[event(input = "DatabaseViewIdPB", output = "DatabaseExportDataPB")]
  ExportRawDatabaseData = 178,

  #[event(input = "MediaCellChangesetPB")]
  UpdateMediaCell = 200,

  #[event(input = "RenameMediaChangesetPB")]
  RenameMediaFile = 201,

  #[event(
    input = "CustomPromptDatabaseConfigPB",
    output = "RepeatedCustomPromptPB"
  )]
  GetDatabaseCustomPrompts = 500,

  #[event(input = "DatabaseViewIdPB", output = "CustomPromptDatabaseConfigPB")]
  TestCustomPromptDatabaseConfiguration = 501,
}