nchursin/doc-generator

Document generator

This is a simple service to generate documents by a template.

Deploy

Docker

makedir doc-templates
# put templates in doc-templates dir
npm run docker

Usage

Template engine

See here

Environment config

# port to host the service on
PORT=3000

# folder with templates
TEMPLATE_PATH=./doc-templates

API

## List templates
curl "http://localhost:3000/templates"

## Generate document
curl -X "PUT" "http://localhost:3000/generate/template_name.docx" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "includeText": false,
  "first_name": "John",
  "last_name": "Doe"
}' -o result.docx

## Generate document from provided docx file
## The following exmaple DOES NOT work AS IS. You need to provide a docx template in the template part of the req
curl -X "POST" "http://localhost:3000/generate" \
     -H 'Content-Type: multipart/form-data; charset=utf-8; boundary=__X_PAW_BOUNDARY__' \
     -F "template=" \
     -F "values={\"first_name\":\"John\",\"last_name\":\"Doe\",\"includeText\":false}"

doc-generator's Issues

Configuration UI

Admin should have a one-stop page to configure the app

Admin - is a tech user. Should have a dedicated perm set

User can generate document via a button from any record

Admin should be able to add a "Generate document" button to any page
The template should be configurable

User - is a business user. Should have a dedicated perm set

Handle errors

Currently, any error falls back to default code 500. This should be changed.

Cases:

• POST /generate - file is missing
• POST /generate - file is not docx
• POST /generate - values are missing
• PUT /generate/:templateId - template not found
• PUT /generate/:templateId - values are missing

Migrate this to be a monorepo

this project should be a monorepo, containing:

1. doc generating server
2. salesforce app

This should make overall version management easier

Admin should be able to configure mappings

Metadata records?
The "generate documents" button should be able to reference these metadata records

Admin - is a tech user. Should have a dedicated perm set