feat: add ContactSalesLead entity (SITES-42069)

[tarunsinghdev]

Refer for description: https://github.com/OneAdobe/experience-success-studio-ui/pull/1675

SITES-42069

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!

[github-actions]

This PR will trigger a minor release when merged.

[sandsinh]

Review

1. siteId is a plain string attribute, not a reference

The PostgreSQL table has site_id UUID REFERENCES sites(id), but the schema defines siteId as a loose string rather than using .addReference(). This means no getSite() navigation method and no referential integrity at the data-access layer — inconsistent with how organizationId is handled via .addReference('belongs_to', 'Organization'). If the relationship is intentionally weak (optional, ON DELETE SET NULL), a comment in the schema explaining that choice would help.

2. No unit tests

Other entities in this package have dedicated test files. This PR adds a model, collection, and schema with none. Should include tests covering:

• Model instantiation and STATUSES enum
• Schema validation (required fields, default status)
• Collection wiring and query methods

3. PR title doesn't follow conventional commits

Current: Feature/sites 42069 contact sales api
Should be: feat: add ContactSalesLead entity (SITES-42069)

Needed for semantic-release and changelog generation.

4. addAllIndex(['email']) — clarify the usage

What query patterns require looking up leads by email alone across all orgs? If leads are always queried within an org context, allByOrganizationId() (from the belongs_to reference) is sufficient. If cross-org email lookup is needed, what's the use case? This mirrors the same question on the standalone email index in the database migration (adobe/mysticat-data-service#238).

[tarunsinghdev]

Review

1. siteId is a plain string attribute, not a reference

The PostgreSQL table has site_id UUID REFERENCES sites(id), but the schema defines siteId as a loose string rather than using .addReference(). This means no getSite() navigation method and no referential integrity at the data-access layer — inconsistent with how organizationId is handled via .addReference('belongs_to', 'Organization'). If the relationship is intentionally weak (optional, ON DELETE SET NULL), a comment in the schema explaining that choice would help.

2. No unit tests

Other entities in this package have dedicated test files. This PR adds a model, collection, and schema with none. Should include tests covering:

• Model instantiation and STATUSES enum
• Schema validation (required fields, default status)
• Collection wiring and query methods

3. PR title doesn't follow conventional commits

Current: Feature/sites 42069 contact sales api Should be: feat: add ContactSalesLead entity (SITES-42069)

Needed for semantic-release and changelog generation.

4. addAllIndex(['email']) — clarify the usage

What query patterns require looking up leads by email alone across all orgs? If leads are always queried within an org context, allByOrganizationId() (from the belongs_to reference) is sufficient. If cross-org email lookup is needed, what's the use case? This mirrors the same question on the standalone email index in the database migration (adobe/mysticat-data-service#238).

@sandsinh Thanks for the thorough review! All 4 points addressed in 489691c:

1. siteId → proper reference — Replaced the plain string attribute with .addReference('belongs_to', 'Site', [], { required: false
   }). This gives us getSite() navigation and FK integrity at the data-access layer. Marked optional since site association isn't
   always present for leads.

2. Unit tests added — Full coverage across 3 test files + fixture:

• Model test: instantiation, STATUSES enum, all getters/setters
• Collection test: wiring and create
• Schema test: attribute validation, required fields, default status, references

All at 100% coverage.

3. PR title — Will update to feat: add ContactSalesLead entity (SITES-42069).

4. Removed addAllIndex(['email']) — Agreed, leads are queried within org context via allByOrganizationId() from the belongs_to
   reference. No cross-org email lookup use case.

Also removed a stale ElectroDB comment from the schema and updated type declarations to include getSite() and allBySiteId().

[solaris007]

🎉 This PR is included in version @adobe/spacecat-shared-data-access-v3.44.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀