#613: Custom PDF templates

[TickleThePanda]

Description

Adds a new way of generating a proposal PDF based off a user officer input. This uses the custom template associated with a call as a template and renders with the proposal data data. To make it easier for the user officer to select the answers they want, the data is manipulated into a new object answers which is passed into the render, with subtemplates included in subobjects.

Introduces a PDF factory picker so that the PdfWorkflowManager can choose between auto or custom templates. Keeps the old factory constructor option to the PdfWorkflowManager to simplify the code for samples and visits.

Moves a lot of the proposal PDF code into its own files to make discovery easier.

Motivation and Context

Refs UserOfficeProject/issue-tracker#613

How Has This Been Tested

Tested locally with the following and by adding new tests.

Proposal template

{"metadata":{"version":"1.2.0","exportDate":"2022-08-23T09:40:46.953Z"},"data":{"template":{"templateId":1,"groupId":"PROPOSAL","name":"default template","description":"original template","isArchived":false},"templateSteps":[{"topic":{"id":1,"title":"New proposal","templateId":1,"sortOrder":0,"isEnabled":true},"fields":[{"question":{"categoryId":1,"id":"proposal_basis","naturalKey":"proposal_basis","dataType":"PROPOSAL_BASIS","question":"Proposal basic information","config":{"tooltip":"","required":false,"small_label":""}},"topicId":1,"sortOrder":0,"config":{"tooltip":"","required":false,"small_label":""},"dependencies":[],"dependenciesOperator":"AND"},{"question":{"categoryId":1,"id":"text_input_1661195968328","naturalKey":"text_input_1661195968328","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}},"topicId":1,"sortOrder":1,"config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false},"dependencies":[],"dependenciesOperator":"AND"}]},{"topic":{"id":3,"title":"New Topic","templateId":1,"sortOrder":1,"isEnabled":true},"fields":[{"question":{"categoryId":1,"id":"generic_template_1661237580553","naturalKey":"generic_template_1661237580553","dataType":"GENERIC_TEMPLATE","question":"New question","config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null}},"topicId":3,"sortOrder":0,"config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null},"dependencies":[],"dependenciesOperator":"AND"},{"question":{"categoryId":1,"id":"selection_from_options_1661240836804","naturalKey":"multiple_select","dataType":"SELECTION_FROM_OPTIONS","question":"Multiple seleect","config":{"small_label":"","required":false,"tooltip":"","variant":"dropdown","options":["A","B","C"],"isMultipleSelect":true}},"topicId":3,"sortOrder":1,"config":{"small_label":"","required":false,"tooltip":"","variant":"dropdown","options":["A","B","C"],"isMultipleSelect":true},"dependencies":[],"dependenciesOperator":"AND"},{"question":{"categoryId":1,"id":"generic_template_1661241012105","naturalKey":"generic_template_1661241012105","dataType":"GENERIC_TEMPLATE","question":"New question","config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null}},"topicId":3,"sortOrder":2,"config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null},"dependencies":[],"dependenciesOperator":"AND"}]}],"questions":[{"categoryId":1,"id":"proposal_basis","naturalKey":"proposal_basis","dataType":"PROPOSAL_BASIS","question":"Proposal basic information","config":{"tooltip":"","required":false,"small_label":""}},{"categoryId":1,"id":"generic_template_1661237580553","naturalKey":"generic_template_1661237580553","dataType":"GENERIC_TEMPLATE","question":"New question","config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null}},{"categoryId":1,"id":"text_input_1661195968328","naturalKey":"text_input_1661195968328","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}},{"categoryId":1,"id":"selection_from_options_1661240836804","naturalKey":"multiple_select","dataType":"SELECTION_FROM_OPTIONS","question":"Multiple seleect","config":{"small_label":"","required":false,"tooltip":"","variant":"dropdown","options":["A","B","C"],"isMultipleSelect":true}},{"categoryId":1,"id":"generic_template_1661241012105","naturalKey":"generic_template_1661241012105","dataType":"GENERIC_TEMPLATE","question":"New question","config":{"addEntryButtonLabel":"Add","templateCategory":"GENERIC_TEMPLATE","templateId":3,"small_label":"","required":false,"maxEntries":null,"minEntries":null}}],"subTemplates":[{"template":{"templateId":3,"groupId":"GENERIC_TEMPLATE","name":"Test","description":"Test","isArchived":false},"templateSteps":[{"topic":{"id":2,"title":"New Sub Topic","templateId":3,"sortOrder":0,"isEnabled":true},"fields":[{"question":{"categoryId":7,"id":"generic_template_basis","naturalKey":"generic_template_basis","dataType":"GENERIC_TEMPLATE_BASIS","question":"Template basic information","config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""}},"topicId":2,"sortOrder":0,"config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""},"dependencies":[],"dependenciesOperator":"AND"},{"question":{"categoryId":7,"id":"text_input_1661237874466","naturalKey":"text_input_1661237874466","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}},"topicId":2,"sortOrder":1,"config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false},"dependencies":[],"dependenciesOperator":"AND"}]}],"questions":[{"categoryId":7,"id":"generic_template_basis","naturalKey":"generic_template_basis","dataType":"GENERIC_TEMPLATE_BASIS","question":"Template basic information","config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""}},{"categoryId":7,"id":"text_input_1661237874466","naturalKey":"text_input_1661237874466","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}}],"subTemplates":[]},{"template":{"templateId":3,"groupId":"GENERIC_TEMPLATE","name":"Test","description":"Test","isArchived":false},"templateSteps":[{"topic":{"id":2,"title":"New Sub Topic","templateId":3,"sortOrder":0,"isEnabled":true},"fields":[{"question":{"categoryId":7,"id":"generic_template_basis","naturalKey":"generic_template_basis","dataType":"GENERIC_TEMPLATE_BASIS","question":"Template basic information","config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""}},"topicId":2,"sortOrder":0,"config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""},"dependencies":[],"dependenciesOperator":"AND"},{"question":{"categoryId":7,"id":"text_input_1661237874466","naturalKey":"text_input_1661237874466","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}},"topicId":2,"sortOrder":1,"config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false},"dependencies":[],"dependenciesOperator":"AND"}]}],"questions":[{"categoryId":7,"id":"generic_template_basis","naturalKey":"generic_template_basis","dataType":"GENERIC_TEMPLATE_BASIS","question":"Template basic information","config":{"titlePlaceholder":"Title","questionLabel":"","tooltip":"","required":false,"small_label":""}},{"categoryId":7,"id":"text_input_1661237874466","naturalKey":"text_input_1661237874466","dataType":"TEXT_INPUT","question":"New question","config":{"required":false,"small_label":"","tooltip":"","htmlQuestion":"","isHtmlQuestion":false,"min":null,"max":null,"multiline":false,"placeholder":"","isCounterHidden":false}}],"subTemplates":[]}]}}

PDF template

<div>
  Title: {{ proposal.title }}
<div>
<div>
  Test question: {{ answers.text_input_1661195968328 }}
</div>
<div>
  Subtemplate:
  {{#each answers.generic_template_1661237580553}}
    {{ generic_template_basis }}
    {{ text_input_1661237874466 }}
  {{/each}}
</div>
<div>
  Multiple choice:
  {{#each answers.multiple_select}}
    {{ . }}
  {{/each}}
</div>
<div>
  <div>
    {{ principalInvestigator.preferredname }} ({{ principalInvestigator.organisation }})
  </div>
  <div>
    {{#each coProposers}}
      {{ preferredname }} ({{ organisation }})
    {{/each}}
  </div>
</div>

Depends on

New template generation will not work until follow up PRs for UserOfficeProject/user-office-backend#716 and UserOfficeProject/user-office-frontend#988 have been merged but it will not break current template generation.

Tests included/Docs Updated?

• I have added tests to cover my changes.
• All relevant doc has been updated

[jekabs-karklins]

Just small comments, but looks good