refactor(api-contracts): create common contracts for public use cases - pt1. kdocs (WPB-21911)

[yamilmedina]

WPB-21911 [Kalium] Create common contracts for Use Cases - kdocs

---

PR Submission Checklist for internal contributors

• The PR Title

  • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
  • contains a reference JIRA issue number like SQPIT-764
  • answers the question: If merged, this PR will: ... ³

• The PR Description

  • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

---

What's new in this PR?

In order to continue Kalium adoption on other platforms and to make it a first class lib. We need to provide standardization.
Currently, the architectural fitness functions we use are flawed.

Issues

• Use case test rules are broken, cells use cases bypassed kdocs requirement of public apis.

Solutions

• Fix tests, and add new for upcoming work to standardize return types for use cases.
• Add kdocs for cells use cases, as they are also part of the public interface.

Testing

Test Coverage (Optional)

• I have added automated test to this contribution

How to Test

Test under everyPublicUseCaseInterfaceHasKDocs and everyPublicUseCaseClassHasKDocs should be green.

---

PR Post Submission Checklist for internal contributors (Optional)

• Wire's Github Workflow has automatically linked the PR to a JIRA issue

---

PR Post Merge Checklist for internal contributors

• If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

---

References

1. https://sparkbox.com/foundry/semantic_commit_messages
2. https://github.com/wireapp/.github#usage
3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

[github-actions]

Test Results

0 tests   - 4 271   0 ✅  - 4 158   0s ⏱️ - 5m 58s
0 suites  -   717   0 💤  -   113 
0 files    -   717   0 ❌ ±    0 

Results for commit 7fdb76a. ± Comparison against base commit 628222c.

♻️ This comment has been updated with latest results.

[github-actions]

Bencher Report

Branch	yamil/refactor/replace-either-for-results
Testbed	ubuntu-latest

⚠️ WARNING: No Threshold found!

Without a Threshold, no Alerts will ever be generated.

• Latency (nanoseconds (ns))

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds flag.

Click to view all benchmark results

Benchmark	Latency	microseconds (µs)
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInFiles	📈 view plot ⚠️ NO THRESHOLD	667.02 µs
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInMemory	📈 view plot ⚠️ NO THRESHOLD	584,740.07 µs
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.messageInsertionBenchmark	📈 view plot ⚠️ NO THRESHOLD	1,353,256.06 µs
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.queryMessagesBenchmark	📈 view plot ⚠️ NO THRESHOLD	25,915.49 µs

🐰 View full continuous benchmarking report in Bencher

[codecov-commenter]

Codecov Report

❌ Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 60.03%. Comparing base (628222c) to head (7fdb76a).

Files with missing lines	Patch %	Lines
...set/UpdateAudioMessageNormalizedLoudnessUseCase.kt	0.00%	6 Missing ⚠️
...gic/feature/conversation/GetConversationUseCase.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3794      +/-   ##
===========================================
- Coverage    60.04%   60.03%   -0.02%     
===========================================
  Files         1823     1823              
  Lines        58046    58051       +5     
  Branches      6318     6318              
===========================================
- Hits         34852    34849       -3     
- Misses       20325    20330       +5     
- Partials      2869     2872       +3     

Files with missing lines	Coverage Δ
...kalium/cells/domain/usecase/CreateFolderUseCase.kt	0.00% <ø> (ø)
...um/cells/domain/usecase/DownloadCellFileUseCase.kt	80.00% <ø> (ø)
.../kalium/cells/domain/usecase/GetCellFileUseCase.kt	0.00% <ø> (ø)
...m/cells/domain/usecase/GetCellFilesPagedUseCase.kt	0.00% <ø> (ø)
...kalium/cells/domain/usecase/GetEditorUrlUseCase.kt	0.00% <ø> (ø)
...e/kalium/cells/domain/usecase/GetFoldersUseCase.kt	0.00% <ø> (ø)
...ire/kalium/cells/domain/usecase/MoveNodeUseCase.kt	100.00% <ø> (ø)
...e/kalium/cells/domain/usecase/RenameNodeUseCase.kt	80.00% <ø> (ø)
...domain/usecase/RestoreNodeFromRecycleBinUseCase.kt	84.61% <ø> (ø)
...usecase/publiclink/GetPublicLinkPasswordUseCase.kt	0.00% <ø> (ø)
... and 4 more

... and 3 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 628222c...7fdb76a. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud