Skip to content

Architecture: CRM — Unified Conversations #702

Description

@curtisdelicata

Implementation epic

Deliver the Unified Conversations capability in the CRM application repository as an independently owned, testable module. The domain specification remains authoritative for business behavior; API, Filament 5, and Livewire 4 are one-to-one presentation packages and must not move business rules into presentation code.

Source specifications

Specification details

Domain

CRM: Unified Conversations

Canonical independent module specification

Domain module: crm-unified-conversations
Application: CRM
Capability group: Communications and contact-center modules
Source scope: CRM.md
Architecture: MODULES.md · TESTING.md · API.md · FILAMENT.md · LIVEWIRE.md

1. Purpose

The Unified Conversations module owns Omnichannel threads, participants, identity matching, assignments, collision detection, drafts, internal notes, attachments, delivery/read state, and timeline. It is the authoritative boundary for this capability and must remain independently installable, testable, versioned, enabled, and reusable across compatible Liberu applications.

2. Full feature scope

  • Omnichannel threads: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Participants: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Identity matching: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Assignments: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Collision detection: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Drafts: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Internal notes: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Attachments: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Delivery/read state: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.
  • Timeline: implement the complete lifecycle, validation, permissions, failure handling, audit evidence, and operator/user feedback required by this capability.

3. Ownership and boundaries

  • Own the capability's domain rules, policies, actions, queries, events, persistence, migrations, configuration, audit semantics, and failure recovery.
  • Expose stable contracts, immutable DTOs/read models, commands, queries, and past-tense domain events where other modules have a legitimate integration need.
  • Consume identity, organizations/teams, authorization, settings, files, notifications, queues, localization, currency, and observability from the shared foundation rather than duplicating them.
  • Never depend on an application's App\ classes, another module's private tables/models, a provider SDK in provider-neutral code, or an optional presentation framework.
  • Keep Filament, Livewire, and HTTP API logic in matching one-to-one presentation packages when those surfaces are required.

4. Implementation strategy

Domain model

  • Define aggregates, entities, value objects, enums, invariants, lifecycle states, and transition rules using the terminology in this specification.
  • Make invalid states unrepresentable where practical and enforce remaining invariants at every mutation boundary.
  • Use opaque stable identifiers and explicit actor, tenant, locale, timezone, and currency context where relevant.

API contract

CRM: Unified Conversations API

Canonical one-to-one API module specification

API package: module-crm-unified-conversations-api
Matching domain module: crm-unified-conversations
Application: CRM
Source feature: Unified Conversations
Architecture: API.md · MODULES.md · TESTING.md

1. Purpose and ownership

This optional API presentation package exposes approved HTTP operations for the Unified Conversations domain module. It presents exactly one independent module, delegates all authoritative behavior to that module's public actions/queries/policies, and contains no other module's API logic.

The domain capability includes:

  • Omnichannel threads
  • participants
  • identity matching
  • assignments
  • collision detection
  • drafts
  • internal notes
  • attachments
  • delivery/read state
  • timeline

Installation does not expose every capability automatically. The host application selects this package, API version, audiences, route groups, and operations in its API manifest.

2. Contract design

Filament surface

CRM: Unified Conversations Filament

Canonical one-to-one Filament 5 implementation

Filament package: module-crm-unified-conversations-filament
Matching domain module: crm-unified-conversations
Application: CRM
Source feature: Unified Conversations
Architecture: FILAMENT.md · MODULES.md · TESTING.md

1. Purpose and ownership

This optional Filament 5 presentation package presents exactly one independent domain module. It contributes reusable resources, pages, widgets, schemas, tables, infolists, and actions to application-owned panels while delegating authorization, validation, tenancy, persistence, and business rules to the crm-unified-conversations public boundary. It must not contain another module's UI or depend on application App\ classes.

2. Module-specific surfaces

  • Omnichannel threads: resource/table/form/action or page behavior for this module's authorized workflow.
  • Participants: resource/table/form/action or page behavior for this module's authorized workflow.
  • Identity matching: resource/table/form/action or page behavior for this module's authorized workflow.
  • Assignments: resource/table/form/action or page behavior for this module's authorized workflow.
  • Collision detection: resource/table/form/action or page behavior for this module's authorized workflow.
  • Drafts: resource/table/form/action or page behavior for this module's authorized workflow.
  • Internal notes: resource/table/form/action or page behavior for this module's authorized workflow.
  • Attachments: resource/table/form/action or page behavior for this module's authorized workflow.
  • Delivery/read state: resource/table/form/action or page behavior for this module's authorized workflow.
  • Timeline: resource/table/form/action or page behavior for this module's authorized workflow.

3. Filament 5 implementation

  • Register a stable module-crm-unified-conversations-filament plugin and discover only classes in this package's namespace; applications attach it explicitly to each eligible panel.

Livewire surface

CRM: Unified Conversations Livewire

Canonical one-to-one Livewire 4 implementation

Livewire package: module-crm-unified-conversations-livewire
Matching domain module: crm-unified-conversations
Application: CRM
Source feature: Unified Conversations
Architecture: LIVEWIRE.md · MODULES.md · TESTING.md

1. Purpose and ownership

This optional Livewire 4 presentation package provides interactive server-driven components for exactly one independent domain module. Components coordinate public queries/actions and presentation state; they do not own persistence, authorization decisions, tenancy, business rules, or theme identity. The package has no dependency on application App\ classes or another module's internals.

2. Module-specific interactions

  • Omnichannel threads: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Participants: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Identity matching: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Assignments: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Collision detection: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Drafts: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Internal notes: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Attachments: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Delivery/read state: interactive component state, validation feedback, loading, and failure recovery for this domain capability.
  • Timeline: interactive component state, validation feedback, loading, and failure recovery for this domain capability.

3. Livewire 4 implementation

  • Register a stable module-crm-unified-conversations-livewire component namespace and service provider; use explicit aliases such as <livewire:module-crm-unified-conversations::component-name /> according to LIVEWIRE.md.

Acceptance criteria

  • Domain ownership, boundaries, data lifecycle, permissions, tenancy, events, failure recovery, telemetry, and migrations match the domain specification.
  • API routes/operations/events, versioning, authentication, authorization scopes, validation, idempotency, errors, pagination, rate limits, and observability match the API specification.
  • Filament package identity, panel/resource/page/widget inventory, authorization, tenancy, navigation, theme integration, accessibility, and cache/discovery behavior match the Filament specification.
  • Livewire package identity, aliases, component inventory, state/actions/events, loading/failure states, authorization, tenancy, accessibility, and lifecycle behavior match the Livewire specification.
  • Unit, feature, contract, architecture, security, compatibility, migration/upgrade, and presentation tests cover allowed, denied, invalid, duplicate, concurrent, wrong-tenant, partial-failure, and recovery paths as applicable.
  • README, changelog, runbook, API/presentation documentation, release notes, and adoption/upgrade guidance are complete.

Explicit exclusions

Do not implement unrelated independent modules, application App namespace coupling inside reusable packages, private cross-module table/model access, provider SDK leakage into provider-neutral code, or business authorization solely in UI/API presentation layers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions