@opencrvs/toolkit 2.1.2 → 2.2.0-rc.1a111f2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/build.sh +2 -12
  2. package/create-countryconfig/package.json +1 -1
  3. package/dist/application-config/index.js +41 -9
  4. package/dist/authentication/index.d.ts +1 -0
  5. package/dist/authentication/index.js +30 -6
  6. package/dist/cli.js +1489 -2020
  7. package/dist/commons/api/router.d.ts +1551 -248
  8. package/dist/commons/application-config/index.d.ts +2 -2
  9. package/dist/commons/conditionals/conditionals.d.ts +3 -3
  10. package/dist/commons/conditionals/index.d.ts +1 -0
  11. package/dist/commons/conditionals/validate.d.ts +5 -0
  12. package/dist/commons/events/ActionConfig.d.ts +146 -20
  13. package/dist/commons/events/ActionDocument.d.ts +89 -0
  14. package/dist/commons/events/ActionInput.d.ts +56 -4
  15. package/dist/commons/events/ActionType.d.ts +13 -1
  16. package/dist/commons/events/AdvancedSearchConfig.d.ts +15 -0
  17. package/dist/commons/events/AuditLog.d.ts +4 -0
  18. package/dist/commons/events/CompositeFieldValue.d.ts +5 -1
  19. package/dist/commons/events/CountryConfigQueryInput.d.ts +192 -18
  20. package/dist/commons/events/Draft.d.ts +36 -1
  21. package/dist/commons/events/EventConfig.d.ts +412 -6
  22. package/dist/commons/events/EventDocument.d.ts +88 -0
  23. package/dist/commons/events/EventIndex.d.ts +43 -6
  24. package/dist/commons/events/EventMetadata.d.ts +23 -1
  25. package/dist/commons/events/EventStatus.d.ts +1 -0
  26. package/dist/commons/events/FieldConfig.d.ts +11 -1
  27. package/dist/commons/events/FieldTypeMapping.d.ts +6 -6
  28. package/dist/commons/events/Flag.d.ts +1 -7
  29. package/dist/commons/events/PlainDate.d.ts +1 -0
  30. package/dist/commons/events/WorkqueueConfig.d.ts +224 -33
  31. package/dist/commons/events/defineConfig.d.ts +7 -2
  32. package/dist/commons/events/event.d.ts +4 -1
  33. package/dist/commons/events/eventConfigValidation.d.ts +26 -1
  34. package/dist/commons/events/field.d.ts +5 -0
  35. package/dist/commons/events/index.d.ts +3 -0
  36. package/dist/commons/events/scopes.d.ts +3 -0
  37. package/dist/commons/events/state/flags.d.ts +1 -1
  38. package/dist/commons/events/state/index.d.ts +10 -2
  39. package/dist/commons/events/state/utils.d.ts +11 -1
  40. package/dist/commons/events/test.utils.d.ts +87 -6
  41. package/dist/commons/events/toNotificationForm.d.ts +17 -0
  42. package/dist/commons/events/utils.d.ts +75 -8
  43. package/dist/conditionals/index.js +16 -4
  44. package/dist/environment/custom-types.d.ts +1 -0
  45. package/dist/environment/custom-types.d.ts.map +1 -1
  46. package/dist/environment/derived-variables.d.ts +24 -4
  47. package/dist/environment/derived-variables.d.ts.map +1 -1
  48. package/dist/environment/derived-variables.js +27 -4
  49. package/dist/environment/questions.d.ts +42 -9
  50. package/dist/environment/questions.d.ts.map +1 -1
  51. package/dist/environment/questions.js +71 -48
  52. package/dist/environment/registry.d.ts +15 -0
  53. package/dist/environment/registry.d.ts.map +1 -0
  54. package/dist/environment/registry.js +112 -0
  55. package/dist/environment/setup-environment.d.ts.map +1 -1
  56. package/dist/environment/setup-environment.js +159 -35
  57. package/dist/environment/templates.d.ts.map +1 -1
  58. package/dist/events/index.js +944 -214
  59. package/dist/migrations/add-notify-config.d.ts +40 -0
  60. package/dist/migrations/add-notify-config.d.ts.map +1 -0
  61. package/dist/migrations/add-notify-config.js +249 -0
  62. package/dist/migrations/index.d.ts +9 -0
  63. package/dist/migrations/index.d.ts.map +1 -0
  64. package/dist/migrations/index.js +1306 -0
  65. package/dist/migrations/move-declaration-to-declare-action.d.ts +38 -0
  66. package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -0
  67. package/dist/migrations/move-declaration-to-declare-action.js +260 -0
  68. package/dist/migrations/{v2.1 → persistent}/add-translations.d.ts +7 -1
  69. package/dist/migrations/persistent/add-translations.d.ts.map +1 -0
  70. package/dist/migrations/{v2.1 → persistent}/add-translations.js +14 -12
  71. package/dist/migrations/persistent/check-upgrade-path.d.ts +36 -0
  72. package/dist/migrations/persistent/check-upgrade-path.d.ts.map +1 -0
  73. package/dist/migrations/persistent/check-upgrade-path.js +105 -0
  74. package/dist/migrations/persistent/update-toolkit-dependency.d.ts +7 -0
  75. package/dist/migrations/persistent/update-toolkit-dependency.d.ts.map +1 -0
  76. package/dist/migrations/persistent/update-toolkit-dependency.js +77 -0
  77. package/dist/migrations/read-declaration-through-helper.d.ts +39 -0
  78. package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -0
  79. package/dist/migrations/read-declaration-through-helper.js +199 -0
  80. package/dist/migrations/replace-incomplete-flag.d.ts +26 -0
  81. package/dist/migrations/replace-incomplete-flag.d.ts.map +1 -0
  82. package/dist/migrations/replace-incomplete-flag.js +126 -0
  83. package/dist/migrations/resolve-versioned-event-config.d.ts +56 -0
  84. package/dist/migrations/resolve-versioned-event-config.d.ts.map +1 -0
  85. package/dist/migrations/resolve-versioned-event-config.js +353 -0
  86. package/dist/migrations/utils.d.ts +61 -0
  87. package/dist/migrations/utils.d.ts.map +1 -0
  88. package/dist/migrations/utils.js +218 -0
  89. package/dist/notification/index.js +887 -129
  90. package/dist/scopes/index.d.ts +83 -90
  91. package/dist/scopes/index.js +26 -6
  92. package/dist/templates/charts-values/dependencies/values.yaml +3 -2
  93. package/dist/templates/charts-values/opencrvs-services/values.yaml +5 -7
  94. package/dist/templates/charts-values/traefik/values.yaml +4 -3
  95. package/dist/verify/endpoints.d.ts +11 -0
  96. package/dist/verify/endpoints.d.ts.map +1 -1
  97. package/dist/verify/endpoints.js +21 -27
  98. package/opencrvs-toolkit-2.2.0-rc.1a111f2.tgz +0 -0
  99. package/package.json +3 -2
  100. package/tsconfig.build.tsbuildinfo +1 -1
  101. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +0 -3
  102. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +0 -1
  103. package/dist/migrations/v2.1/add-explicit-correction-flags.js +0 -234
  104. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +0 -3
  105. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +0 -1
  106. package/dist/migrations/v2.1/add-recovery-link-notifications.js +0 -511
  107. package/dist/migrations/v2.1/add-translations.d.ts.map +0 -1
  108. package/dist/migrations/v2.1/enable-telemetry.d.ts +0 -3
  109. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +0 -1
  110. package/dist/migrations/v2.1/enable-telemetry.js +0 -455
  111. package/dist/migrations/v2.1/index.d.ts +0 -6
  112. package/dist/migrations/v2.1/index.d.ts.map +0 -1
  113. package/dist/migrations/v2.1/index.js +0 -2170
  114. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts +0 -14
  115. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts.map +0 -1
  116. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.js +0 -348
  117. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +0 -2
  118. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +0 -1
  119. package/dist/migrations/v2.1/remove-metabase-package-installs.js +0 -161
  120. package/dist/migrations/v2.1/remove-sentry.d.ts +0 -3
  121. package/dist/migrations/v2.1/remove-sentry.d.ts.map +0 -1
  122. package/dist/migrations/v2.1/remove-sentry.js +0 -354
  123. package/dist/migrations/v2.1/rename-trigger-paths.d.ts +0 -3
  124. package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +0 -1
  125. package/dist/migrations/v2.1/rename-trigger-paths.js +0 -216
  126. package/dist/migrations/v2.1/template-files.d.ts +0 -8
  127. package/dist/migrations/v2.1/template-files.d.ts.map +0 -1
  128. package/dist/migrations/v2.1/template-files.js +0 -49
  129. package/dist/migrations/v2.1/upgrade-tilt.d.ts +0 -8
  130. package/dist/migrations/v2.1/upgrade-tilt.d.ts.map +0 -1
  131. package/dist/migrations/v2.1/upgrade-tilt.js +0 -139
  132. package/dist/templates/countryconfig-template/.tiltignore +0 -1
  133. package/dist/templates/countryconfig-template/Dockerfile.assets +0 -7
  134. package/dist/templates/countryconfig-template/Tiltfile +0 -112
  135. package/dist/templates/countryconfig-template/assets/README.md +0 -1
  136. package/dist/templates/countryconfig-template/assets/clear-all-data-dev.sh +0 -61
  137. package/dist/templates/countryconfig-template/assets/deployment/deploy.sh +0 -455
  138. package/dist/templates/countryconfig-template/assets/deployment/reindex.sh +0 -168
  139. package/dist/templates/countryconfig-template/assets/deployment/validate-required-variables-in-compose-files.ts +0 -67
  140. package/dist/templates/countryconfig-template/assets/elasticsearch/reindex.sh +0 -168
  141. package/dist/templates/countryconfig-template/assets/metabase/README.md +0 -34
  142. package/dist/templates/countryconfig-template/assets/metabase/environment-configuration.sql +0 -36
  143. package/dist/templates/countryconfig-template/assets/metabase/initialize-database.sh +0 -46
  144. package/dist/templates/countryconfig-template/assets/metabase/metabase.init.db.sql +0 -27737
  145. package/dist/templates/countryconfig-template/assets/metabase/open-shell.sh +0 -21
  146. package/dist/templates/countryconfig-template/assets/metabase/package.json +0 -13
  147. package/dist/templates/countryconfig-template/assets/metabase/run-dev.sh +0 -108
  148. package/dist/templates/countryconfig-template/assets/metabase/run.sh +0 -120
  149. package/dist/templates/countryconfig-template/assets/metabase/update-database.sh +0 -40
  150. package/dist/templates/countryconfig-template/assets/postgres/setup-analytics.sh +0 -135
  151. package/dist/templates/countryconfig-template/assets/postgres/setup-reference-data.sh +0 -108
  152. package/dist/templates/countryconfig-template/tilt/clear-all-data.ps1 +0 -50
  153. package/dist/templates/countryconfig-template/tilt/clear-all-data.sh +0 -35
  154. package/dist/templates/countryconfig-template/tilt/common.tilt +0 -145
  155. package/dist/templates/countryconfig-template/tilt/examples/dependencies/values.yaml +0 -15
  156. package/dist/templates/countryconfig-template/tilt/examples/opencrvs-services/values.yaml +0 -56
  157. package/dist/templates/countryconfig-template/tilt/examples/traefik/values-minikube.yaml +0 -21
  158. package/dist/templates/countryconfig-template/tilt/examples/traefik/values.yaml +0 -38
  159. package/dist/templates/countryconfig-template/tilt/helm/dependencies/values.yaml +0 -17
  160. package/dist/templates/countryconfig-template/tilt/helm/opencrvs-services/values.yaml +0 -16
  161. package/dist/templates/countryconfig-template/tilt/lib.tilt +0 -95
  162. package/dist/templates/countryconfig-template/tilt/opencrvs.tilt +0 -136
  163. package/opencrvs-toolkit-2.1.2.tgz +0 -0
@@ -1,168 +0,0 @@
1
- #!/usr/bin/env sh
2
- # This Source Code Form is subject to the terms of the Mozilla Public
3
- # License, v. 2.0. If a copy of the MPL was not distributed with this
4
- # file, You can obtain one at https://mozilla.org/MPL/2.0/.
5
- #
6
- # OpenCRVS is also distributed under the terms of the Civil Registration
7
- # & Healthcare Disclaimer located at http://opencrvs.org/license.
8
- #
9
- # Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
10
-
11
- set -eu
12
-
13
- EVENTS_URL="${EVENTS_URL:-http://localhost:5555/}"
14
- AUTH_URL="${AUTH_URL:-http://localhost:4040/}"
15
- POLL_INTERVAL="${POLL_INTERVAL:-10}"
16
- MAX_POLLS="${MAX_POLLS:-1080}"
17
-
18
- get_reindexing_token() {
19
- curl -s "${AUTH_URL%/}/internal/reindexing-token" | jq -r '.token'
20
- }
21
-
22
- fire_trigger() {
23
- local token=$1
24
- curl -s -o /dev/null \
25
- -X POST \
26
- -H "Authorization: Bearer ${token}" \
27
- -H "Content-Type: application/json" \
28
- -d '{"waitForCompletion": false}' \
29
- "${EVENTS_URL%/}/events/reindex"
30
- }
31
-
32
- fetch_latest_run_since() {
33
- local token=$1
34
- local since
35
- local response
36
- local tmp
37
- local json_type
38
- local code
39
-
40
- since=$(echo "$2" | cut -c1-19)
41
- tmp=$(mktemp)
42
-
43
- response=$(curl -sS \
44
- -H "Authorization: Bearer ${token}" \
45
- -H "Content-Type: application/json" \
46
- "${EVENTS_URL%/}/events/reindex" 2>&1) || {
47
- echo "ERROR: failed to fetch reindex status:" >&2
48
- echo "$response" >&2
49
- rm -f "$tmp"
50
- return 1
51
- }
52
-
53
- printf '%s' "$response" > "$tmp"
54
-
55
- json_type=$(jq -r 'type' "$tmp" 2>/dev/null) || {
56
- echo "ERROR: reindex status response is not valid JSON:" >&2
57
- cat "$tmp" >&2
58
- rm -f "$tmp"
59
- return 1
60
- }
61
-
62
- if [ "$json_type" != "array" ]; then
63
- code=$(jq -r '.code // .data.code // empty' "$tmp")
64
-
65
- if [ "$code" = "UNAUTHORIZED" ]; then
66
- echo "WARN: reindex status token expired; refreshing token..." >&2
67
- rm -f "$tmp"
68
- return 2
69
- fi
70
-
71
- echo "ERROR: unexpected reindex status response:" >&2
72
- jq -c '.' "$tmp" >&2
73
- rm -f "$tmp"
74
- return 1
75
- fi
76
-
77
- jq -c --arg since "$since" \
78
- 'map(select(.timestamp[0:19] >= $since)) | sort_by(.timestamp) | reverse | .[0] // empty' \
79
- "$tmp"
80
-
81
- rm -f "$tmp"
82
- }
83
-
84
- TRIGGER_TIME=$(date -u +"%Y-%m-%dT%H:%M:%S")
85
-
86
- echo "Requesting reindex token..."
87
- TOKEN=$(get_reindexing_token)
88
-
89
- echo "Triggering reindex..."
90
- fire_trigger "$TOKEN"
91
-
92
- echo "Polling reindex status..."
93
- polls=0
94
- first_poll=true
95
- while true; do
96
- if [ "$first_poll" = true ]; then
97
- sleep 3
98
- first_poll=false
99
- else
100
- sleep "${POLL_INTERVAL}"
101
- fi
102
- polls=$(( ${polls:-0} + 1 ))
103
-
104
- if RUN=$(fetch_latest_run_since "$TOKEN" "$TRIGGER_TIME"); then
105
- :
106
- else
107
- rc=$?
108
-
109
- if [ "$rc" -eq 2 ]; then
110
- echo " Token expired, refreshing token..."
111
- TOKEN=$(get_reindexing_token)
112
-
113
- if RUN=$(fetch_latest_run_since "$TOKEN" "$TRIGGER_TIME"); then
114
- :
115
- else
116
- echo "ERROR: failed to fetch reindex status after refreshing token."
117
- exit 1
118
- fi
119
- else
120
- echo "ERROR: failed to fetch reindex status."
121
- exit 1
122
- fi
123
- fi
124
-
125
- if [ -z "$RUN" ]; then
126
- echo " Waiting for reindex to start... (${polls})"
127
- if [ "${polls}" -gt "${MAX_POLLS}" ]; then
128
- echo "ERROR: timed out waiting for reindex to start."
129
- exit 1
130
- fi
131
- continue
132
- fi
133
-
134
- STATUS=$(echo "$RUN" | jq -r '.status')
135
- PROCESSED=$(echo "$RUN" | jq -r '.progress.processed')
136
-
137
- case "$STATUS" in
138
- running)
139
- echo " Running... ${PROCESSED} events processed so far"
140
- if [ "${polls}" -gt "${MAX_POLLS}" ]; then
141
- timeout_secs=$(( ${polls:-0} * ${POLL_INTERVAL:-10} ))
142
- echo "ERROR: reindex timed out after ${timeout_secs} seconds."
143
- exit 1
144
- fi
145
- ;;
146
- completed)
147
- SKIPPED=$(echo "$RUN" | jq -r '.progress.skipped // 0')
148
- echo " Reindex completed — ${PROCESSED} events processed."
149
- if [ "${SKIPPED}" -gt 0 ]; then
150
- echo " WARNING: ${SKIPPED} records were skipped because they could not be read:"
151
- echo "$RUN" | jq -r '.progress.errors[]? | " - " + .'
152
- echo " Please fix the errors and run the reindex again."
153
- fi
154
- exit 0
155
- ;;
156
- failed)
157
- ERROR=$(echo "$RUN" | jq -r '.error_message // "unknown error"')
158
- echo " ERROR: reindex failed: ${ERROR}"
159
- exit 1
160
- ;;
161
- *)
162
- echo " Unknown status '${STATUS}' — continuing to poll..."
163
- if [ "${polls}" -gt "${MAX_POLLS}" ]; then
164
- exit 1
165
- fi
166
- ;;
167
- esac
168
- done
@@ -1,34 +0,0 @@
1
- <!-- START doctoc generated TOC please keep comment here to allow auto update -->
2
- <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3
-
4
- **Table of Contents** _generated with [DocToc](https://github.com/thlorenz/doctoc)_
5
-
6
- - [OpenCRVS Analytics](#opencrvs-analytics)
7
- - [Run in development mode](#run-in-development-mode)
8
- - [Default credentials](#default-credentials)
9
-
10
- <!-- END doctoc generated TOC please keep comment here to allow auto update -->
11
-
12
- # OpenCRVS Analytics
13
-
14
- ### Requirements
15
-
16
- ```
17
- ❯ java -version
18
- openjdk version "21.0.8" 2025-07-15
19
- ```
20
-
21
- ### Run in development mode
22
-
23
- By default, Metabase is not started as part of the OpenCRVS stack as running it requires quite a bit of resources. You can use the following commands to use metabase in development:
24
-
25
- `yarn metabase` – Starts Metabase in port http://localhost:4444
26
- `yarn db:shell` - In the metabase directory – open a SQL shell for the database Metabase created
27
- `yarn db:clear:all` - Clear data from analytics dashboard
28
-
29
- ### Default credentials
30
-
31
- These are the default credentials for logging in to Metabase
32
-
33
- - Username: `user@opencrvs.org`
34
- - Password: `m3tabase`
@@ -1,36 +0,0 @@
1
- UPDATE
2
- PUBLIC.SETTING
3
- SET
4
- "VALUE" = '$OPENCRVS_METABASE_SITE_NAME'
5
- WHERE
6
- "KEY" = 'site-name';
7
-
8
- UPDATE
9
- PUBLIC.SETTING
10
- SET
11
- "VALUE" = '$OPENCRVS_METABASE_SITE_URL'
12
- WHERE
13
- "KEY" = 'site-url';
14
-
15
- UPDATE
16
- PUBLIC.SETTING
17
- SET
18
- "VALUE" = '{"cdc1d5eb-c7f8-8b01-b296-eda34d06b6da":{"name":"$OPENCRVS_METABASE_MAP_NAME","url":"$OPENCRVS_METABASE_MAP_URL","region_key":"$OPENCRVS_METABASE_MAP_REGION_KEY","region_name":"$OPENCRVS_METABASE_MAP_REGION_NAME"}}'
19
- WHERE
20
- "KEY" = 'custom-geojson';
21
-
22
- UPDATE
23
- PUBLIC.METABASE_DATABASE
24
- SET
25
- DETAILS = '{"ssl": $METABASE_DATABASE_SSL,"password":"$METABASE_DATABASE_PASSWORD","destination-database":false,"port":$METABASE_DATABASE_PORT,"advanced-options":false,"schema-filters-type":"all","dbname":"$METABASE_DATABASE_NAME","host":"$METABASE_DATABASE_HOST","tunnel-enabled": false,"user":"$METABASE_DATABASE_USER"}'
26
- WHERE
27
- NAME = 'OpenCRVS Analytics Database';
28
-
29
- UPDATE
30
- PUBLIC.CORE_USER
31
- SET
32
- EMAIL = '$OPENCRVS_METABASE_ADMIN_EMAIL',
33
- PASSWORD = '$OPENCRVS_METABASE_ADMIN_PASSWORD_HASH',
34
- PASSWORD_SALT = '$OPENCRVS_METABASE_ADMIN_PASSWORD_SALT'
35
- WHERE
36
- IS_SUPERUSER = true;
@@ -1,46 +0,0 @@
1
- # This Source Code Form is subject to the terms of the Mozilla Public
2
- # License, v. 2.0. If a copy of the MPL was not distributed with this
3
- # file, You can obtain one at https://mozilla.org/MPL/2.0/.
4
- #
5
- # OpenCRVS is also distributed under the terms of the Civil Registration
6
- # & Healthcare Disclaimer located at http://opencrvs.org/license.
7
- #
8
- # Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
9
-
10
- #!/bin/bash
11
-
12
- echo "Initializing Metabase database"
13
-
14
- metabase_jar=${METABASE_JAR:-'./metabase.jar'}
15
-
16
- metabase_db_path=${MB_DB_FILE:-'/data/metabase/metabase.mv.db'}
17
- metabase_db_path="${metabase_db_path}"
18
- metabase_db_dir="$(dirname $metabase_db_path)"
19
- metabase_db_path_for_metabase=${metabase_db_path%.mv.db}
20
-
21
- if [ -d "$metabase_db_dir" ]; then
22
- echo " Metabase DB directory: $metabase_db_dir"
23
- else
24
- mkdir -p "$metabase_db_dir"
25
- echo " Metabase DB directory created: $metabase_db_dir"
26
- fi
27
-
28
- init_sql_file=${MB_DB_INIT_SQL_FILE}
29
-
30
- ##########
31
- #
32
- # Create an empty database from SQL file
33
- #
34
- #########
35
-
36
-
37
- if [ -f "$init_sql_file" ]; then
38
- if [ ! -f "$metabase_db_path" ]; then
39
- echo "Creating database $metabase_db_path from $init_sql_file"
40
- java -cp "$metabase_jar" org.h2.tools.RunScript -url jdbc:h2:"$metabase_db_path_for_metabase" -script "$init_sql_file"
41
- echo "Database created"
42
- fi
43
- else
44
- echo "MB_DB_INIT_SQL_FILE $init_sql_file not found, SKIP"
45
- fi
46
-