wasp/quicknotes
1
0
Fork 0
Code Issues 1 Pull requests 1 Releases Activity Actions
quicknotes/specs/documents.md

2.9 KiB
Raw Blame History

Documents Specification

Overview

The Documents domain allows users to upload and view PDF documents within the QuickNotes application. This feature is designed to extend the application so that users can manage and view important documents without having to download them.

Data Model

A new entity, Document, will be introduced with the following attributes:

Field Type Description
ID string Unique identifier for the document (UUID)
Filename string Original filename of the uploaded document
Path string Server-side path or storage reference
URL string Public URL to access the document (if needed)
UploadedAt timestamp When the document was uploaded
UpdatedAt timestamp When the document was last updated

Storage Architecture

There are two options for storing PDF documents:

  1. Local Disk Storage: Documents are stored on the local server's filesystem. This method is simple and sufficient for local or small-scale usage.

  2. Blob Storage (e.g., S3): For scalability and better durability, a cloud-based blob storage system (like Amazon S3) could be used. For now, local disk storage is assumed.

API Endpoints

Method Endpoint Description
POST /api/documents Upload a new PDF document
GET /api/documents List all uploaded documents
GET /api/documents/:id Retrieve details of a specific document
DELETE /api/documents/:id Delete a specific document

Upload Endpoint

  • Accepts multipart/form-data with a file field (PDF).
  • Validates that the uploaded file is a PDF.
  • Stores the file in the designated storage (local disk for now).
  • Returns metadata about the uploaded document.

Frontend Integration

PDF Viewer

The frontend will integrate a PDF viewer (similar to PDF.js) to display the PDF inline without forcing a download:

  1. Upload Form: A page where users can select and upload a PDF document.
  2. Viewer Page: A page that embeds a PDF viewer component to display the document. This viewer supports zoom, search within the PDF, and navigation between pages.

Implementation Considerations

  1. Security: Validate file types and implement proper access controls.
  2. Performance: If stored locally, ensure that the server has sufficient storage and backup mechanisms.
  3. Scalability: For future scalability, consider integrating with a cloud blob storage service (e.g., Amazon S3) and a CDN for faster delivery.