Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.
TypeScript agentaiai-agentsall-in-onecrmcrm-systememaillinearmcpmessagingnotesnotionofficerustslackslack-alternativestartupstartup-toolstypescriptworkspace
//! Domain-owned project models.
use macro_user_id::user_id::MacroUserIdStr;
use model::folder::FileSystemNode;
use model::project::Project;
use model_entity::{Entity, EntityType};
use model_owner::Owner;
use models_permissions::share_permission::team_share::AuthorizedTeamShareCommand;
use models_permissions::share_permission::{SharePermissionV2, UpdateSharePermissionRequestV2};
/// Arguments for atomically creating a project and its access metadata.
#[derive(Debug, Clone)]
pub struct CreateProjectArgs {
/// Recorded project owner.
pub owner: Owner,
/// Project name.
pub name: String,
/// Optional parent project.
pub parent_id: Option<String>,
/// Initial sharing configuration.
pub share_permission: SharePermissionV2,
/// Last-edit timestamp; `None` takes now.
pub updated_at: Option<chrono::DateTime<chrono::Utc>>,
}
/// Arguments for editing a project.
#[derive(Debug, Clone)]
pub struct EditProjectArgs {
/// Project identifier.
pub project_id: String,
/// Replacement name, or `None` to leave it unchanged.
pub name: Option<String>,
/// Whether the parent field is part of the update.
pub update_parent: bool,
/// Replacement parent. `None` clears it when `update_parent` is true.
pub parent_id: Option<String>,
/// Optional sharing changes.
pub share_permission: Option<UpdateSharePermissionRequestV2>,
/// Owner-authorized command for an explicit `teamShareAccessLevel`; the
/// repository applies it atomically with the rest of the edit and rejects
/// a team level that arrives without one.
pub team_share: Option<AuthorizedTeamShareCommand>,
}
/// Identifiers affected by a recursive soft deletion.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SoftDeleteResult {
/// Deleted projects, including the requested root.
pub project_ids: Vec<String>,
/// Deleted documents.
pub document_ids: Vec<String>,
/// Deleted chats.
pub chat_ids: Vec<String>,
}
/// Result of restoring a recursively deleted project tree.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RevertDeleteResult {
/// Restored project identifiers.
pub project_ids: Vec<String>,
/// Restored document identifiers.
pub document_ids: Vec<String>,
/// Restored chat identifiers.
pub chat_ids: Vec<String>,
}
/// Data returned after permanently purging a soft-deleted project tree.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PurgedProjectTree {
/// Purged project identifiers, including the requested root.
pub project_ids: Vec<String>,
/// Purged chat identifiers.
pub chat_ids: Vec<String>,
/// Purged document identifiers paired with their owner identifiers.
pub documents: Vec<(String, String)>,
/// Aggregated BOM part counts grouped by SHA.
pub bom_shas: Vec<(String, i64)>,
}
/// Metadata for a project tree finalized after upload.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MarkedUploadedTree {
/// Root project identifier.
pub id: String,
/// Root project name.
pub name: String,
/// Root project owner.
pub user_id: MacroUserIdStr<'static>,
/// Optional parent of the root project.
pub parent_id: Option<String>,
/// Finalized project identifiers, including the root and all descendants.
pub project_ids: Vec<String>,
/// Whether the root project's upload-pending state transitioned to finalized.
pub upload_pending_transitioned: bool,
}
/// Arguments for creating a pending project tree for a folder upload.
#[derive(Debug)]
pub struct UploadFolderRepoArgs {
/// Owner of every project and document in the tree.
pub user_id: MacroUserIdStr<'static>,
/// Initial sharing configuration for every created item.
pub share_permission: SharePermissionV2,
/// Root folder contents to persist.
pub root_folder: FileSystemNode,
/// Name of the root project.
pub root_folder_name: String,
/// Lambda-facing bulk-upload request identifier.
pub upload_request_id: String,
/// Optional parent for the root project.
pub parent_id: Option<String>,
}
/// A live folder below the root of a [`ProjectTree`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProjectTreeFolder {
/// Folder identifier.
pub id: String,
/// Containing folder: the tree's root or another of its folders.
pub parent_id: String,
/// Folder name.
pub name: String,
}
/// The kinds of item a project tree holds besides folders.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ProjectItemKind {
/// A document, tasks included.
Document,
/// A chat.
Chat,
}
/// A live document or chat filed in a [`ProjectTree`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ProjectTreeItem {
/// Whether the item is a document or a chat.
pub kind: ProjectItemKind,
/// Item identifier.
pub id: String,
/// Containing folder: the tree's root or one of its folders.
pub project_id: String,
/// Display name.
pub name: String,
}
impl ProjectTreeItem {
/// The item as an entity reference.
pub fn entity(&self) -> Entity<'static> {
let entity_type = match self.kind {
ProjectItemKind::Document => EntityType::Document,
ProjectItemKind::Chat => EntityType::Chat,
};
entity_type.with_entity_string(self.id.clone())
}
}
/// The live folders, documents, and chats below a project.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ProjectTree {
/// Folders below the root, every parent before its children.
pub folders: Vec<ProjectTreeFolder>,
/// Documents and chats filed in the root or one of its folders.
pub items: Vec<ProjectTreeItem>,
}
/// Result returned by project creation and editing.
pub type MutatedProject = Project;
/// Errors produced by project operations.
#[derive(Debug, thiserror::Error)]
pub enum ProjectError {
/// The requested project was not found.
#[error("project not found: {0}")]
NotFound(String),
/// The caller is not authorized to perform the operation.
#[error("unauthorized")]
Unauthorized,
/// The caller is not authorized, with a client-facing explanation.
#[error("{0}")]
UnauthorizedWithMessage(String),
/// The request is invalid.
#[error("bad request: {0}")]
BadRequest(String),
/// The provided project name exceeds the maximum length.
#[error("name too long")]
NameTooLong {
/// Maximum allowed name length, in grapheme clusters.
max: usize,
},
/// A soft-deleted project cannot be modified.
#[error("cannot modify deleted project")]
CannotModifyDeleted,
/// The requested change conflicts with the persisted state (for example a
/// stale team-share revision); the caller should reload and retry.
#[error("conflict: {0}")]
Conflict(String),
/// The requested parent would recursively nest the project.
#[error("project is recursively nested")]
RecursiveNesting,
/// An internal operation failed.
#[error("{0}")]
Internal(#[from] anyhow::Error),
}