Export Consent Forms (Markdown)

[philippzagar]

Export Consent Forms (Markdown)

:recycle: Current situation & Problem

Until now, users could view and sign a consent document in the Spezi template application using the SpeziOnboarding package. However, the app did not offer any provision to save or export the signed consent document. In the medical domain, the consent form collection is especially important in order to serve as legal cover. See https://github.com/StanfordSpezi/SpeziOnboarding/issues/7.

Utilizes: https://github.com/StanfordSpezi/SpeziFirebase/pull/17

:gear: Release Notes

• The template application now utilizes the OnboardingConsentView of SpeziOnboarding, providing an export and share functionality of the signed consent form as a PDF.

:books: Documentation

Incorporated where necessary. Associated with https://github.com/StanfordSpezi/SpeziOnboarding/pull/26

:white_check_mark: Testing

--

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

• [X] I agree to follow the Code of Conduct and Contributing Guidelines.

[philippzagar]

@PSchmiedmayer PR ready for review, keep in mind that the feat/export-consent-forms branch of SpeziOnboarding is currently set as a dependency so that you are able to test locally / Pipeline succeeds. As soon as https://github.com/StanfordSpezi/SpeziOnboarding/pull/26 is merged and tagged, I'll update the dependency to a tagged version.

[philippzagar]

@PSchmiedmayer Seems like the pipeline is running into some issues:

Error: Encountered a fatal error while running "/Users/runner/hostedtoolcache/CodeQL/2.14.6/x64/codeql/codeql database finalize --finalize-dataset --threads=4 --ram=13004
/Users/runner/work/SpeziTemplateApplication/SpeziTemplateApplication/.codeql/swift". 
Exit code was 32 and error was: CodeQL detected code written in Swift but could not process any of it. Review our troubleshooting guide at https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build.

[codecov[bot]]

Codecov Report

Merging #40 (adf0e97) into main (692c7c9) will decrease coverage by 0.23%. The diff coverage is 84.79%.

Additional details and impacted files

[](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #40 +/- ## ========================================== - Coverage 82.03% 81.79% -0.23% ========================================== Files 32 32 Lines 840 873 +33 ========================================== + Hits 689 714 +25 - Misses 151 159 +8 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [TemplateApplication/Onboarding/Consent.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9PbmJvYXJkaW5nL0NvbnNlbnQuc3dpZnQ=) | `94.12% <100.00%> (-1.53%)` | :arrow_down: | | [...emplateApplication/Onboarding/OnboardingFlow.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9PbmJvYXJkaW5nL09uYm9hcmRpbmdGbG93LnN3aWZ0) | `97.23% <100.00%> (ø)` | | | [TemplateApplication/Onboarding/Welcome.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9PbmJvYXJkaW5nL1dlbGNvbWUuc3dpZnQ=) | `100.00% <100.00%> (ø)` | | | [TemplateApplication/TemplateAppDelegate.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9UZW1wbGF0ZUFwcERlbGVnYXRlLnN3aWZ0) | `97.83% <100.00%> (+0.10%)` | :arrow_up: | | [...n/Onboarding/OnboardingFlow+PreviewSimulator.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9PbmJvYXJkaW5nL09uYm9hcmRpbmdGbG93K1ByZXZpZXdTaW11bGF0b3Iuc3dpZnQ=) | `0.00% <0.00%> (ø)` | | | [...plateApplication/TemplateApplicationStandard.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9UZW1wbGF0ZUFwcGxpY2F0aW9uU3RhbmRhcmQuc3dpZnQ=) | `51.24% <83.34%> (+13.60%)` | :arrow_up: | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [692c7c9...adf0e97](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/40?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).

[PSchmiedmayer]

@philippzagar Thank you for the PR. I will give https://github.com/StanfordSpezi/SpeziOnboarding/pull/26 a review and then we can merge this one here. Also took a look at the build errors in #39 & #41, that should also fix the CI in this PR 👍

[philippzagar]

@PSchmiedmayer Ready for review after you reviewed https://github.com/StanfordSpezi/SpeziOnboarding/pull/26 :)

[philippzagar]

Note to ourselves: We need to merge https://github.com/StanfordSpezi/SpeziFirebase/pull/17 first and adjust the dependencies within this branch

[PSchmiedmayer]

Nice, great job @philippzagar! 🚀