@astralibx/call-log-engine 0.2.0 → 0.3.0

package/README.md

@@ -112,19 +112,44 @@ const engine = createCallLogEngine({
 ## Features
 
 - **Pipeline management** -- CRUD pipelines with configurable stages, default/terminal flags, and stage reordering. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
-- **Call log lifecycle** -- Create, update, change stage, assign, close, reopen calls with automatic timeline tracking. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
+- **Call log lifecycle** -- Create, update, change stage, assign, close, reopen, soft delete calls with automatic timeline tracking. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
+- **Call channels** -- Track communication channel per call (phone, whatsapp, telegram, etc.). Admin-configurable `availableChannels` in settings. Filterable in list queries. Channel distribution in analytics.
+- **Call outcomes** -- Track result of each call separate from pipeline stage (interested, not_interested, no_answer, etc.). Admin-configurable `availableOutcomes` in settings. Filterable, with outcome distribution in analytics.
+- **Follow-up flag** -- `isFollowUp` boolean distinguishes follow-up calls from fresh calls. Filterable in list queries. Follow-up ratio computed in analytics.
+- **Soft delete** -- `DELETE /:id` soft-deletes with `isDeleted` flag and `deletedAt` timestamp. Excluded from all queries and analytics by default. `includeDeleted=true` query param for audit access.
+- **Agent-scoped filtering** -- When `enableAgentScoping` is true (default), non-owner staff see only their own calls in list and analytics. Owners see everything. Based on `role` field from `authenticateAgent` adapter.
 - **Timeline** -- Append-only audit trail per call with notes, stage changes, assignments, follow-up events. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
 - **Contact timeline** -- Merged cross-call timeline for a contact. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
 - **Follow-up worker** -- Background worker polls for due follow-ups and fires `onFollowUpDue` hook. Starts automatically, stops via `engine.destroy()`. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/hooks.md)
-- **Analytics** -- Dashboard stats, agent stats, leaderboard, pipeline stats/funnel, team stats, daily/weekly/overall reports. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
+- **Analytics** -- Dashboard stats, agent stats, leaderboard, pipeline stats/funnel, team stats, daily/weekly/overall reports, channel/outcome distributions, follow-up ratio. Deleted calls excluded from all analytics. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
 - **Export** -- Bulk call export, single call export, pipeline report export in JSON or CSV. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
-- **Settings** -- Runtime-mutable tags, categories, priority levels, follow-up defaults. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
+- **Settings** -- Runtime-mutable tags, categories, priority levels, follow-up defaults, available channels, available outcomes. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
 - **Bulk operations** -- Bulk stage change for multiple call logs at once. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/api-routes.md)
 - **Contact adapters** -- Pluggable contact lookup and creation. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/adapters.md)
 - **Agent sharing** -- Reuse chat-engine's agent collection. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/agent-sharing.md)
 - **Lifecycle hooks** -- 6 hooks for call events, follow-ups, and metrics. [Details](https://github.com/Hariprakash1997/astralib/blob/main/packages/call-log/call-log-engine/docs/hooks.md)
 - **Error classes** -- Typed errors with codes for every failure scenario.
 
+## Phase 2 Routes
+
+### New routes
+
+| Method | Route | Description |
+|--------|-------|-------------|
+| `DELETE` | `/calls/:id` | Soft-delete a call log (sets `isDeleted` + `deletedAt`) |
+| `GET` | `/analytics/channel-distribution` | Channel breakdown — query: `from?`, `to?` |
+| `GET` | `/analytics/outcome-distribution` | Outcome breakdown — query: `from?`, `to?` |
+| `GET` | `/analytics/follow-up-stats` | Follow-up ratio — query: `from?`, `to?` |
+
+### New query params on `GET /calls`
+
+| Param | Type | Description |
+|-------|------|-------------|
+| `channel` | `string` | Filter by communication channel |
+| `outcome` | `string` | Filter by call outcome |
+| `isFollowUp` | `boolean` | Filter follow-up calls (`true` or `false`) |
+| `includeDeleted` | `boolean` | Include soft-deleted calls in results (`true` or `false`, default `false`) |
+
 ## Architecture
 
 The library exposes an Express router from a single factory call:
@@ -134,7 +159,7 @@ The library exposes an Express router from a single factory call:
 | `engine.routes` | REST API -- pipelines, calls, contacts, analytics, settings, export | Protected (via `authenticateAgent` adapter) |
 | `engine.destroy()` | Stops follow-up worker, cleans up resources | Call on shutdown |
 
-All services are also available programmatically via the returned `engine` object: `pipelines`, `callLogs`, `timeline`, `analytics`, `settings`, `export`, `models`.
+All services are also available programmatically via the returned `engine` object: `pipelines`, `callLogs`, `lifecycle`, `timeline`, `analytics`, `pipelineAnalytics`, `settings`, `export`, `models`.
 
 ## Getting Started Guide