@hmcts/dg-docassembly-webcomponent

@hmcts/dg-docassembly-webcomponent

The docassembly webcomponent is an angular library that provides components to generate a document based on a predefined template customised with user input. The library is made up of 3 main components:

• assembly-viewer, which is the parent component that acts as a wrapper that wires the other components together
• form-viewer, which retrieves and displays the input form that allows the user to customise the generated document
• document-viewer, which enables the user to preview the generated document

Integration options

• default setup, wiring between internal components already done
• service-driven setup, more control to the service to define the styling of the component, but also requires the service to do the wiring between the form-viewer and the document-viewer (more details below)

Add as a dependency in your angular app

• add @hmcts/dg-docassembly-webcomponent as a dependency in package.json

• import AssemblyModule and declare it in your NgModule imports.

  For example:

  import { AssemblyModule } from '@hmcts/dg-docassembly-webcomponent';
  
  @NgModule({
    imports: [
      ...,
      AssemblyModule,
    ]
  })
  

• import assets to your angular.json

    {
        "glob": "**/*",
        "input": "node_modules/@hmcts/dg-docassembly-webcomponent/assets",
        "output": "/assets"
    }
  

• and styles

  "styles": [
    "node_modules/@hmcts/dg-docassembly-webcomponent/assets/aui-styles.scss",
    ...
  ],
  

• import JS dependencies as scripts within angular.json

  "scripts": [
      "node_modules/@hmcts/dg-docassembly-webcomponent/assets/js/pdf.combined.min.js",
      "node_modules/@hmcts/dg-docassembly-webcomponent/assets/js/pdf_viewer.min.js",
      "node_modules/@hmcts/dg-docassembly-webcomponent/assets/js/pdf-annotate.min.js"
      ...
  ]
  

• component entry point:

  • using the default setup, the service needs to set: templateName, ouputFormats, templateData

    <app-assembly-viewer *ngIf="selectedTemplate"
                         [templateName]="selectedTemplate"
                         [outputFormats]="['PDF']"
                         [templateData]="templateData"></app-assembly-viewer>
    

  • using the service-driven setup, the service needs to:

    • set the templateName, outputFormats, templateData on the form-viewer
    • listen to the previewDocument event to retrieve the selected outputFormat, and documentUrl these need to be set on the document-viewer

    <app-form-viewer *ngIf="selectedTemplate"
                     [templateName]="selectedTemplate"
                     [outputFormats]="['PDF', 'DOC']"
                     [templateData]="templateData"
                     (previewDocument)="setPreviewData($event)"></app-form-viewer>
    <app-document-viewer *ngIf="documentUrl"
                         [baseUrl]="'api'"
                         [isDM]="true"
                         [contentType]="outputFormat | lowercase"
                         [url]="documentUrl"></app-document-viewer>
    

Accessing template data

Any changes made by the user can be accessed through the 'templateData' property by including a reference to the webcomponent within the service component as follows:

• HTML

  <app-assembly-viewer *ngIf="selectedTemplate" #assemblyComponent
                       [templateName]="selectedTemplate"
                       [templateData]="templateData"></app-assembly-viewer>
  

• component class

  @ViewChild(AssemblyViewerComponent) assemblyComponent: AssemblyViewerComponent;
  
  getAssemblyData() {
    const documentUrl = assemblyComponent.documentUrl;
    const templateData = assemblyComponent.templateData;
  }
  

Backend requirements

The docassembly component requies access to a number of API endpoints, some of which need to be proxied

• rpa-dg-docassembly-api, which depends on rpa-dg-template-management-api and DOCMOSIS
• proxy access to document store through 'document/' endpoint
• access to template store (still to be finalised)

Development setup

Running backend dependencies in docker

• export DOCMOSIS_ACCESS_KEY=<"GET-DOCMOSIS-API-KEY-FROM-TEAM">
• az login
• az acr login --name hmcts --subscription 1c4f0704-a29e-403d-b719-b90c34ef14c9
• docker-compose -f docker-compose-dependencies.yml pull
• docker-compose -f docker-compose-dependencies.yml up

Running the demo angular app

• in another terminal window/tab, build the library then start the app as follows

  npm run package
  npm run build-demo
  npm start