Skip to content

feat(data-access): add type-specific data schemas for suggestions [SITES-39183] #1289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Kanishkavijay39 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(data-access): add type-specific data schemas for suggestions [SITES-39183] #1289

Kanishkavijay39 wants to merge 3 commits into from

Conversation

@Kanishkavijay39
Copy link
Contributor

@Kanishkavijay39 Kanishkavijay39 commented Jan 27, 2026

  • Add DATA_SCHEMAS configuration per opportunity type (8 types defined)
  • Add Joi validation schemas for data structure consistency
  • Add projection configurations for API minimal/summary views
  • Add field transformers for data transformation
  • Add URL extraction logic per opportunity type
  • Add comprehensive JSDoc documentation
  • Add 100% test coverage for new functionality

Benefits:

  • Single source of truth for suggestion data structure
  • Enable data validation in audit-worker before DB writes
  • Enable schema-driven API projections (replaces hardcoded field lists)
  • Graceful fallback for undefined opportunity types
  • Uses OPPORTUNITY_TYPES enum for type safety

Files:

  • suggestion.data-schemas.js: Type-specific Joi schemas & projections
  • suggestion.projection-utils.js: Reusable transformers & fallback config
  • suggestion.model.js: getProjection(), extractUrl(), validateData() methods

Please ensure your pull request adheres to the following guidelines:

  • make sure to link the related issues in this description
  • when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes

Related Issues

Thanks for contributing!

@Kanishkavijay39 Kanishkavijay39 force-pushed the feat/suggestion-data-schemas branch from 25bbd29 to 94e646f Compare January 27, 2026 11:23
@github-actions
Copy link

github-actions bot commented Jan 27, 2026

This PR will trigger a minor release when merged.

@Kanishkavijay39 Kanishkavijay39 mentioned this pull request Jan 27, 2026
Open
refactor(data-access): simplify suggestion schemas and remove unused …
c6821a2 
…URL extraction

- Remove extractUrl() method and urlExtraction config (unused in production)
- Reduce FALLBACK_PROJECTION from 25 fields to 14 URL-only fields
- Remove urlExtraction property from all opportunity type schemas
- Update tests to reflect simplified implementation

This change reduces complexity by removing speculative features that were only used in tests, following YAGNI principle and Single Responsibility Principle.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Kanishkavijay39