github/OpenArchiver
1
1
Fork 0
mirror of https://github.com/LogicLabs-OU/OpenArchiver.git synced 2026-04-06 00:31:57 +02:00
Code Issues 161 Packages Projects Releases Wiki Activity

Legal hold + retention label

Browse Source
This commit is contained in:
wayneshn
2026-03-12 22:29:16 +01:00
parent 81b87b4b7e
commit 0c2bcd8f28
29 changed files with 5495 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

454
docs/enterprise/legal-holds/api.md Normal file
View File

@@ -0,0 +1,454 @@
# Legal Holds: API Endpoints
The legal holds feature exposes a RESTful API for managing holds and linking them to archived emails. All endpoints require authentication and appropriate permissions as specified below.
**Base URL:** `/api/v1/enterprise/legal-holds`
All endpoints also require the `LEGAL_HOLDS` feature to be enabled in the enterprise license.
---
## Hold Management Endpoints
### List All Holds
Retrieves all legal holds ordered by creation date ascending, each annotated with the count of currently linked emails.
- **Endpoint:** `GET /holds`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Response Body
```json
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Project Titan Litigation — 2026",
"reason": "Preservation order received 2026-01-15 re: IP dispute",
"isActive": true,
"caseId": null,
"emailCount": 4821,
"createdAt": "2026-01-15T10:30:00.000Z",
"updatedAt": "2026-01-15T10:30:00.000Z"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "SEC Investigation Q3 2025",
"reason": null,
"isActive": false,
"caseId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"emailCount": 310,
"createdAt": "2025-09-01T08:00:00.000Z",
"updatedAt": "2025-11-20T16:45:00.000Z"
}
]
```
---
### Get Hold by ID
Retrieves a single legal hold by its UUID.
- **Endpoint:** `GET /holds/:id`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ----------------------------- |
| `id` | `uuid` | The UUID of the hold to get. |
#### Response
Returns a single hold object (same shape as the list endpoint), or `404` if not found.
---
### Create Hold
Creates a new legal hold. Holds are always created in the **active** state.
- **Endpoint:** `POST /holds`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Request Body
| Field | Type | Required | Description |
| -------- | -------- | -------- | ----------------------------------------------------------- |
| `name` | `string` | Yes | Unique hold name. Max 255 characters. |
| `reason` | `string` | No | Legal basis or description for the hold. Max 2 000 characters. |
| `caseId` | `uuid` | No | Optional UUID of an `ediscovery_cases` record to link to. |
#### Example Request
```json
{
"name": "Project Titan Litigation — 2026",
"reason": "Preservation notice received from outside counsel on 2026-01-15 regarding IP dispute with ExCorp.",
"caseId": null
}
```
#### Response
- **`201 Created`** — Returns the created hold object with `emailCount: 0`.
- **`409 Conflict`** — A hold with this name already exists.
- **`422 Unprocessable Entity`** — Validation errors.
---
### Update Hold
Updates the name, reason, or `isActive` state of a hold. Only the fields provided in the request body are modified.
- **Endpoint:** `PUT /holds/:id`
- **Method:** `PUT`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | -------------------------------- |
| `id` | `uuid` | The UUID of the hold to update. |
#### Request Body
All fields are optional. At least one must be provided.
| Field | Type | Description |
| ---------- | --------- | -------------------------------------------------- |
| `name` | `string` | New hold name. Max 255 characters. |
| `reason` | `string` | Updated reason/description. Max 2 000 characters. |
| `isActive` | `boolean` | Set to `false` to deactivate, `true` to reactivate. |
#### Example — Deactivate a Hold
```json
{
"isActive": false
}
```
#### Response
- **`200 OK`** — Returns the updated hold object.
- **`404 Not Found`** — Hold with the given ID does not exist.
- **`422 Unprocessable Entity`** — Validation errors.
> **Important:** Setting `isActive` to `false` immediately lifts deletion immunity from all emails solely protected by this hold. The next lifecycle worker cycle will evaluate those emails against retention labels and policies.
---
### Delete Hold
Permanently deletes a legal hold and (via database CASCADE) all associated `email_legal_holds` rows.
- **Endpoint:** `DELETE /holds/:id`
- **Method:** `DELETE`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | -------------------------------- |
| `id` | `uuid` | The UUID of the hold to delete. |
#### Response
- **`204 No Content`** — Hold successfully deleted.
- **`404 Not Found`** — Hold with the given ID does not exist.
- **`409 Conflict`** — The hold is currently active. Deactivate it first by calling `PUT /holds/:id` with `{ "isActive": false }`.
> **Security note:** Active holds cannot be deleted. This requirement forces an explicit, auditable deactivation step before the hold record is removed.
---
## Bulk Operations
### Bulk Apply Hold via Search Query
Applies a legal hold to **all emails matching a Meilisearch query**. The operation is asynchronous-safe: the UI fires the request and the server processes results in pages of 1 000, so even very large result sets do not time out.
- **Endpoint:** `POST /holds/:id/bulk-apply`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ----------------------------------- |
| `id` | `uuid` | The UUID of the hold to apply. |
#### Request Body
| Field | Type | Required | Description |
| ------------- | -------- | -------- | ------------------------------------------------------------------- |
| `searchQuery` | `object` | Yes | A Meilisearch query object (see structure below). |
##### `searchQuery` Object
| Field | Type | Required | Description |
| ------------------ | -------- | -------- | ------------------------------------------------------------------ |
| `query` | `string` | Yes | Full-text search string. Pass `""` to match all documents. |
| `filters` | `object` | No | Key-value filter object (e.g., `{ "from": "user@corp.com" }`). |
| `matchingStrategy` | `string` | No | Meilisearch matching strategy: `"last"`, `"all"`, or `"frequency"`. |
#### Example Request
```json
{
"searchQuery": {
"query": "Project Titan confidential",
"filters": {
"from": "john.doe@acme.com",
"startDate": "2023-01-01",
"endDate": "2025-12-31"
},
"matchingStrategy": "all"
}
}
```
#### Response Body
```json
{
"legalHoldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"emailsLinked": 1247,
"queryUsed": {
"query": "Project Titan confidential",
"filters": {
"from": "john.doe@acme.com",
"startDate": "2023-01-01",
"endDate": "2025-12-31"
},
"matchingStrategy": "all"
}
}
```
- `emailsLinked` — The number of emails **newly** linked to the hold by this operation. Emails already linked to this hold are not counted.
- `queryUsed` — The exact query JSON that was executed, mirroring what was written to the audit log for GoBD proof of scope.
#### Response Codes
- **`200 OK`** — Operation completed. Returns `emailsLinked: 0` if no new emails matched.
- **`404 Not Found`** — Hold with the given ID does not exist.
- **`409 Conflict`** — The hold is inactive. Only active holds can receive new email links.
- **`422 Unprocessable Entity`** — Invalid request body.
---
### Release All Emails from Hold
Removes all `email_legal_holds` associations for the given hold in a single operation. The hold itself is **not** deleted.
- **Endpoint:** `POST /holds/:id/release-all`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------ |
| `id` | `uuid` | The UUID of the hold to release. |
#### Response Body
```json
{
"emailsReleased": 4821
}
```
#### Response Codes
- **`200 OK`** — All email associations removed. Returns `emailsReleased: 0` if the hold had no linked emails.
- **`500 Internal Server Error`** — The hold ID was not found or a database error occurred.
> **Warning:** After release, emails that were solely protected by this hold will be evaluated normally on the next lifecycle worker cycle. Emails with expired retention periods will be deleted.
---
## Per-Email Hold Endpoints
### Get Holds Applied to an Email
Returns all legal holds currently linked to a specific archived email, including both active and inactive holds.
- **Endpoint:** `GET /email/:emailId/holds`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `read:archive`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ---------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
#### Response Body
Returns an empty array `[]` if no holds are applied, or an array of hold-link objects:
```json
[
{
"legalHoldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"holdName": "Project Titan Litigation — 2026",
"isActive": true,
"appliedAt": "2026-01-15T11:00:00.000Z",
"appliedByUserId": "user-uuid-here"
},
{
"legalHoldId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"holdName": "SEC Investigation Q3 2025",
"isActive": false,
"appliedAt": "2025-09-05T09:15:00.000Z",
"appliedByUserId": null
}
]
```
#### Response Codes
- **`200 OK`** — Returns the array of hold-link objects (may be empty).
---
### Apply a Hold to a Specific Email
Links a single archived email to an active legal hold. The operation is idempotent — linking the same email to the same hold twice has no effect.
- **Endpoint:** `POST /email/:emailId/holds`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ---------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
#### Request Body
| Field | Type | Required | Description |
| -------- | ------ | -------- | ------------------------------------ |
| `holdId` | `uuid` | Yes | The UUID of the hold to apply. |
#### Example Request
```json
{
"holdId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
```
#### Response Body
Returns the hold-link object with the DB-authoritative `appliedAt` timestamp:
```json
{
"legalHoldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"holdName": "Project Titan Litigation — 2026",
"isActive": true,
"appliedAt": "2026-01-16T14:22:00.000Z",
"appliedByUserId": "user-uuid-here"
}
```
#### Response Codes
- **`200 OK`** — Hold successfully applied (or was already applied — idempotent).
- **`404 Not Found`** — Email or hold not found.
- **`409 Conflict`** — The hold is inactive and cannot be applied to new emails.
- **`422 Unprocessable Entity`** — Invalid request body.
---
### Remove a Hold from a Specific Email
Unlinks a specific legal hold from a specific archived email. The hold itself is not modified; other emails linked to the same hold are unaffected.
- **Endpoint:** `DELETE /email/:emailId/holds/:holdId`
- **Method:** `DELETE`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ---------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
| `holdId` | `uuid` | The UUID of the hold to remove. |
#### Response Body
```json
{
"message": "Hold removed from email successfully."
}
```
#### Response Codes
- **`200 OK`** — Hold link removed.
- **`404 Not Found`** — No such hold was applied to this email.
---
## Error Responses
All endpoints use the standard error response format:
```json
{
"status": "error",
"statusCode": 409,
"message": "Cannot delete an active legal hold. Deactivate it first to explicitly lift legal protection before deletion.",
"errors": null
}
```
For validation errors (`422 Unprocessable Entity`):
```json
{
"status": "error",
"statusCode": 422,
"message": "Invalid input provided.",
"errors": [
{
"field": "name",
"message": "Name is required."
}
]
}
```
---
## Validation Constraints
| Field | Constraint |
| -------------- | ----------------------------------------------- |
| Hold name | 1–255 characters. |
| Reason | Max 2 000 characters. |
| `caseId` | Must be a valid UUID if provided. |
| `holdId` | Must be a valid UUID. |
| `emailId` | Must be a valid UUID. |
| Search `query` | String (may be empty `""`). |
| `matchingStrategy` | One of `"last"`, `"all"`, `"frequency"`. |

157
docs/enterprise/legal-holds/guide.md Normal file
View File

@@ -0,0 +1,157 @@
# Legal Holds: User Interface Guide
The legal holds management interface is located at **Dashboard → Compliance → Legal Holds**. It provides a complete view of all configured holds and tools for creating, applying, releasing, and deactivating them. Per-email hold controls are also available on each archived email's detail page.
## Overview
Legal holds suspend all automated and manual deletion for specific emails, regardless of any retention labels or policies that might otherwise govern them. They are the highest-priority mechanism in the data lifecycle and are intended for use by compliance officers and legal counsel responding to litigation, investigations, or audit requests.
## Holds Table
The main page displays a table of all legal holds with the following columns:
- **Name:** The hold name and its UUID displayed underneath for reference.
- **Reason:** A short excerpt of the hold's reason/description. Shows _"No reason provided"_ if omitted.
- **Emails:** A badge showing how many archived emails are currently linked to this hold.
- **Status:** A badge indicating whether the hold is:
- **Active** (red badge): The hold is currently granting deletion immunity to linked emails.
- **Inactive** (gray badge): The hold is deactivated; linked emails are no longer immune.
- **Created At:** The date the hold was created, in local date format.
- **Actions:** Dropdown menu with options depending on the hold's state (see below).
The table is sorted by creation date in ascending order.
## Creating a Hold
Click the **"Create New"** button above the table to open the creation dialog. New holds are always created in the **Active** state.
### Form Fields
- **Name** (Required): A unique, descriptive name. Maximum 255 characters.
Examples: `"Project Titan Litigation — 2026"`, `"SEC Investigation Q3 2025"`
- **Reason** (Optional): A free-text description of the legal basis for the hold. Maximum 2 000 characters. This appears in the audit log and is visible to other compliance officers.
### After Creation
The hold immediately becomes active. No emails are linked to it yet — use Bulk Apply or the individual email detail page to add emails.
## Editing a Hold
Click **Edit** from the actions dropdown to modify the hold's name or reason. The `isActive` state is changed separately via the **Activate / Deactivate** action.
## Activating and Deactivating a Hold
The **Deactivate** / **Activate** option appears inline in the actions dropdown. Changing the active state does not remove any email links — it only determines whether those links grant deletion immunity.
> **Important:** Deactivating a hold means that all emails linked *solely* to this hold lose their deletion immunity immediately. If any such emails have an expired retention period, they will be permanently deleted on the very next lifecycle worker cycle.
## Deleting a Hold
A hold **cannot be deleted while it is active**. Attempting to delete an active hold returns a `409 Conflict` error with the message: _"Cannot delete an active legal hold. Deactivate it first..."_
To delete a hold:
1. **Deactivate** it first using the Activate/Deactivate action.
2. Click **Delete** from the actions dropdown.
3. Confirm in the dialog.
Deletion permanently removes the hold record and, via database CASCADE, all `email_legal_holds` link rows. The emails themselves are not deleted — they simply lose the protection that this hold was providing. Any other active holds on those emails continue to protect them.
## Bulk Apply
The **Bulk Apply** option (available only on active holds) opens a search dialog that lets you cast a preservation net across potentially thousands of emails in a single operation.
### Search Fields
- **Full-text query:** Keywords to match against email subject, body, and attachment content. This uses Meilisearch's full-text engine with typo tolerance.
- **From (sender):** Filter by sender email address.
- **Start date / End date:** Filter by the date range of the email's `sentAt` field.
At least one of these fields must be filled before the **Apply Hold** button becomes enabled.
### What Happens During Bulk Apply
1. The system pages through all Meilisearch results matching the query (1 000 hits per page).
2. Each hit's email ID is validated against the database to discard any stale index entries.
3. New hold links are inserted in batches of 500. Emails already linked to this hold are skipped (idempotent).
4. A success notification shows **how many emails were newly placed under the hold** (already-protected emails are not counted again).
5. The exact search query JSON is written to the audit log as GoBD proof of the scope of protection.
> **Warning:** Bulk Apply is a wide-net operation. Review your query carefully — there is no per-email confirmation step. Use the search page first to preview results before applying.
### Bulk Apply and the Audit Log
The audit log entry for a bulk apply contains:
- `action: "BulkApplyHold"`
- `searchQuery`: the exact JSON query used
- `emailsLinked`: number of emails newly linked
- `emailsAlreadyProtected`: number of emails that were already under this hold
## Release All Emails
The **Release All** option (available when the hold has at least one linked email) removes every `email_legal_holds` link for this hold in a single operation.
> **Warning:** This immediately lifts deletion immunity for all emails that were solely protected by this hold. Emails with expired retention periods will be deleted on the next lifecycle worker cycle.
A confirmation dialog is shown before the operation proceeds. On success, a notification reports how many email links were removed.
## Per-Email Hold Controls
### Viewing Holds on a Specific Email
On any archived email's detail page, the **Legal Holds** card lists all holds currently applied to that email, showing:
- Hold name and active/inactive badge
- Date the hold was applied
### Applying a Hold to a Specific Email
In the Legal Holds card, a dropdown lists all currently **active** holds. Select a hold and click **Apply**. The operation is idempotent — applying the same hold twice has no effect.
### Removing a Hold from a Specific Email
Each linked hold in the card has a **Remove** button. Clicking it removes only the link between this email and that specific hold. The hold itself remains and continues to protect other emails.
> **Note:** Removing the last active hold from an email means the email is no longer immune. If its retention period has expired, it will be deleted on the next lifecycle worker cycle.
### Delete Button Behaviour Under a Hold
The **Delete Email** button on the email detail page is not disabled in the UI, but the backend will reject the request if the email is under an active hold. An error toast is displayed: _"Deletion blocked by retention policy (Legal Hold or similar)."_
## Permissions Reference
| Operation | Required Permission |
| -------------------------------- | ------------------- |
| View holds table | `manage:all` |
| Create / edit / delete a hold | `manage:all` |
| Activate / deactivate a hold | `manage:all` |
| Bulk apply | `manage:all` |
| Release all emails from a hold | `manage:all` |
| View holds on a specific email | `read:archive` |
| Apply / remove a hold from email | `manage:all` |
## Workflow: Responding to a Litigation Notice
1. **Receive the litigation notice.** Identify the relevant custodians, date range, and keywords.
2. **Create a hold**: Navigate to Dashboard → Compliance → Legal Holds and click **Create New**. Name it descriptively (e.g., `"Doe v. Acme Corp — 2026"`). Add the legal matter reference as the reason.
3. **Bulk apply**: Click **Bulk Apply** on the new hold. Enter keywords, the custodian's email address in the **From** field, and the relevant date range. Submit.
4. **Verify**: Check the email count badge on the hold row. Review the audit log to confirm the search query was recorded.
5. **Individual additions**: If specific emails not captured by the bulk query need to be preserved, open each email's detail page and apply the hold manually.
6. **When the matter concludes**: Click **Deactivate** on the hold, then **Release All** to remove all email links, and finally **Delete** the hold record if desired.
## Troubleshooting
### Cannot Delete Hold — "Cannot delete an active legal hold"
**Cause:** The hold is still active.
**Solution:** Use the **Deactivate** option from the actions dropdown first.
### Bulk Apply Returns 0 Emails
**Cause 1:** The search query matched no documents in the Meilisearch index.
**Solution:** Verify the query in the main Search page to preview results before applying.
**Cause 2:** All Meilisearch results were stale (emails deleted from the archive before this operation).
**Solution:** This is a data state issue; the stale index entries will be cleaned up on the next index rebuild.
### Delete Email Returns an Error Instead of Deleting
**Cause:** The email is under one or more active legal holds.
**Solution:** This is expected behavior. Deactivate or remove the hold(s) from this email before deleting.
### Hold Emails Count Shows 0 After Bulk Apply
**Cause:** The `emailCount` field is fetched when the page loads. If the bulk operation was just completed, refresh the page to see the updated count.

125
docs/enterprise/legal-holds/index.md Normal file
View File

@@ -0,0 +1,125 @@
# Legal Holds
The Legal Holds feature is an enterprise-grade eDiscovery and compliance mechanism designed to prevent the spoliation (destruction) of evidence. It provides **absolute, unconditional immunity** from deletion for archived emails that are relevant to pending litigation, regulatory investigations, or audits.
## Core Principles
### 1. Absolute Immunity — Highest Precedence in the Lifecycle Pipeline
A legal hold is the final word on whether an email can be deleted. The [Lifecycle Worker](../retention-policy/lifecycle-worker.md) evaluates emails in a strict three-step precedence pipeline:
1. **Step 0 — Legal Hold** ← this feature
2. Step 1 — Retention Label
3. Step 2 — Retention Policy
If an email is linked to **at least one active** legal hold, the lifecycle worker immediately flags it as immune and stops evaluation. No retention label or policy can override this decision. The `RetentionHook` mechanism also blocks any **manual deletion** attempt from the UI — the backend will return an error before any `DELETE` SQL is issued.
### 2. Many-to-Many Relationship
A single email can be placed under multiple holds simultaneously (e.g., one hold for a litigation case and another for a regulatory investigation). The email remains immune as long as **any one** of those holds is active. Each hold-to-email link is recorded independently with its own `appliedAt` timestamp and actor attribution.
### 3. Active/Inactive State Management
Every hold has an `isActive` flag. When a legal matter concludes, the responsible officer deactivates the hold. The deactivation is instantaneous — on the very next lifecycle worker cycle, emails that were solely protected by that hold will be evaluated normally against retention labels and policies. If their retention period has already expired, they will be permanently deleted in that same cycle.
A hold **must be deactivated before it can be deleted**. This requirement forces an explicit, auditable act of lifting legal protection before the hold record can be removed from the system.
### 4. Bulk Preservation via Search Queries
The primary use case for legal holds is casting a wide preservation net quickly. The bulk-apply operation accepts a full Meilisearch query (full-text search + metadata filters such as sender, date range, etc.) and links every matching email to the hold in a single operation. The system pages through results in batches of 1 000 to handle datasets of any size without timing out the UI.
### 5. GoBD Audit Trail
Every action within the legal hold module — hold creation, modification, deactivation, deletion, email linkage, email removal, and bulk operations — is immutably recorded in the cryptographically chained `audit_logs` table. For bulk operations, the exact `SearchQuery` JSON used to cast the hold net is persisted in the audit log as proof of scope, satisfying GoBD and similar evidence-preservation requirements.
## Feature Requirements
The Legal Holds feature requires:
- An active **Enterprise license** with the `LEGAL_HOLDS` feature enabled.
- The `manage:all` permission for all hold management and bulk operations.
- The `read:archive` permission for viewing holds applied to a specific email.
- The `manage:all` permission for applying or removing a hold from an individual email.
## Use Cases
### Active Litigation Hold
Upon receiving a litigation notice, a compliance officer creates a hold named "Project Titan Litigation — 2026", applies it via a bulk query scoped to a specific custodian's emails and a date range, and immediately freezes those records. The audit log provides timestamped proof that the hold was in place from the moment of creation.
### Regulatory Investigation
A regulator requests preservation of all finance-related communications from a specific period. The officer creates a hold and uses a keyword + date-range bulk query to capture every relevant email in seconds, regardless of which users sent or received them.
### Tax Audit
Before an annual audit window, an officer applies a hold to all emails matching tax-relevant keywords. The hold is released once the audit concludes, and standard retention policies resume.
### eDiscovery Case Management
Holds can optionally be linked to an `ediscovery_cases` record (`caseId` field) to organise multiple holds under a single legal matter. This allows all holds, emails, and audit events for a case to be referenced together.
## Architecture Overview
| Component | Location | Description |
| --------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------- |
| Types | `packages/types/src/retention.types.ts` | `LegalHold`, `EmailLegalHoldInfo`, `BulkApplyHoldResult` types |
| Database Schema | `packages/backend/src/database/schema/compliance.ts` | `legal_holds` and `email_legal_holds` table definitions |
| Service | `packages/enterprise/src/modules/legal-holds/LegalHoldService.ts` | All business logic for CRUD, linkage, and bulk operations |
| Controller | `packages/enterprise/src/modules/legal-holds/legal-hold.controller.ts` | Express request handlers with Zod validation |
| Routes | `packages/enterprise/src/modules/legal-holds/legal-hold.routes.ts` | Route registration with auth and feature guards |
| Module | `packages/enterprise/src/modules/legal-holds/legal-hold.module.ts` | App-startup integration and `RetentionHook` registration |
| Frontend Page | `packages/frontend/src/routes/dashboard/compliance/legal-holds/` | SvelteKit management page for holds |
| Email Detail | `packages/frontend/src/routes/dashboard/archived-emails/[id]/` | Per-email hold card in the email detail view |
| Lifecycle Guard | `packages/backend/src/hooks/RetentionHook.ts` | Static hook that blocks deletion if a hold is active |
## Data Model
### `legal_holds` Table
| Column | Type | Description |
| ------------ | -------------- | --------------------------------------------------------------------------- |
| `id` | `uuid` (PK) | Auto-generated unique identifier. |
| `name` | `varchar(255)` | Human-readable hold name. |
| `reason` | `text` | Optional description of why the hold was placed. |
| `is_active` | `boolean` | Whether the hold currently grants immunity. Defaults to `true` on creation. |
| `case_id` | `uuid` (FK) | Optional reference to an `ediscovery_cases` row. |
| `created_at` | `timestamptz` | Hold creation timestamp. |
| `updated_at` | `timestamptz` | Last modification timestamp. |
### `email_legal_holds` Join Table
| Column | Type | Description |
| --------------------- | ------------- | --------------------------------------------------------------- |
| `email_id` | `uuid` (FK) | Reference to `archived_emails.id`. Cascades on delete. |
| `legal_hold_id` | `uuid` (FK) | Reference to `legal_holds.id`. Cascades on delete. |
| `applied_at` | `timestamptz` | DB-server timestamp of when the link was created. |
| `applied_by_user_id` | `uuid` (FK) | User who applied the hold (nullable for system operations). |
The table uses a composite primary key of `(email_id, legal_hold_id)`, enforcing uniqueness at the database level. Duplicate inserts use `ON CONFLICT DO NOTHING` for idempotency.
## Integration Points
### RetentionHook (Deletion Guard)
`LegalHoldModule.initialize()` registers an async check with `RetentionHook` at application startup. `ArchivedEmailService.deleteArchivedEmail()` calls `RetentionHook.canDelete(emailId)` before any storage or database DELETE. If the email is under an active hold, the hook returns `false` and deletion is aborted with a `400 Bad Request` error. This guard is fail-safe: if the hook itself throws an error, deletion is also blocked.
### Lifecycle Worker
The lifecycle worker calls `legalHoldService.isEmailUnderActiveHold(emailId)` as the first step in its per-email evaluation loop. Immune emails are skipped immediately with a `debug`-level log entry; no further evaluation occurs.
### Audit Log
All legal hold operations generate entries in `audit_logs`:
| Action | `actionType` | `targetType` | `targetId` |
| -------------------------------- | ------------ | --------------- | ----------------- |
| Hold created | `CREATE` | `LegalHold` | hold ID |
| Hold updated / deactivated | `UPDATE` | `LegalHold` | hold ID |
| Hold deleted | `DELETE` | `LegalHold` | hold ID |
| Email linked to hold (individual)| `UPDATE` | `ArchivedEmail` | email ID |
| Email unlinked from hold | `UPDATE` | `ArchivedEmail` | email ID |
| Bulk apply via search | `UPDATE` | `LegalHold` | hold ID + query JSON |
| All emails released from hold | `UPDATE` | `LegalHold` | hold ID |
Individual email link/unlink events target `ArchivedEmail` so that a per-email audit search surfaces the complete hold history for that email.

360
docs/enterprise/retention-labels/api.md Normal file
View File

@@ -0,0 +1,360 @@
# Retention Labels: API Endpoints
The retention labels feature exposes a RESTful API for managing retention labels and applying them to individual archived emails. All endpoints require authentication and appropriate permissions as specified below.
**Base URL:** `/api/v1/enterprise/retention-policy`
All endpoints also require the `RETENTION_POLICY` feature to be enabled in the enterprise license.
---
## Label Management Endpoints
### List All Labels
Retrieves all retention labels, ordered by creation date ascending.
- **Endpoint:** `GET /labels`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Response Body
```json
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Legal Hold - Litigation ABC",
"description": "Extended retention for emails related to litigation ABC vs Company",
"retentionPeriodDays": 2555,
"isDisabled": false,
"createdAt": "2025-10-01T00:00:00.000Z"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "Executive Communications",
"description": null,
"retentionPeriodDays": 3650,
"isDisabled": true,
"createdAt": "2025-09-15T12:30:00.000Z"
}
]
```
---
### Get Label by ID
Retrieves a single retention label by its UUID.
- **Endpoint:** `GET /labels/:id`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------ |
| `id` | `uuid` | The UUID of the label to get. |
#### Response Body
Returns a single label object (same shape as the list endpoint), or `404` if not found.
---
### Create Label
Creates a new retention label. The label name must be unique across the system.
- **Endpoint:** `POST /labels`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Request Body
| Field | Type | Required | Description |
| -------------------- | --------- | -------- | -------------------------------------------------------------- |
| `name` | `string` | Yes | Unique label name. Max 255 characters. |
| `description` | `string` | No | Human-readable description. Max 1000 characters. |
| `retentionPeriodDays` | `integer` | Yes | Number of days to retain emails with this label. Minimum 1. |
#### Example Request
```json
{
"name": "Financial Records - Q4 2025",
"description": "Extended retention for Q4 2025 financial correspondence per regulatory requirements",
"retentionPeriodDays": 2555
}
```
#### Response
- **`201 Created`** — Returns the created label object.
- **`409 Conflict`** — A label with this name already exists.
- **`422 Unprocessable Entity`** — Validation errors.
---
### Update Label
Updates an existing retention label. Only the fields included in the request body are modified.
- **Endpoint:** `PUT /labels/:id`
- **Method:** `PUT`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | --------------------------------- |
| `id` | `uuid` | The UUID of the label to update. |
#### Request Body
All fields from the create endpoint are accepted, and all are optional. Only provided fields are updated.
**Important:** The `retentionPeriodDays` field cannot be modified if the label is currently applied to any emails. Attempting to do so will return a `409 Conflict` error.
#### Example Request
```json
{
"name": "Financial Records - Q4 2025 (Updated)",
"description": "Updated description for Q4 2025 financial records retention"
}
```
#### Response
- **`200 OK`** — Returns the updated label object.
- **`404 Not Found`** — Label with the given ID does not exist.
- **`409 Conflict`** — Attempted to modify retention period while label is applied to emails.
- **`422 Unprocessable Entity`** — Validation errors.
---
### Delete Label
Deletes or disables a retention label depending on its usage status.
- **Endpoint:** `DELETE /labels/:id`
- **Method:** `DELETE`
- **Authentication:** Required
- **Permission:** `manage:all`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | --------------------------------- |
| `id` | `uuid` | The UUID of the label to delete. |
#### Deletion Logic
- **Hard Delete**: If the label has never been applied to any emails, it is permanently removed.
- **Soft Disable**: If the label is currently applied to one or more emails, it is marked as `isDisabled = true` instead of being deleted. This preserves the retention clock for tagged emails while preventing new applications.
#### Response Body
```json
{
"action": "deleted"
}
```
or
```json
{
"action": "disabled"
}
```
#### Response Codes
- **`200 OK`** — Label successfully deleted or disabled. Check the `action` field in the response body.
- **`404 Not Found`** — Label with the given ID does not exist.
---
## Email Label Endpoints
### Get Email's Label
Retrieves the retention label currently applied to a specific archived email.
- **Endpoint:** `GET /email/:emailId/label`
- **Method:** `GET`
- **Authentication:** Required
- **Permission:** `read:archive`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
#### Response Body
Returns `null` if no label is applied:
```json
null
```
Or the label information if a label is applied:
```json
{
"labelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"labelName": "Legal Hold - Litigation ABC",
"retentionPeriodDays": 2555,
"appliedAt": "2025-10-15T14:30:00.000Z",
"appliedByUserId": "user123"
}
```
#### Response Codes
- **`200 OK`** — Returns label information or `null`.
- **`500 Internal Server Error`** — Server error during processing.
---
### Apply Label to Email
Applies a retention label to an archived email. If the email already has a label, the existing label is replaced.
- **Endpoint:** `POST /email/:emailId/label`
- **Method:** `POST`
- **Authentication:** Required
- **Permission:** `delete:archive`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
#### Request Body
| Field | Type | Required | Description |
| --------- | ------ | -------- | ------------------------------------ |
| `labelId` | `uuid` | Yes | The UUID of the label to apply. |
#### Example Request
```json
{
"labelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
```
#### Response Body
```json
{
"labelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"labelName": "Legal Hold - Litigation ABC",
"retentionPeriodDays": 2555,
"appliedAt": "2025-10-15T14:30:00.000Z",
"appliedByUserId": "user123"
}
```
#### Response Codes
- **`200 OK`** — Label successfully applied.
- **`404 Not Found`** — Email or label not found.
- **`409 Conflict`** — Attempted to apply a disabled label.
- **`422 Unprocessable Entity`** — Invalid request body.
---
### Remove Label from Email
Removes the retention label from an archived email if one is applied.
- **Endpoint:** `DELETE /email/:emailId/label`
- **Method:** `DELETE`
- **Authentication:** Required
- **Permission:** `delete:archive`
#### Path Parameters
| Parameter | Type | Description |
| --------- | ------ | ------------------------------------- |
| `emailId` | `uuid` | The UUID of the archived email. |
#### Response Body
If a label was removed:
```json
{
"message": "Label removed successfully."
}
```
If no label was applied:
```json
{
"message": "No label was applied to this email."
}
```
#### Response Codes
- **`200 OK`** — Operation completed (regardless of whether a label was actually removed).
- **`500 Internal Server Error`** — Server error during processing.
---
## Error Responses
All endpoints use the standard error response format:
```json
{
"status": "error",
"statusCode": 404,
"message": "The requested resource could not be found.",
"errors": null
}
```
For validation errors (`422 Unprocessable Entity`):
```json
{
"status": "error",
"statusCode": 422,
"message": "Invalid input provided.",
"errors": [
{
"field": "name",
"message": "Name is required."
},
{
"field": "retentionPeriodDays",
"message": "Retention period must be at least 1 day."
}
]
}
```
## Validation Constraints
| Field | Constraint |
| -------------------- | --------------------------------------------- |
| Label name | 1–255 characters, must be unique. |
| Description | Max 1000 characters. |
| Retention period | Positive integer (≥ 1 day). |
| Label ID (UUID) | Must be a valid UUID format. |
| Email ID (UUID) | Must be a valid UUID format. |

229
docs/enterprise/retention-labels/automated-tagging.md Normal file
View File

@@ -0,0 +1,229 @@
# Retention Labels: Automated Application Guide
This guide explains how to use the API to automatically apply retention labels to archived emails, enabling automated compliance and retention management workflows.
## Overview
Automated retention label application allows external systems and services to programmatically tag emails with appropriate retention labels based on content analysis, business rules, or regulatory requirements. This eliminates manual tagging for large volumes of emails while ensuring consistent retention policy enforcement.
## Common Use Cases
### 1. Financial Document Classification
**Scenario**: Automatically identify and tag financial documents (invoices, receipts, payment confirmations) with extended retention periods for regulatory compliance.
**Implementation**:
- Monitor newly ingested emails for financial keywords in subject lines or attachment names
- Apply "Financial Records" label (typically 7+ years retention) to matching emails
- Use content analysis to identify financial document types
### 2. Legal and Compliance Tagging
**Scenario**: Apply legal hold labels to emails related to ongoing litigation or regulatory investigations.
**Implementation**:
- Scan emails for legal-related keywords or specific case references
- Tag emails from/to legal departments with "Legal Hold" labels
- Apply extended retention periods to preserve evidence
### 3. Executive Communication Preservation
**Scenario**: Ensure important communications involving executive leadership are retained beyond standard policies.
**Implementation**:
- Identify emails from C-level executives (CEO, CFO, CTO, etc.)
- Apply "Executive Communications" labels with extended retention
- Preserve strategic business communications for historical reference
### 4. Data Classification Integration
**Scenario**: Integrate with existing data classification systems to apply retention labels based on content sensitivity.
**Implementation**:
- Use AI/ML classification results to determine retention requirements
- Apply labels like "Confidential", "Public", or "Restricted" with appropriate retention periods
- Automate compliance with data protection regulations
### 5. Project-Based Retention
**Scenario**: Apply specific retention periods to emails related to particular projects or contracts.
**Implementation**:
- Identify project-related emails using subject line patterns or participant lists
- Tag with project-specific labels (e.g., "Project Alpha - 5 Year Retention")
- Ensure project documentation meets contractual retention requirements
## API Workflow
### Step 1: Authentication Setup
Create an API key with appropriate permissions:
- Navigate to **Dashboard → Admin → Roles/Users**
- Create a user with `read:archive` and `delete:archive` permissions (minimum required)
- Generate an API for the newly created user
- Securely store the API key for use in automated systems
### Step 2: Identify Target Emails
Use the archived emails API to find emails that need labeling:
**Get Recent Emails**:
```
GET /api/v1/archived-emails?limit=100&sort=archivedAt:desc
```
**Search for Specific Emails**:
```
GET /api/v1/archived-emails/search?query=subject:invoice&limit=50
```
### Step 3: Check Current Label Status
Before applying a new label, verify the email's current state:
**Check Email Label**:
```
GET /api/v1/enterprise/retention-policy/email/{emailId}/label
```
This returns `null` if no label is applied, or the current label information if one exists.
### Step 4: Apply Retention Label
Apply the appropriate label to the email:
**Apply Label**:
```
POST /api/v1/enterprise/retention-policy/email/{emailId}/label
Content-Type: application/json
{
"labelId": "your-label-uuid-here"
}
```
### Step 5: Verify Application
Confirm the label was successfully applied by checking the response or making another GET request.
## Label Management
### Getting Available Labels
List all available retention labels to identify which ones to use:
```
GET /api/v1/enterprise/retention-policy/labels
```
This returns all labels with their IDs, names, retention periods, and status (enabled/disabled).
### Label Selection Strategy
- **Pre-create labels** through the UI with appropriate names and retention periods
- **Map business rules** to specific label IDs in your automation logic
- **Cache label information** to avoid repeated API calls
- **Handle disabled labels** gracefully (they cannot be applied to new emails)
## Implementation Patterns
### Pattern 1: Post-Ingestion Processing
Apply labels after emails have been fully ingested and indexed:
1. Monitor for newly ingested emails (via webhooks or polling)
2. Analyze email content and metadata
3. Determine appropriate retention label based on business rules
4. Apply the label via API
### Pattern 2: Batch Processing
Process emails in scheduled batches:
1. Query for unlabeled emails periodically (daily/weekly)
2. Process emails in manageable batches (50-100 emails)
3. Apply classification logic and labels
4. Log results for audit and monitoring
### Pattern 3: Event-Driven Tagging
React to specific events or triggers:
1. Receive notification of specific events (legal hold notice, project start, etc.)
2. Search for relevant emails based on criteria
3. Apply appropriate labels to all matching emails
4. Document the mass labeling action
## Authentication and Security
### API Key Management
- **Use dedicated API keys** for automated systems (not user accounts)
- **Assign minimal required permissions** (`delete:archive` for label application)
- **Rotate API keys regularly** as part of security best practices
- **Store keys securely** using environment variables or secret management systems
### Request Authentication
Include the API key in all requests:
```
Authorization: Bearer your-api-key-here
Content-Type: application/json
```
## Error Handling
### Common Error Scenarios
- **404 Email Not Found**: The specified email ID doesn't exist
- **404 Label Not Found**: The label ID is invalid or label has been deleted
- **409 Conflict**: Attempting to apply a disabled label
- **422 Validation Error**: Invalid request format or missing required fields
### Best Practices
- **Check response status codes** and handle errors appropriately
- **Implement retry logic** for temporary failures (5xx errors)
- **Log all operations** for audit trails and debugging
- **Continue processing** other emails even if some fail
## Performance Considerations
### Rate Limiting
- **Process emails in batches** rather than individually when possible
- **Add delays between API calls** to avoid overwhelming the server
- **Monitor API response times** and adjust batch sizes accordingly
### Efficiency Tips
- **Cache label information** to reduce API calls
- **Check existing labels** before applying new ones to avoid unnecessary operations
- **Use search API** to filter emails rather than processing all emails
- **Implement incremental processing** to handle only new or modified emails
## Monitoring and Auditing
### Logging Recommendations
- **Log all label applications** with email ID, label ID, and timestamp
- **Track success/failure rates** for monitoring system health
- **Record business rule matches** for compliance reporting
### Audit Trail
All automated label applications are recorded in the system audit log with:
- Actor identified as the API key name
- Target email and applied label details
- Timestamp of the operation
This ensures full traceability of automated retention decisions.
## Integration Examples
### Scenario: Invoice Processing System
1. **Trigger**: New email arrives with invoice attachment
2. **Analysis**: System identifies invoice keywords or attachment types
3. **Action**: Apply "Financial Records - 7 Year" label via API
4. **Result**: Email retained for regulatory compliance period
### Scenario: Legal Hold Implementation
1. **Trigger**: Legal department issues hold notice for specific matter
2. **Search**: Find all emails matching case criteria (participants, keywords, date range)
3. **Action**: Apply "Legal Hold - Matter XYZ" label to all matching emails
4. **Result**: All relevant emails preserved indefinitely
### Scenario: Data Classification Integration
1. **Trigger**: Content classification system processes new emails
2. **Analysis**: ML system categorizes email as "Confidential Financial Data"
3. **Mapping**: Business rules map category to "Financial Confidential - 10 Year" label
4. **Action**: Apply label via API
5. **Result**: Automatic compliance with data retention policies
## Getting Started
1. **Set up authentication** by creating an API key with appropriate permissions
2. **Identify your use cases** and create corresponding retention labels through the UI
3. **Test the API** with a few sample emails to understand the workflow
4. **Implement your business logic** to identify which emails need which labels
5. **Deploy your automation** with proper error handling and monitoring
6. **Monitor results** and adjust your classification rules as needed
This automated approach ensures consistent retention policy enforcement while reducing manual administrative overhead.

206
docs/enterprise/retention-labels/guide.md Normal file
View File

@@ -0,0 +1,206 @@
# Retention Labels: User Interface Guide
The retention labels management interface is located at **Dashboard → Compliance → Retention Labels**. It provides a comprehensive view of all configured labels and tools for creating, editing, deleting, and applying labels to individual archived emails.
## Overview
Retention labels provide item-level retention control, allowing administrators to override normal retention policies for specific emails with custom retention periods. This is particularly useful for legal holds, regulatory compliance, and preserving important business communications.
## Labels Table
The main page displays a table of all retention labels with the following columns:
- **Name:** The label name and its UUID displayed underneath for reference. If a description is provided, it appears below the name in smaller text.
- **Retention Period:** The number of days emails with this label are retained, displayed as "X days".
- **Status:** A badge indicating whether the label is:
- **Enabled** (green badge): The label can be applied to new emails
- **Disabled** (gray badge): The label cannot be applied to new emails but continues to govern already-labeled emails
- **Created At:** The date the label was created, displayed in local date format.
- **Actions:** Dropdown menu with Edit and Delete options for each label.
The table is sorted by creation date in ascending order by default.
## Creating a Label
Click the **"Create New"** button (with plus icon) above the table to open the creation dialog.
### Form Fields
- **Name** (Required): A unique, descriptive name for the label. Maximum 255 characters.
- **Description** (Optional): A detailed explanation of the label's purpose or usage. Maximum 1000 characters.
- **Retention Period (Days)** (Required): The number of days to retain emails with this label. Must be at least 1 day.
### Example Labels
- **Name:** "Legal Hold - Project Alpha"
**Description:** "Extended retention for emails related to ongoing litigation regarding Project Alpha intellectual property dispute"
**Retention Period:** 3650 days (10 years)
- **Name:** "Executive Communications"
**Description:** "Preserve important emails from C-level executives beyond normal retention periods"
**Retention Period:** 2555 days (7 years)
- **Name:** "Financial Records Q4 2025"
**Retention Period:** 2190 days (6 years)
### Success and Error Handling
- **Success**: The dialog closes and a green success notification appears confirming the label was created.
- **Name Conflict**: If a label with the same name already exists, an error notification will display.
- **Validation Errors**: Missing required fields or invalid values will show inline validation messages.
## Editing a Label
Click the **Edit** option from the actions dropdown on any label row to open the edit dialog.
### Editable Fields
- **Name**: Can always be modified (subject to uniqueness constraint)
- **Description**: Can always be modified
- **Retention Period**: Can only be modified if the label has never been applied to any emails
### Retention Period Restrictions
The edit dialog shows a warning message: "Retention period cannot be modified if this label is currently applied to emails." If you attempt to change the retention period for a label that's in use, the system will return a conflict error and display an appropriate error message.
This restriction prevents tampering with active retention schedules and ensures compliance integrity.
### Update Process
1. Modify the desired fields
2. Click **Save** to submit changes
3. The system validates the changes and updates the label
4. A success notification confirms the update
## Deleting a Label
Click the **Delete** option from the actions dropdown to open the deletion confirmation dialog.
### Smart Deletion Behavior
The system uses intelligent deletion logic:
#### Hard Delete
If the label has **never been applied** to any emails:
- The label is permanently removed from the system
- Success message: "Label deleted successfully"
#### Soft Disable
If the label is **currently applied** to one or more emails:
- The label is marked as "Disabled" instead of being deleted
- The label remains in the table with a "Disabled" status badge
- Existing emails keep their retention schedule based on this label
- The label cannot be applied to new emails
- Success message: "Label disabled successfully"
### Confirmation Dialog
The deletion dialog shows:
- **Title**: "Delete Retention Label"
- **Description**: Explains that this action cannot be undone and may disable the label if it's in use
- **Cancel** button to abort the operation
- **Confirm** button to proceed with deletion
## Applying Labels to Emails
Retention labels can be applied to individual archived emails through the email detail pages.
### From Email Detail Page
1. Navigate to an archived email by clicking on it from search results or the archived emails list
2. Look for the "Retention Label" section in the email metadata
3. If no label is applied, you'll see an "Apply Label" button (requires `delete:archive` permission)
4. If a label is already applied, you'll see:
- The current label name and retention period
- "Change Label" and "Remove Label" buttons
### Label Application Process
1. Click **"Apply Label"** or **"Change Label"**
2. A dropdown or dialog shows all available (enabled) labels
3. Select the desired label
4. Confirm the application
5. The system:
- Removes any existing label from the email
- Applies the new label
- Records the action in the audit log
- Updates the email's retention schedule
### One Label Per Email Rule
Each email can have at most one retention label. When you apply a new label to an email that already has a label, the previous label is automatically removed and replaced with the new one.
## Permissions Required
Different operations require different permission levels:
### Label Management
- **Create, Edit, Delete Labels**: Requires `manage:all` permission
- **View Labels Table**: Requires `manage:all` permission
### Email Label Operations
- **View Email Labels**: Requires `read:archive` permission
- **Apply/Remove Email Labels**: Requires `delete:archive` permission
## Status Indicators
### Enabled Labels (Green Badge)
- Can be applied to new emails
- Appears in label selection dropdowns
- Fully functional for all operations
### Disabled Labels (Gray Badge)
- Cannot be applied to new emails
- Does not appear in label selection dropdowns
- Continues to govern retention for already-labeled emails
- Can still be viewed and its details examined
- Results from attempting to delete a label that's currently in use
## Best Practices
### Naming Conventions
- Use descriptive names that indicate purpose: "Legal Hold - Case XYZ", "Executive - Q4 Review"
- Include time periods or case references where relevant
- Maintain consistent naming patterns across your organization
### Descriptions
- Always provide descriptions for complex or specialized labels
- Include the business reason or legal requirement driving the retention period
- Reference specific regulations, policies, or legal matters where applicable
### Retention Periods
- Consider your organization's legal and regulatory requirements
- Common periods:
- **3 years (1095 days)**: Standard business records
- **7 years (2555 days)**: Financial and tax records
- **10 years (3650 days)**: Legal holds and critical business documents
- **Permanent retention**: Use very large numbers (e.g., 36500 days = 100 years)
### Label Lifecycle
- Review labels periodically to identify unused or obsolete labels
- Disabled labels can accumulate over time - consider cleanup procedures
- Document the purpose and expected lifecycle of each label for future administrators
## Troubleshooting
### Cannot Edit Retention Period
**Problem**: Edit dialog shows retention period as locked or returns conflict error
**Cause**: The label is currently applied to one or more emails
**Solution**: Create a new label with the desired retention period instead of modifying the existing one
### Label Not Appearing in Email Application Dropdown
**Problem**: A label doesn't show up when trying to apply it to an email
**Cause**: The label is disabled
**Solution**: Check the labels table - disabled labels show a gray "Disabled" badge
### Cannot Delete Label
**Problem**: Deletion results in label being disabled instead of removed
**Cause**: The label is currently applied to emails
**Solution**: This is expected behavior to preserve retention integrity. The label can only be hard-deleted if it has never been used.
### Permission Denied Errors
**Problem**: Cannot access label management or apply labels to emails
**Cause**: Insufficient permissions
**Solution**: Contact your system administrator to verify you have the required permissions:
- `manage:all` for label management
- `delete:archive` for email label operations

117
docs/enterprise/retention-labels/index.md Normal file
View File

@@ -0,0 +1,117 @@
# Retention Labels
The Retention Labels feature is an enterprise-grade capability that provides item-level retention overrides for archived emails. Unlike retention policies which apply rules to groups of emails, retention labels are manually or programmatically applied to individual emails to override the normal retention lifecycle with specific retention periods.
## Core Principles
### 1. Item-Level Retention Override
Retention labels represent a specific, targeted retention requirement that takes precedence over any automated retention policies. When an email has a retention label applied, the label's `retentionPeriodDays` becomes the governing retention period for that email, regardless of what any retention policy would otherwise specify.
### 2. One Label Per Email
Each archived email can have at most one retention label applied at any time. Applying a new label to an email automatically removes any existing label, ensuring a clean, unambiguous retention state.
### 3. Deletion Behavior
Retention labels implement the following deletion logic:
- **Hard Delete**: If a label has never been applied to any emails, it can be completely removed from the system.
- **Soft Disable**: If a label is currently applied to one or more emails, deletion attempts result in the label being marked as `isDisabled = true`. This keeps the label-email relations but the retention label won't take effective.
- **Delete Disabled Labels**: If a label is currently applied to one or more emails, and it is disabled, a deletion request will delete the label itself and all label-email relations (remove the label from emails it is tagged with).
### 4. Immutable Retention Period
Once a retention label has been applied to any email, its `retentionPeriodDays` value becomes immutable to prevent tampering with active retention schedules. Labels can only have their retention period modified while they have zero applications.
### 5. User Attribution and Audit Trail
Every label application and removal is attributed to a specific user and recorded in the [Audit Log](../audit-log/index.md). This includes both manual UI actions and automated API operations, ensuring complete traceability of retention decisions.
### 6. Lifecycle Integration
The [Lifecycle Worker](../retention-policy/lifecycle-worker.md) gives retention labels the highest priority during email evaluation. If an email has a retention label applied, the label's retention period is used instead of any matching retention policy rules.
## Feature Requirements
The Retention Labels feature requires:
- An active **Enterprise license** with the `RETENTION_POLICY` feature enabled.
- The `manage:all` permission for administrative operations (creating, editing, deleting labels).
- The `delete:archive` permission for applying and removing labels from individual emails.
## Use Cases
### Legal Hold Alternative
Retention labels can serve as a lightweight alternative to formal legal holds by applying extended retention periods (e.g., 10+ years) to specific emails related to litigation or investigation.
### Executive Communications
Apply extended retention to emails from or to executive leadership to ensure important business communications are preserved beyond normal retention periods.
### Regulatory Exceptions
Mark specific emails that must be retained for regulatory compliance (e.g., financial records, safety incidents) with appropriate retention periods regardless of general policy rules.
### Project-Specific Retention
Apply custom retention periods to emails related to specific projects, contracts, or business initiatives that have unique preservation requirements.
## Architecture Overview
The feature is composed of the following components:
| Component | Location | Description |
| -------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------ |
| Types | `packages/types/src/retention.types.ts` | Shared TypeScript types for labels and email label info. |
| Database Schema | `packages/backend/src/database/schema/compliance.ts` | Drizzle ORM table definitions for retention labels. |
| Label Service | `packages/enterprise/src/modules/retention-policy/RetentionLabelService.ts` | CRUD operations and label application logic. |
| API Controller | `packages/enterprise/src/modules/retention-policy/retention-label.controller.ts` | Express request handlers with Zod validation. |
| API Routes | `packages/enterprise/src/modules/retention-policy/retention-policy.routes.ts` | Route registration with auth and feature guards. |
| Frontend Page | `packages/frontend/src/routes/dashboard/compliance/retention-labels/` | SvelteKit page for label management. |
| Email Integration | Individual archived email pages | Label application UI in email detail views. |
## Data Model
### Retention Labels Table
| Column | Type | Description |
| -------------------- | ------------- | --------------------------------------------------------------- |
| `id` | `uuid` (PK) | Auto-generated unique identifier. |
| `name` | `varchar(255)` | Human-readable label name (unique constraint). |
| `retention_period_days` | `integer` | Number of days to retain emails with this label. |
| `description` | `text` | Optional description of the label's purpose. |
| `is_disabled` | `boolean` | Whether the label is disabled (cannot be applied to new emails). |
| `created_at` | `timestamptz` | Creation timestamp. |
### Email Label Applications Table
| Column | Type | Description |
| -------------------- | ------------- | --------------------------------------------------------------- |
| `email_id` | `uuid` (FK) | Reference to the archived email. |
| `label_id` | `uuid` (FK) | Reference to the retention label. |
| `applied_at` | `timestamptz` | Timestamp when the label was applied. |
| `applied_by_user_id` | `uuid` (FK) | User who applied the label (nullable for API key operations). |
The table uses a composite primary key of `(email_id, label_id)` to enforce the one-label-per-email constraint at the database level.
## Integration Points
### Lifecycle Worker
The lifecycle worker queries the `email_retention_labels` table during email evaluation. If an email has a retention label applied, the label's `retentionPeriodDays` takes precedence over any retention policy evaluation.
### Audit Log
All retention label operations generate audit log entries:
- **Label Creation**: Action type `CREATE`, target type `RetentionLabel`
- **Label Updates**: Action type `UPDATE`, target type `RetentionLabel`
- **Label Deletion/Disabling**: Action type `DELETE` or `UPDATE`, target type `RetentionLabel`
- **Label Application**: Action type `UPDATE`, target type `ArchivedEmail`, details include label information
- **Label Removal**: Action type `UPDATE`, target type `ArchivedEmail`, details include removed label information
### Email Detail Pages
Individual archived email pages display any applied retention label and provide controls for users with appropriate permissions to apply or remove labels.

6
packages/backend/src/database/migrations/0026_pink_fantastic_four.sql Normal file
View File

@@ -0,0 +1,6 @@
ALTER TYPE "public"."audit_log_target_type" ADD VALUE 'RetentionLabel' BEFORE 'Role';--> statement-breakpoint
ALTER TYPE "public"."audit_log_target_type" ADD VALUE 'LegalHold' BEFORE 'Role';--> statement-breakpoint
ALTER TABLE "email_legal_holds" ADD COLUMN "applied_at" timestamp with time zone DEFAULT now() NOT NULL;--> statement-breakpoint
ALTER TABLE "email_legal_holds" ADD COLUMN "applied_by_user_id" uuid;--> statement-breakpoint
ALTER TABLE "retention_labels" ADD COLUMN "is_disabled" boolean DEFAULT false NOT NULL;--> statement-breakpoint
ALTER TABLE "email_legal_holds" ADD CONSTRAINT "email_legal_holds_applied_by_user_id_users_id_fk" FOREIGN KEY ("applied_by_user_id") REFERENCES "public"."users"("id") ON DELETE no action ON UPDATE no action;

1595
packages/backend/src/database/migrations/meta/0026_snapshot.json Normal file
View File

File diff suppressed because it is too large Load Diff

7
packages/backend/src/database/migrations/meta/_journal.json
View File

@@ -183,6 +183,13 @@
"when": 1773013461190,
"tag": "0025_peaceful_grim_reaper",
"breakpoints": true
},
{
"idx": 26,
"version": "7",
"when": 1773326266420,
"tag": "0026_pink_fantastic_four",
"breakpoints": true
}
]
}

3
packages/backend/src/database/schema/compliance.ts
View File

@@ -46,6 +46,7 @@ export const retentionLabels = pgTable('retention_labels', {
name: varchar('name', { length: 255 }).notNull(),
retentionPeriodDays: integer('retention_period_days').notNull(),
description: text('description'),
isDisabled: boolean('is_disabled').notNull().default(false),
createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
});
@@ -101,6 +102,8 @@ export const emailLegalHolds = pgTable(
legalHoldId: uuid('legal_hold_id')
.references(() => legalHolds.id, { onDelete: 'cascade' })
.notNull(),
appliedAt: timestamp('applied_at', { withTimezone: true }).notNull().defaultNow(),
appliedByUserId: uuid('applied_by_user_id').references(() => users.id),
},
(t) => [
primaryKey({ columns: [t.emailId, t.legalHoldId] }),

3
packages/backend/src/index.ts
View File

@@ -9,4 +9,5 @@ export { db } from './database';
export * from './database/schema';
export { AuditService } from './services/AuditService';
export * from './config'
export * from './jobs/queues'
export * from './jobs/queues'
export { RetentionHook } from './hooks/RetentionHook';

2
packages/backend/src/services/ingestion-connectors/ImapConnector.ts
View File

@@ -27,7 +27,7 @@ export class ImapConnector implements IEmailConnector {
port: this.credentials.port,
secure: this.credentials.secure,
tls: {
rejectUnauthorized: this.credentials.allowInsecureCert,
rejectUnauthorized: !this.credentials.allowInsecureCert,
requestCert: true,
},
auth: {

20
packages/frontend/src/lib/components/custom/ThemeSwitcher.svelte
View File

@@ -8,15 +8,17 @@
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="ghost" size="icon">
<Sun
class="h-[1.2rem] w-[1.2rem] rotate-0 scale-100 transition-all dark:-rotate-90 dark:scale-0"
/>
<Moon
class="absolute h-[1.2rem] w-[1.2rem] rotate-90 scale-0 transition-all dark:rotate-0 dark:scale-100"
/>
<span class="sr-only">{$t('app.components.theme_switcher.toggle_theme')}</span>
</Button>
{#snippet child({ props })}
<Button {...props} variant="ghost" size="icon">
<Sun
class="h-[1.2rem] w-[1.2rem] rotate-0 scale-100 transition-all dark:-rotate-90 dark:scale-0"
/>
<Moon
class="absolute h-[1.2rem] w-[1.2rem] rotate-90 scale-0 transition-all dark:rotate-0 dark:scale-100"
/>
<span class="sr-only">{$t('app.components.theme_switcher.toggle_theme')}</span>
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content align="end">
<DropdownMenu.Item onclick={() => ($theme = 'light')}>

153
packages/frontend/src/lib/translations/en.json
View File

@@ -40,7 +40,16 @@
"invalid": "Invalid",
"integrity_check_failed_title": "Integrity Check Failed",
"integrity_check_failed_message": "Could not verify the integrity of the email and its attachments.",
"integrity_report_description": "This report verifies that the content of your archived emails has not been altered."
"integrity_report_description": "This report verifies that the content of your archived emails has not been altered.",
"retention_policy": "Retention Policy",
"retention_policy_description": "Shows which retention policy governs this email and when it is scheduled for deletion.",
"retention_no_policy": "No policy applies — this email will not be automatically deleted.",
"retention_period": "Retention Period",
"retention_action": "Action on Expiry",
"retention_matching_policies": "Matching Policies",
"retention_delete_permanently": "Permanent Deletion",
"retention_scheduled_deletion": "Scheduled Deletion",
"retention_policy_overridden_by_label": "This policy is overridden by retention label "
},
"ingestions": {
"title": "Ingestion Sources",
@@ -401,6 +410,148 @@
"delete_success": "Retention policy deleted successfully.",
"delete_error": "Failed to delete retention policy."
},
"retention_labels": {
"title": "Retention Labels",
"header": "Retention Labels",
"meta_description": "Manage retention labels for item-level compliance overrides on individual archived emails.",
"create_new": "Create Label",
"no_labels_found": "No retention labels found.",
"name": "Name",
"description": "Description",
"retention_period": "Retention Period",
"retention_period_days": "Retention Period (days)",
"applied_count": "Applied Emails",
"status": "Status",
"enabled": "Enabled",
"disabled": "Disabled",
"created_at": "Created At",
"actions": "Actions",
"create": "Create",
"edit": "Edit",
"delete": "Delete",
"disable": "Disable",
"save": "Save Changes",
"cancel": "Cancel",
"days": "days",
"create_description": "Create a new retention label. Once applied to emails, the label's retention period cannot be changed.",
"edit_description": "Update this retention label's details.",
"delete_confirmation_title": "Delete this retention label?",
"delete_confirmation_description": "This action will permanently remove the label. It cannot be applied to new emails.",
"disable_confirmation_title": "Disable this retention label?",
"disable_confirmation_description": "This label is currently applied to archived emails and cannot be deleted. It will be disabled so it cannot be applied to new emails, but existing tagged emails will keep this label although it won't take effective.",
"force_delete_confirmation_title": "Permanently delete this disabled label?",
"force_delete_confirmation_description": "This label is disabled but still has email associations. Deleting it will remove all those associations and permanently delete the label. This action cannot be undone.",
"deleting": "Processing",
"confirm": "Confirm",
"create_success": "Retention label created successfully.",
"update_success": "Retention label updated successfully.",
"delete_success": "Retention label deleted successfully.",
"disable_success": "Retention label disabled successfully.",
"delete_error": "Failed to delete retention label.",
"create_error": "Failed to create retention label.",
"update_error": "Failed to update retention label.",
"retention_period_locked": "Retention period cannot be changed while the label is applied to emails.",
"name_placeholder": "e.g. Tax Record - 10 Years",
"description_placeholder": "e.g. Applied to tax-related documents requiring extended retention."
},
"archive_labels": {
"section_title": "Retention Label",
"section_description": "Override this email's retention schedule with a specific label.",
"current_label": "Current Label",
"no_label": "No label applied",
"select_label": "Select a label",
"select_label_placeholder": "Choose a retention label...",
"apply": "Apply Label",
"applying": "Applying...",
"remove": "Remove Label",
"removing": "Removing...",
"apply_success": "Retention label applied successfully.",
"remove_success": "Retention label removed successfully.",
"apply_error": "Failed to apply retention label.",
"remove_error": "Failed to remove retention label.",
"label_overrides_policy": "This label overrides general retention policies for this email.",
"no_labels_available": "No retention labels available. Create labels in Compliance settings.",
"label_inactive": "Inactive",
"label_inactive_note": "This label has been disabled. It no longer provides a retention override or a scheduled deletion date for this email. You may remove it and apply an active label if needed."
},
"legal_holds": {
"title": "Legal Holds",
"header": "Legal Holds",
"meta_description": "Manage legal holds to preserve emails from automated deletion during litigation or regulatory investigations.",
"header_description": "Legal holds suspend automated deletion for specific records relevant to litigation or regulatory investigations.",
"create_new": "Create Hold",
"no_holds_found": "No legal holds found.",
"name": "Name",
"reason": "Reason / Description",
"no_reason": "No reason provided",
"email_count": "Protected Emails",
"status": "Status",
"active": "Active",
"inactive": "Inactive",
"created_at": "Created At",
"actions": "Actions",
"create": "Create",
"edit": "Edit",
"delete": "Delete",
"activate": "Activate",
"deactivate": "Deactivate",
"bulk_apply": "Bulk Apply via Search",
"release_all": "Release All Emails",
"save": "Save Changes",
"cancel": "Cancel",
"confirm": "Confirm Delete",
"name_placeholder": "e.g. Project Titan Litigation - 2026",
"reason_placeholder": "e.g. Pending litigation related to Project Titan. All communications must be preserved.",
"create_description": "Create a new legal hold to prevent automated deletion of relevant emails.",
"edit_description": "Update this legal hold's name or description.",
"delete_confirmation_title": "Permanently delete this legal hold?",
"delete_confirmation_description": "This will permanently delete the hold and remove all email associations. Previously protected emails will be subject to normal retention rules at the next lifecycle worker run.",
"bulk_apply_title": "Bulk Apply Legal Hold via Search",
"bulk_apply_description": "Search for emails using full-text and metadata filters. All matching emails will be placed under this legal hold. The exact query is saved to the audit log as proof of scope.",
"bulk_query": "Search Keywords",
"bulk_query_placeholder": "e.g. Project Titan confidential",
"bulk_query_hint": "Searches email body, subject, and attachment content via the full-text index.",
"bulk_from": "From (Sender Email)",
"bulk_date_start": "Date From",
"bulk_date_end": "Date To",
"bulk_apply_warning": "This action will apply to ALL emails matching your search across the entire archive. The search query will be permanently recorded in the audit log.",
"bulk_apply_confirm": "Apply Hold to Matching Emails",
"release_all_title": "Release all emails from this hold?",
"release_all_description": "All emails will lose their legal hold immunity. They will be evaluated against standard retention policies at the next lifecycle worker run and may be permanently deleted.",
"release_all_confirm": "Release All Emails",
"create_success": "Legal hold created successfully.",
"update_success": "Legal hold updated successfully.",
"delete_success": "Legal hold deleted successfully.",
"activated_success": "Legal hold activated. Protected emails are now immune from deletion.",
"deactivated_success": "Legal hold deactivated. Emails are no longer protected by this hold.",
"bulk_apply_success": "Legal hold applied successfully.",
"release_all_success": "All emails released from hold.",
"create_error": "Failed to create legal hold.",
"update_error": "Failed to update legal hold.",
"delete_error": "Failed to delete legal hold.",
"bulk_apply_error": "Bulk apply failed.",
"release_all_error": "Failed to release emails from hold."
},
"archive_legal_holds": {
"section_title": "Legal Holds",
"section_description": "Suspend automated deletion for this email by placing it under a legal hold.",
"no_holds": "No legal holds applied to this email.",
"hold_name": "Hold Name",
"hold_status": "Status",
"applied_at": "Applied At",
"apply_hold": "Apply a Hold",
"apply_hold_placeholder": "Select a legal hold...",
"apply": "Apply Hold",
"applying": "Applying...",
"remove": "Remove",
"removing": "Removing...",
"apply_success": "Legal hold applied to this email.",
"remove_success": "Legal hold removed from this email.",
"apply_error": "Failed to apply legal hold.",
"remove_error": "Failed to remove legal hold.",
"immune_notice": "This email is protected by an active legal hold and cannot be deleted.",
"no_active_holds": "No active legal holds available. Create holds in Compliance settings."
},
"audit_log": {
"title": "Audit Log",
"header": "Audit Log",

8
packages/frontend/src/routes/dashboard/+layout.svelte
View File

@@ -83,6 +83,14 @@
href: '/dashboard/compliance/retention-policies',
label: $t('app.retention_policies.title'),
},
{
href: '/dashboard/compliance/retention-labels',
label: $t('app.retention_labels.title'),
},
{
href: '/dashboard/compliance/legal-holds',
label: $t('app.legal_holds.title'),
},
],
position: 3,
},

144
packages/frontend/src/routes/dashboard/archived-emails/[id]/+page.server.ts
View File

@@ -1,7 +1,15 @@
import { api } from '$lib/server/api';
import { error } from '@sveltejs/kit';
import type { PageServerLoad } from './$types';
import type { ArchivedEmail, IntegrityCheckResult } from '@open-archiver/types';
import type { Actions, PageServerLoad } from './$types';
import type {
ArchivedEmail,
IntegrityCheckResult,
PolicyEvaluationResult,
RetentionLabel,
EmailRetentionLabelInfo,
LegalHold,
EmailLegalHoldInfo,
} from '@open-archiver/types';
export const load: PageServerLoad = async (event) => {
try {
@@ -31,16 +39,148 @@ export const load: PageServerLoad = async (event) => {
const email: ArchivedEmail = await emailResponse.json();
const integrityReport: IntegrityCheckResult[] = await integrityResponse.json();
// Enterprise-only: fetch retention policy evaluation separately
// to keep the OSS code path completely untouched.
let retentionPolicy: PolicyEvaluationResult | null = null;
let retentionLabels: RetentionLabel[] = [];
let emailRetentionLabel: EmailRetentionLabelInfo | null = null;
let legalHolds: LegalHold[] = [];
let emailLegalHolds: EmailLegalHoldInfo[] = [];
if (event.locals.enterpriseMode) {
// Fetch all enterprise compliance data in parallel — all best-effort
const [retentionRes, labelsRes, emailLabelRes, holdsRes, emailHoldsRes] =
await Promise.all([
api(`/enterprise/retention-policy/email/${id}`, event).catch(() => null),
api('/enterprise/retention-policy/labels', event).catch(() => null),
api(`/enterprise/retention-policy/email/${id}/label`, event).catch(() => null),
api('/enterprise/legal-holds/holds', event).catch(() => null),
api(`/enterprise/legal-holds/email/${id}/holds`, event).catch(() => null),
]);
if (retentionRes?.ok) {
retentionPolicy = await retentionRes.json();
}
if (labelsRes?.ok) {
const labelsJson: RetentionLabel[] = await labelsRes.json();
// Only show enabled labels in the dropdown
retentionLabels = labelsJson.filter((l) => !l.isDisabled);
}
if (emailLabelRes?.ok) {
emailRetentionLabel = await emailLabelRes.json();
}
if (holdsRes?.ok) {
const holdsJson: LegalHold[] = await holdsRes.json();
// Only show active holds in the apply dropdown
legalHolds = holdsJson.filter((h) => h.isActive);
}
if (emailHoldsRes?.ok) {
emailLegalHolds = await emailHoldsRes.json();
}
}
return {
email,
integrityReport,
retentionPolicy,
retentionLabels,
emailRetentionLabel,
legalHolds,
emailLegalHolds,
};
} catch (e) {
console.error('Failed to load archived email:', e);
return {
email: null,
integrityReport: [],
retentionPolicy: null,
retentionLabels: [],
emailRetentionLabel: null,
legalHolds: [],
emailLegalHolds: [],
error: 'Failed to load email',
};
}
};
export const actions: Actions = {
applyLabel: async (event) => {
const data = await event.request.formData();
const emailId = event.params.id;
const labelId = data.get('labelId') as string;
const response = await api(`/enterprise/retention-policy/email/${emailId}/label`, event, {
method: 'POST',
body: JSON.stringify({ labelId }),
});
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return { success: false, message: (res as { message?: string }).message || 'Failed to apply label' };
}
return { success: true, action: 'applied' };
},
removeLabel: async (event) => {
const emailId = event.params.id;
const response = await api(`/enterprise/retention-policy/email/${emailId}/label`, event, {
method: 'DELETE',
});
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return { success: false, message: (res as { message?: string }).message || 'Failed to remove label' };
}
return { success: true, action: 'removed' };
},
applyHold: async (event) => {
const data = await event.request.formData();
const emailId = event.params.id;
const holdId = data.get('holdId') as string;
const response = await api(`/enterprise/legal-holds/email/${emailId}/holds`, event, {
method: 'POST',
body: JSON.stringify({ holdId }),
});
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return {
success: false,
message: (res as { message?: string }).message || 'Failed to apply legal hold.',
};
}
return { success: true, action: 'holdApplied' };
},
removeHold: async (event) => {
const data = await event.request.formData();
const emailId = event.params.id;
const holdId = data.get('holdId') as string;
const response = await api(
`/enterprise/legal-holds/email/${emailId}/holds/${holdId}`,
event,
{ method: 'DELETE' }
);
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return {
success: false,
message: (res as { message?: string }).message || 'Failed to remove legal hold.',
};
}
return { success: true, action: 'holdRemoved' };
},
};

545
packages/frontend/src/routes/dashboard/archived-emails/[id]/+page.svelte
View File

@@ -1,5 +1,5 @@
<script lang="ts">
import type { PageData } from './$types';
import type { ActionData, PageData } from './$types';
import { Button } from '$lib/components/ui/button';
import * as Card from '$lib/components/ui/card';
import EmailPreview from '$lib/components/custom/EmailPreview.svelte';
@@ -9,19 +9,116 @@
import { formatBytes } from '$lib/utils';
import { goto } from '$app/navigation';
import * as Dialog from '$lib/components/ui/dialog';
import * as Select from '$lib/components/ui/select/index.js';
import { setAlert } from '$lib/components/custom/alert/alert-state.svelte';
import { t } from '$lib/translations';
import { ShieldCheck, ShieldAlert, AlertTriangle } from 'lucide-svelte';
import * as Alert from '$lib/components/ui/alert';
import { Badge } from '$lib/components/ui/badge';
import * as HoverCard from '$lib/components/ui/hover-card';
import { Clock, Trash2, CalendarClock, AlertCircle, Shield, CircleAlert, Tag } from 'lucide-svelte';
import { page } from '$app/state';
import { enhance } from '$app/forms';
import type { LegalHold, EmailLegalHoldInfo } from '@open-archiver/types';
let { data }: { data: PageData } = $props();
let { data, form }: { data: PageData; form: ActionData } = $props();
let email = $derived(data.email);
let integrityReport = $derived(data.integrityReport);
let retentionPolicy = $derived(data.retentionPolicy);
let retentionLabels = $derived(data.retentionLabels);
let emailRetentionLabel = $derived(data.emailRetentionLabel);
let legalHolds = $derived(data.legalHolds as LegalHold[]);
let emailLegalHolds = $derived(data.emailLegalHolds as EmailLegalHoldInfo[]);
let enterpriseMode = $derived(page.data.enterpriseMode);
/** Scheduled deletion date from the matching retention policy: sentAt + appliedRetentionDays */
let scheduledDeletionDate = $derived.by(() => {
if (!email || !retentionPolicy || retentionPolicy.appliedRetentionDays === 0) return null;
const sentDate = new Date(email.sentAt);
const deletionDate = new Date(sentDate);
deletionDate.setDate(deletionDate.getDate() + retentionPolicy.appliedRetentionDays);
return deletionDate;
});
/**
* Scheduled deletion date derived from the applied retention label.
* Only computed when a label is active (not disabled).
*/
let scheduledDeletionDateByLabel = $derived.by(() => {
if (!email || !emailRetentionLabel || emailRetentionLabel.isLabelDisabled) return null;
const sentDate = new Date(email.sentAt);
const deletionDate = new Date(sentDate);
deletionDate.setDate(deletionDate.getDate() + emailRetentionLabel.retentionPeriodDays);
return deletionDate;
});
let isDeleteDialogOpen = $state(false);
let isDeleting = $state(false);
// --- Label state ---
let selectedLabelId = $state('');
let isApplyingLabel = $state(false);
let isRemovingLabel = $state(false);
// --- Legal hold state (enterprise only) ---
let selectedHoldId = $state('');
let isApplyingHold = $state(false);
let isRemovingHoldId = $state<string | null>(null);
// React to form results for label and hold actions
$effect(() => {
if (form) {
if (form.success === false && form.message) {
setAlert({
type: 'error',
title: $t('app.archive_labels.apply_error'),
message: String(form.message),
duration: 5000,
show: true,
});
}
if (form.success && form.action === 'applied') {
setAlert({
type: 'success',
title: $t('app.archive_labels.apply_success'),
message: '',
duration: 3000,
show: true,
});
selectedLabelId = '';
}
if (form.success && form.action === 'removed') {
setAlert({
type: 'success',
title: $t('app.archive_labels.remove_success'),
message: '',
duration: 3000,
show: true,
});
selectedLabelId = '';
}
if (form.success && form.action === 'holdApplied') {
setAlert({
type: 'success',
title: $t('app.archive_legal_holds.apply_success'),
message: '',
duration: 3000,
show: true,
});
selectedHoldId = '';
}
if (form.success && form.action === 'holdRemoved') {
setAlert({
type: 'success',
title: $t('app.archive_legal_holds.remove_success'),
message: '',
duration: 3000,
show: true,
});
}
}
});
async function download(path: string, filename: string) {
if (!browser) return;
@@ -43,7 +140,6 @@
a.remove();
} catch (error) {
console.error('Download failed:', error);
// Optionally, show an error message to the user
}
}
@@ -156,6 +252,7 @@
<Button
variant="outline"
size="sm"
class="text-xs"
onclick={() =>
download(
attachment.storagePath,
@@ -180,21 +277,22 @@
</Card.Header>
<Card.Content class="space-y-2">
<Button
class="text-xs"
onclick={() =>
download(email.storagePath, `${email.subject || 'email'}.eml`)}
>{$t('app.archive.download_eml')}</Button
>
<Button variant="destructive" onclick={() => (isDeleteDialogOpen = true)}>
<Button variant="destructive" class="text-xs" onclick={() => (isDeleteDialogOpen = true)}>
{$t('app.archive.delete_email')}
</Button>
</Card.Content>
</Card.Root>
{#if integrityReport && integrityReport.length > 0}
<Card.Root>
<Card.Header>
<Card.Title>{$t('app.archive.integrity_report')}</Card.Title>
<Card.Description>
<Card.Description class="text-xs">
<span class="mt-1">
{$t('app.archive.integrity_report_description')}
<a
@@ -221,7 +319,7 @@
/>
{/if}
<div class="min-w-0 max-w-64">
<p class="truncate text-sm font-medium">
<p class="truncate text-xs font-medium">
{#if item.type === 'email'}
{$t('app.archive.email_eml')}
{:else}
@@ -260,6 +358,439 @@
</Alert.Description>
</Alert.Root>
{/if}
<!-- Legal Holds card (Enterprise only) -->
{#if enterpriseMode}
<Card.Root>
<Card.Header>
<Card.Title class="flex items-center gap-2">
{$t('app.archive_legal_holds.section_title')}
</Card.Title>
<Card.Description class="text-xs">
<span class="mt-1">
{$t('app.archive_legal_holds.section_description')}
<a
href="https://docs.openarchiver.com/enterprise/legal-holds/guide.html"
target="_blank"
class="text-primary underline underline-offset-2"
>{$t('app.common.read_docs')}</a
>.
</span>
</Card.Description>
</Card.Header>
<Card.Content class="space-y-3">
<!-- List of holds already applied to this email -->
{#if emailLegalHolds && emailLegalHolds.length > 0}
<div class="space-y-2">
{#each emailLegalHolds as holdInfo (holdInfo.legalHoldId)}
<div class="flex items-center justify-between rounded-md border p-2">
<div class="min-w-0 flex-1">
<div class="flex items-center gap-2">
<span class="truncate text-xs font-medium">
{holdInfo.holdName}
</span>
{#if holdInfo.isActive}
<Badge class="bg-destructive text-white text-xs">
{$t('app.legal_holds.active')}
</Badge>
{:else}
<Badge variant="secondary" class="text-xs">
{$t('app.legal_holds.inactive')}
</Badge>
{/if}
</div>
<p class="text-muted-foreground mt-0.5 text-xs">
{$t('app.archive_legal_holds.applied_at')}:
{new Date(holdInfo.appliedAt).toLocaleDateString()}
</p>
</div>
<form
method="POST"
action="?/removeHold"
use:enhance={() => {
isRemovingHoldId = holdInfo.legalHoldId;
return async ({ update }) => {
isRemovingHoldId = null;
await update();
};
}}
>
<input
type="hidden"
name="holdId"
value={holdInfo.legalHoldId}
/>
<Button
type="submit"
variant="ghost"
size="sm"
class="text-muted-foreground hover:text-destructive ml-2 shrink-0 text-xs"
disabled={isRemovingHoldId === holdInfo.legalHoldId}
>
{#if isRemovingHoldId === holdInfo.legalHoldId}
{$t('app.archive_legal_holds.removing')}
{:else}
{$t('app.archive_legal_holds.remove')}
{/if}
</Button>
</form>
</div>
{/each}
</div>
{:else}
<p class="text-muted-foreground text-xs">
{$t('app.archive_legal_holds.no_holds')}
</p>
{/if}
<!-- Apply an additional hold to this email -->
{#if legalHolds && legalHolds.length > 0}
<form
method="POST"
action="?/applyHold"
class="space-y-2"
use:enhance={() => {
isApplyingHold = true;
return async ({ update }) => {
isApplyingHold = false;
await update();
};
}}
>
<input type="hidden" name="holdId" value={selectedHoldId} />
<Select.Root
type="single"
value={selectedHoldId}
onValueChange={(v) => (selectedHoldId = v)}
>
<Select.Trigger class="w-full text-xs">
{#if selectedHoldId}
{legalHolds.find((h) => h.id === selectedHoldId)?.name ??
$t('app.archive_legal_holds.apply_hold_placeholder')}
{:else}
{$t('app.archive_legal_holds.apply_hold_placeholder')}
{/if}
</Select.Trigger>
<Select.Content class="text-xs">
{#each legalHolds as hold (hold.id)}
<Select.Item value={hold.id} class="text-xs">{hold.name}</Select.Item>
{/each}
</Select.Content>
</Select.Root>
<Button
type="submit"
variant="outline"
size="sm"
class="w-full text-xs"
disabled={isApplyingHold || !selectedHoldId}
>
{#if isApplyingHold}
{$t('app.archive_legal_holds.applying')}
{:else}
{$t('app.archive_legal_holds.apply')}
{/if}
</Button>
</form>
{:else if !emailLegalHolds?.length}
<p class="text-muted-foreground text-xs">
{$t('app.archive_legal_holds.no_active_holds')}
</p>
{/if}
</Card.Content>
</Card.Root>
{/if}
{#if enterpriseMode && retentionPolicy}
<Card.Root>
<Card.Header>
<Card.Title>{$t('app.archive.retention_policy')}</Card.Title>
<Card.Description class="text-xs">
<span class="mt-1">
{$t('app.archive.retention_policy_description')}
<a
href="https://docs.openarchiver.com/enterprise/retention-policy/guide.html"
target="_blank"
class="text-primary underline underline-offset-2"
>{$t('app.common.read_docs')}</a
>.
</span>
</Card.Description>
</Card.Header>
<Card.Content class="space-y-3">
<!-- Override notice: shown when an active retention label is applied -->
{#if emailRetentionLabel && !emailRetentionLabel.isLabelDisabled}
<div class="flex items-start align-middle gap-2 rounded-md px-2 py-1.5 bg-muted-foreground text-muted">
<CircleAlert class=" h-4 w-4 flex-shrink-0" />
<div class=" text-xs">
{$t('app.archive.retention_policy_overridden_by_label')}
<span class="font-medium">{emailRetentionLabel.labelName}</span>.
</div>
</div>
{/if}
{#if retentionPolicy.appliedRetentionDays === 0}
<p class="text-muted-foreground text-xs">
{$t('app.archive.retention_no_policy')}
</p>
{:else}
<div class="space-y-2">
<div class="flex items-center gap-2">
<Clock class="text-muted-foreground h-4 w-4 flex-shrink-0" />
<span class="text-xs font-medium"
>{$t('app.archive.retention_period')}:</span
>
<Badge variant="secondary">
{retentionPolicy.appliedRetentionDays}
{$t('app.retention_policies.days')}
</Badge>
</div>
{#if scheduledDeletionDate}
<div class="flex items-center gap-2">
<CalendarClock
class="text-muted-foreground h-4 w-4 flex-shrink-0"
/>
<span class="text-xs font-medium"
>{$t('app.archive.retention_scheduled_deletion')}:</span
>
<Badge
variant={scheduledDeletionDate <= new Date()
? 'destructive'
: 'secondary'}
>
{scheduledDeletionDate.toLocaleDateString()}
</Badge>
</div>
{/if}
<div class="flex items-center gap-2">
<Trash2 class="text-muted-foreground h-4 w-4 flex-shrink-0" />
<span class="text-xs font-medium"
>{$t('app.archive.retention_action')}:</span
>
<Badge variant="outline">
{$t('app.archive.retention_delete_permanently')}
</Badge>
</div>
{#if retentionPolicy.matchingPolicyIds.length > 0}
<div class="space-y-2">
<div class="text-xs font-medium">
{$t('app.archive.retention_matching_policies')}:
</div>
<div class="flex flex-wrap gap-1">
{#each retentionPolicy.matchingPolicyIds as policyId}
<Badge variant="outline" class="text-xs font-mono">
{policyId}
</Badge>
{/each}
</div>
</div>
{/if}
</div>
{/if}
</Card.Content>
</Card.Root>
{/if}
<!-- Retention Label section (Enterprise only) -->
{#if enterpriseMode}
<Card.Root>
<Card.Header>
<Card.Title class="flex items-center gap-2">
{$t('app.archive_labels.section_title')}
</Card.Title>
<Card.Description class="text-xs">
<span class="mt-1">
{$t('app.archive_labels.section_description')}
<a
href="https://docs.openarchiver.com/enterprise/retention-labels/guide.html"
target="_blank"
class="text-primary underline underline-offset-2"
>{$t('app.common.read_docs')}</a
>.
</span>
</Card.Description>
</Card.Header>
<Card.Content class="space-y-3">
{#if emailRetentionLabel}
<!-- A label is applied to this email -->
{#if emailRetentionLabel.isLabelDisabled}
<!-- Label exists but has been disabled — show inactive state -->
<div class="space-y-2">
<div class="flex items-center gap-2">
<span class="text-muted-foreground text-xs">
{$t('app.archive_labels.current_label')}:
</span>
<Badge variant="secondary">
{emailRetentionLabel.labelName}
</Badge>
<Badge variant="outline" class="text-muted-foreground text-xs">
{$t('app.archive_labels.label_inactive')}
</Badge>
</div>
<div class="flex items-start gap-2 rounded-md border border-dashed p-2">
<AlertCircle class="text-muted-foreground mt-0.5 h-4 w-4 flex-shrink-0" />
<p class="text-muted-foreground text-xs">
{$t('app.archive_labels.label_inactive_note')}
</p>
</div>
<!-- Still allow removal of the inactive label -->
<form
method="POST"
action="?/removeLabel"
use:enhance={() => {
isRemovingLabel = true;
return async ({ update }) => {
isRemovingLabel = false;
await update();
};
}}
>
<Button
type="submit"
variant="outline"
size="sm"
class="w-full text-xs"
disabled={isRemovingLabel}
>
{#if isRemovingLabel}
{$t('app.archive_labels.removing')}
{:else}
{$t('app.archive_labels.remove')}
{/if}
</Button>
</form>
</div>
{:else}
<!-- Active label applied — show full details including scheduled deletion -->
<div class="space-y-2">
<div class="flex items-center gap-2">
<span class="text-muted-foreground text-xs">
{$t('app.archive_labels.current_label')}:
</span>
<Badge variant="default">
{emailRetentionLabel.labelName}
</Badge>
</div>
<div class="flex items-center gap-2">
<Clock class="text-muted-foreground h-4 w-4 flex-shrink-0" />
<span class="text-xs font-medium">
{$t('app.archive.retention_period')}:
</span>
<Badge variant="secondary">
{emailRetentionLabel.retentionPeriodDays}
{$t('app.retention_labels.days')}
</Badge>
</div>
{#if scheduledDeletionDateByLabel}
<div class="flex items-center gap-2">
<CalendarClock
class="text-muted-foreground h-4 w-4 flex-shrink-0"
/>
<span class="text-xs font-medium">
{$t('app.archive.retention_scheduled_deletion')}:
</span>
<Badge
variant={scheduledDeletionDateByLabel <= new Date()
? 'destructive'
: 'secondary'}
>
{scheduledDeletionDateByLabel.toLocaleDateString()}
</Badge>
</div>
{/if}
<p class="text-muted-foreground text-xs">
{$t('app.archive_labels.label_overrides_policy')}
</p>
<form
method="POST"
action="?/removeLabel"
use:enhance={() => {
isRemovingLabel = true;
return async ({ update }) => {
isRemovingLabel = false;
await update();
};
}}
>
<Button
type="submit"
variant="outline"
size="sm"
class="w-full text-xs"
disabled={isRemovingLabel}
>
{#if isRemovingLabel}
{$t('app.archive_labels.removing')}
{:else}
{$t('app.archive_labels.remove')}
{/if}
</Button>
</form>
</div>
{/if}
{:else if retentionLabels.length > 0}
<!-- No label applied — show selector -->
<p class="text-muted-foreground text-xs">
{$t('app.archive_labels.no_label')}
</p>
<form
method="POST"
action="?/applyLabel"
class="space-y-2"
use:enhance={() => {
isApplyingLabel = true;
return async ({ update }) => {
isApplyingLabel = false;
await update();
};
}}
>
<input type="hidden" name="labelId" value={selectedLabelId} />
<Select.Root
type="single"
value={selectedLabelId}
onValueChange={(v) => (selectedLabelId = v)}
>
<Select.Trigger class="w-full text-xs">
{#if selectedLabelId}
{retentionLabels.find((l) => l.id === selectedLabelId)?.name ??
$t('app.archive_labels.select_label_placeholder')}
{:else}
{$t('app.archive_labels.select_label_placeholder')}
{/if}
</Select.Trigger>
<Select.Content class="text-xs">
{#each retentionLabels as label (label.id)}
<Select.Item value={label.id}>
{label.name}
<span class="text-muted-foreground ml-1 text-xs">
({label.retentionPeriodDays} {$t('app.retention_labels.days')})
</span>
</Select.Item>
{/each}
</Select.Content>
</Select.Root>
<Button
type="submit"
variant="outline"
size="sm"
class="w-full text-xs"
disabled={isApplyingLabel || !selectedLabelId}
>
{#if isApplyingLabel}
{$t('app.archive_labels.applying')}
{:else}
{$t('app.archive_labels.apply')}
{/if}
</Button>
</form>
{:else}
<p class="text-muted-foreground text-xs">
{$t('app.archive_labels.no_labels_available')}
</p>
{/if}
</Card.Content>
</Card.Root>
{/if}
{#if email.thread && email.thread.length > 1}
<Card.Root>

157
packages/frontend/src/routes/dashboard/compliance/legal-holds/+page.server.ts Normal file
View File

@@ -0,0 +1,157 @@
import { api } from '$lib/server/api';
import { error } from '@sveltejs/kit';
import type { Actions, PageServerLoad } from './$types';
import type { LegalHold, SearchQuery } from '@open-archiver/types';
export const load: PageServerLoad = async (event) => {
if (!event.locals.enterpriseMode) {
throw error(
403,
'This feature is only available in the Enterprise Edition. Please contact Open Archiver to upgrade.'
);
}
const holdsRes = await api('/enterprise/legal-holds/holds', event);
const holdsJson = await holdsRes.json();
if (!holdsRes.ok) {
throw error(holdsRes.status, holdsJson.message || JSON.stringify(holdsJson));
}
const holds: LegalHold[] = holdsJson;
return { holds };
};
export const actions: Actions = {
create: async (event) => {
const data = await event.request.formData();
const body = {
name: data.get('name') as string,
reason: (data.get('reason') as string) || undefined,
};
const response = await api('/enterprise/legal-holds/holds', event, {
method: 'POST',
body: JSON.stringify(body),
});
const res = await response.json();
if (!response.ok) {
return { success: false, message: res.message || 'Failed to create legal hold.' };
}
return { success: true };
},
update: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const body: Record<string, string | undefined> = {
name: data.get('name') as string,
reason: (data.get('reason') as string) || undefined,
};
const response = await api(`/enterprise/legal-holds/holds/${id}`, event, {
method: 'PUT',
body: JSON.stringify(body),
});
const res = await response.json();
if (!response.ok) {
return { success: false, message: res.message || 'Failed to update legal hold.' };
}
return { success: true };
},
toggleActive: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const isActive = data.get('isActive') === 'true';
const response = await api(`/enterprise/legal-holds/holds/${id}`, event, {
method: 'PUT',
body: JSON.stringify({ isActive }),
});
const res = await response.json();
if (!response.ok) {
return { success: false, message: res.message || 'Failed to update legal hold.' };
}
return { success: true, isActive };
},
delete: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const response = await api(`/enterprise/legal-holds/holds/${id}`, event, {
method: 'DELETE',
});
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return { success: false, message: (res as { message?: string }).message || 'Failed to delete legal hold.' };
}
return { success: true };
},
bulkApply: async (event) => {
const data = await event.request.formData();
const holdId = data.get('holdId') as string;
const rawQuery = data.get('searchQuery') as string;
let searchQuery: SearchQuery;
try {
searchQuery = JSON.parse(rawQuery) as SearchQuery;
} catch {
return { success: false, message: 'Invalid search query format.' };
}
const response = await api(`/enterprise/legal-holds/holds/${holdId}/bulk-apply`, event, {
method: 'POST',
body: JSON.stringify({ searchQuery }),
});
const res = await response.json();
if (!response.ok) {
return {
success: false,
message: (res as { message?: string }).message || 'Bulk apply failed.',
};
}
const result = res as { emailsLinked: number };
return { success: true, emailsLinked: result.emailsLinked };
},
releaseAll: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const response = await api(`/enterprise/legal-holds/holds/${id}/release-all`, event, {
method: 'POST',
});
const res = await response.json();
if (!response.ok) {
return {
success: false,
message: (res as { message?: string }).message || 'Failed to release emails from hold.',
};
}
const result = res as { emailsReleased: number };
return { success: true, emailsReleased: result.emailsReleased };
},
};

626
packages/frontend/src/routes/dashboard/compliance/legal-holds/+page.svelte Normal file
View File

@@ -0,0 +1,626 @@
<script lang="ts">
import type { ActionData, PageData } from './$types';
import { t } from '$lib/translations';
import { Button } from '$lib/components/ui/button';
import { Badge } from '$lib/components/ui/badge';
import * as Table from '$lib/components/ui/table';
import * as Dialog from '$lib/components/ui/dialog/index.js';
import * as DropdownMenu from '$lib/components/ui/dropdown-menu/index.js';
import { Input } from '$lib/components/ui/input';
import { Label } from '$lib/components/ui/label';
import { Textarea } from '$lib/components/ui/textarea';
import { enhance } from '$app/forms';
import { MoreHorizontal, Plus, Users } from 'lucide-svelte';
import { setAlert } from '$lib/components/custom/alert/alert-state.svelte';
import type { LegalHold } from '@open-archiver/types';
let { data, form }: { data: PageData; form: ActionData } = $props();
let holds = $derived(data.holds);
// --- Dialog state ---
let isCreateOpen = $state(false);
let isEditOpen = $state(false);
let isDeleteOpen = $state(false);
let isBulkApplyOpen = $state(false);
let isReleaseAllOpen = $state(false);
let selectedHold = $state<LegalHold | null>(null);
let isFormLoading = $state(false);
// Bulk apply search query fields
let bulkQuery = $state('');
let bulkFiltersFrom = $state('');
let bulkFiltersDateStart = $state('');
let bulkFiltersDateEnd = $state('');
function openEdit(hold: LegalHold) {
selectedHold = hold;
isEditOpen = true;
}
function openDelete(hold: LegalHold) {
selectedHold = hold;
isDeleteOpen = true;
}
function openBulkApply(hold: LegalHold) {
selectedHold = hold;
bulkQuery = '';
bulkFiltersFrom = '';
bulkFiltersDateStart = '';
bulkFiltersDateEnd = '';
isBulkApplyOpen = true;
}
function openReleaseAll(hold: LegalHold) {
selectedHold = hold;
isReleaseAllOpen = true;
}
/** Builds a SearchQuery JSON string from the bulk apply form fields. */
function buildSearchQuery(): string {
const filters: Record<string, string> = {};
if (bulkFiltersFrom) filters['from'] = bulkFiltersFrom;
if (bulkFiltersDateStart) filters['startDate'] = bulkFiltersDateStart;
if (bulkFiltersDateEnd) filters['endDate'] = bulkFiltersDateEnd;
return JSON.stringify({
query: bulkQuery,
filters: Object.keys(filters).length > 0 ? filters : undefined,
matchingStrategy: 'all',
});
}
</script>
<svelte:head>
<title>{$t('app.legal_holds.title')} - Open Archiver</title>
<meta name="description" content={$t('app.legal_holds.meta_description')} />
<meta
name="keywords"
content="legal hold, eDiscovery, compliance, litigation hold, evidence preservation, spoliation prevention"
/>
</svelte:head>
<div class="mb-6 flex items-center justify-between">
<div>
<h1 class="text-2xl font-bold">{$t('app.legal_holds.header')}</h1>
<p class="text-muted-foreground mt-1 text-sm">
{$t('app.legal_holds.header_description')}
</p>
</div>
<Button onclick={() => (isCreateOpen = true)}>
<Plus class="mr-1.5 h-4 w-4" />
{$t('app.legal_holds.create_new')}
</Button>
</div>
<div class="rounded-md border">
<Table.Root>
<Table.Header>
<Table.Row>
<Table.Head>{$t('app.legal_holds.name')}</Table.Head>
<Table.Head>{$t('app.legal_holds.reason')}</Table.Head>
<Table.Head>{$t('app.legal_holds.email_count')}</Table.Head>
<Table.Head>{$t('app.legal_holds.status')}</Table.Head>
<Table.Head>{$t('app.legal_holds.created_at')}</Table.Head>
<Table.Head class="text-right">{$t('app.legal_holds.actions')}</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
{#if holds && holds.length > 0}
{#each holds as hold (hold.id)}
<Table.Row>
<Table.Cell class="font-medium">
<div class="flex items-center gap-2">
<div>
<div>{hold.name}</div>
<div class="mt-0.5 font-mono text-[10px] text-muted-foreground">
{hold.id}
</div>
</div>
</div>
</Table.Cell>
<Table.Cell class="max-w-[300px]">
{#if hold.reason}
<span class="text-muted-foreground line-clamp-2 text-xs">{hold.reason}</span>
{:else}
<span class="text-muted-foreground text-xs italic">
{$t('app.legal_holds.no_reason')}
</span>
{/if}
</Table.Cell>
<Table.Cell>
<div class="flex items-center gap-1.5">
<Users class="text-muted-foreground h-3.5 w-3.5" />
<Badge variant={hold.emailCount > 0 ? 'secondary' : 'outline'}>
{hold.emailCount}
</Badge>
</div>
</Table.Cell>
<Table.Cell>
{#if hold.isActive}
<Badge class="bg-destructive text-white">
{$t('app.legal_holds.active')}
</Badge>
{:else}
<Badge variant="secondary">
{$t('app.legal_holds.inactive')}
</Badge>
{/if}
</Table.Cell>
<Table.Cell>
{new Date(hold.createdAt).toLocaleDateString()}
</Table.Cell>
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
{#snippet child({ props })}
<Button
{...props}
variant="ghost"
size="icon"
class="h-8 w-8"
aria-label={$t('app.ingestions.open_menu')}
>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content align="end">
<DropdownMenu.Item onclick={() => openEdit(hold)}>
{$t('app.legal_holds.edit')}
</DropdownMenu.Item>
{#if hold.isActive}
<DropdownMenu.Item onclick={() => openBulkApply(hold)}>
{$t('app.legal_holds.bulk_apply')}
</DropdownMenu.Item>
{/if}
{#if hold.emailCount > 0}
<DropdownMenu.Item onclick={() => openReleaseAll(hold)}>
{$t('app.legal_holds.release_all')}
</DropdownMenu.Item>
{/if}
<!-- Toggle active/inactive -->
<form method="POST" action="?/toggleActive" use:enhance={() => {
return async ({ result, update }) => {
if (result.type === 'success' && result.data?.success !== false) {
const newState = result.data?.isActive as boolean;
setAlert({
type: 'success',
title: newState
? $t('app.legal_holds.activated_success')
: $t('app.legal_holds.deactivated_success'),
message: '',
duration: 3000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.legal_holds.update_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}>
<input type="hidden" name="id" value={hold.id} />
<input type="hidden" name="isActive" value={String(!hold.isActive)} />
<DropdownMenu.Item>
<button type="submit" class="w-full text-left">
{hold.isActive
? $t('app.legal_holds.deactivate')
: $t('app.legal_holds.activate')}
</button>
</DropdownMenu.Item>
</form>
<DropdownMenu.Separator />
<DropdownMenu.Item
class="text-destructive focus:text-destructive"
onclick={() => openDelete(hold)}
>
{$t('app.legal_holds.delete')}
</DropdownMenu.Item>
</DropdownMenu.Content>
</DropdownMenu.Root>
</Table.Cell>
</Table.Row>
{/each}
{:else}
<Table.Row>
<Table.Cell colspan={6} class="h-24 text-center">
{$t('app.legal_holds.no_holds_found')}
</Table.Cell>
</Table.Row>
{/if}
</Table.Body>
</Table.Root>
</div>
<!-- Create dialog -->
<Dialog.Root bind:open={isCreateOpen}>
<Dialog.Content class="sm:max-w-[500px]">
<Dialog.Header>
<Dialog.Title>{$t('app.legal_holds.create')}</Dialog.Title>
<Dialog.Description>
{$t('app.legal_holds.create_description')}
</Dialog.Description>
</Dialog.Header>
<form
method="POST"
action="?/create"
class="space-y-4"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isCreateOpen = false;
setAlert({
type: 'success',
title: $t('app.legal_holds.create_success'),
message: '',
duration: 3000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.legal_holds.create_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<div class="space-y-1.5">
<Label for="create-name">{$t('app.legal_holds.name')}</Label>
<Input
id="create-name"
name="name"
required
placeholder={$t('app.legal_holds.name_placeholder')}
/>
</div>
<div class="space-y-1.5">
<Label for="create-reason">{$t('app.legal_holds.reason')}</Label>
<Textarea
id="create-reason"
name="reason"
placeholder={$t('app.legal_holds.reason_placeholder')}
/>
</div>
<div class="flex justify-end gap-2">
<Button
type="button"
variant="outline"
onclick={() => (isCreateOpen = false)}
disabled={isFormLoading}
>
{$t('app.legal_holds.cancel')}
</Button>
<Button type="submit" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.legal_holds.create')}
{/if}
</Button>
</div>
</form>
</Dialog.Content>
</Dialog.Root>
<!-- Edit dialog -->
<Dialog.Root bind:open={isEditOpen}>
<Dialog.Content class="sm:max-w-[500px]">
<Dialog.Header>
<Dialog.Title>{$t('app.legal_holds.edit')}</Dialog.Title>
<Dialog.Description>
{$t('app.legal_holds.edit_description')}
</Dialog.Description>
</Dialog.Header>
{#if selectedHold}
<form
method="POST"
action="?/update"
class="space-y-4"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isEditOpen = false;
selectedHold = null;
setAlert({
type: 'success',
title: $t('app.legal_holds.update_success'),
message: '',
duration: 3000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.legal_holds.update_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="id" value={selectedHold.id} />
<div class="space-y-1.5">
<Label for="edit-name">{$t('app.legal_holds.name')}</Label>
<Input id="edit-name" name="name" required value={selectedHold.name} />
</div>
<div class="space-y-1.5">
<Label for="edit-reason">{$t('app.legal_holds.reason')}</Label>
<Textarea
id="edit-reason"
name="reason"
value={selectedHold.reason ?? ''}
/>
</div>
<div class="flex justify-end gap-2">
<Button
type="button"
variant="outline"
onclick={() => (isEditOpen = false)}
disabled={isFormLoading}
>
{$t('app.legal_holds.cancel')}
</Button>
<Button type="submit" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.legal_holds.save')}
{/if}
</Button>
</div>
</form>
{/if}
</Dialog.Content>
</Dialog.Root>
<!-- Bulk Apply dialog -->
<Dialog.Root bind:open={isBulkApplyOpen}>
<Dialog.Content class="sm:max-w-[560px]">
<Dialog.Header>
<Dialog.Title>{$t('app.legal_holds.bulk_apply_title')}</Dialog.Title>
<Dialog.Description>
{$t('app.legal_holds.bulk_apply_description')}
</Dialog.Description>
</Dialog.Header>
{#if selectedHold}
<form
method="POST"
action="?/bulkApply"
class="space-y-4"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isBulkApplyOpen = false;
const count = result.data?.emailsLinked as number;
setAlert({
type: 'success',
title: $t('app.legal_holds.bulk_apply_success'),
message: `${count} email(s) placed under legal hold.`,
duration: 5000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.legal_holds.bulk_apply_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="holdId" value={selectedHold.id} />
<!-- Hidden input built from the reactive fields -->
<input type="hidden" name="searchQuery" value={buildSearchQuery()} />
<div class="space-y-1.5">
<Label for="bulk-query">{$t('app.legal_holds.bulk_query')}</Label>
<Input
id="bulk-query"
bind:value={bulkQuery}
placeholder={$t('app.legal_holds.bulk_query_placeholder')}
/>
<p class="text-muted-foreground text-xs">
{$t('app.legal_holds.bulk_query_hint')}
</p>
</div>
<div class="space-y-1.5">
<Label for="bulk-from">{$t('app.legal_holds.bulk_from')}</Label>
<Input
id="bulk-from"
bind:value={bulkFiltersFrom}
placeholder="e.g. john@company.com"
/>
</div>
<div class="grid grid-cols-2 gap-3">
<div class="space-y-1.5">
<Label for="bulk-start">{$t('app.legal_holds.bulk_date_start')}</Label>
<Input id="bulk-start" type="date" bind:value={bulkFiltersDateStart} />
</div>
<div class="space-y-1.5">
<Label for="bulk-end">{$t('app.legal_holds.bulk_date_end')}</Label>
<Input id="bulk-end" type="date" bind:value={bulkFiltersDateEnd} />
</div>
</div>
<div class="rounded-md border border-amber-200 bg-amber-50 p-3 dark:border-amber-900 dark:bg-amber-950">
<p class="text-xs text-amber-800 dark:text-amber-200">
{$t('app.legal_holds.bulk_apply_warning')}
</p>
</div>
<div class="flex justify-end gap-2">
<Button
type="button"
variant="outline"
onclick={() => (isBulkApplyOpen = false)}
disabled={isFormLoading}
>
{$t('app.legal_holds.cancel')}
</Button>
<Button type="submit" disabled={isFormLoading || (!bulkQuery && !bulkFiltersFrom && !bulkFiltersDateStart)}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.legal_holds.bulk_apply_confirm')}
{/if}
</Button>
</div>
</form>
{/if}
</Dialog.Content>
</Dialog.Root>
<!-- Release All dialog -->
<Dialog.Root bind:open={isReleaseAllOpen}>
<Dialog.Content>
<Dialog.Header>
<Dialog.Title>{$t('app.legal_holds.release_all_title')}</Dialog.Title>
<Dialog.Description>
{$t('app.legal_holds.release_all_description')}
</Dialog.Description>
</Dialog.Header>
<Dialog.Footer>
<Button
variant="outline"
onclick={() => (isReleaseAllOpen = false)}
disabled={isFormLoading}
>
{$t('app.legal_holds.cancel')}
</Button>
{#if selectedHold}
<form
method="POST"
action="?/releaseAll"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isReleaseAllOpen = false;
const count = result.data?.emailsReleased as number;
setAlert({
type: 'success',
title: $t('app.legal_holds.release_all_success'),
message: `${count} email(s) released from hold.`,
duration: 4000,
show: true,
});
selectedHold = null;
} else {
setAlert({
type: 'error',
title: $t('app.legal_holds.release_all_error'),
message:
result.type === 'success'
? String(result.data?.message ?? '')
: '',
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="id" value={selectedHold.id} />
<Button type="submit" variant="destructive" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.legal_holds.release_all_confirm')}
{/if}
</Button>
</form>
{/if}
</Dialog.Footer>
</Dialog.Content>
</Dialog.Root>
<!-- Delete confirmation dialog -->
<Dialog.Root bind:open={isDeleteOpen}>
<Dialog.Content>
<Dialog.Header>
<Dialog.Title>{$t('app.legal_holds.delete_confirmation_title')}</Dialog.Title>
<Dialog.Description>
{$t('app.legal_holds.delete_confirmation_description')}
</Dialog.Description>
</Dialog.Header>
<Dialog.Footer>
<Button
variant="outline"
onclick={() => (isDeleteOpen = false)}
disabled={isFormLoading}
>
{$t('app.legal_holds.cancel')}
</Button>
{#if selectedHold}
<form
method="POST"
action="?/delete"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isDeleteOpen = false;
setAlert({
type: 'success',
title: $t('app.legal_holds.delete_success'),
message: '',
duration: 3000,
show: true,
});
selectedHold = null;
} else {
setAlert({
type: 'error',
title: $t('app.legal_holds.delete_error'),
message:
result.type === 'success'
? String(result.data?.message ?? '')
: '',
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="id" value={selectedHold.id} />
<Button type="submit" variant="destructive" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.legal_holds.confirm')}
{/if}
</Button>
</form>
{/if}
</Dialog.Footer>
</Dialog.Content>
</Dialog.Root>

96
packages/frontend/src/routes/dashboard/compliance/retention-labels/+page.server.ts Normal file
View File

@@ -0,0 +1,96 @@
import { api } from '$lib/server/api';
import { error } from '@sveltejs/kit';
import type { Actions, PageServerLoad } from './$types';
import type { RetentionLabel } from '@open-archiver/types';
export const load: PageServerLoad = async (event) => {
if (!event.locals.enterpriseMode) {
throw error(
403,
'This feature is only available in the Enterprise Edition. Please contact Open Archiver to upgrade.'
);
}
const labelsRes = await api('/enterprise/retention-policy/labels', event);
const labelsJson = await labelsRes.json();
if (!labelsRes.ok) {
throw error(labelsRes.status, labelsJson.message || JSON.stringify(labelsJson));
}
const labels: RetentionLabel[] = labelsJson;
return { labels };
};
export const actions: Actions = {
create: async (event) => {
const data = await event.request.formData();
const body = {
name: data.get('name') as string,
description: (data.get('description') as string) || undefined,
retentionPeriodDays: Number(data.get('retentionPeriodDays')),
};
const response = await api('/enterprise/retention-policy/labels', event, {
method: 'POST',
body: JSON.stringify(body),
});
const res = await response.json();
if (!response.ok) {
return { success: false, message: res.message || 'Failed to create label' };
}
return { success: true };
},
update: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const body: Record<string, string | number | undefined> = {
name: data.get('name') as string,
description: (data.get('description') as string) || undefined,
};
// Only include retentionPeriodDays if provided (it may be locked)
const retentionDays = data.get('retentionPeriodDays');
if (retentionDays) {
body.retentionPeriodDays = Number(retentionDays);
}
const response = await api(`/enterprise/retention-policy/labels/${id}`, event, {
method: 'PUT',
body: JSON.stringify(body),
});
const res = await response.json();
if (!response.ok) {
return { success: false, message: res.message || 'Failed to update label' };
}
return { success: true };
},
delete: async (event) => {
const data = await event.request.formData();
const id = data.get('id') as string;
const response = await api(`/enterprise/retention-policy/labels/${id}`, event, {
method: 'DELETE',
});
if (!response.ok) {
const res = await response.json().catch(() => ({}));
return { success: false, message: res.message || 'Failed to delete label' };
}
const result = await response.json();
return { success: true, action: result.action as 'deleted' | 'disabled' };
},
};

426
packages/frontend/src/routes/dashboard/compliance/retention-labels/+page.svelte Normal file
View File

@@ -0,0 +1,426 @@
<script lang="ts">
import type { ActionData, PageData } from './$types';
import { t } from '$lib/translations';
import { Button } from '$lib/components/ui/button';
import { Badge } from '$lib/components/ui/badge';
import * as Table from '$lib/components/ui/table';
import * as Dialog from '$lib/components/ui/dialog/index.js';
import * as DropdownMenu from '$lib/components/ui/dropdown-menu/index.js';
import { Input } from '$lib/components/ui/input';
import { Label } from '$lib/components/ui/label';
import { Textarea } from '$lib/components/ui/textarea';
import { enhance } from '$app/forms';
import { MoreHorizontal, Plus } from 'lucide-svelte';
import { setAlert } from '$lib/components/custom/alert/alert-state.svelte';
import type { RetentionLabel } from '@open-archiver/types';
let { data, form }: { data: PageData; form: ActionData } = $props();
let labels = $derived(data.labels);
// --- Dialog state ---
let isCreateOpen = $state(false);
let isEditOpen = $state(false);
let isDeleteOpen = $state(false);
let selectedLabel = $state<RetentionLabel | null>(null);
let isFormLoading = $state(false);
let isDeleting = $state(false);
function openEdit(label: RetentionLabel) {
selectedLabel = label;
isEditOpen = true;
}
function openDelete(label: RetentionLabel) {
selectedLabel = label;
isDeleteOpen = true;
}
</script>
<svelte:head>
<title>{$t('app.retention_labels.title')} - Open Archiver</title>
<meta name="description" content={$t('app.retention_labels.meta_description')} />
<meta
name="keywords"
content="retention labels, data retention, email compliance, item-level retention, GDPR"
/>
</svelte:head>
<div class="mb-6 flex items-center justify-between">
<h1 class="text-2xl font-bold">{$t('app.retention_labels.header')}</h1>
<Button onclick={() => (isCreateOpen = true)}>
<Plus class="mr-1.5 h-4 w-4" />
{$t('app.retention_labels.create_new')}
</Button>
</div>
<div class="rounded-md border">
<Table.Root>
<Table.Header>
<Table.Row>
<Table.Head>{$t('app.retention_labels.name')}</Table.Head>
<Table.Head>{$t('app.retention_labels.retention_period')}</Table.Head>
<Table.Head>{$t('app.retention_labels.applied_count')}</Table.Head>
<Table.Head>{$t('app.retention_labels.status')}</Table.Head>
<Table.Head>{$t('app.retention_labels.created_at')}</Table.Head>
<Table.Head class="text-right">{$t('app.retention_labels.actions')}</Table.Head>
</Table.Row>
</Table.Header>
<Table.Body>
{#if labels && labels.length > 0}
{#each labels as label (label.id)}
<Table.Row>
<Table.Cell class="font-medium">
<div>{label.name}</div>
<div class="mt-0.5 font-mono text-[10px] text-muted-foreground">
{label.id}
</div>
{#if label.description}
<div class="text-muted-foreground mt-0.5 text-xs">
{label.description}
</div>
{/if}
</Table.Cell>
<Table.Cell>
{label.retentionPeriodDays}
{$t('app.retention_labels.days')}
</Table.Cell>
<!-- Applied email count — shows a subtle badge with the number -->
<Table.Cell>
<Badge variant={label.appliedEmailCount > 0 ? 'secondary' : 'outline'}>
{label.appliedEmailCount}
</Badge>
</Table.Cell>
<Table.Cell>
{#if label.isDisabled}
<Badge variant="secondary">
{$t('app.retention_labels.disabled')}
</Badge>
{:else}
<Badge variant="default" class="bg-green-500 text-white">
{$t('app.retention_labels.enabled')}
</Badge>
{/if}
</Table.Cell>
<Table.Cell>
{new Date(label.createdAt).toLocaleDateString()}
</Table.Cell>
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
{#snippet child({ props })}
<Button
{...props}
variant="ghost"
size="icon"
class="h-8 w-8"
aria-label={$t('app.ingestions.open_menu')}
>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content align="end">
<DropdownMenu.Item onclick={() => openEdit(label)}>
{$t('app.retention_labels.edit')}
</DropdownMenu.Item>
<DropdownMenu.Item
class="text-destructive focus:text-destructive"
onclick={() => openDelete(label)}
>
{label.appliedEmailCount > 0 && !label.isDisabled
? $t('app.retention_labels.disable')
: $t('app.retention_labels.delete')}
</DropdownMenu.Item>
</DropdownMenu.Content>
</DropdownMenu.Root>
</Table.Cell>
</Table.Row>
{/each}
{:else}
<Table.Row>
<Table.Cell colspan={6} class="h-24 text-center">
{$t('app.retention_labels.no_labels_found')}
</Table.Cell>
</Table.Row>
{/if}
</Table.Body>
</Table.Root>
</div>
<!-- Create dialog -->
<Dialog.Root bind:open={isCreateOpen}>
<Dialog.Content class="sm:max-w-[500px]">
<Dialog.Header>
<Dialog.Title>{$t('app.retention_labels.create')}</Dialog.Title>
<Dialog.Description>
{$t('app.retention_labels.create_description')}
</Dialog.Description>
</Dialog.Header>
<form
method="POST"
action="?/create"
class="space-y-4"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isCreateOpen = false;
setAlert({
type: 'success',
title: $t('app.retention_labels.create_success'),
message: '',
duration: 3000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.retention_labels.create_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<div class="space-y-1.5">
<Label for="create-name">{$t('app.retention_labels.name')}</Label>
<Input
id="create-name"
name="name"
required
placeholder={$t('app.retention_labels.name_placeholder')}
/>
</div>
<div class="space-y-1.5">
<Label for="create-description">{$t('app.retention_labels.description')}</Label>
<Textarea
id="create-description"
name="description"
placeholder={$t('app.retention_labels.description_placeholder')}
/>
</div>
<div class="space-y-1.5">
<Label for="create-retention">
{$t('app.retention_labels.retention_period_days')}
</Label>
<Input
id="create-retention"
name="retentionPeriodDays"
type="number"
min="1"
required
/>
</div>
<div class="flex justify-end gap-2">
<Button
type="button"
variant="outline"
onclick={() => (isCreateOpen = false)}
disabled={isFormLoading}
>
{$t('app.retention_labels.cancel')}
</Button>
<Button type="submit" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.retention_labels.create')}
{/if}
</Button>
</div>
</form>
</Dialog.Content>
</Dialog.Root>
<!-- Edit dialog -->
<Dialog.Root bind:open={isEditOpen}>
<Dialog.Content class="sm:max-w-[500px]">
<Dialog.Header>
<Dialog.Title>{$t('app.retention_labels.edit')}</Dialog.Title>
<Dialog.Description>
{$t('app.retention_labels.edit_description')}
</Dialog.Description>
</Dialog.Header>
{#if selectedLabel}
<form
method="POST"
action="?/update"
class="space-y-4"
use:enhance={() => {
isFormLoading = true;
return async ({ result, update }) => {
isFormLoading = false;
if (result.type === 'success' && result.data?.success !== false) {
isEditOpen = false;
selectedLabel = null;
setAlert({
type: 'success',
title: $t('app.retention_labels.update_success'),
message: '',
duration: 3000,
show: true,
});
} else if (result.type === 'success' && result.data?.success === false) {
setAlert({
type: 'error',
title: $t('app.retention_labels.update_error'),
message: String(result.data?.message ?? ''),
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="id" value={selectedLabel.id} />
<div class="space-y-1.5">
<Label for="edit-name">{$t('app.retention_labels.name')}</Label>
<Input
id="edit-name"
name="name"
required
value={selectedLabel.name}
/>
</div>
<div class="space-y-1.5">
<Label for="edit-description">{$t('app.retention_labels.description')}</Label>
<Textarea
id="edit-description"
name="description"
value={selectedLabel.description ?? ''}
/>
</div>
<div class="space-y-1.5">
<Label for="edit-retention">
{$t('app.retention_labels.retention_period_days')}
</Label>
<Input
id="edit-retention"
name="retentionPeriodDays"
type="number"
min="1"
required
value={selectedLabel.retentionPeriodDays}
/>
<p class="text-muted-foreground text-xs">
{$t('app.retention_labels.retention_period_locked')}
</p>
</div>
<div class="flex justify-end gap-2">
<Button
type="button"
variant="outline"
onclick={() => (isEditOpen = false)}
disabled={isFormLoading}
>
{$t('app.retention_labels.cancel')}
</Button>
<Button type="submit" disabled={isFormLoading}>
{#if isFormLoading}
{$t('app.common.working')}
{:else}
{$t('app.retention_labels.save')}
{/if}
</Button>
</div>
</form>
{/if}
</Dialog.Content>
</Dialog.Root>
<!--
Delete / Disable / Force-delete confirmation dialog.
Three cases driven by (isDisabled, appliedEmailCount):
1. appliedEmailCount === 0 → hard-delete (no emails, safe to remove)
2. appliedEmailCount > 0, enabled → soft-disable (keep email retention clocks)
3. appliedEmailCount > 0, disabled → force hard-delete (remove relations + label)
-->
<Dialog.Root bind:open={isDeleteOpen}>
<Dialog.Content>
<Dialog.Header>
<Dialog.Title>
{#if (selectedLabel?.appliedEmailCount ?? 0) > 0 && !selectedLabel?.isDisabled}
{$t('app.retention_labels.disable_confirmation_title')}
{:else if (selectedLabel?.appliedEmailCount ?? 0) > 0 && selectedLabel?.isDisabled}
{$t('app.retention_labels.force_delete_confirmation_title')}
{:else}
{$t('app.retention_labels.delete_confirmation_title')}
{/if}
</Dialog.Title>
<Dialog.Description>
{#if (selectedLabel?.appliedEmailCount ?? 0) > 0 && !selectedLabel?.isDisabled}
{$t('app.retention_labels.disable_confirmation_description')}
{:else if (selectedLabel?.appliedEmailCount ?? 0) > 0 && selectedLabel?.isDisabled}
{$t('app.retention_labels.force_delete_confirmation_description')}
{:else}
{$t('app.retention_labels.delete_confirmation_description')}
{/if}
</Dialog.Description>
</Dialog.Header>
<Dialog.Footer>
<Button
variant="outline"
onclick={() => (isDeleteOpen = false)}
disabled={isDeleting}
>
{$t('app.retention_labels.cancel')}
</Button>
{#if selectedLabel}
<form
method="POST"
action="?/delete"
use:enhance={() => {
isDeleting = true;
return async ({ result, update }) => {
isDeleting = false;
if (result.type === 'success' && result.data?.success !== false) {
isDeleteOpen = false;
const action = result.data?.action;
setAlert({
type: 'success',
title:
action === 'disabled'
? $t('app.retention_labels.disable_success')
: $t('app.retention_labels.delete_success'),
message: '',
duration: 3000,
show: true,
});
selectedLabel = null;
} else {
setAlert({
type: 'error',
title: $t('app.retention_labels.delete_error'),
message:
result.type === 'success'
? String(result.data?.message ?? '')
: '',
duration: 5000,
show: true,
});
}
await update();
};
}}
>
<input type="hidden" name="id" value={selectedLabel.id} />
<Button type="submit" variant="destructive" disabled={isDeleting}>
{#if isDeleting}
{$t('app.retention_labels.deleting')}
{:else if (selectedLabel.appliedEmailCount ?? 0) > 0 && !selectedLabel.isDisabled}
{$t('app.retention_labels.disable')}
{:else}
{$t('app.retention_labels.confirm')}
{/if}
</Button>
</form>
{/if}
</Dialog.Footer>
</Dialog.Content>
</Dialog.Root>

24
packages/frontend/src/routes/dashboard/ingestions/+page.svelte
View File

@@ -265,10 +265,12 @@
{#if selectedIds.length > 0}
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="outline">
{$t('app.ingestions.bulk_actions')} ({selectedIds.length})
<MoreHorizontal class="ml-2 h-4 w-4" />
</Button>
{#snippet child({ props })}
<Button {...props} variant="outline">
{$t('app.ingestions.bulk_actions')} ({selectedIds.length})
<MoreHorizontal class="ml-2 h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content>
<DropdownMenu.Item onclick={handleBulkForceSync}>
@@ -382,12 +384,14 @@
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only"
>{$t('app.ingestions.open_menu')}</span
>
<MoreHorizontal class="h-4 w-4" />
</Button>
{#snippet child({ props })}
<Button {...props} variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only"
>{$t('app.ingestions.open_menu')}</span
>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content>
<DropdownMenu.Label

14
packages/frontend/src/routes/dashboard/settings/api-keys/+page.svelte
View File

@@ -111,7 +111,9 @@
<h1 class="text-2xl font-bold">{$t('app.api_keys_page.title')}</h1>
<Dialog.Root bind:open={newAPIKeyDialogOpen}>
<Dialog.Trigger>
<Button>{$t('app.api_keys_page.generate_new_key')}</Button>
{#snippet child({ props })}
<Button {...props}>{$t('app.api_keys_page.generate_new_key')}</Button>
{/snippet}
</Dialog.Trigger>
<Dialog.Content>
<Dialog.Header>
@@ -203,10 +205,12 @@
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.users.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{#snippet child({ props })}
<Button {...props} variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.users.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content>
<DropdownMenu.Label

10
packages/frontend/src/routes/dashboard/settings/roles/+page.svelte
View File

@@ -136,10 +136,12 @@
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.roles.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{#snippet child({ props })}
<Button {...props} variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.roles.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content>
<DropdownMenu.Label

10
packages/frontend/src/routes/dashboard/settings/users/+page.svelte
View File

@@ -135,10 +135,12 @@
<Table.Cell class="text-right">
<DropdownMenu.Root>
<DropdownMenu.Trigger>
<Button variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.users.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{#snippet child({ props })}
<Button {...props} variant="ghost" class="h-8 w-8 p-0">
<span class="sr-only">{$t('app.users.open_menu')}</span>
<MoreHorizontal class="h-4 w-4" />
</Button>
{/snippet}
</DropdownMenu.Trigger>
<DropdownMenu.Content>
<DropdownMenu.Label

2
packages/types/src/audit-log.enums.ts
View File

@@ -28,6 +28,8 @@ export const AuditLogTargetTypes = [
'Dashboard',
'IngestionSource',
'RetentionPolicy',
'RetentionLabel',
'LegalHold',
'Role',
'SystemEvent',
'SystemSettings',

1
packages/types/src/license.types.ts
View File

@@ -4,6 +4,7 @@
export enum OpenArchiverFeature {
AUDIT_LOG = 'audit-log',
RETENTION_POLICY = 'retention-policy',
LEGAL_HOLDS = 'legal-holds',
SSO = 'sso',
STATUS = 'status',
ALL = 'all',

39
packages/types/src/retention.types.ts
View File

@@ -77,9 +77,27 @@ export interface RetentionLabel {
name: string;
retentionPeriodDays: number;
description?: string;
isDisabled: boolean;
/**
* Number of archived emails that currently have this label applied.
* Used by the management UI to show usage and decide whether deletion
* is a hard-delete (0) or a soft-disable (> 0).
*/
appliedEmailCount: number;
createdAt: string; // ISO Date string
}
/** The retention label currently applied to an archived email. */
export interface EmailRetentionLabelInfo {
labelId: string;
labelName: string;
retentionPeriodDays: number;
appliedAt: string; // ISO Date string
appliedByUserId: string | null;
/** True when the label itself has been soft-disabled (isDisabled = true on the label row). */
isLabelDisabled: boolean;
}
export interface RetentionEvent {
id: string;
eventName: string;
@@ -94,4 +112,25 @@ export interface LegalHold {
name: string;
reason?: string;
isActive: boolean;
caseId?: string | null;
/** Number of emails currently under this hold. */
emailCount: number;
createdAt: string; // ISO Date string
updatedAt: string; // ISO Date string
}
/** Info about a legal hold applied to a specific email. */
export interface EmailLegalHoldInfo {
legalHoldId: string;
holdName: string;
isActive: boolean;
appliedAt: string; // ISO Date string
appliedByUserId: string | null;
}
/** Result returned after applying a hold to emails via bulk query. */
export interface BulkApplyHoldResult {
legalHoldId: string;
emailsLinked: number;
queryUsed: Record<string, unknown>;
}