Implement recycle bin functionality for notes: Add UI tabs for notes and trash, update API endpoints for managing trashed notes, and enhance note repository methods for soft deletion and restoration.

Author: starichkov

DOCUMENTATION.md

@@ -112,22 +112,52 @@ For API endpoints, we use a special pattern:
 ```javascript
 /**
  * @name GET /notes
- * @description Retrieve all notes from the database
+ * @description Retrieve all active notes from the database
  * @route GET /
- * @returns {Object[]} 200 - Array of note objects
+ * @returns {Object[]} 200 - Array of active note objects
  * @returns {Object} 500 - Error response
  * @example
  * // Response format:
  * [
  *   {
  *     "id": "note_123",
  *     "title": "Sample Note",
- *     "content": "This is a sample note content"
+ *     "content": "This is a sample note content",
+ *     "status": "active",
+ *     "deletedAt": null,
+ *     "createdAt": "2023-01-01T00:00:00.000Z",
+ *     "updatedAt": "2023-01-02T00:00:00.000Z"
  *   }
  * ]
  */
 ```
 
+### Trash Functionality API Documentation
+The application now includes comprehensive trash functionality with the following endpoints:
+
+```javascript
+/**
+ * @name GET /notes/trash
+ * @description Retrieve all deleted notes
+ * @route GET /trash
+ * @returns {Object[]} 200 - Array of deleted note objects
+ */
+
+/**
+ * @name POST /notes/:id/restore
+ * @description Restore a note from trash
+ * @route POST /:id/restore
+ * @returns {void} 204 - No content (successful restoration)
+ */
+
+/**
+ * @name DELETE /notes/:id/permanent
+ * @description Permanently delete a note
+ * @route DELETE /:id/permanent
+ * @returns {void} 204 - No content (successful permanent deletion)
+ */
+```
+
 This creates comprehensive API documentation in the Global section.
 
 ## Maintaining Documentation

README.md

@@ -17,8 +17,10 @@ A RESTful API for managing text notes, built with Node.js, Express, and NoSQL da
 ## Features
 
 - Create, read, update, and delete text notes
+- **Trash functionality** - Move notes to trash instead of immediate deletion
+- **Restore notes** from trash or permanently delete them
 - RESTful API design
-- Simple and intuitive web UI
+- Simple and intuitive web UI with tabs for Notes and Trash
 - Database-agnostic architecture
 - Multiple database implementations (CouchDB, MongoDB)
 - Environment-based configuration
@@ -151,6 +153,22 @@ Each Docker Compose setup includes:
 - **Data persistence**: Named volumes for database data
 - **Network isolation**: Services communicate through a private network
 
+### Local Testing
+
+Run the following command to execute tests and get a coverage report:
+
+```shell
+npm run test:coverage
+```
+
+Then open report file from `coverage/lcov-report/index.html`.
+
+Or, alternatively, use an existing custom script:
+
+```shell
+npm run test:coverage:open
+```
+
 ### Automated Testing
 
 #### Local Testing Script
@@ -232,11 +250,16 @@ Once the server is running, you can:
 
 ## API Endpoints
 
-### Get all notes
+### Get all active notes
 ```
 GET /api/notes
 ```
 
+### Get all deleted notes
+```
+GET /api/notes/trash
+```
+
 ### Get a note by ID
 ```
 GET /api/notes/:id
@@ -264,11 +287,21 @@ Content-Type: application/json
 }
 ```
 
-### Delete a note
+### Move a note to trash (soft delete)
 ```
 DELETE /api/notes/:id
 ```
 
+### Restore a note from trash
+```
+POST /api/notes/:id/restore
+```
+
+### Permanently delete a note
+```
+DELETE /api/notes/:id/permanent
+```
+
 ## Health Check
 
 ```
@@ -285,10 +318,15 @@ http://localhost:3000/
 
 ### UI Features
 
-- View all notes in a responsive grid layout
+- **Tab Navigation**: Switch between "Notes" and "Trash" views
+- **Notes View**: View all active notes in a responsive grid layout
+- **Recycle Bin View**: View deleted notes with restore/permanently delete options
 - Create new notes with a modal form
 - Edit existing notes
-- Delete notes with confirmation
+- **Trash Operations**:
+  - Move notes to trash (soft delete) with confirmation
+  - Restore notes from trash back to active status
+  - Permanently delete notes from trash (with strong confirmation)
 - Responsive design that works on desktop and mobile devices
 
 The UI is built with vanilla JavaScript, HTML, and CSS, with no external dependencies. It communicates with the API endpoints described above.