feat(headless): creation of headless attached citations controller

[SimonMilord]

SFINT-6517

IN THIS PR:

• Added the Headless Attached Citations controller that will support the attach citations feature.
• Added unit tests to cover the controller

It supports the following methods:

• isAttached -> checks in the state if a citation document is attached
• attach -> attaches a citation document to the attached results state
• detach -> detaches a citation document from the attached results state

TEST:

[github-actions]

🔗 Scratch Orgs ready to test this PR:

• ✅ LWS Enabled: Open Org
• ✅ LWS Disabled: Open Org

[SimonMilord]

will update this to isAttachedFromCitation

[erocheleau]

Some small suggestions, but otherwise almost ready to merge!

[erocheleau]

Suggested change

	caseIdMatches && isCitation && (permanentIdMatches || uriHashMatches)
	caseIdMatches && (permanentIdMatches || uriHashMatches)

This is what we discussed right? No matter if it's a citation or not, it's attached.

[erocheleau]

This is something I would centralize in an accessor btw, we have the exact same code duplicated in the headless-attached-results.ts

export const selectAttachedResultsForCase =
  (caseId: string) =>
  (state: State): AttachedResult[] =>
    state.attachedResults.results.filter((attached) => attached.caseId === caseId);

// And then use it like this:
const getAttachedResultsForRecord = (): AttachedResult[] =>
  selectAttachedResultsForCase(caseId)(engine.state);

[erocheleau]

I believe Bueno exposes something for this already no?

[erocheleau]

These will include a bunch of undefined is that what you want?

{
    uriHash: undefined,
    source: undefined,
    ...
}

[erocheleau]

You can omit the intermediate variable if you want, only if you want.

Suggested change

	const resultToAttach = buildAttachedResultFromCitation(citation);
	dispatch(attachResult(resultToAttach));
	dispatch(attachResult(buildAttachedResultFromCitation(citation)));

[erocheleau]

I believe it's an anti-pattern to include this method here,

either you could use the exposed method from the actual component if it's exposed.

Or, you create the object you already expect and don't go through mapping.

Otherwise if the mapping changes in the actual component you have to maintain this part too.

What's important to test is the expectated values, so hardcode that expected value.