Merge branch 'release-v1.3.3' of github.com:opencrvs/opencrvs-farajal…

…and into release-v1.4.0

CHANGELOG.md

@@ -1,9 +1,68 @@
-## [1.4.0](https://github.com/opencrvs/opencrvs-core/compare/v1.3.2...v1.4.0) (TBD)
+# Changelog
 
-## Breaking changes
+## [1.4.0](https://github.com/opencrvs/opencrvs-core/compare/v1.3.3...v1.4.0) (TBD)
+### Bug fixes
 
-## New features
+See [Releases](https://github.com/opencrvs/opencrvs-core/releases) for release notes of older releases.
 
-## Bug fixes
+## [1.3.3](https://github.com/opencrvs/opencrvs-farajaland/compare/v1.3.2...v1.3.3) (TBD)
 
-See [Releases](https://github.com/opencrvs/opencrvs-core/releases) for release notes of older releases.
+### Breaking changes
+
+### New features
+
+- #### Greater customizability of location data in certificates
+    The various admin level handlebars e.g. **statePlaceofbirth**,
+    **districtPrimaryMother** only contained the name of that location which was
+    not able to take advantage of all the information OpenCRVS had available
+    about the various admin levels e.g. the name of that location in the
+    secondary language. So we are introducing a new set of admin level
+    handlebars that would contain the **id** of that location which we can
+    resolve into a value of the shape
+    ```
+    {
+      name: string
+      alias: string
+    }
+    ```
+    using the new **"location"** handlebar helper. Here name is the primary
+    label of the location and alias being the secondary one. Currently only
+    these 2 fields are available but we will be adding more fields depending on
+    various countries requirements. If previously the certificate svg used to
+    contain `{{districtPlaceofbirth}}` then now we can replace it with
+    `{{location districtPlaceofbirthId 'name'}}`. To access alias, the `'name'`
+    needs to be replaced with `'alias'`.
+
+    Below is a list of all the new handlebars that are meant to be used with the
+    "location" handlebar helper.
+
+    - statePrimaryInformantId
+    - districtPrimaryInformantId
+    - statePlaceofbirthId
+    - districtPlaceofbirthId
+    - statePrimaryMotherId
+    - districtPrimaryMotherId
+    - statePrimaryFatherId
+    - districtPrimaryFatherId
+    - statePrimaryDeceasedId
+    - districtPrimaryDeceasedId
+    - statePlaceofdeathId
+    - districtPlaceofdeathId
+    - statePrimaryGroomId
+    - districtPrimaryGroomId
+    - statePrimaryBrideId
+    - districtPrimaryBrideId
+    - statePlaceofmarriageId
+    - districtPlaceofmarriageId
+    - registrar.stateId
+    - registrar.districtId
+    - registrar.officeId
+    - registrationAgent.stateId
+    - registrationAgent.districtId
+    - registrationAgent.officeId
+
+    ##### We will be deprecating the counterpart of the above mentioned handlebars that contains only the label of the specified location in a future version so we highly recommend that implementers update their certificates to use these new ones.
+
+### Bug fixes
+
+See [Releases](https://github.com/opencrvs/opencrvs-farajaland/releases) for release notes of older releases.

src/form/birth/certificate-handlebars.ts

@@ -17,11 +17,11 @@ export const certificateHandlebars = {
   certificateDate: 'certificateDate',
   registrar: 'registrar',
   registrationAgent: 'registrationAgent',
-  registrarName: 'registrarName',
-  role: 'role',
-  registrarSignature: 'registrarSignature',
+  registrarName: 'registrarName', // @deprecated use registrar.name instead
+  role: 'role', // @deprecated use registrar.role instead
+  registrarSignature: 'registrarSignature', // @deprecated use registrar.signature instead
   registrationDate: 'registrationDate',
-  registrationLocation: 'registrationLocation',
+  registrationLocation: 'registrationLocation', // @deprecated use registrar.office/state/district instead
   contactEmail: 'contactEmail',
   contactPhoneNumber: 'contactPhoneNumber',
   mosipAid: 'mosipAid',
@@ -62,8 +62,10 @@ export const certificateHandlebars = {
   fatherOccupation: 'fatherOccupation',
   fatherEducationalAttainment: 'fatherEducationalAttainment',
   countryPlaceofbirth: 'countryPlaceofbirth',
-  statePlaceofbirth: 'statePlaceofbirth',
-  districtPlaceofbirth: 'districtPlaceofbirth',
+  statePlaceofbirth: 'statePlaceofbirth', // @deprecated use statePlaceofbirthId instead
+  statePlaceofbirthId: 'statePlaceofbirthId',
+  districtPlaceofbirth: 'districtPlaceofbirth', // @deprecated use districtPlaceofbirthId instead
+  districtPlaceofbirthId: 'districtPlaceofbirthId',
   cityPlaceofbirth: 'cityPlaceofbirth',
   addressLine3UrbanOptionPlaceofbirth: 'addressLine3UrbanOptionPlaceofbirth',
   addressLine2UrbanOptionPlaceofbirth: 'addressLine2UrbanOptionPlaceofbirth',
@@ -81,8 +83,10 @@ export const certificateHandlebars = {
     'internationalAddressLine3Placeofbirth',
   internationalPostalCodePlaceofbirth: 'internationalPostalCodePlaceofbirth',
   countryPrimaryInformant: 'countryPrimaryInformant',
-  statePrimaryInformant: 'statePrimaryInformant',
-  districtPrimaryInformant: 'districtPrimaryInformant',
+  statePrimaryInformant: 'statePrimaryInformant', // @deprecated use statePrimaryInformantId instead
+  statePrimaryInformantId: 'statePrimaryInformantId',
+  districtPrimaryInformant: 'districtPrimaryInformant', // @deprecated use districtPrimaryInformantId instead
+  districtPrimaryInformantId: 'districtPrimaryInformantId',
   cityPrimaryInformant: 'cityPrimaryInformant',
   addressLine3UrbanOptionPrimaryInformant:
     'addressLine3UrbanOptionPrimaryInformant',
@@ -106,8 +110,10 @@ export const certificateHandlebars = {
   internationalPostalCodePrimaryInformant:
     'internationalPostalCodePrimaryInformant',
   countryPrimaryMother: 'countryPrimaryMother',
-  statePrimaryMother: 'statePrimaryMother',
-  districtPrimaryMother: 'districtPrimaryMother',
+  statePrimaryMother: 'statePrimaryMother', // @deprecated use statePrimaryMotherId instead
+  statePrimaryMotherId: 'statePrimaryMotherId',
+  districtPrimaryMother: 'districtPrimaryMother', // @deprecated use districtPrimaryMotherId instead
+  districtPrimaryMotherId: 'districtPrimaryMotherId',
   cityPrimaryMother: 'cityPrimaryMother',
   addressLine3UrbanOptionPrimaryMother: 'addressLine3UrbanOptionPrimaryMother',
   addressLine2UrbanOptionPrimaryMother: 'addressLine2UrbanOptionPrimaryMother',
@@ -126,8 +132,10 @@ export const certificateHandlebars = {
   internationalPostalCodePrimaryMother: 'internationalPostalCodePrimaryMother',
   fatherReasonNotApplying: 'fatherReasonNotApplying',
   countryPrimaryFather: 'countryPrimaryFather',
-  statePrimaryFather: 'statePrimaryFather',
-  districtPrimaryFather: 'districtPrimaryFather',
+  statePrimaryFather: 'statePrimaryFather', // @deprecated use statePrimaryFatherId instead
+  statePrimaryFatherId: 'statePrimaryFatherId',
+  districtPrimaryFather: 'districtPrimaryFather', // @deprecated use districtPrimaryFatherId instead
+  districtPrimaryFatherId: 'districtPrimaryFatherId',
   cityPrimaryFather: 'cityPrimaryFather',
   addressLine3UrbanOptionPrimaryFather: 'addressLine3UrbanOptionPrimaryFather',
   addressLine2UrbanOptionPrimaryFather: 'addressLine2UrbanOptionPrimaryFather',