Implement product docs backend API (Stories 1 & 2)

[Eric-Flecher-Glean]

Description

This PR implements the first two stories from the technical implementation plan for a test-driven product documentation listing site.

Story 1: Data Layer & Service Logic ✅

• Created static JSON data store (docs-data/docs.json) with Medtronic product documentation metadata (8 products across 5 categories)
• Implemented TypeScript type definitions (Doc interface)
• Built document service (docsService.ts) with data access and filtering:
  • getAllDocs() - returns all documents sorted by order then title
  • findDocById(id) - retrieves single document by ID
  • filterDocs(query) - filters by search query and/or category (case-insensitive)
• Added comprehensive unit tests (11 tests covering sorting, retrieval, and filtering edge cases)

Story 2: Express REST API ✅

• Implemented Express API with two endpoints:
  • GET /api/docs - list all docs with optional filtering via query params (?q=search&category=Micra)
  • GET /api/docs/:id - get single document by ID (returns 404 if not found)
• Added CORS support for frontend integration
• Separated Express app from HTTP server for testability
• Created integration tests using Supertest (8 tests covering all endpoints and query combinations)

Files Added

• demo/product-docs-site/README.md - Documentation for the project
• demo/product-docs-site/docs-data/docs.json - Product metadata (8 documents)
• demo/product-docs-site/backend/ - Complete TypeScript backend with Node.js + Express
  • src/types/Doc.ts - Shared TypeScript interface
  • src/services/docsService.ts - Data access layer (60 lines)
  • src/routes/docs.ts - Express routes (20 lines)
  • src/index.ts - Express app setup (10 lines)
  • src/server.ts - HTTP server bootstrap (10 lines)
  • test/docsService.test.ts - Service unit tests (120 lines, 11 tests)
  • test/docsRoutes.test.ts - API integration tests (100 lines, 8 tests)
  • Configuration files: package.json, tsconfig.json, jest.config.cjs, .gitignore

Testing

Test Results

All 19 tests passing (ran via npm test in demo/product-docs-site/backend/):

PASS test/docsService.test.ts
PASS test/docsRoutes.test.ts

Test Suites: 2 passed, 2 total
Tests:       19 passed, 19 total
Time:        2.574 s

Test Coverage

• ✅ Service layer unit tests (11 tests):

  • Document sorting by order and title
  • Document retrieval by ID (found and not found cases)
  • Filtering with no query (returns all)
  • Case-insensitive category filtering
  • Search query filtering across title, tags, category, product_family
  • Combined category + query filters (AND logic)
  • Empty results for non-matching queries

• ✅ API route integration tests (8 tests):

  • GET /api/docs returns 200 and array of documents
  • Document structure validation
  • Query parameter filtering (?q=Micra)
  • Category parameter filtering (?category=Micra)
  • Combined filters (?q=technical&category=Micra)
  • Empty array for no matches
  • GET /api/docs/:id returns 200 for valid ID
  • GET /api/docs/:id returns 404 for invalid ID

Manual Testing

Backend server can be started with:

cd demo/product-docs-site/backend
npm install
npm run dev  # Starts on http://localhost:4000

API examples:

curl http://localhost:4000/api/docs
curl http://localhost:4000/api/docs?q=Micra
curl http://localhost:4000/api/docs?category=Micra
curl http://localhost:4000/api/docs/micra-vr2-technical-specifications

---

🤖 Generated by Glean Code Writer
📝 Chat link - https://app.glean.com/chat/593ef5f3e218438cbe47bec1b99745f9